From 99a4f94db5ae25dd1688fe29556ba46923715e5f Mon Sep 17 00:00:00 2001 From: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Date: Fri, 5 Jan 2024 13:37:53 +0100 Subject: [PATCH 1/9] feat(medusa-payment-stripe): Add delay to Stripe webhook (#5838) **What** - Migrate Stripe plugin to use API Routes + Subscribers - Change the behaviour of Stripe webhook Instead of processing webhook events immediately, we fire an event to perform the work in the background. The primary reason for changing the webhook is that the previous implementation led to occasional conflicts due to a race condition between the client's and the webhook's request to complete a cart. Now, we emit an event with a configurable delay (defaults to 2s) to prevent this from happening This approach was preferred over adding a timeout directly to the webhook execution, as it is generally best practice to respond to a webhook event immediately after receiving it. --- .changeset/metal-pans-beg.md | 6 ++++ packages/medusa-payment-stripe/package.json | 2 +- .../stripe-payments/[order_id]/route.ts | 7 ++++ .../src/api/hooks/index.ts | 18 ---------- .../src/api/hooks/stripe.ts | 25 ------------- .../medusa-payment-stripe/src/api/index.ts | 35 ------------------- .../src/api/middlewares.ts | 12 +++++++ .../src/api/stripe/hooks/route.ts | 28 +++++++++++++++ .../src/api/utils/__tests__/utils.spec.ts | 6 ++-- .../src/api/utils/utils.ts | 14 +++----- .../src/core/stripe-base.ts | 2 +- packages/medusa-payment-stripe/src/index.ts | 6 ++-- .../src/subscribers/stripe.ts | 24 +++++++++++++ .../src/{types.ts => types/index.ts} | 0 .../api/routes/store/auth/create-session.ts | 3 +- yarn.lock | 2 +- 16 files changed, 92 insertions(+), 98 deletions(-) create mode 100644 .changeset/metal-pans-beg.md create mode 100644 packages/medusa-payment-stripe/src/api/admin/orders/stripe-payments/[order_id]/route.ts delete mode 100644 packages/medusa-payment-stripe/src/api/hooks/index.ts delete mode 100644 packages/medusa-payment-stripe/src/api/hooks/stripe.ts delete mode 100644 packages/medusa-payment-stripe/src/api/index.ts create mode 100644 packages/medusa-payment-stripe/src/api/middlewares.ts create mode 100644 packages/medusa-payment-stripe/src/api/stripe/hooks/route.ts create mode 100644 packages/medusa-payment-stripe/src/subscribers/stripe.ts rename packages/medusa-payment-stripe/src/{types.ts => types/index.ts} (100%) diff --git a/.changeset/metal-pans-beg.md b/.changeset/metal-pans-beg.md new file mode 100644 index 0000000000000..a48e3a8af0643 --- /dev/null +++ b/.changeset/metal-pans-beg.md @@ -0,0 +1,6 @@ +--- +"@medusajs/medusa": patch +"medusa-payment-stripe": patch +--- + +feat(medusa-payment-stripe): Add delay to Stripe webhook diff --git a/packages/medusa-payment-stripe/package.json b/packages/medusa-payment-stripe/package.json index 8fa34bcf85d00..d6b847fd10834 100644 --- a/packages/medusa-payment-stripe/package.json +++ b/packages/medusa-payment-stripe/package.json @@ -48,9 +48,9 @@ "medusa-react": "^9.0.0" }, "dependencies": { + "@medusajs/utils": "^1.11.2", "body-parser": "^1.19.0", "express": "^4.17.1", - "medusa-core-utils": "^1.2.0", "stripe": "^11.10.0" }, "gitHead": "81a7ff73d012fda722f6e9ef0bd9ba0232d37808", diff --git a/packages/medusa-payment-stripe/src/api/admin/orders/stripe-payments/[order_id]/route.ts b/packages/medusa-payment-stripe/src/api/admin/orders/stripe-payments/[order_id]/route.ts new file mode 100644 index 0000000000000..06b28b0fed69c --- /dev/null +++ b/packages/medusa-payment-stripe/src/api/admin/orders/stripe-payments/[order_id]/route.ts @@ -0,0 +1,7 @@ +import { MedusaRequest, MedusaResponse } from "@medusajs/medusa" +import { getStripePayments } from "../../../../../controllers/get-payments" + +export const GET = async (req: MedusaRequest, res: MedusaResponse) => { + const payments = await getStripePayments(req) + res.json({ payments }) +} diff --git a/packages/medusa-payment-stripe/src/api/hooks/index.ts b/packages/medusa-payment-stripe/src/api/hooks/index.ts deleted file mode 100644 index 87a02f60c0f39..0000000000000 --- a/packages/medusa-payment-stripe/src/api/hooks/index.ts +++ /dev/null @@ -1,18 +0,0 @@ -import stripeHooks from "./stripe" -import { Router } from "express" -import bodyParser from "body-parser" -import { wrapHandler } from "@medusajs/medusa" - -const route = Router() - -export default (app) => { - app.use("/stripe", route) - - route.post( - "/hooks", - // stripe constructEvent fails without body-parser - bodyParser.raw({ type: "application/json" }), - wrapHandler(stripeHooks) - ) - return app -} diff --git a/packages/medusa-payment-stripe/src/api/hooks/stripe.ts b/packages/medusa-payment-stripe/src/api/hooks/stripe.ts deleted file mode 100644 index cb66a17e91b58..0000000000000 --- a/packages/medusa-payment-stripe/src/api/hooks/stripe.ts +++ /dev/null @@ -1,25 +0,0 @@ -import { Request, Response } from "express" -import { constructWebhook, handlePaymentHook } from "../utils/utils" - -export default async (req: Request, res: Response) => { - let event - try { - event = constructWebhook({ - signature: req.headers["stripe-signature"], - body: req.body, - container: req.scope, - }) - } catch (err) { - res.status(400).send(`Webhook Error: ${err.message}`) - return - } - - const paymentIntent = event.data.object - - const { statusCode } = await handlePaymentHook({ - event, - container: req.scope, - paymentIntent, - }) - res.sendStatus(statusCode) -} diff --git a/packages/medusa-payment-stripe/src/api/index.ts b/packages/medusa-payment-stripe/src/api/index.ts deleted file mode 100644 index 3c179b876f544..0000000000000 --- a/packages/medusa-payment-stripe/src/api/index.ts +++ /dev/null @@ -1,35 +0,0 @@ -import { authenticate } from "@medusajs/medusa" -import { ConfigModule } from "@medusajs/types" -import getConfigFile from "@medusajs/utils/dist/common/get-config-file" -import cors from "cors" -import { Router } from "express" -import { getStripePayments } from "../controllers/get-payments" -import hooks from "./hooks" - -export default (rootDirectory) => { - const app = Router() - - hooks(app) - - const { configModule } = getConfigFile( - rootDirectory, - "medusa-config" - ) - - const corsOptions = { - origin: configModule?.projectConfig?.admin_cors?.split(","), - credentials: true, - } - - app.use( - `/admin/orders/stripe-payments/:order_id`, - cors(corsOptions), - authenticate() - ) - app.get(`/admin/orders/stripe-payments/:order_id`, async (req, res) => { - const payments = await getStripePayments(req) - res.json({ payments }) - }) - - return app -} diff --git a/packages/medusa-payment-stripe/src/api/middlewares.ts b/packages/medusa-payment-stripe/src/api/middlewares.ts new file mode 100644 index 0000000000000..dcda4a8f249e8 --- /dev/null +++ b/packages/medusa-payment-stripe/src/api/middlewares.ts @@ -0,0 +1,12 @@ +import type { MiddlewaresConfig } from "@medusajs/medusa" +import { raw } from "body-parser" + +export const config: MiddlewaresConfig = { + routes: [ + { + bodyParser: false, + matcher: "/stripe/hooks", + middlewares: [raw({ type: "application/json" })], + }, + ], +} diff --git a/packages/medusa-payment-stripe/src/api/stripe/hooks/route.ts b/packages/medusa-payment-stripe/src/api/stripe/hooks/route.ts new file mode 100644 index 0000000000000..35132700a67b6 --- /dev/null +++ b/packages/medusa-payment-stripe/src/api/stripe/hooks/route.ts @@ -0,0 +1,28 @@ +import { MedusaRequest, MedusaResponse } from "@medusajs/medusa" +import { constructWebhook } from "../../utils/utils" + +const WEBHOOK_DELAY = process.env.STRIPE_WEBHOOK_DELAY ?? 5000 // 5s +const WEBHOOK_RETRIES = process.env.STRIPE_WEBHOOK_RETRIES ?? 3 + +export const POST = async (req: MedusaRequest, res: MedusaResponse) => { + try { + const event = constructWebhook({ + signature: req.headers["stripe-signature"], + body: req.body, + container: req.scope, + }) + + const eventBus = req.scope.resolve("eventBusService") + + // we delay the processing of the event to avoid a conflict caused by a race condition + await eventBus.emit("medusa.stripe_payment_intent_update", event, { + delay: WEBHOOK_DELAY, + attempts: WEBHOOK_RETRIES, + }) + } catch (err) { + res.status(400).send(`Webhook Error: ${err.message}`) + return + } + + res.sendStatus(200) +} diff --git a/packages/medusa-payment-stripe/src/api/utils/__tests__/utils.spec.ts b/packages/medusa-payment-stripe/src/api/utils/__tests__/utils.spec.ts index 0a46e2ff0c0e2..5d6ccf11afd50 100644 --- a/packages/medusa-payment-stripe/src/api/utils/__tests__/utils.spec.ts +++ b/packages/medusa-payment-stripe/src/api/utils/__tests__/utils.spec.ts @@ -1,8 +1,7 @@ import { PostgresError } from "@medusajs/medusa" -import Stripe from "stripe" import { EOL } from "os" +import Stripe from "stripe" -import { buildError, handlePaymentHook, isPaymentCollection } from "../utils" import { container } from "../__fixtures__/container" import { existingCartId, @@ -14,6 +13,7 @@ import { paymentId, paymentIntentId, } from "../__fixtures__/data" +import { buildError, handlePaymentHook, isPaymentCollection } from "../utils" describe("Utils", () => { afterEach(() => { @@ -334,7 +334,7 @@ describe("Utils", () => { const paymentIntent = { id: paymentIntentId, metadata: { cart_id: nonExistingCartId }, - last_payment_error: { message: "error message" }, + last_payment_error: { message: "error message" } as any, } await handlePaymentHook({ event, container, paymentIntent }) diff --git a/packages/medusa-payment-stripe/src/api/utils/utils.ts b/packages/medusa-payment-stripe/src/api/utils/utils.ts index bb2fa17bba0df..275afe5168eb7 100644 --- a/packages/medusa-payment-stripe/src/api/utils/utils.ts +++ b/packages/medusa-payment-stripe/src/api/utils/utils.ts @@ -4,8 +4,8 @@ import { IdempotencyKeyService, PostgresError, } from "@medusajs/medusa" +import { MedusaError } from "@medusajs/utils" import { AwilixContainer } from "awilix" -import { MedusaError } from "medusa-core-utils" import { EOL } from "os" import Stripe from "stripe" @@ -51,19 +51,15 @@ export async function handlePaymentHook({ container, paymentIntent, }: { - event: { type: string; id: string } + event: Partial container: AwilixContainer - paymentIntent: { - id: string - metadata: { cart_id?: string; resource_id?: string } - last_payment_error?: { message: string } - } + paymentIntent: Partial }): Promise<{ statusCode: number }> { const logger = container.resolve("logger") const cartId = - paymentIntent.metadata.cart_id ?? paymentIntent.metadata.resource_id // Backward compatibility - const resourceId = paymentIntent.metadata.resource_id + paymentIntent.metadata?.cart_id ?? paymentIntent.metadata?.resource_id // Backward compatibility + const resourceId = paymentIntent.metadata?.resource_id switch (event.type) { case "payment_intent.succeeded": diff --git a/packages/medusa-payment-stripe/src/core/stripe-base.ts b/packages/medusa-payment-stripe/src/core/stripe-base.ts index 0cdd4b2beedd4..df800aeade0cc 100644 --- a/packages/medusa-payment-stripe/src/core/stripe-base.ts +++ b/packages/medusa-payment-stripe/src/core/stripe-base.ts @@ -6,6 +6,7 @@ import { PaymentProcessorSessionResponse, PaymentSessionStatus, } from "@medusajs/medusa" +import { MedusaError } from "@medusajs/utils" import { EOL } from "os" import Stripe from "stripe" import { @@ -14,7 +15,6 @@ import { PaymentIntentOptions, StripeOptions, } from "../types" -import { MedusaError } from "@medusajs/utils" abstract class StripeBase extends AbstractPaymentProcessor { static identifier = "" diff --git a/packages/medusa-payment-stripe/src/index.ts b/packages/medusa-payment-stripe/src/index.ts index 5184713378a14..6b0f5ee0f2302 100644 --- a/packages/medusa-payment-stripe/src/index.ts +++ b/packages/medusa-payment-stripe/src/index.ts @@ -1,8 +1,8 @@ -export * from "./types" export * from "./core/stripe-base" -export * from "./services/stripe-blik" export * from "./services/stripe-bancontact" +export * from "./services/stripe-blik" export * from "./services/stripe-giropay" export * from "./services/stripe-ideal" -export * from "./services/stripe-przelewy24" export * from "./services/stripe-provider" +export * from "./services/stripe-przelewy24" +export * from "./types" diff --git a/packages/medusa-payment-stripe/src/subscribers/stripe.ts b/packages/medusa-payment-stripe/src/subscribers/stripe.ts new file mode 100644 index 0000000000000..739bcb4350dca --- /dev/null +++ b/packages/medusa-payment-stripe/src/subscribers/stripe.ts @@ -0,0 +1,24 @@ +import { type SubscriberArgs, type SubscriberConfig } from "@medusajs/medusa" +import Stripe from "stripe" +import { handlePaymentHook } from "../api/utils/utils" + +export default async function stripeHandler({ + data, + container, +}: SubscriberArgs) { + const event = data + const paymentIntent = event.data.object as Stripe.PaymentIntent + + await handlePaymentHook({ + event, + container, + paymentIntent, + }) +} + +export const config: SubscriberConfig = { + event: "medusa.stripe_payment_intent_update", + context: { + subscriberId: "medusa.stripe_payment_intent_update", + }, +} diff --git a/packages/medusa-payment-stripe/src/types.ts b/packages/medusa-payment-stripe/src/types/index.ts similarity index 100% rename from packages/medusa-payment-stripe/src/types.ts rename to packages/medusa-payment-stripe/src/types/index.ts diff --git a/packages/medusa/src/api/routes/store/auth/create-session.ts b/packages/medusa/src/api/routes/store/auth/create-session.ts index d89508054208d..9540e98bdc9a1 100644 --- a/packages/medusa/src/api/routes/store/auth/create-session.ts +++ b/packages/medusa/src/api/routes/store/auth/create-session.ts @@ -1,10 +1,9 @@ import { IsEmail, IsNotEmpty } from "class-validator" -import jwt from "jsonwebtoken" import { EntityManager } from "typeorm" +import { defaultRelations } from "." import AuthService from "../../../../services/auth" import CustomerService from "../../../../services/customer" import { validator } from "../../../../utils/validator" -import { defaultRelations } from "." /** * @oas [post] /store/auth diff --git a/yarn.lock b/yarn.lock index b153d61a67295..159c7348f1ba7 100644 --- a/yarn.lock +++ b/yarn.lock @@ -35980,6 +35980,7 @@ __metadata: dependencies: "@medusajs/admin": ^7.1.7 "@medusajs/medusa": ^1.17.4 + "@medusajs/utils": ^1.11.2 "@tanstack/react-table": ^8.7.9 "@types/stripe": ^8.0.417 awilix: ^8.0.1 @@ -35987,7 +35988,6 @@ __metadata: cross-env: ^5.2.1 express: ^4.17.1 jest: ^25.5.4 - medusa-core-utils: ^1.2.0 medusa-react: ^9.0.11 rimraf: ^5.0.1 stripe: ^11.10.0 From bf63c4e6a32258565e1d361b8919afbf93cc2c72 Mon Sep 17 00:00:00 2001 From: Adrien de Peretti Date: Fri, 5 Jan 2024 14:40:58 +0100 Subject: [PATCH 2/9] feat(orchestration, workflows-sdk): Add events management and implementation to manage async workflows (#5951) * feat(orchestration, workflows-sdk): Add events management and implementation to manage async workflows * Create fresh-boxes-scream.md * cleanup * fix: resolveValue input ref * resolve value recursive * chore: resolve result value only for new api * chore: save checkpoint before scheduling * features * fix: beginTransaction checking existing transaction --------- Co-authored-by: Carlos R. L. Rodrigues Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com> --- .changeset/fresh-boxes-scream.md | 6 + .../transaction/transaction-orchestrator.ts | 33 +- .../transaction/datastore/abstract-storage.ts | 118 ++++ .../datastore/base-in-memory-storage.ts | 37 ++ .../transaction/distributed-transaction.ts | 144 ++++- .../orchestration/src/transaction/errors.ts | 29 + .../orchestration/src/transaction/index.ts | 9 +- .../transaction/transaction-orchestrator.ts | 554 ++++++++++++++---- .../src/transaction/transaction-step.ts | 65 +- .../orchestration/src/transaction/types.ts | 64 ++ .../src/workflow/global-workflow.ts | 52 +- .../src/workflow/local-workflow.ts | 247 +++++++- .../helper/__tests__/workflow-export.spec.ts | 22 + .../src/helper/workflow-export.ts | 249 ++++++-- packages/workflows-sdk/src/index.ts | 1 + packages/workflows-sdk/src/medusa-workflow.ts | 27 + .../src/utils/composer/create-workflow.ts | 59 +- .../utils/composer/helpers/resolve-value.ts | 2 +- 18 files changed, 1441 insertions(+), 277 deletions(-) create mode 100644 .changeset/fresh-boxes-scream.md create mode 100644 packages/orchestration/src/transaction/datastore/abstract-storage.ts create mode 100644 packages/orchestration/src/transaction/datastore/base-in-memory-storage.ts create mode 100644 packages/workflows-sdk/src/medusa-workflow.ts diff --git a/.changeset/fresh-boxes-scream.md b/.changeset/fresh-boxes-scream.md new file mode 100644 index 0000000000000..95cd2fb067aec --- /dev/null +++ b/.changeset/fresh-boxes-scream.md @@ -0,0 +1,6 @@ +--- +"@medusajs/orchestration": patch +"@medusajs/workflows-sdk": patch +--- + +feat(orchestration, workflows-sdk): Add events management and implementation to manage async workflows diff --git a/packages/orchestration/src/__tests__/transaction/transaction-orchestrator.ts b/packages/orchestration/src/__tests__/transaction/transaction-orchestrator.ts index 557291f6d323d..19dcbdcfbbfe3 100644 --- a/packages/orchestration/src/__tests__/transaction/transaction-orchestrator.ts +++ b/packages/orchestration/src/__tests__/transaction/transaction-orchestrator.ts @@ -70,8 +70,8 @@ describe("Transaction Orchestrator", () => { expect.objectContaining({ metadata: { model_id: "transaction-name", - reply_to_topic: "trans:transaction-name", - idempotency_key: "transaction_id_123:firstMethod:invoke", + idempotency_key: + "transaction-name:transaction_id_123:firstMethod:invoke", action: "firstMethod", action_type: "invoke", attempt: 1, @@ -85,8 +85,8 @@ describe("Transaction Orchestrator", () => { expect.objectContaining({ metadata: { model_id: "transaction-name", - reply_to_topic: "trans:transaction-name", - idempotency_key: "transaction_id_123:secondMethod:invoke", + idempotency_key: + "transaction-name:transaction_id_123:secondMethod:invoke", action: "secondMethod", action_type: "invoke", attempt: 1, @@ -654,6 +654,7 @@ describe("Transaction Orchestrator", () => { next: { action: "firstMethod", async: true, + compensateAsync: true, next: { action: "secondMethod", }, @@ -675,8 +676,10 @@ describe("Transaction Orchestrator", () => { expect(mocks.one).toBeCalledTimes(1) expect(mocks.two).toBeCalledTimes(0) expect(transaction.getState()).toBe(TransactionState.INVOKING) + expect(transaction.getFlow().hasWaitingSteps).toBe(true) const mocktransactionId = TransactionOrchestrator.getKeyName( + "transaction-name", transaction.transactionId, "firstMethod", TransactionHandlerType.INVOKE @@ -688,6 +691,7 @@ describe("Transaction Orchestrator", () => { ) expect(transaction.getState()).toBe(TransactionState.DONE) + expect(transaction.getFlow().hasWaitingSteps).toBe(false) }) it("Should hold the status COMPENSATING while the transaction hasn't finished compensating", async () => { @@ -731,8 +735,11 @@ describe("Transaction Orchestrator", () => { next: { action: "firstMethod", async: true, + compensateAsync: true, next: { action: "secondMethod", + async: true, + compensateAsync: true, }, }, } @@ -745,22 +752,31 @@ describe("Transaction Orchestrator", () => { ) const mocktransactionId = TransactionOrchestrator.getKeyName( + "transaction-name", transaction.transactionId, "firstMethod", TransactionHandlerType.INVOKE ) - const registerBeforeAllowed = await strategy - .registerStepFailure(mocktransactionId, null, handler) - .catch((e) => e.message) + const mockSecondStepId = TransactionOrchestrator.getKeyName( + "transaction-name", + transaction.transactionId, + "secondMethod", + TransactionHandlerType.INVOKE + ) await strategy.resume(transaction) expect(mocks.one).toBeCalledTimes(1) expect(mocks.compensateOne).toBeCalledTimes(0) expect(mocks.two).toBeCalledTimes(0) + + const registerBeforeAllowed = await strategy + .registerStepSuccess(mockSecondStepId, handler) + .catch((e) => e.message) + expect(registerBeforeAllowed).toEqual( - "Cannot set step failure when status is idle" + "Cannot set step success when status is idle" ) expect(transaction.getState()).toBe(TransactionState.INVOKING) @@ -774,6 +790,7 @@ describe("Transaction Orchestrator", () => { expect(mocks.compensateOne).toBeCalledTimes(1) const mocktransactionIdCompensate = TransactionOrchestrator.getKeyName( + "transaction-name", transaction.transactionId, "firstMethod", TransactionHandlerType.COMPENSATE diff --git a/packages/orchestration/src/transaction/datastore/abstract-storage.ts b/packages/orchestration/src/transaction/datastore/abstract-storage.ts new file mode 100644 index 0000000000000..aab8c5e677c5a --- /dev/null +++ b/packages/orchestration/src/transaction/datastore/abstract-storage.ts @@ -0,0 +1,118 @@ +import { + DistributedTransaction, + TransactionCheckpoint, +} from "../distributed-transaction" +import { TransactionStep } from "../transaction-step" +import { TransactionModelOptions } from "../types" + +export interface IDistributedTransactionStorage { + get(key: string): Promise + list(): Promise + save(key: string, data: TransactionCheckpoint, ttl?: number): Promise + delete(key: string): Promise + archive(key: string, options?: TransactionModelOptions): Promise + scheduleRetry( + transaction: DistributedTransaction, + step: TransactionStep, + timestamp: number, + interval: number + ): Promise + clearRetry( + transaction: DistributedTransaction, + step: TransactionStep + ): Promise + scheduleTransactionTimeout( + transaction: DistributedTransaction, + timestamp: number, + interval: number + ): Promise + scheduleStepTimeout( + transaction: DistributedTransaction, + step: TransactionStep, + timestamp: number, + interval: number + ): Promise + clearTransactionTimeout(transaction: DistributedTransaction): Promise + clearStepTimeout( + transaction: DistributedTransaction, + step: TransactionStep + ): Promise +} + +export abstract class DistributedTransactionStorage + implements IDistributedTransactionStorage +{ + constructor() { + /* noop */ + } + + async get(key: string): Promise { + throw new Error("Method 'get' not implemented.") + } + + async list(): Promise { + throw new Error("Method 'list' not implemented.") + } + + async save( + key: string, + data: TransactionCheckpoint, + ttl?: number + ): Promise { + throw new Error("Method 'save' not implemented.") + } + + async delete(key: string): Promise { + throw new Error("Method 'delete' not implemented.") + } + + async archive(key: string, options?: TransactionModelOptions): Promise { + throw new Error("Method 'archive' not implemented.") + } + + async scheduleRetry( + transaction: DistributedTransaction, + step: TransactionStep, + timestamp: number, + interval: number + ): Promise { + throw new Error("Method 'scheduleRetry' not implemented.") + } + + async clearRetry( + transaction: DistributedTransaction, + step: TransactionStep + ): Promise { + throw new Error("Method 'clearRetry' not implemented.") + } + + async scheduleTransactionTimeout( + transaction: DistributedTransaction, + timestamp: number, + interval: number + ): Promise { + throw new Error("Method 'scheduleTransactionTimeout' not implemented.") + } + + async clearTransactionTimeout( + transaction: DistributedTransaction + ): Promise { + throw new Error("Method 'clearTransactionTimeout' not implemented.") + } + + async scheduleStepTimeout( + transaction: DistributedTransaction, + step: TransactionStep, + timestamp: number, + interval: number + ): Promise { + throw new Error("Method 'scheduleStepTimeout' not implemented.") + } + + async clearStepTimeout( + transaction: DistributedTransaction, + step: TransactionStep + ): Promise { + throw new Error("Method 'clearStepTimeout' not implemented.") + } +} diff --git a/packages/orchestration/src/transaction/datastore/base-in-memory-storage.ts b/packages/orchestration/src/transaction/datastore/base-in-memory-storage.ts new file mode 100644 index 0000000000000..69ab557a03f02 --- /dev/null +++ b/packages/orchestration/src/transaction/datastore/base-in-memory-storage.ts @@ -0,0 +1,37 @@ +import { TransactionCheckpoint } from "../distributed-transaction" +import { TransactionModelOptions } from "../types" +import { DistributedTransactionStorage } from "./abstract-storage" + +// eslint-disable-next-line max-len +export class BaseInMemoryDistributedTransactionStorage extends DistributedTransactionStorage { + private storage: Map + + constructor() { + super() + this.storage = new Map() + } + + async get(key: string): Promise { + return this.storage.get(key) + } + + async list(): Promise { + return Array.from(this.storage.values()) + } + + async save( + key: string, + data: TransactionCheckpoint, + ttl?: number + ): Promise { + this.storage.set(key, data) + } + + async delete(key: string): Promise { + this.storage.delete(key) + } + + async archive(key: string, options?: TransactionModelOptions): Promise { + this.storage.delete(key) + } +} diff --git a/packages/orchestration/src/transaction/distributed-transaction.ts b/packages/orchestration/src/transaction/distributed-transaction.ts index cd283e0a7e763..16d05c2f62a5d 100644 --- a/packages/orchestration/src/transaction/distributed-transaction.ts +++ b/packages/orchestration/src/transaction/distributed-transaction.ts @@ -1,12 +1,17 @@ import { isDefined } from "@medusajs/utils" -import { TransactionFlow } from "./transaction-orchestrator" -import { TransactionStepHandler } from "./transaction-step" +import { EventEmitter } from "events" +import { IDistributedTransactionStorage } from "./datastore/abstract-storage" +import { BaseInMemoryDistributedTransactionStorage } from "./datastore/base-in-memory-storage" +import { + TransactionFlow, + TransactionOrchestrator, +} from "./transaction-orchestrator" +import { TransactionStep, TransactionStepHandler } from "./transaction-step" import { TransactionHandlerType, TransactionState } from "./types" /** * @typedef TransactionMetadata * @property model_id - The id of the model_id that created the transaction (modelId). - * @property reply_to_topic - The topic to reply to for the transaction. * @property idempotency_key - The idempotency key of the transaction. * @property action - The action of the transaction. * @property action_type - The type of the transaction. @@ -15,7 +20,6 @@ import { TransactionHandlerType, TransactionState } from "./types" */ export type TransactionMetadata = { model_id: string - reply_to_topic: string idempotency_key: string action: string action_type: TransactionHandlerType @@ -70,13 +74,19 @@ export class TransactionPayload { * DistributedTransaction represents a distributed transaction, which is a transaction that is composed of multiple steps that are executed in a specific order. */ -export class DistributedTransaction { +export class DistributedTransaction extends EventEmitter { public modelId: string public transactionId: string private readonly errors: TransactionStepError[] = [] - private readonly context: TransactionContext = new TransactionContext() + private static keyValueStore: IDistributedTransactionStorage + + public static setStorage(storage: IDistributedTransactionStorage) { + this.keyValueStore = storage + } + + private static keyPrefix = "dtrans" constructor( private flow: TransactionFlow, @@ -85,6 +95,8 @@ export class DistributedTransaction { errors?: TransactionStepError[], context?: TransactionContext ) { + super() + this.transactionId = flow.transactionId this.modelId = flow.modelId @@ -156,6 +168,7 @@ export class DistributedTransaction { this.getFlow().state === TransactionState.INVOKING ) } + public canRevert(): boolean { return ( this.getFlow().state === TransactionState.DONE || @@ -163,36 +176,129 @@ export class DistributedTransaction { ) } - public static keyValueStore: any = {} // TODO: Use Key/Value db - private static keyPrefix = "dtrans:" - public async saveCheckpoint(): Promise { - // TODO: Use Key/Value db to save transactions - const key = DistributedTransaction.keyPrefix + this.transactionId + public hasTimeout(): boolean { + return !!this.getFlow().definition.timeout + } + + public getTimeoutInterval(): number | undefined { + return this.getFlow().definition.timeout + } + + public async saveCheckpoint( + ttl = 0 + ): Promise { + const options = this.getFlow().options + if (!options?.storeExecution) { + return + } + const data = new TransactionCheckpoint( this.getFlow(), this.getContext(), this.getErrors() ) - DistributedTransaction.keyValueStore[key] = JSON.stringify(data) + + const key = TransactionOrchestrator.getKeyName( + DistributedTransaction.keyPrefix, + this.modelId, + this.transactionId + ) + await DistributedTransaction.keyValueStore.save(key, data, ttl) return data } public static async loadTransaction( + modelId: string, transactionId: string ): Promise { - // TODO: Use Key/Value db to load transactions - const key = DistributedTransaction.keyPrefix + transactionId - if (DistributedTransaction.keyValueStore[key]) { - return JSON.parse(DistributedTransaction.keyValueStore[key]) + const key = TransactionOrchestrator.getKeyName( + DistributedTransaction.keyPrefix, + modelId, + transactionId + ) + + const loadedData = await DistributedTransaction.keyValueStore.get(key) + if (loadedData) { + return loadedData } return null } public async deleteCheckpoint(): Promise { - // TODO: Delete from Key/Value db - const key = DistributedTransaction.keyPrefix + this.transactionId - delete DistributedTransaction.keyValueStore[key] + const options = this.getFlow().options + if (!options?.storeExecution) { + return + } + + const key = TransactionOrchestrator.getKeyName( + DistributedTransaction.keyPrefix, + this.modelId, + this.transactionId + ) + await DistributedTransaction.keyValueStore.delete(key) + } + + public async archiveCheckpoint(): Promise { + const options = this.getFlow().options + + const key = TransactionOrchestrator.getKeyName( + DistributedTransaction.keyPrefix, + this.modelId, + this.transactionId + ) + await DistributedTransaction.keyValueStore.archive(key, options) + } + + public async scheduleRetry( + step: TransactionStep, + interval: number + ): Promise { + await this.saveCheckpoint() + await DistributedTransaction.keyValueStore.scheduleRetry( + this, + step, + Date.now(), + interval + ) + } + + public async clearRetry(step: TransactionStep): Promise { + await DistributedTransaction.keyValueStore.clearRetry(this, step) + } + + public async scheduleTransactionTimeout(interval: number): Promise { + await this.saveCheckpoint() + await DistributedTransaction.keyValueStore.scheduleTransactionTimeout( + this, + Date.now(), + interval + ) + } + + public async clearTransactionTimeout(): Promise { + await DistributedTransaction.keyValueStore.clearTransactionTimeout(this) + } + + public async scheduleStepTimeout( + step: TransactionStep, + interval: number + ): Promise { + await this.saveCheckpoint() + await DistributedTransaction.keyValueStore.scheduleStepTimeout( + this, + step, + Date.now(), + interval + ) + } + + public async clearStepTimeout(step: TransactionStep): Promise { + await DistributedTransaction.keyValueStore.clearStepTimeout(this, step) } } + +DistributedTransaction.setStorage( + new BaseInMemoryDistributedTransactionStorage() +) diff --git a/packages/orchestration/src/transaction/errors.ts b/packages/orchestration/src/transaction/errors.ts index 95a093c5b3a95..331784e80c3f9 100644 --- a/packages/orchestration/src/transaction/errors.ts +++ b/packages/orchestration/src/transaction/errors.ts @@ -13,3 +13,32 @@ export class PermanentStepFailureError extends Error { this.name = "PermanentStepFailure" } } + +export class StepTimeoutError extends Error { + static isStepTimeoutError(error: Error): error is StepTimeoutError { + return ( + error instanceof StepTimeoutError || error.name === "StepTimeoutError" + ) + } + + constructor(message?: string) { + super(message) + this.name = "StepTimeoutError" + } +} + +export class TransactionTimeoutError extends Error { + static isTransactionTimeoutError( + error: Error + ): error is TransactionTimeoutError { + return ( + error instanceof TransactionTimeoutError || + error.name === "TransactionTimeoutError" + ) + } + + constructor(message?: string) { + super(message) + this.name = "TransactionTimeoutError" + } +} diff --git a/packages/orchestration/src/transaction/index.ts b/packages/orchestration/src/transaction/index.ts index 6633e3b3c3acf..d06cb879ef7d2 100644 --- a/packages/orchestration/src/transaction/index.ts +++ b/packages/orchestration/src/transaction/index.ts @@ -1,6 +1,7 @@ -export * from "./types" -export * from "./transaction-orchestrator" -export * from "./transaction-step" +export * from "./datastore/abstract-storage" export * from "./distributed-transaction" -export * from "./orchestrator-builder" export * from "./errors" +export * from "./orchestrator-builder" +export * from "./transaction-orchestrator" +export * from "./transaction-step" +export * from "./types" diff --git a/packages/orchestration/src/transaction/transaction-orchestrator.ts b/packages/orchestration/src/transaction/transaction-orchestrator.ts index fd6b74cd23afe..1e1c79a8427dd 100644 --- a/packages/orchestration/src/transaction/transaction-orchestrator.ts +++ b/packages/orchestration/src/transaction/transaction-orchestrator.ts @@ -5,22 +5,33 @@ import { } from "./distributed-transaction" import { TransactionStep, TransactionStepHandler } from "./transaction-step" import { + DistributedTransactionEvent, TransactionHandlerType, + TransactionModelOptions, TransactionState, - TransactionStepsDefinition, TransactionStepStatus, + TransactionStepsDefinition, } from "./types" +import { MedusaError, promiseAll } from "@medusajs/utils" import { EventEmitter } from "events" -import { promiseAll } from "@medusajs/utils" -import { PermanentStepFailureError } from "./errors" +import { + PermanentStepFailureError, + StepTimeoutError, + TransactionTimeoutError, +} from "./errors" export type TransactionFlow = { modelId: string + options?: TransactionModelOptions definition: TransactionStepsDefinition transactionId: string + hasAsyncSteps: boolean hasFailedSteps: boolean + hasWaitingSteps: boolean hasSkippedSteps: boolean + timedOutAt: number | null + startedAt?: number state: TransactionState steps: { [key: string]: TransactionStep @@ -33,13 +44,15 @@ export type TransactionFlow = { */ export class TransactionOrchestrator extends EventEmitter { private static ROOT_STEP = "_root" + public static DEFAULT_TTL = 30 private invokeSteps: string[] = [] private compensateSteps: string[] = [] public static DEFAULT_RETRIES = 0 constructor( public id: string, - private definition: TransactionStepsDefinition + private definition: TransactionStepsDefinition, + private options?: TransactionModelOptions ) { super() } @@ -126,12 +139,34 @@ export class TransactionOrchestrator extends EventEmitter { } } - private checkAllSteps(transaction: DistributedTransaction): { + private async checkStepTimeout(transaction, step) { + let hasTimedOut = false + if ( + step.hasTimeout() && + !step.timedOutAt && + step.canCancel() && + step.startedAt! + step.getTimeoutInterval()! * 1e3 < Date.now() + ) { + step.timedOutAt = Date.now() + await transaction.saveCheckpoint() + this.emit(DistributedTransactionEvent.TIMEOUT, { transaction }) + await TransactionOrchestrator.setStepFailure( + transaction, + step, + new StepTimeoutError(), + 0 + ) + hasTimedOut = true + } + return hasTimedOut + } + + private async checkAllSteps(transaction: DistributedTransaction): Promise<{ next: TransactionStep[] total: number remaining: number completed: number - } { + }> { let hasSkipped = false let hasIgnoredFailure = false let hasFailed = false @@ -158,12 +193,44 @@ export class TransactionOrchestrator extends EventEmitter { const stepDef = flow.steps[step] const curState = stepDef.getStates() + const hasTimedOut = await this.checkStepTimeout(transaction, stepDef) + if (hasTimedOut) { + continue + } + if (curState.status === TransactionStepStatus.WAITING) { hasWaiting = true - if (stepDef.canRetry()) { - nextSteps.push(stepDef) + + if (stepDef.hasAwaitingRetry()) { + if (stepDef.canRetryAwaiting()) { + stepDef.retryRescheduledAt = null + nextSteps.push(stepDef) + } else if (!stepDef.retryRescheduledAt) { + stepDef.hasScheduledRetry = true + stepDef.retryRescheduledAt = Date.now() + + await transaction.scheduleRetry( + stepDef, + stepDef.definition.retryIntervalAwaiting! + ) + } } + continue + } else if (curState.status === TransactionStepStatus.TEMPORARY_FAILURE) { + if (!stepDef.canRetry()) { + if (stepDef.hasRetryInterval() && !stepDef.retryRescheduledAt) { + stepDef.hasScheduledRetry = true + stepDef.retryRescheduledAt = Date.now() + + await transaction.scheduleRetry( + stepDef, + stepDef.definition.retryInterval! + ) + } + continue + } + stepDef.retryRescheduledAt = null } if (stepDef.canInvoke(flow.state) || stepDef.canCompensate(flow.state)) { @@ -185,6 +252,8 @@ export class TransactionOrchestrator extends EventEmitter { } } + flow.hasWaitingSteps = hasWaiting + const totalSteps = allSteps.length - 1 if ( flow.state === TransactionState.WAITING_TO_COMPENSATE && @@ -194,9 +263,9 @@ export class TransactionOrchestrator extends EventEmitter { flow.state = TransactionState.COMPENSATING this.flagStepsToRevert(flow) - this.emit("compensate", transaction) + this.emit(DistributedTransactionEvent.COMPENSATE_BEGIN, { transaction }) - return this.checkAllSteps(transaction) + return await this.checkAllSteps(transaction) } else if (completedSteps === totalSteps) { if (hasSkipped) { flow.hasSkippedSteps = true @@ -211,11 +280,6 @@ export class TransactionOrchestrator extends EventEmitter { ? TransactionState.REVERTED : TransactionState.DONE } - - this.emit("finish", transaction) - - // TODO: check TransactionModel if it should delete the checkpoint when the transaction is done - void transaction.deleteCheckpoint() } return { @@ -267,9 +331,25 @@ export class TransactionOrchestrator extends EventEmitter { step.changeState(TransactionState.DONE) } - if (step.definition.async) { + const flow = transaction.getFlow() + if (step.definition.async || flow.options?.strictCheckpoints) { await transaction.saveCheckpoint() } + + const cleaningUp: Promise[] = [] + if (step.hasRetryScheduled()) { + cleaningUp.push(transaction.clearRetry(step)) + } + if (step.hasTimeout()) { + cleaningUp.push(transaction.clearStepTimeout(step)) + } + + await promiseAll(cleaningUp) + + const eventName = step.isCompensating() + ? DistributedTransactionEvent.COMPENSATE_STEP_SUCCESS + : DistributedTransactionEvent.STEP_SUCCESS + transaction.emit(eventName, { step, transaction }) } private static async setStepFailure( @@ -282,6 +362,8 @@ export class TransactionOrchestrator extends EventEmitter { step.changeStatus(TransactionStepStatus.TEMPORARY_FAILURE) + const flow = transaction.getFlow() + const cleaningUp: Promise[] = [] if (step.failures > maxRetries) { step.changeState(TransactionState.FAILED) step.changeStatus(TransactionStepStatus.PERMANENT_FAILURE) @@ -295,7 +377,6 @@ export class TransactionOrchestrator extends EventEmitter { ) if (!step.isCompensating()) { - const flow = transaction.getFlow() if (step.definition.continueOnPermanentFailure) { for (const childStep of step.next) { const child = flow.steps[childStep] @@ -305,107 +386,175 @@ export class TransactionOrchestrator extends EventEmitter { flow.state = TransactionState.WAITING_TO_COMPENSATE } } + + if (step.hasTimeout()) { + cleaningUp.push(transaction.clearStepTimeout(step)) + } + } + + if (step.definition.async || flow.options?.strictCheckpoints) { + await transaction.saveCheckpoint() } - if (step.definition.async) { + if (step.hasRetryScheduled()) { + cleaningUp.push(transaction.clearRetry(step)) + } + + await promiseAll(cleaningUp) + + const eventName = step.isCompensating() + ? DistributedTransactionEvent.COMPENSATE_STEP_FAILURE + : DistributedTransactionEvent.STEP_FAILURE + transaction.emit(eventName, { step, transaction }) + } + + private async checkTransactionTimeout(transaction, currentSteps) { + let hasTimedOut = false + const flow = transaction.getFlow() + if ( + transaction.hasTimeout() && + !flow.timedOutAt && + flow.startedAt! + transaction.getTimeoutInterval()! * 1e3 < Date.now() + ) { + flow.timedOutAt = Date.now() + this.emit(DistributedTransactionEvent.TIMEOUT, { transaction }) + + for (const step of currentSteps) { + await TransactionOrchestrator.setStepFailure( + transaction, + step, + new TransactionTimeoutError(), + 0 + ) + } + await transaction.saveCheckpoint() + + hasTimedOut = true } + return hasTimedOut } private async executeNext( transaction: DistributedTransaction ): Promise { - if (transaction.hasFinished()) { - return - } + let continueExecution = true - const flow = transaction.getFlow() - const nextSteps = this.checkAllSteps(transaction) - const execution: Promise[] = [] + while (continueExecution) { + if (transaction.hasFinished()) { + return + } - for (const step of nextSteps.next) { - const curState = step.getStates() - const type = step.isCompensating() - ? TransactionHandlerType.COMPENSATE - : TransactionHandlerType.INVOKE + const flow = transaction.getFlow() + const nextSteps = await this.checkAllSteps(transaction) + const execution: Promise[] = [] - step.lastAttempt = Date.now() - step.attempts++ + const hasTimedOut = await this.checkTransactionTimeout( + transaction, + nextSteps.next + ) + if (hasTimedOut) { + continue + } - if (curState.state === TransactionState.NOT_STARTED) { - if (step.isCompensating()) { - step.changeState(TransactionState.COMPENSATING) + if (nextSteps.remaining === 0) { + if (transaction.hasTimeout()) { + await transaction.clearTransactionTimeout() + } - if (step.definition.noCompensation) { - step.changeState(TransactionState.REVERTED) - continue - } - } else if (flow.state === TransactionState.INVOKING) { - step.changeState(TransactionState.INVOKING) + if (flow.options?.retentionTime == undefined) { + await transaction.deleteCheckpoint() + } else { + await transaction.archiveCheckpoint() } + + this.emit(DistributedTransactionEvent.FINISH, { transaction }) } - step.changeStatus(TransactionStepStatus.WAITING) - - const payload = new TransactionPayload( - { - model_id: flow.modelId, - reply_to_topic: TransactionOrchestrator.getKeyName( - "trans", - flow.modelId - ), - idempotency_key: TransactionOrchestrator.getKeyName( - flow.transactionId, - step.definition.action!, - type - ), - action: step.definition.action + "", - action_type: type, - attempt: step.attempts, - timestamp: Date.now(), - }, - transaction.payload, - transaction.getContext() - ) + let hasSyncSteps = false + for (const step of nextSteps.next) { + const curState = step.getStates() + const type = step.isCompensating() + ? TransactionHandlerType.COMPENSATE + : TransactionHandlerType.INVOKE - const setStepFailure = async ( - error: Error | any, - { endRetry }: { endRetry?: boolean } = {} - ) => { - return TransactionOrchestrator.setStepFailure( - transaction, - step, - error, - endRetry ? 0 : step.definition.maxRetries - ) - } + step.lastAttempt = Date.now() + step.attempts++ - if (!step.definition.async) { - execution.push( - transaction - .handler(step.definition.action + "", type, payload, transaction) - .then(async (response: any) => { - await TransactionOrchestrator.setStepSuccess( - transaction, - step, - response - ) - }) - .catch(async (error) => { - if ( - PermanentStepFailureError.isPermanentStepFailureError(error) - ) { - await setStepFailure(error, { endRetry: true }) - return - } - await setStepFailure(error) - }) + if (curState.state === TransactionState.NOT_STARTED) { + if (!step.startedAt) { + step.startedAt = Date.now() + } + + if (step.isCompensating()) { + step.changeState(TransactionState.COMPENSATING) + + if (step.definition.noCompensation) { + step.changeState(TransactionState.REVERTED) + continue + } + } else if (flow.state === TransactionState.INVOKING) { + step.changeState(TransactionState.INVOKING) + } + } + + step.changeStatus(TransactionStepStatus.WAITING) + + const payload = new TransactionPayload( + { + model_id: flow.modelId, + idempotency_key: TransactionOrchestrator.getKeyName( + flow.modelId, + flow.transactionId, + step.definition.action!, + type + ), + action: step.definition.action + "", + action_type: type, + attempt: step.attempts, + timestamp: Date.now(), + }, + transaction.payload, + transaction.getContext() ) - } else { - execution.push( - transaction.saveCheckpoint().then(async () => + + if (step.hasTimeout() && !step.timedOutAt && step.attempts === 1) { + await transaction.scheduleStepTimeout(step, step.definition.timeout!) + } + + transaction.emit(DistributedTransactionEvent.STEP_BEGIN, { + step, + transaction, + }) + + const setStepFailure = async ( + error: Error | any, + { endRetry }: { endRetry?: boolean } = {} + ) => { + return TransactionOrchestrator.setStepFailure( + transaction, + step, + error, + endRetry ? 0 : step.definition.maxRetries + ) + } + + const isAsync = step.isCompensating() + ? step.definition.compensateAsync + : step.definition.async + + if (!isAsync) { + hasSyncSteps = true + execution.push( transaction .handler(step.definition.action + "", type, payload, transaction) + .then(async (response: any) => { + await TransactionOrchestrator.setStepSuccess( + transaction, + step, + response + ) + }) .catch(async (error) => { if ( PermanentStepFailureError.isPermanentStepFailureError(error) @@ -413,17 +562,44 @@ export class TransactionOrchestrator extends EventEmitter { await setStepFailure(error, { endRetry: true }) return } + await setStepFailure(error) }) ) - ) + } else { + execution.push( + transaction.saveCheckpoint().then(async () => + transaction + .handler( + step.definition.action + "", + type, + payload, + transaction + ) + .catch(async (error) => { + if ( + PermanentStepFailureError.isPermanentStepFailureError(error) + ) { + await setStepFailure(error, { endRetry: true }) + return + } + + await setStepFailure(error) + }) + ) + ) + } + } + + if (hasSyncSteps && flow.options?.strictCheckpoints) { + await transaction.saveCheckpoint() } - } - await promiseAll(execution) + await promiseAll(execution) - if (nextSteps.next.length > 0) { - await this.executeNext(transaction) + if (nextSteps.next.length === 0) { + continueExecution = false + } } } @@ -433,7 +609,8 @@ export class TransactionOrchestrator extends EventEmitter { */ public async resume(transaction: DistributedTransaction): Promise { if (transaction.modelId !== this.id) { - throw new Error( + throw new MedusaError( + MedusaError.Types.NOT_ALLOWED, `TransactionModel "${transaction.modelId}" cannot be orchestrated by "${this.id}" model.` ) } @@ -446,9 +623,23 @@ export class TransactionOrchestrator extends EventEmitter { if (flow.state === TransactionState.NOT_STARTED) { flow.state = TransactionState.INVOKING - this.emit("begin", transaction) + flow.startedAt = Date.now() + + if (this.options?.storeExecution) { + await transaction.saveCheckpoint( + flow.hasAsyncSteps ? 0 : TransactionOrchestrator.DEFAULT_TTL + ) + } + + if (transaction.hasTimeout()) { + await transaction.scheduleTransactionTimeout( + transaction.getTimeoutInterval()! + ) + } + + this.emit(DistributedTransactionEvent.BEGIN, { transaction }) } else { - this.emit("resume", transaction) + this.emit(DistributedTransactionEvent.RESUME, { transaction }) } await this.executeNext(transaction) @@ -462,14 +653,18 @@ export class TransactionOrchestrator extends EventEmitter { transaction: DistributedTransaction ): Promise { if (transaction.modelId !== this.id) { - throw new Error( + throw new MedusaError( + MedusaError.Types.NOT_ALLOWED, `TransactionModel "${transaction.modelId}" cannot be orchestrated by "${this.id}" model.` ) } const flow = transaction.getFlow() if (flow.state === TransactionState.FAILED) { - throw new Error(`Cannot revert a perment failed transaction.`) + throw new MedusaError( + MedusaError.Types.NOT_ALLOWED, + `Cannot revert a perment failed transaction.` + ) } flow.state = TransactionState.WAITING_TO_COMPENSATE @@ -477,33 +672,54 @@ export class TransactionOrchestrator extends EventEmitter { await this.executeNext(transaction) } - private async createTransactionFlow( - transactionId: string - ): Promise { - return { + private createTransactionFlow(transactionId: string): TransactionFlow { + const [steps, features] = TransactionOrchestrator.buildSteps( + this.definition + ) + + const hasAsyncSteps = features.hasAsyncSteps + const hasStepTimeouts = features.hasStepTimeouts + const hasRetriesTimeout = features.hasRetriesTimeout + + this.options ??= {} + if (hasAsyncSteps || hasStepTimeouts || hasRetriesTimeout) { + this.options.storeExecution = true + } + + const flow: TransactionFlow = { modelId: this.id, + options: this.options, transactionId: transactionId, + hasAsyncSteps, hasFailedSteps: false, hasSkippedSteps: false, + hasWaitingSteps: false, + timedOutAt: null, state: TransactionState.NOT_STARTED, definition: this.definition, - steps: TransactionOrchestrator.buildSteps(this.definition), + steps, } + + return flow } private static async loadTransactionById( + modelId: string, transactionId: string ): Promise { const transaction = await DistributedTransaction.loadTransaction( + modelId, transactionId ) if (transaction !== null) { const flow = transaction.flow - transaction.flow.steps = TransactionOrchestrator.buildSteps( + const [steps] = TransactionOrchestrator.buildSteps( flow.definition, flow.steps ) + + transaction.flow.steps = steps return transaction } @@ -513,7 +729,14 @@ export class TransactionOrchestrator extends EventEmitter { private static buildSteps( flow: TransactionStepsDefinition, existingSteps?: { [key: string]: TransactionStep } - ): { [key: string]: TransactionStep } { + ): [ + { [key: string]: TransactionStep }, + { + hasAsyncSteps: boolean + hasStepTimeouts: boolean + hasRetriesTimeout: boolean + } + ] { const states: { [key: string]: TransactionStep } = { [TransactionOrchestrator.ROOT_STEP]: { id: TransactionOrchestrator.ROOT_STEP, @@ -526,6 +749,12 @@ export class TransactionOrchestrator extends EventEmitter { { obj: flow, level: [TransactionOrchestrator.ROOT_STEP] }, ] + const features = { + hasAsyncSteps: false, + hasStepTimeouts: false, + hasRetriesTimeout: false, + } + while (queue.length > 0) { const { obj, level } = queue.shift() @@ -547,11 +776,28 @@ export class TransactionOrchestrator extends EventEmitter { const id = level.join(".") const parent = level.slice(0, level.length - 1).join(".") - states[parent].next?.push(id) + if (!existingSteps || parent === TransactionOrchestrator.ROOT_STEP) { + states[parent].next?.push(id) + } const definitionCopy = { ...obj } delete definitionCopy.next + if (definitionCopy.async) { + features.hasAsyncSteps = true + } + + if (definitionCopy.timeout) { + features.hasStepTimeouts = true + } + + if ( + definitionCopy.retryInterval || + definitionCopy.retryIntervalAwaiting + ) { + features.hasRetriesTimeout = true + } + states[id] = Object.assign( new TransactionStep(), existingSteps?.[id] || { @@ -577,7 +823,7 @@ export class TransactionOrchestrator extends EventEmitter { } } - return states + return [states, features] } /** Create a new transaction @@ -591,12 +837,12 @@ export class TransactionOrchestrator extends EventEmitter { payload?: unknown ): Promise { const existingTransaction = - await TransactionOrchestrator.loadTransactionById(transactionId) + await TransactionOrchestrator.loadTransactionById(this.id, transactionId) let newTransaction = false - let modelFlow + let modelFlow: TransactionFlow if (!existingTransaction) { - modelFlow = await this.createTransactionFlow(transactionId) + modelFlow = this.createTransactionFlow(transactionId) newTransaction = true } else { modelFlow = existingTransaction.flow @@ -609,13 +855,49 @@ export class TransactionOrchestrator extends EventEmitter { existingTransaction?.errors, existingTransaction?.context ) - if (newTransaction) { - await transaction.saveCheckpoint() + + if ( + newTransaction && + this.options?.storeExecution && + this.options?.strictCheckpoints + ) { + await transaction.saveCheckpoint( + modelFlow.hasAsyncSteps ? 0 : TransactionOrchestrator.DEFAULT_TTL + ) } return transaction } + /** Returns an existing transaction + * @param transactionId - unique identifier of the transaction + * @param handler - function to handle action of the transaction + */ + public async retrieveExistingTransaction( + transactionId: string, + handler: TransactionStepHandler + ): Promise { + const existingTransaction = + await TransactionOrchestrator.loadTransactionById(this.id, transactionId) + + if (!existingTransaction) { + throw new MedusaError( + MedusaError.Types.NOT_FOUND, + `Transaction ${transactionId} could not be found.` + ) + } + + const transaction = new DistributedTransaction( + existingTransaction.flow, + handler, + undefined, + existingTransaction?.errors, + existingTransaction?.context + ) + + return transaction + } + private static getStepByAction( flow: TransactionFlow, action: string @@ -633,9 +915,8 @@ export class TransactionOrchestrator extends EventEmitter { handler?: TransactionStepHandler, transaction?: DistributedTransaction ): Promise<[DistributedTransaction, TransactionStep]> { - const [transactionId, action, actionType] = responseIdempotencyKey.split( - TransactionOrchestrator.SEPARATOR - ) + const [modelId, transactionId, action, actionType] = + responseIdempotencyKey.split(TransactionOrchestrator.SEPARATOR) if (!transaction && !handler) { throw new Error( @@ -645,10 +926,16 @@ export class TransactionOrchestrator extends EventEmitter { if (!transaction) { const existingTransaction = - await TransactionOrchestrator.loadTransactionById(transactionId) + await TransactionOrchestrator.loadTransactionById( + modelId, + transactionId + ) if (existingTransaction === null) { - throw new Error(`Transaction ${transactionId} could not be found.`) + throw new MedusaError( + MedusaError.Types.NOT_FOUND, + `Transaction ${transactionId} could not be found.` + ) } transaction = new DistributedTransaction( @@ -697,16 +984,20 @@ export class TransactionOrchestrator extends EventEmitter { ) if (step.getStates().status === TransactionStepStatus.WAITING) { + this.emit(DistributedTransactionEvent.RESUME, { + transaction: curTransaction, + }) + await TransactionOrchestrator.setStepSuccess( curTransaction, step, response ) - this.emit("resume", curTransaction) await this.executeNext(curTransaction) } else { - throw new Error( + throw new MedusaError( + MedusaError.Types.NOT_ALLOWED, `Cannot set step success when status is ${step.getStates().status}` ) } @@ -736,16 +1027,21 @@ export class TransactionOrchestrator extends EventEmitter { ) if (step.getStates().status === TransactionStepStatus.WAITING) { + this.emit(DistributedTransactionEvent.RESUME, { + transaction: curTransaction, + }) + await TransactionOrchestrator.setStepFailure( curTransaction, step, error, 0 ) - this.emit("resume", curTransaction) + await this.executeNext(curTransaction) } else { - throw new Error( + throw new MedusaError( + MedusaError.Types.NOT_ALLOWED, `Cannot set step failure when status is ${step.getStates().status}` ) } diff --git a/packages/orchestration/src/transaction/transaction-step.ts b/packages/orchestration/src/transaction/transaction-step.ts index 72f63e9d25a58..57b06acf31e84 100644 --- a/packages/orchestration/src/transaction/transaction-step.ts +++ b/packages/orchestration/src/transaction/transaction-step.ts @@ -1,3 +1,4 @@ +import { MedusaError } from "@medusajs/utils" import { DistributedTransaction, TransactionPayload, @@ -5,8 +6,8 @@ import { import { TransactionHandlerType, TransactionState, - TransactionStepStatus, TransactionStepsDefinition, + TransactionStepStatus, } from "./types" export type TransactionStepHandler = ( @@ -30,6 +31,8 @@ export class TransactionStep { * @member attempts - The number of attempts made to execute the step * @member failures - The number of failures encountered while executing the step * @member lastAttempt - The timestamp of the last attempt made to execute the step + * @member hasScheduledRetry - A flag indicating if a retry has been scheduled + * @member retryRescheduledAt - The timestamp of the last retry scheduled * @member next - The ids of the next steps in the flow * @member saveResponse - A flag indicating if the response of a step should be shared in the transaction context and available to subsequent steps - default is true */ @@ -48,6 +51,10 @@ export class TransactionStep { attempts: number failures: number lastAttempt: number | null + retryRescheduledAt: number | null + hasScheduledRetry: boolean + timedOutAt: number | null + startedAt?: number next: string[] saveResponse: boolean @@ -70,6 +77,10 @@ export class TransactionStep { return this.stepFailed } + public isInvoking() { + return !this.stepFailed + } + public changeState(toState: TransactionState) { const allowed = { [TransactionState.DORMANT]: [TransactionState.NOT_STARTED], @@ -99,7 +110,8 @@ export class TransactionStep { return } - throw new Error( + throw new MedusaError( + MedusaError.Types.NOT_ALLOWED, `Updating State from "${curState.state}" to "${toState}" is not allowed.` ) } @@ -128,16 +140,49 @@ export class TransactionStep { return } - throw new Error( + throw new MedusaError( + MedusaError.Types.NOT_ALLOWED, `Updating Status from "${curState.status}" to "${toStatus}" is not allowed.` ) } + hasRetryScheduled(): boolean { + return !!this.hasScheduledRetry + } + + hasRetryInterval(): boolean { + return !!this.definition.retryInterval + } + + hasTimeout(): boolean { + return !!this.definition.timeout + } + + getTimeoutInterval(): number | undefined { + return this.definition.timeout + } + canRetry(): boolean { + return ( + !this.definition.retryInterval || + !!( + this.lastAttempt && + this.definition.retryInterval && + Date.now() - this.lastAttempt > this.definition.retryInterval * 1e3 + ) + ) + } + + hasAwaitingRetry(): boolean { + return !!this.definition.retryIntervalAwaiting + } + + canRetryAwaiting(): boolean { return !!( + this.hasAwaitingRetry() && this.lastAttempt && - this.definition.retryInterval && - Date.now() - this.lastAttempt > this.definition.retryInterval * 1e3 + Date.now() - this.lastAttempt > + this.definition.retryIntervalAwaiting! * 1e3 ) } @@ -158,4 +203,14 @@ export class TransactionStep { flowState === TransactionState.COMPENSATING ) } + + canCancel(): boolean { + return ( + !this.isCompensating() && + [ + TransactionStepStatus.WAITING, + TransactionStepStatus.TEMPORARY_FAILURE, + ].includes(this.getStates().status) + ) + } } diff --git a/packages/orchestration/src/transaction/types.ts b/packages/orchestration/src/transaction/types.ts index 25ab21c78ddf9..16f27985f5c62 100644 --- a/packages/orchestration/src/transaction/types.ts +++ b/packages/orchestration/src/transaction/types.ts @@ -1,3 +1,6 @@ +import { DistributedTransaction } from "./distributed-transaction" +import { TransactionStep } from "./transaction-step" + export enum TransactionHandlerType { INVOKE = "invoke", COMPENSATE = "compensate", @@ -9,8 +12,10 @@ export type TransactionStepsDefinition = { noCompensation?: boolean maxRetries?: number retryInterval?: number + retryIntervalAwaiting?: number timeout?: number async?: boolean + compensateAsync?: boolean noWait?: boolean saveResponse?: boolean next?: TransactionStepsDefinition | TransactionStepsDefinition[] @@ -36,8 +41,67 @@ export enum TransactionState { SKIPPED = "skipped", } +export type TransactionModelOptions = { + timeout?: number + storeExecution?: boolean + retentionTime?: number + strictCheckpoints?: boolean +} + export type TransactionModel = { id: string flow: TransactionStepsDefinition hash: string + options?: TransactionModelOptions +} + +export enum DistributedTransactionEvent { + BEGIN = "begin", + RESUME = "resume", + COMPENSATE_BEGIN = "compensateBegin", + FINISH = "finish", + TIMEOUT = "timeout", + STEP_BEGIN = "stepBegin", + STEP_SUCCESS = "stepSuccess", + STEP_FAILURE = "stepFailure", + COMPENSATE_STEP_SUCCESS = "compensateStepSuccess", + COMPENSATE_STEP_FAILURE = "compensateStepFailure", +} + +export type DistributedTransactionEvents = { + onBegin?: (args: { transaction: DistributedTransaction }) => void + onResume?: (args: { transaction: DistributedTransaction }) => void + onFinish?: (args: { + transaction: DistributedTransaction + result?: unknown + errors?: unknown[] + }) => void + onTimeout?: (args: { transaction: DistributedTransaction }) => void + + onStepBegin?: (args: { + step: TransactionStep + transaction: DistributedTransaction + }) => void + + onStepSuccess?: (args: { + step: TransactionStep + transaction: DistributedTransaction + }) => void + + onStepFailure?: (args: { + step: TransactionStep + transaction: DistributedTransaction + }) => void + + onCompensateBegin?: (args: { transaction: DistributedTransaction }) => void + + onCompensateStepSuccess?: (args: { + step: TransactionStep + transaction: DistributedTransaction + }) => void + + onCompensateStepFailure?: (args: { + step: TransactionStep + transaction: DistributedTransaction + }) => void } diff --git a/packages/orchestration/src/workflow/global-workflow.ts b/packages/orchestration/src/workflow/global-workflow.ts index 0cc69e2ac0f01..49975060989e2 100644 --- a/packages/orchestration/src/workflow/global-workflow.ts +++ b/packages/orchestration/src/workflow/global-workflow.ts @@ -2,17 +2,22 @@ import { Context, LoadedModule, MedusaContainer } from "@medusajs/types" import { createContainerLike, createMedusaContainer } from "@medusajs/utils" import { asValue } from "awilix" -import { DistributedTransaction } from "../transaction" +import { + DistributedTransaction, + DistributedTransactionEvents, +} from "../transaction" import { WorkflowDefinition, WorkflowManager } from "./workflow-manager" export class GlobalWorkflow extends WorkflowManager { protected static workflows: Map = new Map() protected container: MedusaContainer protected context: Context + protected subscribe: DistributedTransactionEvents constructor( modulesLoaded?: LoadedModule[] | MedusaContainer, - context?: Context + context?: Context, + subscribe?: DistributedTransactionEvents ) { super() @@ -35,6 +40,7 @@ export class GlobalWorkflow extends WorkflowManager { this.container = container this.context = context ?? {} + this.subscribe = subscribe ?? {} } async run(workflowId: string, uniqueTransactionId: string, input?: unknown) { @@ -52,6 +58,18 @@ export class GlobalWorkflow extends WorkflowManager { input ) + if (this.subscribe.onStepBegin) { + transaction.once("stepBegin", this.subscribe.onStepBegin) + } + + if (this.subscribe.onStepSuccess) { + transaction.once("stepSuccess", this.subscribe.onStepSuccess) + } + + if (this.subscribe.onStepFailure) { + transaction.once("stepFailure", this.subscribe.onStepFailure) + } + await orchestrator.resume(transaction) return transaction @@ -67,6 +85,21 @@ export class GlobalWorkflow extends WorkflowManager { } const workflow = WorkflowManager.workflows.get(workflowId)! + const orchestrator = workflow.orchestrator + orchestrator.once("resume", (transaction) => { + if (this.subscribe.onStepBegin) { + transaction.once("stepBegin", this.subscribe.onStepBegin) + } + + if (this.subscribe.onStepSuccess) { + transaction.once("stepSuccess", this.subscribe.onStepSuccess) + } + + if (this.subscribe.onStepFailure) { + transaction.once("stepFailure", this.subscribe.onStepFailure) + } + }) + return await workflow.orchestrator.registerStepSuccess( idempotencyKey, workflow.handler(this.container, this.context), @@ -85,6 +118,21 @@ export class GlobalWorkflow extends WorkflowManager { } const workflow = WorkflowManager.workflows.get(workflowId)! + const orchestrator = workflow.orchestrator + orchestrator.once("resume", (transaction) => { + if (this.subscribe.onStepBegin) { + transaction.once("stepBegin", this.subscribe.onStepBegin) + } + + if (this.subscribe.onStepSuccess) { + transaction.once("stepSuccess", this.subscribe.onStepSuccess) + } + + if (this.subscribe.onStepFailure) { + transaction.once("stepFailure", this.subscribe.onStepFailure) + } + }) + return await workflow.orchestrator.registerStepFailure( idempotencyKey, error, diff --git a/packages/orchestration/src/workflow/local-workflow.ts b/packages/orchestration/src/workflow/local-workflow.ts index 5228b2ee28442..c19436a14cb39 100644 --- a/packages/orchestration/src/workflow/local-workflow.ts +++ b/packages/orchestration/src/workflow/local-workflow.ts @@ -3,6 +3,8 @@ import { createContainerLike, createMedusaContainer } from "@medusajs/utils" import { asValue } from "awilix" import { DistributedTransaction, + DistributedTransactionEvent, + DistributedTransactionEvents, TransactionOrchestrator, TransactionStepsDefinition, } from "../transaction" @@ -79,7 +81,174 @@ export class LocalWorkflow { return this.workflow.flow_ } - async run(uniqueTransactionId: string, input?: unknown, context?: Context) { + private registerEventCallbacks({ + orchestrator, + transaction, + subscribe, + idempotencyKey, + }: { + orchestrator: TransactionOrchestrator + transaction?: DistributedTransaction + subscribe?: DistributedTransactionEvents + idempotencyKey?: string + }) { + const modelId = orchestrator.id + let transactionId + + if (transaction) { + transactionId = transaction!.transactionId + } else if (idempotencyKey) { + const [, trxId] = idempotencyKey!.split(":") + transactionId = trxId + } + + const eventWrapperMap = new Map() + for (const [key, handler] of Object.entries(subscribe ?? {})) { + eventWrapperMap.set(key, (args) => { + const { transaction } = args + + if ( + transaction.transactionId !== transactionId || + transaction.modelId !== modelId + ) { + return + } + + handler(args) + }) + } + + if (subscribe?.onBegin) { + orchestrator.on( + DistributedTransactionEvent.BEGIN, + eventWrapperMap.get("onBegin") + ) + } + + if (subscribe?.onResume) { + orchestrator.on( + DistributedTransactionEvent.RESUME, + eventWrapperMap.get("onResume") + ) + } + + if (subscribe?.onCompensateBegin) { + orchestrator.on( + DistributedTransactionEvent.COMPENSATE_BEGIN, + eventWrapperMap.get("onCompensateBegin") + ) + } + + if (subscribe?.onTimeout) { + orchestrator.on( + DistributedTransactionEvent.TIMEOUT, + eventWrapperMap.get("onTimeout") + ) + } + + if (subscribe?.onFinish) { + orchestrator.on( + DistributedTransactionEvent.FINISH, + eventWrapperMap.get("onFinish") + ) + } + + const resumeWrapper = ({ transaction }) => { + if ( + transaction.modelId !== modelId || + transaction.transactionId !== transactionId + ) { + return + } + + if (subscribe?.onStepBegin) { + transaction.on( + DistributedTransactionEvent.STEP_BEGIN, + eventWrapperMap.get("onStepBegin") + ) + } + + if (subscribe?.onStepSuccess) { + transaction.on( + DistributedTransactionEvent.STEP_SUCCESS, + eventWrapperMap.get("onStepSuccess") + ) + } + + if (subscribe?.onStepFailure) { + transaction.on( + DistributedTransactionEvent.STEP_FAILURE, + eventWrapperMap.get("onStepFailure") + ) + } + + if (subscribe?.onCompensateStepSuccess) { + transaction.on( + DistributedTransactionEvent.COMPENSATE_STEP_SUCCESS, + eventWrapperMap.get("onCompensateStepSuccess") + ) + } + + if (subscribe?.onCompensateStepFailure) { + transaction.on( + DistributedTransactionEvent.COMPENSATE_STEP_FAILURE, + eventWrapperMap.get("onCompensateStepFailure") + ) + } + } + + if (transaction) { + resumeWrapper({ transaction }) + } else { + orchestrator.once("resume", resumeWrapper) + } + + const cleanUp = () => { + subscribe?.onFinish && + orchestrator.removeListener( + DistributedTransactionEvent.FINISH, + eventWrapperMap.get("onFinish") + ) + subscribe?.onResume && + orchestrator.removeListener( + DistributedTransactionEvent.RESUME, + eventWrapperMap.get("onResume") + ) + subscribe?.onBegin && + orchestrator.removeListener( + DistributedTransactionEvent.BEGIN, + eventWrapperMap.get("onBegin") + ) + subscribe?.onCompensateBegin && + orchestrator.removeListener( + DistributedTransactionEvent.COMPENSATE_BEGIN, + eventWrapperMap.get("onCompensateBegin") + ) + subscribe?.onTimeout && + orchestrator.removeListener( + DistributedTransactionEvent.TIMEOUT, + eventWrapperMap.get("onTimeout") + ) + + orchestrator.removeListener( + DistributedTransactionEvent.RESUME, + resumeWrapper + ) + + eventWrapperMap.clear() + } + + return { + cleanUpEventListeners: cleanUp, + } + } + + async run( + uniqueTransactionId: string, + input?: unknown, + context?: Context, + subscribe?: DistributedTransactionEvents + ) { if (this.flow.hasChanges) { this.commit() } @@ -92,36 +261,104 @@ export class LocalWorkflow { input ) + const { cleanUpEventListeners } = this.registerEventCallbacks({ + orchestrator, + transaction, + subscribe, + }) + await orchestrator.resume(transaction) + cleanUpEventListeners() + + return transaction + } + + async getRunningTransaction(uniqueTransactionId: string, context?: Context) { + const { handler, orchestrator } = this.workflow + + const transaction = await orchestrator.retrieveExistingTransaction( + uniqueTransactionId, + handler(this.container, context) + ) + + return transaction + } + + async cancel( + uniqueTransactionId: string, + context?: Context, + subscribe?: DistributedTransactionEvents + ) { + const { orchestrator } = this.workflow + + const transaction = await this.getRunningTransaction( + uniqueTransactionId, + context + ) + + const { cleanUpEventListeners } = this.registerEventCallbacks({ + orchestrator, + transaction, + subscribe, + }) + + await orchestrator.cancelTransaction(transaction) + + cleanUpEventListeners() + return transaction } async registerStepSuccess( idempotencyKey: string, response?: unknown, - context?: Context + context?: Context, + subscribe?: DistributedTransactionEvents ): Promise { const { handler, orchestrator } = this.workflow - return await orchestrator.registerStepSuccess( + + const { cleanUpEventListeners } = this.registerEventCallbacks({ + orchestrator, + idempotencyKey, + subscribe, + }) + + const transaction = await orchestrator.registerStepSuccess( idempotencyKey, handler(this.container, context), undefined, response ) + + cleanUpEventListeners() + + return transaction } async registerStepFailure( idempotencyKey: string, error?: Error | any, - context?: Context + context?: Context, + subscribe?: DistributedTransactionEvents ): Promise { const { handler, orchestrator } = this.workflow - return await orchestrator.registerStepFailure( + + const { cleanUpEventListeners } = this.registerEventCallbacks({ + orchestrator, + idempotencyKey, + subscribe, + }) + + const transaction = await orchestrator.registerStepFailure( idempotencyKey, error, handler(this.container, context) ) + + cleanUpEventListeners() + + return transaction } addAction( diff --git a/packages/workflows-sdk/src/helper/__tests__/workflow-export.spec.ts b/packages/workflows-sdk/src/helper/__tests__/workflow-export.spec.ts index 9a4222555c920..f479bd9046371 100644 --- a/packages/workflows-sdk/src/helper/__tests__/workflow-export.spec.ts +++ b/packages/workflows-sdk/src/helper/__tests__/workflow-export.spec.ts @@ -23,6 +23,28 @@ jest.mock("@medusajs/orchestration", () => { }), } }), + registerStepSuccess: jest.fn(() => { + return { + getErrors: jest.fn(), + getState: jest.fn(() => "done"), + getContext: jest.fn(() => { + return { + invoke: { result_step: "invoke_test" }, + } + }), + } + }), + registerStepFailure: jest.fn(() => { + return { + getErrors: jest.fn(), + getState: jest.fn(() => "done"), + getContext: jest.fn(() => { + return { + invoke: { result_step: "invoke_test" }, + } + }), + } + }), } }), } diff --git a/packages/workflows-sdk/src/helper/workflow-export.ts b/packages/workflows-sdk/src/helper/workflow-export.ts index 7b940609f2cb7..7a319cb156f5b 100644 --- a/packages/workflows-sdk/src/helper/workflow-export.ts +++ b/packages/workflows-sdk/src/helper/workflow-export.ts @@ -1,5 +1,6 @@ import { DistributedTransaction, + DistributedTransactionEvents, LocalWorkflow, TransactionHandlerType, TransactionState, @@ -8,15 +9,36 @@ import { import { Context, LoadedModule, MedusaContainer } from "@medusajs/types" import { MedusaModule } from "@medusajs/modules-sdk" +import { OrchestrationUtils } from "@medusajs/utils" import { EOL } from "os" import { ulid } from "ulid" -import { OrchestrationUtils } from "@medusajs/utils" +import { MedusaWorkflow } from "../medusa-workflow" +import { resolveValue } from "../utils/composer" export type FlowRunOptions = { input?: TData context?: Context - resultFrom?: string | string[] + resultFrom?: string | string[] | Symbol throwOnError?: boolean + events?: DistributedTransactionEvents +} + +export type FlowRegisterStepSuccessOptions = { + idempotencyKey: string + response?: TData + context?: Context + resultFrom?: string | string[] | Symbol + throwOnError?: boolean + events?: DistributedTransactionEvents +} + +export type FlowRegisterStepFailureOptions = { + idempotencyKey: string + response?: TData + context?: Context + resultFrom?: string | string[] | Symbol + throwOnError?: boolean + events?: DistributedTransactionEvents } export type WorkflowResult = { @@ -25,24 +47,59 @@ export type WorkflowResult = { result: TResult } +export type ExportedWorkflow< + TData = unknown, + TResult = unknown, + TDataOverride = undefined, + TResultOverride = undefined +> = { + run: ( + args?: FlowRunOptions< + TDataOverride extends undefined ? TData : TDataOverride + > + ) => Promise< + WorkflowResult< + TResultOverride extends undefined ? TResult : TResultOverride + > + > + registerStepSuccess: ( + args?: FlowRegisterStepSuccessOptions< + TDataOverride extends undefined ? TData : TDataOverride + > + ) => Promise< + WorkflowResult< + TResultOverride extends undefined ? TResult : TResultOverride + > + > + registerStepFailure: ( + args?: FlowRegisterStepFailureOptions< + TDataOverride extends undefined ? TData : TDataOverride + > + ) => Promise< + WorkflowResult< + TResultOverride extends undefined ? TResult : TResultOverride + > + > +} + export const exportWorkflow = ( workflowId: string, - defaultResult?: string, - dataPreparation?: (data: TData) => Promise + defaultResult?: string | Symbol, + dataPreparation?: (data: TData) => Promise, + options?: { + wrappedInput?: boolean + } ) => { - return function ( + function exportedWorkflow< + TDataOverride = undefined, + TResultOverride = undefined + >( container?: LoadedModule[] | MedusaContainer - ): Omit & { - run: ( - args?: FlowRunOptions< - TDataOverride extends undefined ? TData : TDataOverride - > - ) => Promise< - WorkflowResult< - TResultOverride extends undefined ? TResult : TResultOverride - > - > - } { + ): Omit< + LocalWorkflow, + "run" | "registerStepSuccess" | "registerStepFailure" + > & + ExportedWorkflow { if (!container) { container = MedusaModule.getLoadedModules().map( (mod) => Object.values(mod)[0] @@ -52,36 +109,15 @@ export const exportWorkflow = ( const flow = new LocalWorkflow(workflowId, container) const originalRun = flow.run.bind(flow) - const newRun = async ( - { input, context, throwOnError, resultFrom }: FlowRunOptions = { - throwOnError: true, - resultFrom: defaultResult, - } - ) => { - resultFrom ??= defaultResult - throwOnError ??= true - - if (typeof dataPreparation === "function") { - try { - const copyInput = input ? JSON.parse(JSON.stringify(input)) : input - input = await dataPreparation(copyInput as TData) - } catch (err) { - if (throwOnError) { - throw new Error( - `Data preparation failed: ${err.message}${EOL}${err.stack}` - ) - } - return { - errors: [err], - } - } - } + const originalRegisterStepSuccess = flow.registerStepSuccess.bind(flow) + const originalRegisterStepFailure = flow.registerStepFailure.bind(flow) - const transaction = await originalRun( - context?.transactionId ?? ulid(), - input, - context - ) + const originalExecution = async ( + method, + { throwOnError, resultFrom }, + ...args + ) => { + const transaction = await method.apply(method, args) const errors = transaction.getErrors(TransactionHandlerType.INVOKE) @@ -95,21 +131,31 @@ export const exportWorkflow = ( let result: any = undefined - if (resultFrom) { - if (Array.isArray(resultFrom)) { - result = resultFrom.map((from) => { + const resFrom = + resultFrom?.__type === OrchestrationUtils.SymbolWorkflowStep + ? resultFrom.__step__ + : resultFrom + + if (resFrom) { + if (Array.isArray(resFrom)) { + result = resFrom.map((from) => { const res = transaction.getContext().invoke?.[from] return res?.__type === OrchestrationUtils.SymbolWorkflowWorkflowData ? res.output : res }) } else { - const res = transaction.getContext().invoke?.[resultFrom] + const res = transaction.getContext().invoke?.[resFrom] result = res?.__type === OrchestrationUtils.SymbolWorkflowWorkflowData ? res.output : res } + + const ret = result || resFrom + result = options?.wrappedInput + ? await resolveValue(ret, transaction.getContext()) + : ret } return { @@ -118,18 +164,103 @@ export const exportWorkflow = ( result, } } + + const newRun = async ( + { input, context, throwOnError, resultFrom, events }: FlowRunOptions = { + throwOnError: true, + resultFrom: defaultResult, + } + ) => { + resultFrom ??= defaultResult + throwOnError ??= true + + if (typeof dataPreparation === "function") { + try { + const copyInput = input ? JSON.parse(JSON.stringify(input)) : input + input = await dataPreparation(copyInput as TData) + } catch (err) { + if (throwOnError) { + throw new Error( + `Data preparation failed: ${err.message}${EOL}${err.stack}` + ) + } + return { + errors: [err], + } + } + } + + return await originalExecution( + originalRun, + { throwOnError, resultFrom }, + context?.transactionId ?? ulid(), + input, + context, + events + ) + } flow.run = newRun as any - return flow as unknown as LocalWorkflow & { - run: ( - args?: FlowRunOptions< - TDataOverride extends undefined ? TData : TDataOverride - > - ) => Promise< - WorkflowResult< - TResultOverride extends undefined ? TResult : TResultOverride - > - > + const newRegisterStepSuccess = async ( + { + response, + idempotencyKey, + context, + throwOnError, + resultFrom, + events, + }: FlowRegisterStepSuccessOptions = { + idempotencyKey: "", + throwOnError: true, + resultFrom: defaultResult, + } + ) => { + resultFrom ??= defaultResult + throwOnError ??= true + + return await originalExecution( + originalRegisterStepSuccess, + { throwOnError, resultFrom }, + idempotencyKey, + response, + context, + events + ) + } + flow.registerStepSuccess = newRegisterStepSuccess as any + + const newRegisterStepFailure = async ( + { + response, + idempotencyKey, + context, + throwOnError, + resultFrom, + events, + }: FlowRegisterStepFailureOptions = { + idempotencyKey: "", + throwOnError: true, + resultFrom: defaultResult, + } + ) => { + resultFrom ??= defaultResult + throwOnError ??= true + + return await originalExecution( + originalRegisterStepFailure, + { throwOnError, resultFrom }, + idempotencyKey, + response, + context, + events + ) } + flow.registerStepFailure = newRegisterStepFailure as any + + return flow as unknown as LocalWorkflow & + ExportedWorkflow } + + MedusaWorkflow.registerWorkflow(workflowId, exportedWorkflow) + return exportedWorkflow } diff --git a/packages/workflows-sdk/src/index.ts b/packages/workflows-sdk/src/index.ts index b7791bb21d781..9c27d4e26a115 100644 --- a/packages/workflows-sdk/src/index.ts +++ b/packages/workflows-sdk/src/index.ts @@ -1,3 +1,4 @@ export * from "./helper" +export * from "./medusa-workflow" export * from "./utils/composer" export * as Composer from "./utils/composer" diff --git a/packages/workflows-sdk/src/medusa-workflow.ts b/packages/workflows-sdk/src/medusa-workflow.ts new file mode 100644 index 0000000000000..0a48ef2d72ec2 --- /dev/null +++ b/packages/workflows-sdk/src/medusa-workflow.ts @@ -0,0 +1,27 @@ +import { LocalWorkflow } from "@medusajs/orchestration" +import { LoadedModule, MedusaContainer } from "@medusajs/types" +import { ExportedWorkflow } from "./helper" + +export class MedusaWorkflow { + static workflows: Record< + string, + ( + container?: LoadedModule[] | MedusaContainer + ) => Omit< + LocalWorkflow, + "run" | "registerStepSuccess" | "registerStepFailure" + > & + ExportedWorkflow + > = {} + + static registerWorkflow(workflowId, exportedWorkflow) { + MedusaWorkflow.workflows[workflowId] = exportedWorkflow + } + + static getWorkflow(workflowId) { + return MedusaWorkflow.workflows[workflowId] + } +} + +global.MedusaWorkflow ??= MedusaWorkflow +exports.MedusaWorkflow = global.MedusaWorkflow diff --git a/packages/workflows-sdk/src/utils/composer/create-workflow.ts b/packages/workflows-sdk/src/utils/composer/create-workflow.ts index 546515a65efc3..072a6cf0d4ee6 100644 --- a/packages/workflows-sdk/src/utils/composer/create-workflow.ts +++ b/packages/workflows-sdk/src/utils/composer/create-workflow.ts @@ -5,8 +5,7 @@ import { } from "@medusajs/orchestration" import { LoadedModule, MedusaContainer } from "@medusajs/types" import { OrchestrationUtils } from "@medusajs/utils" -import { exportWorkflow, FlowRunOptions, WorkflowResult } from "../../helper" -import { resolveValue } from "./helpers" +import { ExportedWorkflow, exportWorkflow } from "../../helper" import { proxify } from "./helpers/proxy" import { CreateWorkflowComposerContext, @@ -66,17 +65,11 @@ global[OrchestrationUtils.SymbolMedusaWorkflowComposerContext] = null type ReturnWorkflow> = { ( container?: LoadedModule[] | MedusaContainer - ): Omit & { - run: ( - args?: FlowRunOptions< - TDataOverride extends undefined ? TData : TDataOverride - > - ) => Promise< - WorkflowResult< - TResultOverride extends undefined ? TResult : TResultOverride - > - > - } + ): Omit< + LocalWorkflow, + "run" | "registerStepSuccess" | "registerStepFailure" + > & + ExportedWorkflow } & THooks & { getName: () => string } @@ -198,43 +191,19 @@ export function createWorkflow< WorkflowManager.update(name, context.flow, handlers) - const workflow = exportWorkflow(name) + const workflow = exportWorkflow( + name, + returnedStep, + undefined, + { + wrappedInput: true, + } + ) const mainFlow = ( container?: LoadedModule[] | MedusaContainer ) => { const workflow_ = workflow(container) - const originalRun = workflow_.run - - workflow_.run = (async ( - args?: FlowRunOptions< - TDataOverride extends undefined ? TData : TDataOverride - > - ): Promise< - WorkflowResult< - TResultOverride extends undefined ? TResult : TResultOverride - > - > => { - args ??= {} - args.resultFrom ??= - returnedStep?.__type === OrchestrationUtils.SymbolWorkflowStep - ? returnedStep.__step__ - : undefined - - // Forwards the input to the ref object on composer.apply - const workflowResult = (await originalRun( - args - )) as unknown as WorkflowResult< - TResultOverride extends undefined ? TResult : TResultOverride - > - - workflowResult.result = await resolveValue( - workflowResult.result || returnedStep, - workflowResult.transaction.getContext() - ) - - return workflowResult - }) as any return workflow_ } diff --git a/packages/workflows-sdk/src/utils/composer/helpers/resolve-value.ts b/packages/workflows-sdk/src/utils/composer/helpers/resolve-value.ts index 8fb49aa423c1b..0fdf7d2881cb1 100644 --- a/packages/workflows-sdk/src/utils/composer/helpers/resolve-value.ts +++ b/packages/workflows-sdk/src/utils/composer/helpers/resolve-value.ts @@ -41,7 +41,7 @@ export async function resolveValue(input, transactionContext) { if (Array.isArray(inputTOUnwrap)) { return await promiseAll( - inputTOUnwrap.map((i) => unwrapInput(i, transactionContext)) + inputTOUnwrap.map((i) => resolveValue(i, transactionContext)) ) } From 6fc6a9de6a336204fa0e1037502cb5cf801089dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frane=20Poli=C4=87?= <16856471+fPolic@users.noreply.github.com> Date: Fri, 5 Jan 2024 14:51:57 +0100 Subject: [PATCH 3/9] feat(medusa, link-modules): sales channel <> pubkey link (#5820) --- .changeset/rotten-lobsters-move.md | 7 +++ .../__tests__/admin/publishable-api-key.js | 28 ++++----- .../link-modules/src/definitions/index.ts | 1 + .../publishable-api-key-sales-channel.ts | 63 +++++++++++++++++++ packages/link-modules/src/links.ts | 6 ++ packages/medusa/src/joiner-configs/index.ts | 1 + .../publishable-api-key-service.ts | 26 ++++++++ ...811-publishable-key-sales-channels-link.ts | 29 +++++++++ .../publishable-api-key-sales-channel.ts | 23 +++++-- packages/medusa/src/models/sales-channel.ts | 15 +++++ .../publishable-api-key-sales-channel.ts | 14 +++-- .../services/__tests__/publishable-api-key.ts | 20 +++--- 12 files changed, 195 insertions(+), 38 deletions(-) create mode 100644 .changeset/rotten-lobsters-move.md create mode 100644 packages/link-modules/src/definitions/publishable-api-key-sales-channel.ts create mode 100644 packages/medusa/src/joiner-configs/publishable-api-key-service.ts create mode 100644 packages/medusa/src/migrations/1701894188811-publishable-key-sales-channels-link.ts diff --git a/.changeset/rotten-lobsters-move.md b/.changeset/rotten-lobsters-move.md new file mode 100644 index 0000000000000..be856f4b6b8d1 --- /dev/null +++ b/.changeset/rotten-lobsters-move.md @@ -0,0 +1,7 @@ +--- +"@medusajs/link-modules": patch +"@medusajs/medusa": patch + +--- + +feat: PubKey <> SC joiner config diff --git a/integration-tests/api/__tests__/admin/publishable-api-key.js b/integration-tests/api/__tests__/admin/publishable-api-key.js index 4f4765adc6c48..5386fa0dd41e2 100644 --- a/integration-tests/api/__tests__/admin/publishable-api-key.js +++ b/integration-tests/api/__tests__/admin/publishable-api-key.js @@ -338,14 +338,14 @@ describe("Publishable API keys", () => { expect(response.status).toBe(200) expect(mappings).toEqual([ - { + expect.objectContaining({ sales_channel_id: salesChannel1.id, publishable_key_id: pubKeyId, - }, - { + }), + expect.objectContaining({ sales_channel_id: salesChannel2.id, publishable_key_id: pubKeyId, - }, + }), ]) expect(response.data.publishable_api_key).toMatchObject({ @@ -386,10 +386,10 @@ describe("Publishable API keys", () => { await dbConnection.manager.query( `INSERT INTO publishable_api_key_sales_channel - (publishable_key_id, sales_channel_id) - VALUES ('${pubKeyId}', '${salesChannel1.id}'), - ('${pubKeyId}', '${salesChannel2.id}'), - ('${pubKeyId}', '${salesChannel3.id}');` + (id, publishable_key_id, sales_channel_id) + VALUES ('pksc-1','${pubKeyId}', '${salesChannel1.id}'), + ('pksc-2','${pubKeyId}', '${salesChannel2.id}'), + ('pksc-3','${pubKeyId}', '${salesChannel3.id}');` ) }) @@ -417,16 +417,16 @@ describe("Publishable API keys", () => { const mappings = await dbConnection.manager.query( `SELECT * FROM publishable_api_key_sales_channel - WHERE publishable_key_id = '${pubKeyId}'` + WHERE publishable_key_id = '${pubKeyId}';` ) expect(response.status).toBe(200) expect(mappings).toEqual([ - { + expect.objectContaining({ sales_channel_id: salesChannel3.id, publishable_key_id: pubKeyId, - }, + }), ]) expect(response.data.publishable_api_key).toMatchObject({ @@ -467,9 +467,9 @@ describe("Publishable API keys", () => { await dbConnection.manager.query( `INSERT INTO publishable_api_key_sales_channel - (publishable_key_id, sales_channel_id) - VALUES ('${pubKeyId}', '${salesChannel1.id}'), - ('${pubKeyId}', '${salesChannel2.id}');` + (id, publishable_key_id, sales_channel_id) + VALUES ('pksc-1', '${pubKeyId}', '${salesChannel1.id}'), + ('pksc-2', '${pubKeyId}', '${salesChannel2.id}');` ) }) diff --git a/packages/link-modules/src/definitions/index.ts b/packages/link-modules/src/definitions/index.ts index 14cf0ca3d5762..4c75b587b227b 100644 --- a/packages/link-modules/src/definitions/index.ts +++ b/packages/link-modules/src/definitions/index.ts @@ -5,3 +5,4 @@ export * from "./product-shipping-profile" export * from "./product-sales-channel" export * from "./cart-sales-channel" export * from "./order-sales-channel" +export * from "./publishable-api-key-sales-channel" diff --git a/packages/link-modules/src/definitions/publishable-api-key-sales-channel.ts b/packages/link-modules/src/definitions/publishable-api-key-sales-channel.ts new file mode 100644 index 0000000000000..a9fd53ab421fe --- /dev/null +++ b/packages/link-modules/src/definitions/publishable-api-key-sales-channel.ts @@ -0,0 +1,63 @@ +import { ModuleJoinerConfig } from "@medusajs/types" +import { LINKS } from "../links" + +export const PublishableApiKeySalesChannel: ModuleJoinerConfig = { + serviceName: LINKS.PublishableApiKeySalesChannel, + isLink: true, + databaseConfig: { + tableName: "publishable_api_key_sales_channel", + idPrefix: "pksc", + }, + alias: [ + { + name: "publishable_api_key_sales_channel", + }, + { + name: "publishable_api_key_sales_channels", + }, + ], + primaryKeys: ["id", "publishable_key_id", "sales_channel_id"], + relationships: [ + { + serviceName: "publishableApiKeyService", + isInternalService: true, + primaryKey: "id", + foreignKey: "publishable_key_id", + alias: "publishable_key", + }, + { + serviceName: "salesChannelService", + isInternalService: true, + primaryKey: "id", + foreignKey: "sales_channel_id", + alias: "sales_channel", + }, + ], + extends: [ + { + serviceName: "publishableApiKeyService", + fieldAlias: { + sales_channels: "sales_channels_link.sales_channel", + }, + relationship: { + serviceName: LINKS.PublishableApiKeySalesChannel, + isInternalService: true, + primaryKey: "publishable_key_id", + foreignKey: "id", + alias: "sales_channels_link", + isList: true, + }, + }, + { + serviceName: "salesChannelService", + relationship: { + serviceName: LINKS.PublishableApiKeySalesChannel, + isInternalService: true, + primaryKey: "sales_channel_id", + foreignKey: "id", + alias: "publishable_keys_link", + isList: true, + }, + }, + ], +} diff --git a/packages/link-modules/src/links.ts b/packages/link-modules/src/links.ts index c38b0ed7158b8..5f6c39dfff5a0 100644 --- a/packages/link-modules/src/links.ts +++ b/packages/link-modules/src/links.ts @@ -40,4 +40,10 @@ export const LINKS = { "salesChannelService", "sales_channel_id" ), + PublishableApiKeySalesChannel: composeLinkName( + "publishableApiKeyService", + "publishable_key_id", + "salesChannelService", + "sales_channel_id" + ), } diff --git a/packages/medusa/src/joiner-configs/index.ts b/packages/medusa/src/joiner-configs/index.ts index 084dc203f659d..7f7849d2d7fbd 100644 --- a/packages/medusa/src/joiner-configs/index.ts +++ b/packages/medusa/src/joiner-configs/index.ts @@ -3,3 +3,4 @@ export * as customer from "./customer-service" export * as region from "./region-service" export * as salesChannel from "./sales-channel-service" export * as shippingProfile from "./shipping-profile-service" +export * as publishableApiKey from "./publishable-api-key-service" diff --git a/packages/medusa/src/joiner-configs/publishable-api-key-service.ts b/packages/medusa/src/joiner-configs/publishable-api-key-service.ts new file mode 100644 index 0000000000000..dc7bf583568f0 --- /dev/null +++ b/packages/medusa/src/joiner-configs/publishable-api-key-service.ts @@ -0,0 +1,26 @@ +import { ModuleJoinerConfig } from "@medusajs/types" + +export default { + serviceName: "publishableApiKeyService", + primaryKeys: ["id"], + linkableKeys: { publishable_key_id: "PublishableApiKey" }, + schema: ` + scalar Date + scalar JSON + + type PublishableApiKey { + id: ID! + sales_channel_id: String! + publishable_key_id: String! + created_at: Date! + updated_at: Date! + deleted_at: Date + } + `, + alias: [ + { + name: ["publishable_api_key", "publishable_api_keys"], + args: { entity: "PublishableApiKey" }, + }, + ], +} as ModuleJoinerConfig diff --git a/packages/medusa/src/migrations/1701894188811-publishable-key-sales-channels-link.ts b/packages/medusa/src/migrations/1701894188811-publishable-key-sales-channels-link.ts new file mode 100644 index 0000000000000..017645c1fef8e --- /dev/null +++ b/packages/medusa/src/migrations/1701894188811-publishable-key-sales-channels-link.ts @@ -0,0 +1,29 @@ +import { MigrationInterface, QueryRunner } from "typeorm" + +export class PublishableKeySalesChannelLink1701894188811 + implements MigrationInterface +{ + public async up(queryRunner: QueryRunner): Promise { + await queryRunner.query(` + ALTER TABLE "publishable_api_key_sales_channel" ADD COLUMN IF NOT EXISTS "id" text; + UPDATE "publishable_api_key_sales_channel" SET "id" = 'pksc_' || substr(md5(random()::text), 0, 27) WHERE id is NULL; + ALTER TABLE "publishable_api_key_sales_channel" ALTER COLUMN "id" SET NOT NULL; + + CREATE INDEX IF NOT EXISTS "IDX_id_publishable_api_key_sales_channel" ON "publishable_api_key_sales_channel" ("id"); + + ALTER TABLE "publishable_api_key_sales_channel" ADD COLUMN IF NOT EXISTS "created_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(); + ALTER TABLE "publishable_api_key_sales_channel" ADD COLUMN IF NOT EXISTS "updated_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(); + ALTER TABLE "publishable_api_key_sales_channel" ADD COLUMN IF NOT EXISTS "deleted_at" TIMESTAMP WITH TIME ZONE; + `) + } + + public async down(queryRunner: QueryRunner): Promise { + await queryRunner.query(` + DROP INDEX IF EXISTS "IDX_id_publishable_api_key_sales_channel"; + ALTER TABLE "publishable_api_key_sales_channel" DROP COLUMN IF EXISTS "id"; + ALTER TABLE "publishable_api_key_sales_channel" DROP COLUMN IF EXISTS "created_at"; + ALTER TABLE "publishable_api_key_sales_channel" DROP COLUMN IF EXISTS "updated_at"; + ALTER TABLE "publishable_api_key_sales_channel" DROP COLUMN IF EXISTS "deleted_at"; + `) + } +} diff --git a/packages/medusa/src/models/publishable-api-key-sales-channel.ts b/packages/medusa/src/models/publishable-api-key-sales-channel.ts index 32ba90818fe02..744b5e0146b43 100644 --- a/packages/medusa/src/models/publishable-api-key-sales-channel.ts +++ b/packages/medusa/src/models/publishable-api-key-sales-channel.ts @@ -1,12 +1,25 @@ -import { Entity, PrimaryColumn } from "typeorm" +import { BeforeInsert, Column, Entity, PrimaryColumn } from "typeorm" +import { BaseEntity } from "../interfaces" +import { generateEntityId } from "../utils" -@Entity() -export class PublishableApiKeySalesChannel { - @PrimaryColumn() +@Entity("publishable_api_key_sales_channel") +export class PublishableApiKeySalesChannel extends BaseEntity { + @Column({ type: "text" }) + id: string + + @PrimaryColumn({ type: "text" }) sales_channel_id: string - @PrimaryColumn() + @PrimaryColumn({ type: "text" }) publishable_key_id: string + + /** + * @apiIgnore + */ + @BeforeInsert() + private beforeInsert(): void { + this.id = generateEntityId(this.id, "pksc") + } } /** diff --git a/packages/medusa/src/models/sales-channel.ts b/packages/medusa/src/models/sales-channel.ts index 6a71b6ad2654a..4e3f5c8525e2b 100644 --- a/packages/medusa/src/models/sales-channel.ts +++ b/packages/medusa/src/models/sales-channel.ts @@ -11,6 +11,7 @@ import { SalesChannelLocation } from "./sales-channel-location" import { Product } from "./product" import { Cart } from "./cart" import { Order } from "./order" +import { PublishableApiKey } from "./publishable-api-key" @FeatureFlagEntity("sales_channels") export class SalesChannel extends SoftDeletableEntity { @@ -74,6 +75,20 @@ export class SalesChannel extends SoftDeletableEntity { ) orders: Order[] + @ManyToMany(() => PublishableApiKey) + @JoinTable({ + name: "publishable_api_key_sales_channel", + inverseJoinColumn: { + name: "publishable_key_id", + referencedColumnName: "id", + }, + joinColumn: { + name: "sales_channel_id", + referencedColumnName: "id", + }, + }) + publishableKeys: PublishableApiKey[] + @OneToMany( () => SalesChannelLocation, (scLocation) => scLocation.sales_channel, diff --git a/packages/medusa/src/repositories/publishable-api-key-sales-channel.ts b/packages/medusa/src/repositories/publishable-api-key-sales-channel.ts index 2a51854749092..11e1cd96dd6bd 100644 --- a/packages/medusa/src/repositories/publishable-api-key-sales-channel.ts +++ b/packages/medusa/src/repositories/publishable-api-key-sales-channel.ts @@ -3,6 +3,7 @@ import { Brackets, In } from "typeorm" import { PublishableApiKeySalesChannel, SalesChannel } from "../models" import { dataSource } from "../loaders/database" import SalesChannelRepository from "./sales-channel" +import { generateEntityId } from "../utils" const publishableApiKeySalesChannelAlias = "PublishableKeySalesChannel" @@ -64,15 +65,16 @@ export const PublishableApiKeySalesChannelRepository = dataSource publishableApiKeyId: string, salesChannelIds: string[] ): Promise { + const valuesToInsert = salesChannelIds.map((id) => ({ + id: generateEntityId(undefined, "pksc"), + sales_channel_id: id, + publishable_key_id: publishableApiKeyId, + })) + await this.createQueryBuilder() .insert() .into(PublishableApiKeySalesChannel) - .values( - salesChannelIds.map((id) => ({ - sales_channel_id: id, - publishable_key_id: publishableApiKeyId, - })) - ) + .values(valuesToInsert) .orIgnore() .execute() }, diff --git a/packages/medusa/src/services/__tests__/publishable-api-key.ts b/packages/medusa/src/services/__tests__/publishable-api-key.ts index 8c0e093932ff4..453930090cd26 100644 --- a/packages/medusa/src/services/__tests__/publishable-api-key.ts +++ b/packages/medusa/src/services/__tests__/publishable-api-key.ts @@ -41,19 +41,13 @@ describe("PublishableApiKeyService", () => { await publishableApiKeyService.retrieve( IdMap.getId("order-edit-with-changes") ) - expect( - publishableApiKeyRepository.findOne - ).toHaveBeenCalledTimes(1) - expect( - publishableApiKeyRepository.findOne - ).toHaveBeenCalledWith( - { - relationLoadStrategy: "query", - where: { - id: IdMap.getId("order-edit-with-changes") - } - } - ) + expect(publishableApiKeyRepository.findOne).toHaveBeenCalledTimes(1) + expect(publishableApiKeyRepository.findOne).toHaveBeenCalledWith({ + relationLoadStrategy: "query", + where: { + id: IdMap.getId("order-edit-with-changes"), + }, + }) }) it("should create a publishable api key and call the repository with the right arguments as well as the event bus service", async () => { From 7d650771d1c1d3e5d77ff95c12e4970743b64303 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 5 Jan 2024 17:03:38 +0200 Subject: [PATCH 4/9] docs: generate medusa-react reference (#6004) * add new plugin for better organization * added handling in theme for mutations and query types * added tsdoc to hooks * added tsdocs to utility functions * added tsdoc to providers * generated reference * general fixes for generated reference * generated api reference specs + general fixes * add missing import react * split utilities into different directories * added overview page * added link to customer authentication section * fix lint errors * added changeset * fix readme * fixed build error * added expand fields + other sections to overview * updated what's new section * general refactoring * remove unnecessary query field * fix links * added ignoreApi option --- .changeset/clean-timers-hunt.md | 5 + .../src/classes/typedoc-manager.ts | 13 +- .../packages/scripts/generate-reference.ts | 2 +- docs-util/packages/typedoc-config/_merger.js | 126 +- .../extended-tsconfig/medusa-react.json | 9 + .../extended-tsconfig/tsdoc.json | 12 + .../packages/typedoc-config/medusa-react.js | 10 + .../packages/typedoc-plugin-custom/README.md | 9 + .../src/generate-namespace.ts | 258 + .../typedoc-plugin-custom/src/index.ts | 3 + .../src/parse-oas-schema-plugin.ts | 5 +- .../typedoc-plugin-markdown-medusa/README.md | 1 + .../src/index.ts | 7 + .../src/render-utils.ts | 20 +- .../src/resources/helpers/comments.ts | 8 +- .../resources/helpers/if-has-hook-params.ts | 14 + .../helpers/if-has-mutation-params.ts | 23 + .../helpers/if-has-mutation-return.ts | 23 + .../resources/helpers/if-has-query-return.ts | 23 + .../resources/helpers/if-react-query-type.ts | 17 + .../resources/helpers/parameter-component.ts | 19 +- .../helpers/react-query-hook-params.ts | 19 + .../helpers/react-query-mutation-params.ts | 37 + .../helpers/react-query-mutation-return.ts | 37 + .../helpers/react-query-query-return.ts | 37 + .../src/resources/helpers/reflection-title.ts | 11 +- .../src/resources/helpers/returns.ts | 42 +- .../type-declaration-object-literal.ts | 36 +- .../helpers/type-parameter-component.ts | 13 +- .../resources/partials/member.declaration.hbs | 2 +- .../partials/member.getterSetter.hbs | 4 +- .../src/resources/partials/member.hbs | 4 +- .../partials/member.react-query.signature.hbs | 125 + .../partials/member.signature-wrapper.hbs | 9 + .../resources/partials/member.signature.hbs | 2 +- .../src/resources/partials/members.hbs | 6 +- .../src/resources/templates/reflection.hbs | 2 +- .../src/theme.ts | 177 +- .../src/types.ts | 4 + .../src/utils/format-parameter-component.ts | 58 + .../src/utils/react-query-utils.ts | 263 + .../src/utils/reflection-formatter.ts | 11 +- .../src/utils/reflection-template-strings.ts | 10 + ...atter.ts => reflection-type-parameters.ts} | 251 +- docs-util/packages/types/lib/index.d.ts | 27 + .../packages/utils/src/get-type-children.ts | 112 +- docs-util/typedoc-json-output/0-medusa.json | 1674 +- docs-util/typedoc-json-output/0-types.json | 8874 +- docs-util/typedoc-json-output/entities.json | 1515 +- docs-util/typedoc-json-output/js-client.json | 4808 +- .../typedoc-json-output/medusa-react.json | 113047 +++++++++++++++ docs-util/typedoc-json-output/pricing.json | 1391 +- docs-util/typedoc-json-output/services.json | 33034 +++-- ...leteCustomerGroupsGroupCustomerBatchReq.ts | 3 + .../AdminDeletePriceListPricesPricesReq.ts | 5 +- ...iceListsPriceListProductsPricesBatchReq.ts | 3 + ...oductCategoriesCategoryProductsBatchReq.ts | 5 +- .../AdminDeleteProductsFromCollectionReq.ts | 3 + ...ePublishableApiKeySalesChannelsBatchReq.ts | 3 + ...eteSalesChannelsChannelProductsBatchReq.ts | 5 +- .../AdminDeleteTaxRatesTaxRateProductsReq.ts | 3 + ...DeleteTaxRatesTaxRateShippingOptionsReq.ts | 3 + .../src/lib/models/AdminDeleteUploadsReq.ts | 3 + .../lib/models/AdminPaymentCollectionsRes.ts | 3 + .../src/lib/models/AdminPostAuthReq.ts | 3 + .../src/lib/models/AdminPostBatchesReq.ts | 3 + .../AdminPostCollectionsCollectionReq.ts | 3 + .../src/lib/models/AdminPostCollectionsReq.ts | 3 + .../models/AdminPostCurrenciesCurrencyReq.ts | 3 + ...ostCustomerGroupsGroupCustomersBatchReq.ts | 3 + .../models/AdminPostCustomerGroupsGroupReq.ts | 3 + .../lib/models/AdminPostCustomerGroupsReq.ts | 3 + .../models/AdminPostCustomersCustomerReq.ts | 3 + .../src/lib/models/AdminPostCustomersReq.ts | 3 + ...untsDiscountConditionsConditionBatchReq.ts | 3 + ...minPostDiscountsDiscountDynamicCodesReq.ts | 3 + .../models/AdminPostDiscountsDiscountReq.ts | 3 + .../src/lib/models/AdminPostDiscountsReq.ts | 3 + ...stDraftOrdersDraftOrderLineItemsItemReq.ts | 3 + ...inPostDraftOrdersDraftOrderLineItemsReq.ts | 3 + .../AdminPostDraftOrdersDraftOrderReq.ts | 3 + .../src/lib/models/AdminPostDraftOrdersReq.ts | 3 + .../models/AdminPostGiftCardsGiftCardReq.ts | 3 + .../src/lib/models/AdminPostGiftCardsReq.ts | 3 + ...PostInventoryItemsItemLocationLevelsReq.ts | 3 + .../lib/models/AdminPostInventoryItemsReq.ts | 3 + .../src/lib/models/AdminPostNotesNoteReq.ts | 3 + .../src/lib/models/AdminPostNotesReq.ts | 3 + ...nPostNotificationsNotificationResendReq.ts | 3 + ...nPostOrderEditsEditLineItemsLineItemReq.ts | 3 + .../AdminPostOrderEditsEditLineItemsReq.ts | 3 + .../models/AdminPostOrderEditsOrderEditReq.ts | 3 + .../src/lib/models/AdminPostOrderEditsReq.ts | 3 + .../models/AdminPostOrdersOrderRefundsReq.ts | 3 + .../src/lib/models/AdminPostOrdersOrderReq.ts | 3 + .../models/AdminPostOrdersOrderReturnsReq.ts | 3 + .../models/AdminPostOrdersOrderShipmentReq.ts | 3 + .../models/AdminPostOrdersOrderSwapsReq.ts | 3 + .../lib/models/AdminPostPaymentRefundsReq.ts | 3 + .../AdminPostPriceListPricesPricesReq.ts | 3 + ...dminPostPriceListsPriceListPriceListReq.ts | 3 + .../models/AdminPostPriceListsPriceListReq.ts | 3 + ...oductCategoriesCategoryProductsBatchReq.ts | 5 +- .../AdminPostProductCategoriesCategoryReq.ts | 3 + .../models/AdminPostProductCategoriesReq.ts | 3 + .../AdminPostProductsProductOptionsReq.ts | 3 + .../lib/models/AdminPostProductsProductReq.ts | 3 + .../AdminPostProductsProductVariantsReq.ts | 3 + .../src/lib/models/AdminPostProductsReq.ts | 3 + .../AdminPostProductsToCollectionReq.ts | 3 + ...tPublishableApiKeySalesChannelsBatchReq.ts | 3 + ...tPublishableApiKeysPublishableApiKeyReq.ts | 3 + .../models/AdminPostPublishableApiKeysReq.ts | 3 + .../AdminPostRegionsRegionCountriesReq.ts | 3 + ...ostRegionsRegionFulfillmentProvidersReq.ts | 3 + ...minPostRegionsRegionPaymentProvidersReq.ts | 3 + .../lib/models/AdminPostRegionsRegionReq.ts | 3 + .../src/lib/models/AdminPostRegionsReq.ts | 3 + .../lib/models/AdminPostReservationsReq.ts | 3 + .../AdminPostReservationsReservationReq.ts | 3 + .../models/AdminPostReturnReasonsReasonReq.ts | 3 + .../lib/models/AdminPostReturnReasonsReq.ts | 3 + .../AdminPostReturnsReturnReceiveReq.ts | 3 + ...ostSalesChannelsChannelProductsBatchReq.ts | 5 +- .../lib/models/AdminPostSalesChannelsReq.ts | 3 + .../AdminPostSalesChannelsSalesChannelReq.ts | 3 + .../AdminPostShippingOptionsOptionReq.ts | 3 + .../lib/models/AdminPostShippingOptionsReq.ts | 3 + .../AdminPostShippingProfilesProfileReq.ts | 3 + .../models/AdminPostShippingProfilesReq.ts | 3 + .../AdminPostStockLocationsLocationReq.ts | 3 + .../lib/models/AdminPostStockLocationsReq.ts | 3 + .../src/lib/models/AdminPostStoreReq.ts | 3 + .../src/lib/models/AdminPostTaxRatesReq.ts | 3 + .../AdminPostTaxRatesTaxRateProductsReq.ts | 3 + .../lib/models/AdminPostTaxRatesTaxRateReq.ts | 3 + ...inPostTaxRatesTaxRateShippingOptionsReq.ts | 3 + .../models/AdminPostUploadsDownloadUrlReq.ts | 3 + .../lib/models/AdminResetPasswordRequest.ts | 3 + .../models/AdminResetPasswordTokenRequest.ts | 3 + .../lib/models/AdminStockLocationsListRes.ts | 3 + .../AdminUpdatePaymentCollectionsReq.ts | 3 + .../StorePaymentCollectionSessionsReq.ts | 3 + .../StorePaymentCollectionsSessionRes.ts | 3 + .../StorePostCartsCartLineItemsItemReq.ts | 3 + .../models/StorePostCartsCartLineItemsReq.ts | 3 + .../StorePostCartsCartPaymentSessionReq.ts | 3 + .../src/lib/models/StorePostCartsCartReq.ts | 3 + .../StorePostCartsCartShippingMethodReq.ts | 3 + ...torePostCustomersCustomerAcceptClaimReq.ts | 3 + ...StorePostCustomersCustomerOrderClaimReq.ts | 3 + .../models/StorePostCustomersCustomerReq.ts | 3 + .../src/lib/models/StorePostCustomersReq.ts | 3 + .../StorePostOrderEditsOrderEditDecline.ts | 3 + ...entCollectionsBatchSessionsAuthorizeReq.ts | 3 + ...ePostPaymentCollectionsBatchSessionsReq.ts | 3 + .../src/lib/models/StorePostReturnsReq.ts | 3 + .../src/lib/models/StorePostSwapsReq.ts | 3 + .../src/resources/admin/draft-orders.ts | 2 +- .../src/resources/admin/gift-cards.ts | 2 +- .../src/resources/admin/inventory-item.ts | 9 - .../medusa-js/src/resources/admin/orders.ts | 10 +- .../medusa-js/src/resources/admin/payments.ts | 7 +- .../resources/admin/publishable-api-keys.ts | 2 - .../medusa-js/src/resources/admin/returns.ts | 2 +- .../src/resources/admin/sales-channels.ts | 4 +- .../src/resources/admin/shipping-profiles.ts | 4 +- .../src/resources/admin/tax-rates.ts | 4 +- .../medusa-js/src/resources/admin/uploads.ts | 4 +- packages/medusa-js/src/resources/carts.ts | 4 +- .../medusa-js/src/resources/line-items.ts | 2 +- .../medusa-js/src/resources/order-edits.ts | 2 +- .../src/resources/payment-collections.ts | 8 +- packages/medusa-js/src/resources/products.ts | 2 +- packages/medusa-js/src/resources/regions.ts | 2 +- packages/medusa-js/src/typings.ts | 10 +- packages/medusa-react/src/contexts/cart.tsx | 145 +- packages/medusa-react/src/contexts/index.ts | 14 + packages/medusa-react/src/contexts/medusa.tsx | 110 +- .../src/contexts/session-cart.tsx | 156 +- packages/medusa-react/src/helpers/index.ts | 296 +- .../src/hooks/admin/auth/index.ts | 17 +- .../src/hooks/admin/auth/mutations.ts | 64 + .../src/hooks/admin/auth/queries.ts | 25 + .../src/hooks/admin/batch-jobs/index.ts | 15 + .../src/hooks/admin/batch-jobs/mutations.ts | 104 +- .../src/hooks/admin/batch-jobs/queries.ts | 150 + .../src/hooks/admin/claims/index.ts | 15 + .../src/hooks/admin/claims/mutations.ts | 284 +- .../src/hooks/admin/collections/index.ts | 12 + .../src/hooks/admin/collections/mutations.ts | 176 +- .../src/hooks/admin/collections/queries.ts | 102 + .../src/hooks/admin/currencies/index.ts | 15 + .../src/hooks/admin/currencies/mutations.ts | 36 + .../src/hooks/admin/currencies/queries.ts | 72 + .../src/hooks/admin/custom/index.ts | 9 + .../src/hooks/admin/custom/mutations.ts | 105 + .../src/hooks/admin/custom/queries.ts | 62 + .../src/hooks/admin/customer-groups/index.ts | 15 + .../hooks/admin/customer-groups/mutations.ts | 178 +- .../hooks/admin/customer-groups/queries.ts | 222 +- .../src/hooks/admin/customers/index.ts | 12 + .../src/hooks/admin/customers/mutations.ts | 71 + .../src/hooks/admin/customers/queries.ts | 111 + .../src/hooks/admin/discounts/index.ts | 15 + .../src/hooks/admin/discounts/mutations.ts | 545 + .../src/hooks/admin/discounts/queries.ts | 225 + .../src/hooks/admin/draft-orders/index.ts | 14 + .../src/hooks/admin/draft-orders/mutations.ts | 279 +- .../src/hooks/admin/draft-orders/queries.ts | 110 + .../src/hooks/admin/gift-cards/index.ts | 15 + .../src/hooks/admin/gift-cards/mutations.ts | 107 + .../src/hooks/admin/gift-cards/queries.ts | 107 + .../src/hooks/admin/inventory-item/index.ts | 17 + .../hooks/admin/inventory-item/mutations.ts | 240 +- .../src/hooks/admin/inventory-item/queries.ts | 167 + .../src/hooks/admin/invites/index.ts | 14 + .../src/hooks/admin/invites/mutations.ts | 110 + .../src/hooks/admin/invites/queries.ts | 32 + .../src/hooks/admin/notes/index.ts | 12 + .../src/hooks/admin/notes/mutations.ts | 99 + .../src/hooks/admin/notes/queries.ts | 103 + .../src/hooks/admin/notifications/index.ts | 13 + .../hooks/admin/notifications/mutations.ts | 36 + .../src/hooks/admin/notifications/queries.ts | 109 + .../src/hooks/admin/order-edits/index.ts | 14 + .../src/hooks/admin/order-edits/mutations.ts | 395 + .../src/hooks/admin/order-edits/queries.ts | 187 + .../src/hooks/admin/orders/index.ts | 14 + .../src/hooks/admin/orders/mutations.ts | 443 + .../src/hooks/admin/orders/queries.ts | 144 + .../hooks/admin/payment-collections/index.ts | 12 + .../admin/payment-collections/mutations.ts | 112 + .../admin/payment-collections/queries.ts | 36 + .../src/hooks/admin/payments/index.ts | 12 + .../src/hooks/admin/payments/mutations.ts | 81 + .../src/hooks/admin/payments/queries.ts | 34 + .../src/hooks/admin/price-lists/index.ts | 14 + .../src/hooks/admin/price-lists/mutations.ts | 336 + .../src/hooks/admin/price-lists/queries.ts | 282 + .../hooks/admin/product-categories/index.ts | 16 + .../admin/product-categories/mutations.ts | 223 +- .../hooks/admin/product-categories/queries.ts | 199 + .../src/hooks/admin/product-tags/index.ts | 13 + .../src/hooks/admin/product-tags/queries.ts | 84 + .../src/hooks/admin/product-types/index.ts | 13 + .../src/hooks/admin/product-types/queries.ts | 84 + .../src/hooks/admin/products/index.ts | 14 + .../src/hooks/admin/products/mutations.ts | 417 +- .../src/hooks/admin/products/queries.ts | 170 + .../hooks/admin/publishable-api-keys/index.ts | 20 + .../admin/publishable-api-keys/mutations.ts | 245 +- .../admin/publishable-api-keys/queries.ts | 182 +- .../src/hooks/admin/regions/index.ts | 15 + .../src/hooks/admin/regions/mutations.ts | 364 + .../src/hooks/admin/regions/queries.ts | 158 + .../src/hooks/admin/reservations/index.ts | 18 + .../src/hooks/admin/reservations/mutations.ts | 107 + .../src/hooks/admin/reservations/queries.ts | 146 + .../src/hooks/admin/return-reasons/index.ts | 15 + .../hooks/admin/return-reasons/mutations.ts | 109 + .../src/hooks/admin/return-reasons/queries.ts | 66 + .../src/hooks/admin/returns/index.ts | 15 + .../src/hooks/admin/returns/mutations.ts | 79 + .../src/hooks/admin/returns/queries.ts | 34 + .../src/hooks/admin/sales-channels/index.ts | 15 + .../hooks/admin/sales-channels/mutations.ts | 305 +- .../src/hooks/admin/sales-channels/queries.ts | 152 +- .../src/hooks/admin/shipping-options/index.ts | 15 + .../hooks/admin/shipping-options/mutations.ts | 126 + .../hooks/admin/shipping-options/queries.ts | 74 + .../hooks/admin/shipping-profiles/index.ts | 15 + .../admin/shipping-profiles/mutations.ts | 118 +- .../hooks/admin/shipping-profiles/queries.ts | 72 + .../src/hooks/admin/stock-locations/index.ts | 18 + .../hooks/admin/stock-locations/mutations.ts | 106 +- .../hooks/admin/stock-locations/queries.ts | 156 + .../src/hooks/admin/store/index.ts | 13 + .../src/hooks/admin/store/mutations.ts | 89 + .../src/hooks/admin/store/queries.ts | 98 + .../src/hooks/admin/swaps/index.ts | 15 + .../src/hooks/admin/swaps/mutations.ts | 292 +- .../src/hooks/admin/swaps/queries.ts | 102 + .../src/hooks/admin/tax-rates/index.ts | 14 + .../src/hooks/admin/tax-rates/mutations.ts | 348 + .../src/hooks/admin/tax-rates/queries.ts | 174 + .../src/hooks/admin/uploads/index.ts | 14 + .../src/hooks/admin/uploads/mutations.ts | 112 + .../src/hooks/admin/users/index.ts | 14 + .../src/hooks/admin/users/mutations.ts | 170 + .../src/hooks/admin/users/queries.ts | 62 + .../src/hooks/admin/variants/index.ts | 14 + .../src/hooks/admin/variants/queries.ts | 217 + .../src/hooks/store/carts/index.ts | 16 + .../src/hooks/store/carts/mutations.ts | 401 +- .../src/hooks/store/carts/queries.ts | 39 + .../src/hooks/store/collections/index.ts | 11 + .../src/hooks/store/collections/queries.ts | 107 + .../src/hooks/store/customers/index.ts | 12 + .../src/hooks/store/customers/mutations.ts | 84 +- .../src/hooks/store/customers/queries.ts | 60 + .../src/hooks/store/gift-cards/index.ts | 12 + .../src/hooks/store/gift-cards/queries.ts | 33 + .../src/hooks/store/line-items/index.ts | 11 + .../src/hooks/store/line-items/mutations.ts | 133 +- .../src/hooks/store/order-edits/index.ts | 13 + .../src/hooks/store/order-edits/mutations.ts | 75 + .../src/hooks/store/order-edits/queries.ts | 36 + .../src/hooks/store/orders/index.ts | 13 + .../src/hooks/store/orders/mutations.ts | 70 + .../src/hooks/store/orders/queries.ts | 109 + .../hooks/store/payment-collections/index.ts | 10 + .../store/payment-collections/mutations.ts | 260 + .../store/payment-collections/queries.ts | 39 + .../hooks/store/product-categories/index.ts | 14 + .../hooks/store/product-categories/queries.ts | 232 + .../src/hooks/store/product-tags/index.ts | 11 + .../src/hooks/store/product-tags/queries.ts | 84 + .../src/hooks/store/product-types/index.ts | 11 + .../src/hooks/store/product-types/queries.ts | 84 + .../src/hooks/store/products/index.ts | 13 + .../src/hooks/store/products/queries.ts | 143 + .../src/hooks/store/regions/index.ts | 13 + .../src/hooks/store/regions/queries.ts | 63 + .../src/hooks/store/return-reasons/index.ts | 10 + .../src/hooks/store/return-reasons/queries.ts | 69 + .../src/hooks/store/returns/index.ts | 12 + .../src/hooks/store/returns/mutations.ts | 44 + .../src/hooks/store/shipping-options/index.ts | 12 + .../hooks/store/shipping-options/queries.ts | 82 + .../src/hooks/store/swaps/index.ts | 13 + .../src/hooks/store/swaps/mutations.ts | 55 + .../src/hooks/store/swaps/queries.ts | 34 + packages/medusa-react/src/types.ts | 1 + .../api/routes/admin/auth/create-session.ts | 26 + .../api/routes/admin/auth/delete-session.ts | 22 + .../src/api/routes/admin/auth/get-session.ts | 18 + .../routes/admin/batch/cancel-batch-job.ts | 26 + .../routes/admin/batch/confirm-batch-job.ts | 26 + .../routes/admin/batch/create-batch-job.ts | 27 + .../api/routes/admin/batch/get-batch-job.ts | 22 + .../api/routes/admin/batch/list-batch-jobs.ts | 32 + .../routes/admin/collections/add-products.ts | 29 + .../admin/collections/create-collection.ts | 25 + .../admin/collections/delete-collection.ts | 26 + .../admin/collections/get-collection.ts | 22 + .../admin/collections/list-collections.ts | 27 + .../admin/collections/remove-products.ts | 29 + .../admin/collections/update-collection.ts | 29 + .../admin/currencies/list-currencies.ts | 27 + .../admin/currencies/update-currency.ts | 29 + .../customer-groups/add-customers-batch.ts | 33 + .../customer-groups/create-customer-group.ts | 21 + .../customer-groups/delete-customer-group.ts | 24 + .../customer-groups/delete-customers-batch.ts | 34 + .../get-customer-group-customers.ts | 36 + .../customer-groups/get-customer-group.ts | 24 + .../customer-groups/list-customer-groups.ts | 34 + .../customer-groups/update-customer-group.ts | 27 + .../routes/admin/customers/create-customer.ts | 30 + .../routes/admin/customers/get-customer.ts | 24 + .../routes/admin/customers/list-customers.ts | 27 + .../routes/admin/customers/update-customer.ts | 30 + .../api/routes/admin/discounts/add-region.ts | 26 + .../add-resources-to-condition-batch.ts | 42 + .../admin/discounts/create-condition.ts | 33 + .../routes/admin/discounts/create-discount.ts | 41 + .../admin/discounts/create-dynamic-code.ts | 33 + .../admin/discounts/delete-condition.ts | 32 + .../routes/admin/discounts/delete-discount.ts | 18 + .../admin/discounts/delete-dynamic-code.ts | 26 + .../delete-resources-from-condition-batch.ts | 41 + .../routes/admin/discounts/get-condition.ts | 34 + .../admin/discounts/get-discount-by-code.ts | 24 + .../routes/admin/discounts/get-discount.ts | 24 + .../routes/admin/discounts/list-discounts.ts | 27 + .../routes/admin/discounts/remove-region.ts | 26 + .../admin/discounts/update-condition.ts | 37 + .../routes/admin/discounts/update-discount.ts | 25 + .../admin/draft-orders/create-draft-order.ts | 36 + .../admin/draft-orders/create-line-item.ts | 31 + .../admin/draft-orders/delete-draft-order.ts | 28 + .../admin/draft-orders/delete-line-item.ts | 28 + .../admin/draft-orders/get-draft-order.ts | 26 + .../admin/draft-orders/list-draft-orders.ts | 27 + .../admin/draft-orders/register-payment.ts | 28 + .../admin/draft-orders/update-draft-order.ts | 31 + .../admin/draft-orders/update-line-item.ts | 31 + .../admin/gift-cards/create-gift-card.ts | 29 + .../admin/gift-cards/delete-gift-card.ts | 28 + .../routes/admin/gift-cards/get-gift-card.ts | 22 + .../admin/gift-cards/list-gift-cards.ts | 28 + .../admin/gift-cards/update-gift-card.ts | 31 + .../inventory-items/create-inventory-item.ts | 25 + .../inventory-items/create-location-level.ts | 35 + .../inventory-items/delete-inventory-item.ts | 24 + .../inventory-items/delete-location-level.ts | 26 + .../inventory-items/get-inventory-item.ts | 27 + .../inventory-items/list-inventory-items.ts | 32 + .../inventory-items/list-location-levels.ts | 33 + .../inventory-items/update-inventory-item.ts | 30 + .../inventory-items/update-location-level.ts | 34 + .../api/routes/admin/invites/accept-invite.ts | 34 + .../api/routes/admin/invites/delete-invite.ts | 26 + .../api/routes/admin/invites/resend-invite.ts | 26 + .../src/api/routes/admin/notes/create-note.ts | 27 + .../src/api/routes/admin/notes/delete-note.ts | 22 + .../src/api/routes/admin/notes/get-note.ts | 22 + .../src/api/routes/admin/notes/list-notes.ts | 25 + .../src/api/routes/admin/notes/update-note.ts | 31 + .../admin/notifications/list-notifications.ts | 27 + .../notifications/resend-notification.ts | 29 + .../routes/admin/order-edits/add-line-item.ts | 32 + .../admin/order-edits/cancel-order-edit.ts | 32 + .../admin/order-edits/confirm-order-edit.ts | 30 + .../admin/order-edits/create-order-edit.ts | 24 + .../admin/order-edits/delete-line-item.ts | 32 + .../delete-order-edit-item-change.ts | 32 + .../admin/order-edits/delete-order-edit.ts | 27 + .../admin/order-edits/get-order-edit.ts | 25 + .../admin/order-edits/list-order-edit.ts | 29 + .../admin/order-edits/request-confirmation.ts | 33 + .../update-order-edit-line-item.ts | 35 + .../admin/order-edits/update-order-edit.ts | 32 + .../admin/orders/add-shipping-method.ts | 34 + .../api/routes/admin/orders/archive-order.ts | 28 + .../api/routes/admin/orders/cancel-claim.ts | 23 + .../admin/orders/cancel-fulfillment-claim.ts | 32 + .../admin/orders/cancel-fulfillment-swap.ts | 33 + .../routes/admin/orders/cancel-fulfillment.ts | 30 + .../api/routes/admin/orders/cancel-order.ts | 28 + .../api/routes/admin/orders/cancel-swap.ts | 32 + .../routes/admin/orders/capture-payment.ts | 28 + .../api/routes/admin/orders/complete-order.ts | 28 + .../admin/orders/create-claim-shipment.ts | 30 + .../api/routes/admin/orders/create-claim.ts | 36 + .../routes/admin/orders/create-fulfillment.ts | 38 + .../routes/admin/orders/create-shipment.ts | 33 + .../admin/orders/create-swap-shipment.ts | 37 + .../api/routes/admin/orders/create-swap.ts | 34 + .../api/routes/admin/orders/fulfill-claim.ts | 29 + .../api/routes/admin/orders/fulfill-swap.ts | 34 + .../src/api/routes/admin/orders/get-order.ts | 26 + .../api/routes/admin/orders/list-orders.ts | 25 + .../admin/orders/process-swap-payment.ts | 32 + .../api/routes/admin/orders/refund-payment.ts | 35 + .../api/routes/admin/orders/request-return.ts | 39 + .../api/routes/admin/orders/update-claim.ts | 30 + .../api/routes/admin/orders/update-order.ts | 32 + .../delete-payment-collection.ts | 28 + .../get-payment-collection.ts | 28 + .../routes/admin/payment-collections/index.ts | 1 + .../mark-authorized-payment-collection.ts | 28 + .../update-payment-collection.ts | 33 + .../routes/admin/payments/capture-payment.ts | 28 + .../api/routes/admin/payments/get-payment.ts | 26 + .../routes/admin/payments/refund-payment.ts | 38 + .../admin/price-lists/add-prices-batch.ts | 37 + .../admin/price-lists/create-price-list.ts | 42 + .../admin/price-lists/delete-price-list.ts | 28 + .../admin/price-lists/delete-prices-batch.ts | 29 +- .../price-lists/delete-product-prices.ts | 35 + .../delete-products-prices-batch.ts | 33 + .../price-lists/delete-variant-prices.ts | 35 + .../admin/price-lists/get-price-list.ts | 27 + .../price-lists/list-price-list-products.ts | 35 + .../admin/price-lists/list-price-lists.ts | 29 +- .../admin/price-lists/update-price-list.ts | 33 + .../product-categories/add-products-batch.ts | 41 +- .../create-product-category.ts | 27 + .../delete-product-category.ts | 30 + .../delete-products-batch.ts | 41 +- .../get-product-category.ts | 30 + .../list-product-categories.ts | 32 + .../update-product-category.ts | 35 + .../admin/product-tags/list-product-tags.ts | 32 + .../admin/product-types/list-product-types.ts | 32 + .../api/routes/admin/products/add-option.ts | 33 + .../routes/admin/products/create-product.ts | 52 + .../routes/admin/products/create-variant.ts | 43 + .../routes/admin/products/delete-option.ts | 32 + .../routes/admin/products/delete-product.ts | 28 + .../routes/admin/products/delete-variant.ts | 32 + .../api/routes/admin/products/get-product.ts | 26 + .../routes/admin/products/list-products.ts | 25 + .../admin/products/list-tag-usage-count.ts | 25 + .../routes/admin/products/update-option.ts | 37 + .../routes/admin/products/update-product.ts | 33 + .../routes/admin/products/update-variant.ts | 35 + .../add-channels-batch.ts | 40 + .../create-publishable-api-key.ts | 25 + .../delete-channels-batch.ts | 40 + .../delete-publishable-api-key.ts | 30 + .../get-publishable-api-key.ts | 30 + ...list-publishable-api-key-sales-channels.ts | 38 + .../list-publishable-api-keys.ts | 34 + .../revoke-publishable-api-key.ts | 30 + .../update-publishable-api-key.ts | 33 + .../api/routes/admin/regions/add-country.ts | 33 + .../admin/regions/add-fulfillment-provider.ts | 36 + .../admin/regions/add-payment-provider.ts | 36 + .../api/routes/admin/regions/create-region.ts | 32 + .../api/routes/admin/regions/delete-region.ts | 28 + .../admin/regions/get-fulfillment-options.ts | 41 + .../api/routes/admin/regions/get-region.ts | 26 + .../api/routes/admin/regions/list-regions.ts | 25 + .../routes/admin/regions/remove-country.ts | 30 + .../regions/remove-fulfillment-provider.ts | 33 + .../admin/regions/remove-payment-provider.ts | 33 + .../api/routes/admin/regions/update-region.ts | 33 + .../admin/reservations/create-reservation.ts | 31 + .../admin/reservations/delete-reservation.ts | 28 + .../admin/reservations/get-reservation.ts | 24 + .../admin/reservations/list-reservations.ts | 27 + .../admin/reservations/update-reservation.ts | 29 + .../admin/return-reasons/create-reason.ts | 29 + .../admin/return-reasons/delete-reason.ts | 28 + .../routes/admin/return-reasons/get-reason.ts | 24 + .../admin/return-reasons/list-reasons.ts | 29 + .../admin/return-reasons/update-reason.ts | 33 + .../api/routes/admin/returns/cancel-return.ts | 28 + .../api/routes/admin/returns/list-returns.ts | 29 + .../routes/admin/returns/receive-return.ts | 36 + .../admin/sales-channels/add-product-batch.ts | 37 +- .../associate-stock-location.ts | 31 + .../sales-channels/create-sales-channel.ts | 26 + .../sales-channels/delete-products-batch.ts | 39 +- .../sales-channels/delete-sales-channel.ts | 28 + .../admin/sales-channels/get-sales-channel.ts | 25 + .../sales-channels/list-sales-channels.ts | 27 + .../sales-channels/remove-stock-location.ts | 31 + .../sales-channels/update-sales-channel.ts | 33 + .../create-shipping-option.ts | 40 + .../delete-shipping-option.ts | 28 + .../shipping-options/get-shipping-option.ts | 27 + .../shipping-options/list-shipping-options.ts | 30 + .../update-shipping-option.ts | 39 + .../create-shipping-profile.ts | 30 + .../delete-shipping-profile.ts | 28 + .../shipping-profiles/get-shipping-profile.ts | 29 + .../list-shipping-profiles.ts | 30 + .../update-shipping-profile.ts | 36 + .../stock-locations/create-stock-location.ts | 25 + .../stock-locations/delete-stock-location.ts | 26 + .../stock-locations/get-stock-location.ts | 27 + .../api/routes/admin/stock-locations/index.ts | 1 + .../stock-locations/list-stock-locations.ts | 32 + .../stock-locations/update-stock-location.ts | 31 + .../api/routes/admin/store/add-currency.ts | 22 + .../src/api/routes/admin/store/get-store.ts | 21 + .../admin/store/list-payment-providers.ts | 31 + .../routes/admin/store/list-tax-providers.ts | 31 + .../api/routes/admin/store/remove-currency.ts | 22 + .../api/routes/admin/store/update-store.ts | 25 + .../src/api/routes/admin/swaps/get-swap.ts | 22 + .../src/api/routes/admin/swaps/list-swaps.ts | 25 + .../admin/tax-rates/add-to-product-types.ts | 32 + .../routes/admin/tax-rates/add-to-products.ts | 29 + .../tax-rates/add-to-shipping-options.ts | 33 + .../routes/admin/tax-rates/create-tax-rate.ts | 36 + .../routes/admin/tax-rates/delete-tax-rate.ts | 26 + .../routes/admin/tax-rates/get-tax-rate.ts | 22 + .../routes/admin/tax-rates/list-tax-rates.ts | 30 + .../tax-rates/remove-from-product-types.ts | 34 + .../admin/tax-rates/remove-from-products.ts | 29 + .../tax-rates/remove-from-shipping-options.ts | 33 + .../routes/admin/tax-rates/update-tax-rate.ts | 31 + .../admin/uploads/create-protected-upload.ts | 22 + .../api/routes/admin/uploads/create-upload.ts | 22 + .../api/routes/admin/uploads/delete-upload.ts | 25 + .../routes/admin/uploads/get-download-url.ts | 25 + .../src/api/routes/admin/users/create-user.ts | 25 + .../src/api/routes/admin/users/delete-user.ts | 26 + .../src/api/routes/admin/users/get-user.ts | 24 + .../src/api/routes/admin/users/list-users.ts | 25 + .../admin/users/reset-password-token.ts | 27 + .../api/routes/admin/users/reset-password.ts | 29 + .../src/api/routes/admin/users/update-user.ts | 30 + .../routes/admin/variants/get-inventory.ts | 33 + .../api/routes/admin/variants/get-variant.ts | 24 + .../routes/admin/variants/list-variants.ts | 27 + .../routes/store/carts/add-shipping-method.ts | 30 + .../api/routes/store/carts/complete-cart.ts | 25 + .../src/api/routes/store/carts/create-cart.ts | 28 + .../store/carts/create-line-item/index.ts | 32 + .../store/carts/create-payment-sessions.ts | 25 + .../routes/store/carts/delete-line-item.ts | 29 + .../store/carts/delete-payment-session.ts | 29 + .../src/api/routes/store/carts/get-cart.ts | 31 + .../store/carts/refresh-payment-session.ts | 29 + .../routes/store/carts/set-payment-session.ts | 30 + .../src/api/routes/store/carts/update-cart.ts | 30 + .../routes/store/carts/update-line-item.ts | 32 + .../store/carts/update-payment-session.ts | 31 + .../store/collections/get-collection.ts | 22 + .../store/collections/list-collections.ts | 27 + .../routes/store/customers/create-customer.ts | 31 + .../routes/store/customers/get-customer.ts | 20 + .../api/routes/store/customers/list-orders.ts | 26 + .../routes/store/customers/update-customer.ts | 33 + .../routes/store/gift-cards/get-gift-card.ts | 25 + .../store/order-edits/complete-order-edit.ts | 28 + .../store/order-edits/decline-order-edit.ts | 31 + .../store/order-edits/get-order-edit.ts | 28 + .../store/orders/confirm-order-request.ts | 29 + .../routes/store/orders/get-order-by-cart.ts | 26 + .../src/api/routes/store/orders/get-order.ts | 26 + .../api/routes/store/orders/lookup-order.ts | 33 + .../api/routes/store/orders/request-order.ts | 29 + .../authorize-batch-payment-sessions.ts | 33 + .../authorize-payment-session.ts | 30 + .../get-payment-collection.ts | 31 + .../routes/store/payment-collections/index.ts | 1 + .../manage-batch-payment-sessions.ts | 59 + .../manage-payment-session.ts | 34 + .../refresh-payment-session.ts | 30 + .../get-product-category.ts | 24 + .../list-product-categories.ts | 32 + .../store/product-tags/list-product-tags.ts | 32 + .../store/product-types/list-product-types.ts | 32 + .../api/routes/store/products/get-product.ts | 22 + .../routes/store/products/list-products.ts | 25 + .../api/routes/store/regions/get-region.ts | 24 + .../api/routes/store/regions/list-regions.ts | 26 + .../routes/store/return-reasons/get-reason.ts | 27 + .../store/return-reasons/list-reasons.ts | 29 + .../api/routes/store/returns/create-return.ts | 40 + .../store/shipping-options/list-options.ts | 30 + .../shipping-options/list-shipping-options.ts | 36 + .../src/api/routes/store/swaps/create-swap.ts | 46 + .../routes/store/swaps/get-swap-by-cart.ts | 25 + packages/medusa/src/types/common.ts | 2 +- www/apps/api-reference/package.json | 2 +- .../tsx/admin_auth/deleteundefined | 19 + .../code_samples/tsx/admin_auth/getundefined | 15 + .../code_samples/tsx/admin_auth/postundefined | 22 + .../tsx/admin_batch-jobs/getundefined | 29 + .../tsx/admin_batch-jobs/postundefined | 23 + .../tsx/admin_batch-jobs_{id}/getundefined | 19 + .../postundefined | 23 + .../postundefined | 23 + .../tsx/admin_collections/getundefined | 24 + .../tsx/admin_collections/postundefined | 21 + .../admin_collections_{id}/deleteundefined | 23 + .../tsx/admin_collections_{id}/getundefined | 19 + .../tsx/admin_collections_{id}/postundefined | 25 + .../deleteundefined | 25 + .../postundefined | 25 + .../tsx/admin_currencies/getundefined | 24 + .../tsx/admin_currencies_{code}/postundefined | 25 + .../tsx/admin_customer-groups/getundefined | 31 + .../tsx/admin_customer-groups/postundefined | 17 + .../deleteundefined | 21 + .../admin_customer-groups_{id}/getundefined | 21 + .../admin_customer-groups_{id}/postundefined | 23 + .../getundefined | 33 + .../deleteundefined | 30 + .../postundefined | 29 + .../tsx/admin_customers/getundefined | 24 + .../tsx/admin_customers/postundefined | 26 + .../tsx/admin_customers_{id}/getundefined | 21 + .../tsx/admin_customers_{id}/postundefined | 26 + .../tsx/admin_discounts/getundefined | 24 + .../tsx/admin_discounts/postundefined | 37 + .../admin_discounts_code_{code}/getundefined | 21 + .../postundefined | 30 + .../deleteundefined | 29 + .../getundefined | 31 + .../postundefined | 34 + .../deleteundefined | 38 + .../postundefined | 38 + .../tsx/admin_discounts_{id}/deleteundefined | 15 + .../tsx/admin_discounts_{id}/getundefined | 21 + .../tsx/admin_discounts_{id}/postundefined | 21 + .../postundefined | 29 + .../deleteundefined | 23 + .../deleteundefined | 23 + .../postundefined | 23 + .../tsx/admin_draft-orders/getundefined | 24 + .../tsx/admin_draft-orders/postundefined | 32 + .../admin_draft-orders_{id}/deleteundefined | 25 + .../tsx/admin_draft-orders_{id}/getundefined | 23 + .../tsx/admin_draft-orders_{id}/postundefined | 27 + .../postundefined | 27 + .../deleteundefined | 25 + .../postundefined | 27 + .../admin_draft-orders_{id}_pay/postundefined | 25 + .../tsx/admin_gift-cards/getundefined | 25 + .../tsx/admin_gift-cards/postundefined | 25 + .../tsx/admin_gift-cards_{id}/deleteundefined | 25 + .../tsx/admin_gift-cards_{id}/getundefined | 19 + .../tsx/admin_gift-cards_{id}/postundefined | 27 + .../tsx/admin_inventory-items/getundefined | 29 + .../tsx/admin_inventory-items/postundefined | 21 + .../deleteundefined | 21 + .../admin_inventory-items_{id}/getundefined | 24 + .../admin_inventory-items_{id}/postundefined | 27 + .../getundefined | 30 + .../postundefined | 31 + .../deleteundefined | 23 + .../postundefined | 31 + .../tsx/admin_invites_accept/postundefined | 31 + .../admin_invites_{invite_id}/deleteundefined | 23 + .../postundefined | 23 + .../code_samples/tsx/admin_notes/getundefined | 22 + .../tsx/admin_notes/postundefined | 23 + .../tsx/admin_notes_{id}/deleteundefined | 19 + .../tsx/admin_notes_{id}/getundefined | 19 + .../tsx/admin_notes_{id}/postundefined | 27 + .../tsx/admin_notifications/getundefined | 24 + .../postundefined | 25 + .../tsx/admin_order-edits/getundefined | 26 + .../tsx/admin_order-edits/postundefined | 20 + .../admin_order-edits_{id}/deleteundefined | 24 + .../tsx/admin_order-edits_{id}/getundefined | 22 + .../tsx/admin_order-edits_{id}/postundefined | 28 + .../postundefined | 29 + .../deleteundefined | 29 + .../postundefined | 27 + .../postundefined | 28 + .../deleteundefined | 29 + .../postundefined | 31 + .../postundefined | 30 + .../tsx/admin_orders/getundefined | 22 + .../tsx/admin_orders_{id}/getundefined | 23 + .../tsx/admin_orders_{id}/postundefined | 28 + .../admin_orders_{id}_archive/postundefined | 25 + .../admin_orders_{id}_cancel/postundefined | 25 + .../admin_orders_{id}_capture/postundefined | 25 + .../admin_orders_{id}_claims/postundefined | 33 + .../postundefined | 27 + .../postundefined | 20 + .../postundefined | 26 + .../postundefined | 29 + .../postundefined | 27 + .../admin_orders_{id}_complete/postundefined | 25 + .../postundefined | 35 + .../postundefined | 27 + .../admin_orders_{id}_refund/postundefined | 31 + .../admin_orders_{id}_return/postundefined | 35 + .../admin_orders_{id}_shipment/postundefined | 29 + .../postundefined | 31 + .../tsx/admin_orders_{id}_swaps/postundefined | 30 + .../postundefined | 29 + .../postundefined | 31 + .../postundefined | 30 + .../postundefined | 29 + .../postundefined | 34 + .../deleteundefined | 25 + .../getundefined | 25 + .../postundefined | 29 + .../postundefined | 25 + .../tsx/admin_payments_{id}/getundefined | 23 + .../admin_payments_{id}_capture/postundefined | 25 + .../admin_payments_{id}_refund/postundefined | 34 + .../tsx/admin_price-lists/getundefined | 24 + .../tsx/admin_price-lists/postundefined | 38 + .../admin_price-lists_{id}/deleteundefined | 25 + .../tsx/admin_price-lists_{id}/getundefined | 24 + .../tsx/admin_price-lists_{id}/postundefined | 29 + .../deleteundefined | 23 + .../postundefined | 33 + .../getundefined | 32 + .../deleteundefined | 29 + .../deleteundefined | 32 + .../deleteundefined | 32 + .../tsx/admin_product-categories/getundefined | 29 + .../admin_product-categories/postundefined | 23 + .../deleteundefined | 27 + .../getundefined | 27 + .../postundefined | 31 + .../deleteundefined | 35 + .../postundefined | 35 + .../tsx/admin_product-tags/getundefined | 29 + .../tsx/admin_product-types/getundefined | 29 + .../tsx/admin_products/getundefined | 22 + .../tsx/admin_products/postundefined | 48 + .../tsx/admin_products_tag-usage/getundefined | 22 + .../tsx/admin_products_{id}/deleteundefined | 25 + .../tsx/admin_products_{id}/getundefined | 23 + .../tsx/admin_products_{id}/postundefined | 29 + .../admin_products_{id}_options/postundefined | 29 + .../deleteundefined | 29 + .../postundefined | 34 + .../postundefined | 39 + .../deleteundefined | 29 + .../postundefined | 32 + .../admin_publishable-api-keys/getundefined | 31 + .../admin_publishable-api-keys/postundefined | 21 + .../deleteundefined | 27 + .../getundefined | 27 + .../postundefined | 29 + .../postundefined | 27 + .../getundefined | 35 + .../deleteundefined | 36 + .../postundefined | 36 + .../tsx/admin_regions/getundefined | 22 + .../tsx/admin_regions/postundefined | 28 + .../tsx/admin_regions_{id}/deleteundefined | 25 + .../tsx/admin_regions_{id}/getundefined | 23 + .../tsx/admin_regions_{id}/postundefined | 29 + .../postundefined | 29 + .../deleteundefined | 27 + .../getundefined | 38 + .../postundefined | 32 + .../deleteundefined | 30 + .../postundefined | 32 + .../deleteundefined | 30 + .../tsx/admin_reservations/getundefined | 24 + .../tsx/admin_reservations/postundefined | 27 + .../admin_reservations_{id}/deleteundefined | 25 + .../tsx/admin_reservations_{id}/getundefined | 21 + .../tsx/admin_reservations_{id}/postundefined | 25 + .../tsx/admin_return-reasons/getundefined | 26 + .../tsx/admin_return-reasons/postundefined | 25 + .../admin_return-reasons_{id}/deleteundefined | 25 + .../admin_return-reasons_{id}/getundefined | 21 + .../admin_return-reasons_{id}/postundefined | 29 + .../tsx/admin_returns/getundefined | 26 + .../admin_returns_{id}_cancel/postundefined | 25 + .../admin_returns_{id}_receive/postundefined | 32 + .../tsx/admin_sales-channels/getundefined | 24 + .../tsx/admin_sales-channels/postundefined | 22 + .../admin_sales-channels_{id}/deleteundefined | 25 + .../admin_sales-channels_{id}/getundefined | 22 + .../admin_sales-channels_{id}/postundefined | 29 + .../deleteundefined | 33 + .../postundefined | 31 + .../deleteundefined | 28 + .../postundefined | 28 + .../tsx/admin_shipping-options/getundefined | 27 + .../tsx/admin_shipping-options/postundefined | 36 + .../deleteundefined | 25 + .../admin_shipping-options_{id}/getundefined | 24 + .../admin_shipping-options_{id}/postundefined | 35 + .../tsx/admin_shipping-profiles/getundefined | 27 + .../tsx/admin_shipping-profiles/postundefined | 26 + .../deleteundefined | 25 + .../admin_shipping-profiles_{id}/getundefined | 26 + .../postundefined | 32 + .../tsx/admin_stock-locations/getundefined | 29 + .../tsx/admin_stock-locations/postundefined | 21 + .../deleteundefined | 23 + .../admin_stock-locations_{id}/getundefined | 24 + .../admin_stock-locations_{id}/postundefined | 27 + .../code_samples/tsx/admin_store/getundefined | 18 + .../tsx/admin_store/postundefined | 21 + .../deleteundefined | 19 + .../postundefined | 19 + .../getundefined | 28 + .../admin_store_tax-providers/getundefined | 28 + .../code_samples/tsx/admin_swaps/getundefined | 22 + .../tsx/admin_swaps_{id}/getundefined | 19 + .../tsx/admin_tax-rates/getundefined | 27 + .../tsx/admin_tax-rates/postundefined | 32 + .../tsx/admin_tax-rates_{id}/deleteundefined | 23 + .../tsx/admin_tax-rates_{id}/getundefined | 19 + .../tsx/admin_tax-rates_{id}/postundefined | 27 + .../deleteundefined | 31 + .../postundefined | 29 + .../deleteundefined | 25 + .../postundefined | 25 + .../deleteundefined | 29 + .../postundefined | 29 + .../tsx/admin_uploads/deleteundefined | 21 + .../tsx/admin_uploads/postundefined | 19 + .../admin_uploads_download-url/postundefined | 21 + .../tsx/admin_uploads_protected/postundefined | 19 + .../code_samples/tsx/admin_users/getundefined | 22 + .../tsx/admin_users/postundefined | 22 + .../admin_users_password-token/postundefined | 23 + .../admin_users_reset-password/postundefined | 25 + .../tsx/admin_users_{id}/deleteundefined | 23 + .../tsx/admin_users_{id}/getundefined | 21 + .../tsx/admin_users_{id}/postundefined | 27 + .../tsx/admin_variants/getundefined | 24 + .../tsx/admin_variants_{id}/getundefined | 21 + .../getundefined | 30 + ...teCustomerGroupsGroupCustomerBatchReq.yaml | 1 + .../AdminDeletePriceListPricesPricesReq.yaml | 3 +- ...eListsPriceListProductsPricesBatchReq.yaml | 1 + ...uctCategoriesCategoryProductsBatchReq.yaml | 3 +- .../AdminDeleteProductsFromCollectionReq.yaml | 1 + ...ublishableApiKeySalesChannelsBatchReq.yaml | 1 + ...eSalesChannelsChannelProductsBatchReq.yaml | 3 +- ...AdminDeleteTaxRatesTaxRateProductsReq.yaml | 1 + ...leteTaxRatesTaxRateShippingOptionsReq.yaml | 3 + .../schemas/AdminDeleteUploadsReq.yaml | 1 + .../schemas/AdminPaymentCollectionsRes.yaml | 1 + .../components/schemas/AdminPostAuthReq.yaml | 1 + .../schemas/AdminPostBatchesReq.yaml | 1 + .../AdminPostCollectionsCollectionReq.yaml | 1 + .../schemas/AdminPostCollectionsReq.yaml | 1 + .../AdminPostCurrenciesCurrencyReq.yaml | 1 + ...tCustomerGroupsGroupCustomersBatchReq.yaml | 1 + .../AdminPostCustomerGroupsGroupReq.yaml | 1 + .../schemas/AdminPostCustomerGroupsReq.yaml | 1 + .../AdminPostCustomersCustomerReq.yaml | 1 + .../schemas/AdminPostCustomersReq.yaml | 1 + ...tsDiscountConditionsConditionBatchReq.yaml | 1 + ...nPostDiscountsDiscountDynamicCodesReq.yaml | 1 + .../AdminPostDiscountsDiscountReq.yaml | 1 + .../schemas/AdminPostDiscountsReq.yaml | 1 + ...DraftOrdersDraftOrderLineItemsItemReq.yaml | 1 + ...PostDraftOrdersDraftOrderLineItemsReq.yaml | 1 + .../AdminPostDraftOrdersDraftOrderReq.yaml | 1 + .../schemas/AdminPostDraftOrdersReq.yaml | 1 + .../AdminPostGiftCardsGiftCardReq.yaml | 1 + .../schemas/AdminPostGiftCardsReq.yaml | 1 + ...stInventoryItemsItemLocationLevelsReq.yaml | 1 + .../schemas/AdminPostInventoryItemsReq.yaml | 1 + .../schemas/AdminPostNotesNoteReq.yaml | 1 + .../components/schemas/AdminPostNotesReq.yaml | 1 + ...ostNotificationsNotificationResendReq.yaml | 1 + ...ostOrderEditsEditLineItemsLineItemReq.yaml | 1 + .../AdminPostOrderEditsEditLineItemsReq.yaml | 1 + .../AdminPostOrderEditsOrderEditReq.yaml | 1 + .../schemas/AdminPostOrderEditsReq.yaml | 1 + .../AdminPostOrdersOrderRefundsReq.yaml | 1 + .../schemas/AdminPostOrdersOrderReq.yaml | 1 + .../AdminPostOrdersOrderReturnsReq.yaml | 1 + .../AdminPostOrdersOrderShipmentReq.yaml | 1 + .../schemas/AdminPostOrdersOrderSwapsReq.yaml | 1 + .../schemas/AdminPostPaymentRefundsReq.yaml | 1 + .../AdminPostPriceListPricesPricesReq.yaml | 1 + ...inPostPriceListsPriceListPriceListReq.yaml | 1 + .../AdminPostPriceListsPriceListReq.yaml | 1 + ...uctCategoriesCategoryProductsBatchReq.yaml | 3 +- ...AdminPostProductCategoriesCategoryReq.yaml | 1 + .../AdminPostProductCategoriesReq.yaml | 1 + .../AdminPostProductsProductOptionsReq.yaml | 1 + .../schemas/AdminPostProductsProductReq.yaml | 1 + .../AdminPostProductsProductVariantsReq.yaml | 1 + .../schemas/AdminPostProductsReq.yaml | 1 + .../AdminPostProductsToCollectionReq.yaml | 1 + ...ublishableApiKeySalesChannelsBatchReq.yaml | 1 + ...ublishableApiKeysPublishableApiKeyReq.yaml | 1 + .../AdminPostPublishableApiKeysReq.yaml | 1 + .../AdminPostRegionsRegionCountriesReq.yaml | 1 + ...tRegionsRegionFulfillmentProvidersReq.yaml | 1 + ...nPostRegionsRegionPaymentProvidersReq.yaml | 1 + .../schemas/AdminPostRegionsRegionReq.yaml | 1 + .../schemas/AdminPostRegionsReq.yaml | 1 + .../schemas/AdminPostReservationsReq.yaml | 1 + .../AdminPostReservationsReservationReq.yaml | 1 + .../AdminPostReturnReasonsReasonReq.yaml | 1 + .../schemas/AdminPostReturnReasonsReq.yaml | 1 + .../AdminPostReturnsReturnReceiveReq.yaml | 1 + ...tSalesChannelsChannelProductsBatchReq.yaml | 3 +- .../schemas/AdminPostSalesChannelsReq.yaml | 1 + ...AdminPostSalesChannelsSalesChannelReq.yaml | 1 + .../AdminPostShippingOptionsOptionReq.yaml | 1 + .../schemas/AdminPostShippingOptionsReq.yaml | 1 + .../AdminPostShippingProfilesProfileReq.yaml | 1 + .../schemas/AdminPostShippingProfilesReq.yaml | 1 + .../AdminPostStockLocationsLocationReq.yaml | 1 + .../schemas/AdminPostStockLocationsReq.yaml | 1 + .../components/schemas/AdminPostStoreReq.yaml | 1 + .../schemas/AdminPostTaxRatesReq.yaml | 1 + .../AdminPostTaxRatesTaxRateProductsReq.yaml | 1 + .../schemas/AdminPostTaxRatesTaxRateReq.yaml | 1 + ...PostTaxRatesTaxRateShippingOptionsReq.yaml | 1 + .../AdminPostUploadsDownloadUrlReq.yaml | 1 + .../schemas/AdminResetPasswordRequest.yaml | 1 + .../AdminResetPasswordTokenRequest.yaml | 1 + .../schemas/AdminStockLocationsListRes.yaml | 1 + .../AdminUpdatePaymentCollectionsReq.yaml | 1 + .../specs/admin/openapi.full.yaml | 7341 +- .../specs/admin/paths/admin_auth.yaml | 12 + .../specs/admin/paths/admin_batch-jobs.yaml | 8 + .../admin/paths/admin_batch-jobs_{id}.yaml | 4 + .../paths/admin_batch-jobs_{id}_cancel.yaml | 4 + .../paths/admin_batch-jobs_{id}_confirm.yaml | 4 + .../specs/admin/paths/admin_collections.yaml | 8 + .../admin/paths/admin_collections_{id}.yaml | 12 + ...admin_collections_{id}_products_batch.yaml | 10 + .../specs/admin/paths/admin_currencies.yaml | 4 + .../admin/paths/admin_currencies_{code}.yaml | 4 + .../admin/paths/admin_customer-groups.yaml | 8 + .../paths/admin_customer-groups_{id}.yaml | 12 + .../admin_customer-groups_{id}_customers.yaml | 4 + ..._customer-groups_{id}_customers_batch.yaml | 10 + .../specs/admin/paths/admin_customers.yaml | 8 + .../admin/paths/admin_customers_{id}.yaml | 8 + .../specs/admin/paths/admin_discounts.yaml | 8 + .../paths/admin_discounts_code_{code}.yaml | 4 + ...in_discounts_{discount_id}_conditions.yaml | 5 + ...iscount_id}_conditions_{condition_id}.yaml | 15 + ...t_id}_conditions_{condition_id}_batch.yaml | 10 + .../admin/paths/admin_discounts_{id}.yaml | 12 + .../admin_discounts_{id}_dynamic-codes.yaml | 4 + ...n_discounts_{id}_dynamic-codes_{code}.yaml | 5 + ...in_discounts_{id}_regions_{region_id}.yaml | 10 + .../specs/admin/paths/admin_draft-orders.yaml | 8 + .../admin/paths/admin_draft-orders_{id}.yaml | 12 + .../admin_draft-orders_{id}_line-items.yaml | 4 + ...raft-orders_{id}_line-items_{line_id}.yaml | 10 + .../paths/admin_draft-orders_{id}_pay.yaml | 4 + .../specs/admin/paths/admin_gift-cards.yaml | 8 + .../admin/paths/admin_gift-cards_{id}.yaml | 12 + .../admin/paths/admin_inventory-items.yaml | 8 + .../paths/admin_inventory-items_{id}.yaml | 12 + ..._inventory-items_{id}_location-levels.yaml | 10 + ...ms_{id}_location-levels_{location_id}.yaml | 10 + .../admin/paths/admin_invites_accept.yaml | 4 + .../paths/admin_invites_{invite_id}.yaml | 4 + .../admin_invites_{invite_id}_resend.yaml | 4 + .../specs/admin/paths/admin_notes.yaml | 8 + .../specs/admin/paths/admin_notes_{id}.yaml | 12 + .../admin/paths/admin_notifications.yaml | 4 + .../admin_notifications_{id}_resend.yaml | 4 + .../specs/admin/paths/admin_order-edits.yaml | 8 + .../admin/paths/admin_order-edits_{id}.yaml | 12 + .../paths/admin_order-edits_{id}_cancel.yaml | 4 + ..._order-edits_{id}_changes_{change_id}.yaml | 5 + .../paths/admin_order-edits_{id}_confirm.yaml | 4 + .../paths/admin_order-edits_{id}_items.yaml | 4 + ...dmin_order-edits_{id}_items_{item_id}.yaml | 10 + .../paths/admin_order-edits_{id}_request.yaml | 4 + .../specs/admin/paths/admin_orders.yaml | 4 + .../specs/admin/paths/admin_orders_{id}.yaml | 8 + .../paths/admin_orders_{id}_archive.yaml | 4 + .../admin/paths/admin_orders_{id}_cancel.yaml | 4 + .../paths/admin_orders_{id}_capture.yaml | 4 + .../admin/paths/admin_orders_{id}_claims.yaml | 4 + .../admin_orders_{id}_claims_{claim_id}.yaml | 4 + ..._orders_{id}_claims_{claim_id}_cancel.yaml | 5 + ...s_{id}_claims_{claim_id}_fulfillments.yaml | 5 + ..._fulfillments_{fulfillment_id}_cancel.yaml | 5 + ...ders_{id}_claims_{claim_id}_shipments.yaml | 5 + .../paths/admin_orders_{id}_complete.yaml | 4 + .../paths/admin_orders_{id}_fulfillment.yaml | 4 + ..._fulfillments_{fulfillment_id}_cancel.yaml | 5 + .../admin/paths/admin_orders_{id}_refund.yaml | 4 + .../admin/paths/admin_orders_{id}_return.yaml | 4 + .../paths/admin_orders_{id}_shipment.yaml | 4 + .../admin_orders_{id}_shipping-methods.yaml | 4 + .../admin/paths/admin_orders_{id}_swaps.yaml | 4 + ...in_orders_{id}_swaps_{swap_id}_cancel.yaml | 5 + ...ers_{id}_swaps_{swap_id}_fulfillments.yaml | 5 + ..._fulfillments_{fulfillment_id}_cancel.yaml | 5 + ..._{id}_swaps_{swap_id}_process-payment.yaml | 5 + ...orders_{id}_swaps_{swap_id}_shipments.yaml | 5 + .../paths/admin_payment-collections_{id}.yaml | 12 + ...in_payment-collections_{id}_authorize.yaml | 5 + .../admin/paths/admin_payments_{id}.yaml | 4 + .../paths/admin_payments_{id}_capture.yaml | 4 + .../paths/admin_payments_{id}_refund.yaml | 4 + .../specs/admin/paths/admin_price-lists.yaml | 8 + .../admin/paths/admin_price-lists_{id}.yaml | 12 + .../admin_price-lists_{id}_prices_batch.yaml | 9 + .../admin_price-lists_{id}_products.yaml | 4 + ...rice-lists_{id}_products_prices_batch.yaml | 5 + ...sts_{id}_products_{product_id}_prices.yaml | 5 + ...sts_{id}_variants_{variant_id}_prices.yaml | 5 + .../admin/paths/admin_product-categories.yaml | 8 + .../paths/admin_product-categories_{id}.yaml | 12 + ...roduct-categories_{id}_products_batch.yaml | 10 + .../specs/admin/paths/admin_product-tags.yaml | 4 + .../admin/paths/admin_product-types.yaml | 4 + .../specs/admin/paths/admin_products.yaml | 8 + .../admin/paths/admin_products_tag-usage.yaml | 4 + .../admin/paths/admin_products_{id}.yaml | 12 + .../paths/admin_products_{id}_options.yaml | 4 + ...min_products_{id}_options_{option_id}.yaml | 10 + .../paths/admin_products_{id}_variants.yaml | 4 + ...n_products_{id}_variants_{variant_id}.yaml | 10 + .../paths/admin_publishable-api-keys.yaml | 8 + .../admin_publishable-api-keys_{id}.yaml | 12 + ...dmin_publishable-api-keys_{id}_revoke.yaml | 5 + ...lishable-api-keys_{id}_sales-channels.yaml | 5 + ...le-api-keys_{id}_sales-channels_batch.yaml | 10 + .../specs/admin/paths/admin_regions.yaml | 8 + .../specs/admin/paths/admin_regions_{id}.yaml | 12 + .../paths/admin_regions_{id}_countries.yaml | 4 + ...regions_{id}_countries_{country_code}.yaml | 5 + ...dmin_regions_{id}_fulfillment-options.yaml | 5 + ...in_regions_{id}_fulfillment-providers.yaml | 5 + ...}_fulfillment-providers_{provider_id}.yaml | 5 + .../admin_regions_{id}_payment-providers.yaml | 4 + ..._{id}_payment-providers_{provider_id}.yaml | 5 + .../specs/admin/paths/admin_reservations.yaml | 8 + .../admin/paths/admin_reservations_{id}.yaml | 12 + .../admin/paths/admin_return-reasons.yaml | 8 + .../paths/admin_return-reasons_{id}.yaml | 12 + .../specs/admin/paths/admin_returns.yaml | 4 + .../paths/admin_returns_{id}_cancel.yaml | 4 + .../paths/admin_returns_{id}_receive.yaml | 4 + .../admin/paths/admin_sales-channels.yaml | 8 + .../paths/admin_sales-channels_{id}.yaml | 12 + ...in_sales-channels_{id}_products_batch.yaml | 10 + ...n_sales-channels_{id}_stock-locations.yaml | 10 + .../admin/paths/admin_shipping-options.yaml | 8 + .../paths/admin_shipping-options_{id}.yaml | 12 + .../admin/paths/admin_shipping-profiles.yaml | 8 + .../paths/admin_shipping-profiles_{id}.yaml | 12 + .../admin/paths/admin_stock-locations.yaml | 8 + .../paths/admin_stock-locations_{id}.yaml | 12 + .../specs/admin/paths/admin_store.yaml | 8 + .../paths/admin_store_currencies_{code}.yaml | 8 + .../paths/admin_store_payment-providers.yaml | 4 + .../paths/admin_store_tax-providers.yaml | 4 + .../specs/admin/paths/admin_swaps.yaml | 4 + .../specs/admin/paths/admin_swaps_{id}.yaml | 4 + .../specs/admin/paths/admin_tax-rates.yaml | 8 + .../admin/paths/admin_tax-rates_{id}.yaml | 12 + ...in_tax-rates_{id}_product-types_batch.yaml | 10 + .../admin_tax-rates_{id}_products_batch.yaml | 9 + ...tax-rates_{id}_shipping-options_batch.yaml | 10 + .../specs/admin/paths/admin_uploads.yaml | 8 + .../paths/admin_uploads_download-url.yaml | 4 + .../admin/paths/admin_uploads_protected.yaml | 4 + .../specs/admin/paths/admin_users.yaml | 8 + .../paths/admin_users_password-token.yaml | 4 + .../paths/admin_users_reset-password.yaml | 4 + .../specs/admin/paths/admin_users_{id}.yaml | 12 + .../specs/admin/paths/admin_variants.yaml | 4 + .../admin/paths/admin_variants_{id}.yaml | 4 + .../paths/admin_variants_{id}_inventory.yaml | 4 + .../tsx/store_carts/postundefined | 25 + .../tsx/store_carts_{id}/getundefined | 28 + .../tsx/store_carts_{id}/postundefined | 26 + .../store_carts_{id}_complete/postundefined | 22 + .../store_carts_{id}_line-items/postundefined | 28 + .../deleteundefined | 26 + .../postundefined | 28 + .../postundefined | 26 + .../postundefined | 22 + .../deleteundefined | 26 + .../postundefined | 28 + .../postundefined | 26 + .../postundefined | 26 + .../tsx/store_collections/getundefined | 24 + .../tsx/store_collections_{id}/getundefined | 19 + .../tsx/store_customers/postundefined | 27 + .../tsx/store_customers_me/getundefined | 17 + .../tsx/store_customers_me/postundefined | 29 + .../store_customers_me_orders/getundefined | 23 + .../tsx/store_gift-cards_{code}/getundefined | 22 + .../tsx/store_order-edits_{id}/getundefined | 25 + .../postundefined | 25 + .../postundefined | 27 + .../tsx/store_orders/getundefined | 30 + .../postundefined | 25 + .../store_orders_cart_{cart_id}/getundefined | 23 + .../postundefined | 25 + .../tsx/store_orders_{id}/getundefined | 23 + .../getundefined | 28 + .../postundefined | 30 + .../postundefined | 55 + .../postundefined | 29 + .../postundefined | 27 + .../postundefined | 27 + .../tsx/store_product-categories/getundefined | 29 + .../getundefined | 21 + .../tsx/store_product-tags/getundefined | 29 + .../tsx/store_product-types/getundefined | 29 + .../tsx/store_products/getundefined | 22 + .../tsx/store_products_{id}/getundefined | 19 + .../tsx/store_regions/getundefined | 23 + .../tsx/store_regions_{id}/getundefined | 21 + .../tsx/store_return-reasons/getundefined | 26 + .../store_return-reasons_{id}/getundefined | 24 + .../tsx/store_returns/postundefined | 36 + .../tsx/store_shipping-options/getundefined | 27 + .../getundefined | 33 + .../tsx/store_swaps/postundefined | 42 + .../tsx/store_swaps_{cart_id}/getundefined | 22 + .../StorePaymentCollectionSessionsReq.yaml | 1 + .../StorePaymentCollectionsSessionRes.yaml | 1 + .../StorePostCartsCartLineItemsItemReq.yaml | 1 + .../StorePostCartsCartLineItemsReq.yaml | 1 + .../StorePostCartsCartPaymentSessionReq.yaml | 1 + .../schemas/StorePostCartsCartReq.yaml | 1 + .../StorePostCartsCartShippingMethodReq.yaml | 1 + ...rePostCustomersCustomerAcceptClaimReq.yaml | 1 + ...orePostCustomersCustomerOrderClaimReq.yaml | 1 + .../StorePostCustomersCustomerReq.yaml | 1 + .../schemas/StorePostCustomersReq.yaml | 1 + .../StorePostOrderEditsOrderEditDecline.yaml | 1 + ...tCollectionsBatchSessionsAuthorizeReq.yaml | 1 + ...ostPaymentCollectionsBatchSessionsReq.yaml | 1 + .../schemas/StorePostReturnsReq.yaml | 1 + .../components/schemas/StorePostSwapsReq.yaml | 1 + .../specs/store/openapi.full.yaml | 1468 + .../specs/store/paths/store_carts.yaml | 4 + .../specs/store/paths/store_carts_{id}.yaml | 8 + .../paths/store_carts_{id}_complete.yaml | 4 + .../paths/store_carts_{id}_line-items.yaml | 4 + ...store_carts_{id}_line-items_{line_id}.yaml | 10 + .../store_carts_{id}_payment-session.yaml | 4 + .../store_carts_{id}_payment-sessions.yaml | 4 + ...s_{id}_payment-sessions_{provider_id}.yaml | 10 + ...ayment-sessions_{provider_id}_refresh.yaml | 5 + .../store_carts_{id}_shipping-methods.yaml | 4 + .../specs/store/paths/store_collections.yaml | 4 + .../store/paths/store_collections_{id}.yaml | 4 + .../specs/store/paths/store_customers.yaml | 4 + .../specs/store/paths/store_customers_me.yaml | 8 + .../paths/store_customers_me_orders.yaml | 4 + .../store/paths/store_gift-cards_{code}.yaml | 4 + .../store/paths/store_order-edits_{id}.yaml | 4 + .../store_order-edits_{id}_complete.yaml | 4 + .../paths/store_order-edits_{id}_decline.yaml | 4 + .../specs/store/paths/store_orders.yaml | 4 + .../store_orders_batch_customer_token.yaml | 4 + .../paths/store_orders_cart_{cart_id}.yaml | 4 + .../paths/store_orders_customer_confirm.yaml | 4 + .../specs/store/paths/store_orders_{id}.yaml | 4 + .../paths/store_payment-collections_{id}.yaml | 4 + ...ore_payment-collections_{id}_sessions.yaml | 5 + ...yment-collections_{id}_sessions_batch.yaml | 5 + ...ections_{id}_sessions_batch_authorize.yaml | 5 + ...ollections_{id}_sessions_{session_id}.yaml | 5 + ..._{id}_sessions_{session_id}_authorize.yaml | 5 + .../store/paths/store_product-categories.yaml | 4 + .../paths/store_product-categories_{id}.yaml | 4 + .../specs/store/paths/store_product-tags.yaml | 4 + .../store/paths/store_product-types.yaml | 4 + .../specs/store/paths/store_products.yaml | 4 + .../store/paths/store_products_{id}.yaml | 4 + .../specs/store/paths/store_regions.yaml | 4 + .../specs/store/paths/store_regions_{id}.yaml | 4 + .../store/paths/store_return-reasons.yaml | 4 + .../paths/store_return-reasons_{id}.yaml | 4 + .../specs/store/paths/store_returns.yaml | 4 + .../store/paths/store_shipping-options.yaml | 4 + .../store_shipping-options_{cart_id}.yaml | 4 + .../specs/store/paths/store_swaps.yaml | 4 + .../store/paths/store_swaps_{cart_id}.yaml | 4 + .../api-reference/utils/get-paths-of-tag.ts | 15 +- .../content/development/batch-jobs/create.mdx | 92 +- .../admin/manage-publishable-api-keys.mdx | 89 +- www/apps/docs/content/homepage.mdx | 28 +- www/apps/docs/content/js-client/overview.mdx | 4 +- .../docs/content/medusa-react/overview.mdx | 935 +- .../storefront/implement-cart.mdx | 34 +- .../storefront/implement-checkout-flow.mdx | 22 +- .../admin/manage-customer-groups.mdx | 63 +- .../customers/admin/manage-customers.mdx | 65 +- .../implement-customer-profiles.mdx | 55 +- .../discounts/admin/manage-discounts.mdx | 131 +- .../gift-cards/admin/manage-gift-cards.mdx | 62 +- .../gift-cards/storefront/use-gift-cards.mdx | 10 +- .../admin/manage-inventory-items.mdx | 108 +- .../manage-item-allocations-in-orders.mdx | 54 +- .../admin/manage-reservations.mdx | 40 +- .../admin/manage-stock-locations.mdx | 103 +- .../modules/orders/admin/edit-order.mdx | 164 +- .../modules/orders/admin/manage-claims.mdx | 99 +- .../orders/admin/manage-draft-orders.mdx | 143 +- .../modules/orders/admin/manage-orders.mdx | 153 +- .../modules/orders/admin/manage-returns.mdx | 82 +- .../modules/orders/admin/manage-swaps.mdx | 98 +- .../orders/storefront/create-return.mdx | 34 +- .../modules/orders/storefront/create-swap.mdx | 9 +- .../orders/storefront/handle-order-edits.mdx | 85 +- .../storefront/implement-claim-order.mdx | 54 +- .../storefront/retrieve-order-details.mdx | 26 +- .../price-lists/admin/_import-prices.mdx | 12 +- .../price-lists/admin/manage-price-lists.mdx | 196 +- .../products/admin/import-products.mdx | 18 +- .../products/admin/manage-categories.mdx | 131 +- .../products/admin/manage-products.mdx | 182 +- .../products/storefront/show-products.mdx | 8 +- .../products/storefront/use-categories.mdx | 13 +- .../admin/manage-currencies.mdx | 40 +- .../admin/manage-regions.mdx | 52 +- .../storefront/use-regions.mdx | 3 +- .../modules/sales-channels/admin/manage.mdx | 65 +- .../modules/taxes/admin/manage-tax-rates.mdx | 166 +- .../taxes/admin/manage-tax-settings.mdx | 38 +- .../modules/users/admin/manage-invites.mdx | 37 +- .../modules/users/admin/manage-profile.mdx | 38 +- .../modules/users/admin/manage-users.mdx | 36 +- .../types.CacheTypes.ICacheService.mdx | 141 - ...artWorkflow.CreateCartWorkflowInputDTO.mdx | 362 - ...es.CartWorkflow.CreateLineItemInputDTO.mdx | 26 - ...types.CommonTypes.AddressCreatePayload.mdx | 107 - .../types.CommonTypes.AddressPayload.mdx | 107 - .../types.CommonTypes.BaseEntity.mdx | 35 - .../types.CommonTypes.CustomFindOptions.mdx | 76 - ...pes.CommonTypes.DateComparisonOperator.mdx | 44 - .../types.CommonTypes.FindConfig.mdx | 79 - ...types.CommonTypes.FindPaginationParams.mdx | 26 - .../types.CommonTypes.FindParams.mdx | 26 - ...ommonTypes.NumericalComparisonOperator.mdx | 44 - .../types.CommonTypes.SoftDeletableEntity.mdx | 44 - ...s.CommonTypes.StringComparisonOperator.mdx | 71 - .../types/types.CommonTypes.ConfigModule.mdx | 284 - .../types.CommonTypes.DeleteResponse.mdx | 39 - ...pes.CommonTypes.HttpCompressionOptions.mdx | 46 - .../types.CommonTypes.PaginatedResponse.mdx | 37 - .../types/types.CommonTypes.PartialPick.mdx | 28 - ...types.CommonTypes.ProjectConfigOptions.mdx | 257 - .../types/types.CommonTypes.QueryConfig.mdx | 106 - .../types/types.CommonTypes.QuerySelector.mdx | 19 - .../types.CommonTypes.RequestQueryFields.mdx | 55 - ...types.CommonTypes.WithRequiredProperty.mdx | 30 - ...pes.CommonWorkflow.WorkflowInputConfig.mdx | 100 - .../interfaces/types.DAL.BaseFilterable.mdx | 42 - .../DAL/interfaces/types.DAL.OptionsQuery.mdx | 94 - .../types.DAL.RepositoryService.mdx | 1202 - .../interfaces/types.DAL.RestoreReturn.mdx | 33 - .../interfaces/types.DAL.SoftDeleteReturn.mdx | 33 - .../types.DAL.TreeRepositoryService.mdx | 889 - .../DAL/types/types.DAL.FindOptions.mdx | 125 - ...s.EventBusTypes.IEventBusModuleService.mdx | 297 - .../types.EventBusTypes.IEventBusService.mdx | 310 - .../types/types.EventBusTypes.EmitData.mdx | 51 - .../types.EventBusTypes.EventHandler.mdx | 58 - .../types/types.EventBusTypes.Subscriber.mdx | 58 - .../types.EventBusTypes.SubscriberContext.mdx | 19 - ...pes.EventBusTypes.SubscriberDescriptor.mdx | 28 - .../types.FeatureFlagTypes.IFlagRouter.mdx | 26 - .../types.FeatureFlagTypes.FlagSettings.mdx | 46 - ...tory.IInventoryService.adjustInventory.mdx | 202 - ...ory.IInventoryService.confirmInventory.mdx | 119 - ....IInventoryService.createInventoryItem.mdx | 380 - ...IInventoryService.createInventoryItems.mdx | 237 - ...IInventoryService.createInventoryLevel.mdx | 228 - ...InventoryService.createInventoryLevels.mdx | 157 - ...InventoryService.createReservationItem.mdx | 264 - ...nventoryService.createReservationItems.mdx | 184 - ....IInventoryService.deleteInventoryItem.mdx | 88 - ...e.deleteInventoryItemLevelByLocationId.mdx | 87 - ...IInventoryService.deleteInventoryLevel.mdx | 98 - ...InventoryService.deleteReservationItem.mdx | 87 - ...vice.deleteReservationItemByLocationId.mdx | 87 - ...rvice.deleteReservationItemsByLineItem.mdx | 87 - ...y.IInventoryService.listInventoryItems.mdx | 278 - ....IInventoryService.listInventoryLevels.mdx | 260 - ...IInventoryService.listReservationItems.mdx | 278 - ...IInventoryService.restoreInventoryItem.mdx | 87 - ...ntoryService.retrieveAvailableQuantity.mdx | 110 - ...InventoryService.retrieveInventoryItem.mdx | 332 - ...nventoryService.retrieveInventoryLevel.mdx | 191 - ...ventoryService.retrieveReservationItem.mdx | 185 - ...entoryService.retrieveReservedQuantity.mdx | 110 - ...ventoryService.retrieveStockedQuantity.mdx | 110 - ....IInventoryService.updateInventoryItem.mdx | 392 - ...IInventoryService.updateInventoryLevel.mdx | 223 - ...InventoryService.updateInventoryLevels.mdx | 148 - ...InventoryService.updateReservationItem.mdx | 239 - ...ricingModuleService.addPriceListPrices.mdx | 225 - ...ricing.IPricingModuleService.addPrices.mdx | 645 - ...pricing.IPricingModuleService.addRules.mdx | 437 - ....IPricingModuleService.calculatePrices.mdx | 218 - .../pricing.IPricingModuleService.create.mdx | 680 - ...IPricingModuleService.createCurrencies.mdx | 179 - ...ricingModuleService.createMoneyAmounts.mdx | 238 - ...cingModuleService.createPriceListRules.mdx | 175 - ...IPricingModuleService.createPriceLists.mdx | 324 - ...IPricingModuleService.createPriceRules.mdx | 206 - ...Service.createPriceSetMoneyAmountRules.mdx | 170 - ....IPricingModuleService.createRuleTypes.mdx | 177 - .../pricing.IPricingModuleService.delete.mdx | 113 - ...IPricingModuleService.deleteCurrencies.mdx | 114 - ...ricingModuleService.deleteMoneyAmounts.mdx | 115 - ...cingModuleService.deletePriceListRules.mdx | 113 - ...IPricingModuleService.deletePriceLists.mdx | 113 - ...IPricingModuleService.deletePriceRules.mdx | 115 - ...Service.deletePriceSetMoneyAmountRules.mdx | 113 - ....IPricingModuleService.deleteRuleTypes.mdx | 113 - .../pricing.IPricingModuleService.list.mdx | 361 - ...ing.IPricingModuleService.listAndCount.mdx | 360 - ...ngModuleService.listAndCountCurrencies.mdx | 280 - ...ModuleService.listAndCountMoneyAmounts.mdx | 321 - ...duleService.listAndCountPriceListRules.mdx | 339 - ...ngModuleService.listAndCountPriceLists.mdx | 367 - ...ngModuleService.listAndCountPriceRules.mdx | 328 - ...e.listAndCountPriceSetMoneyAmountRules.mdx | 329 - ...rvice.listAndCountPriceSetMoneyAmounts.mdx | 320 - ...ingModuleService.listAndCountRuleTypes.mdx | 325 - ...g.IPricingModuleService.listCurrencies.mdx | 281 - ...IPricingModuleService.listMoneyAmounts.mdx | 322 - ...ricingModuleService.listPriceListRules.mdx | 340 - ...g.IPricingModuleService.listPriceLists.mdx | 368 - ...g.IPricingModuleService.listPriceRules.mdx | 329 - ...leService.listPriceSetMoneyAmountRules.mdx | 329 - ...ModuleService.listPriceSetMoneyAmounts.mdx | 320 - ...ng.IPricingModuleService.listRuleTypes.mdx | 326 - ...cingModuleService.removePriceListRules.mdx | 513 - ...cing.IPricingModuleService.removeRules.mdx | 137 - ...pricing.IPricingModuleService.retrieve.mdx | 333 - ...IPricingModuleService.retrieveCurrency.mdx | 241 - ...icingModuleService.retrieveMoneyAmount.mdx | 369 - ...PricingModuleService.retrievePriceList.mdx | 580 - ...ingModuleService.retrievePriceListRule.mdx | 415 - ...PricingModuleService.retrievePriceRule.mdx | 346 - ...rvice.retrievePriceSetMoneyAmountRules.mdx | 337 - ...IPricingModuleService.retrieveRuleType.mdx | 236 - ...PricingModuleService.setPriceListRules.mdx | 515 - ...IPricingModuleService.updateCurrencies.mdx | 177 - ...ricingModuleService.updateMoneyAmounts.mdx | 186 - ...cingModuleService.updatePriceListRules.mdx | 185 - ...IPricingModuleService.updatePriceLists.mdx | 224 - ...IPricingModuleService.updatePriceRules.mdx | 207 - ...Service.updatePriceSetMoneyAmountRules.mdx | 177 - ....IPricingModuleService.updateRuleTypes.mdx | 177 - .../product.IProductModuleService.create.mdx | 641 - ...t.IProductModuleService.createCategory.mdx | 482 - ...ProductModuleService.createCollections.mdx | 176 - ...ct.IProductModuleService.createOptions.mdx | 159 - ...oduct.IProductModuleService.createTags.mdx | 149 - ...duct.IProductModuleService.createTypes.mdx | 167 - ...t.IProductModuleService.createVariants.mdx | 329 - .../product.IProductModuleService.delete.mdx | 113 - ...t.IProductModuleService.deleteCategory.mdx | 113 - ...ProductModuleService.deleteCollections.mdx | 113 - ...ct.IProductModuleService.deleteOptions.mdx | 113 - ...oduct.IProductModuleService.deleteTags.mdx | 114 - ...duct.IProductModuleService.deleteTypes.mdx | 113 - ...t.IProductModuleService.deleteVariants.mdx | 113 - .../product.IProductModuleService.list.mdx | 394 - ...uct.IProductModuleService.listAndCount.mdx | 393 - ...ctModuleService.listAndCountCategories.mdx | 355 - ...tModuleService.listAndCountCollections.mdx | 319 - ...oductModuleService.listAndCountOptions.mdx | 319 - ...IProductModuleService.listAndCountTags.mdx | 310 - ...ProductModuleService.listAndCountTypes.mdx | 310 - ...ductModuleService.listAndCountVariants.mdx | 338 - ...t.IProductModuleService.listCategories.mdx | 356 - ....IProductModuleService.listCollections.mdx | 320 - ...duct.IProductModuleService.listOptions.mdx | 320 - ...product.IProductModuleService.listTags.mdx | 311 - ...roduct.IProductModuleService.listTypes.mdx | 311 - ...uct.IProductModuleService.listVariants.mdx | 339 - .../product.IProductModuleService.restore.mdx | 160 - ....IProductModuleService.restoreVariants.mdx | 157 - ...product.IProductModuleService.retrieve.mdx | 945 - ...IProductModuleService.retrieveCategory.mdx | 499 - ...roductModuleService.retrieveCollection.mdx | 516 - ...t.IProductModuleService.retrieveOption.mdx | 571 - ...duct.IProductModuleService.retrieveTag.mdx | 498 - ...uct.IProductModuleService.retrieveType.mdx | 236 - ....IProductModuleService.retrieveVariant.mdx | 742 - ...oduct.IProductModuleService.softDelete.mdx | 160 - .../product.IProductModuleService.update.mdx | 479 - ...t.IProductModuleService.updateCategory.mdx | 490 - ...ProductModuleService.updateCollections.mdx | 195 - ...ct.IProductModuleService.updateOptions.mdx | 168 - ...oduct.IProductModuleService.updateTags.mdx | 159 - ...duct.IProductModuleService.updateTypes.mdx | 168 - ...t.IProductModuleService.updateVariants.mdx | 329 - ..._location.IStockLocationService.create.mdx | 315 - ..._location.IStockLocationService.delete.mdx | 83 - ...ck_location.IStockLocationService.list.mdx | 234 - ...ion.IStockLocationService.listAndCount.mdx | 233 - ...ocation.IStockLocationService.retrieve.mdx | 360 - ..._location.IStockLocationService.update.mdx | 397 - .../interfaces/types.LoggerTypes.Logger.mdx | 125 - ...dkTypes.ModuleServiceInitializeOptions.mdx | 216 - .../types.ModulesSdkTypes.Constructor.mdx | 35 - ...ulesSdkTypes.ExternalModuleDeclaration.mdx | 183 - ...ulesSdkTypes.InternalModuleDeclaration.mdx | 192 - ...s.ModulesSdkTypes.LinkModuleDefinition.mdx | 238 - .../types.ModulesSdkTypes.LoaderOptions.mdx | 188 - .../types.ModulesSdkTypes.ModuleConfig.mdx | 5 - ...types.ModulesSdkTypes.ModuleDefinition.mdx | 100 - .../types.ModulesSdkTypes.ModuleExports.mdx | 64 - ...pes.ModulesSdkTypes.ModuleJoinerConfig.mdx | 5 - ...s.ModulesSdkTypes.ModuleLoaderFunction.mdx | 392 - ...types.ModulesSdkTypes.ModuleResolution.mdx | 192 - ...erviceInitializeCustomDataLayerOptions.mdx | 28 - ...es.ModulesSdkTypes.RemoteQueryFunction.mdx | 44 - ...s.PriceListWorkflow.CreatePriceListDTO.mdx | 357 - ...ceListWorkflow.CreatePriceListPriceDTO.mdx | 62 - ...iceListWorkflow.CreatePriceListRuleDTO.mdx | 26 - ...istWorkflow.CreatePriceListWorkflowDTO.mdx | 172 - ...rkflow.CreatePriceListWorkflowInputDTO.mdx | 182 - ....RemovePriceListPricesWorkflowInputDTO.mdx | 26 - ...emovePriceListProductsWorkflowInputDTO.mdx | 26 - ...emovePriceListVariantsWorkflowInputDTO.mdx | 26 - ...rkflow.RemovePriceListWorkflowInputDTO.mdx | 17 - ...istWorkflow.UpdatePriceListWorkflowDTO.mdx | 109 - ...rkflow.UpdatePriceListWorkflowInputDTO.mdx | 119 - ...ypes.SalesChannelTypes.SalesChannelDTO.mdx | 127 - ...esChannelTypes.SalesChannelLocationDTO.mdx | 109 - .../types.SearchTypes.ISearchService.mdx | 372 - .../types/types.SearchTypes.IndexSettings.mdx | 37 - ...ctionBaseTypes.ITransactionBaseService.mdx | 35 - .../types.WorkflowTypes.CartWorkflow.mdx | 8 - .../types.WorkflowTypes.CommonWorkflow.mdx | 7 - .../types.WorkflowTypes.PriceListWorkflow.mdx | 21 - .../entities/classes/entities.Address.mdx | 165 +- .../classes/entities.AnalyticsConfig.mdx | 66 +- .../entities/classes/entities.BatchJob.mdx | 384 +- .../entities/classes/entities.Cart.mdx | 381 +- .../entities/classes/entities.ClaimImage.mdx | 220 +- .../entities/classes/entities.ClaimItem.mdx | 1144 +- .../entities/classes/entities.ClaimOrder.mdx | 192 +- .../entities/classes/entities.ClaimTag.mdx | 57 +- .../entities/classes/entities.Country.mdx | 248 +- .../entities/classes/entities.Currency.mdx | 49 +- .../classes/entities.CustomShippingOption.mdx | 645 +- .../entities/classes/entities.Customer.mdx | 1060 +- .../classes/entities.CustomerGroup.mdx | 339 +- .../entities/classes/entities.Discount.mdx | 592 +- .../classes/entities.DiscountCondition.mdx | 858 +- ...ntities.DiscountConditionCustomerGroup.mdx | 266 +- .../entities.DiscountConditionProduct.mdx | 510 +- ...ies.DiscountConditionProductCollection.mdx | 266 +- .../entities.DiscountConditionProductTag.mdx | 248 +- .../entities.DiscountConditionProductType.mdx | 248 +- .../classes/entities.DiscountRule.mdx | 267 +- .../entities/classes/entities.DraftOrder.mdx | 129 +- .../entities/classes/entities.Fulfillment.mdx | 1269 +- .../classes/entities.FulfillmentItem.mdx | 627 +- .../classes/entities.FulfillmentProvider.mdx | 21 +- .../entities/classes/entities.GiftCard.mdx | 825 +- .../classes/entities.GiftCardTransaction.mdx | 734 +- .../classes/entities.IdempotencyKey.mdx | 93 +- .../entities/classes/entities.Image.mdx | 57 +- .../entities/classes/entities.Invite.mdx | 121 +- .../entities/classes/entities.LineItem.mdx | 391 +- .../classes/entities.LineItemAdjustment.mdx | 75 +- .../classes/entities.LineItemTaxLine.mdx | 84 +- .../entities/classes/entities.MoneyAmount.mdx | 873 +- .../entities/classes/entities.Note.mdx | 193 +- .../classes/entities.Notification.mdx | 574 +- .../classes/entities.NotificationProvider.mdx | 21 +- .../entities/classes/entities.Oauth.mdx | 57 +- .../entities/classes/entities.Order.mdx | 516 +- .../entities/classes/entities.OrderEdit.mdx | 264 +- .../classes/entities.OrderItemChange.mdx | 102 +- .../entities/classes/entities.Payment.mdx | 1331 +- .../classes/entities.PaymentCollection.mdx | 712 +- .../classes/entities.PaymentProvider.mdx | 21 +- .../classes/entities.PaymentSession.mdx | 499 +- .../entities/classes/entities.PriceList.mdx | 377 +- .../entities/classes/entities.Product.mdx | 1320 +- .../classes/entities.ProductCategory.mdx | 609 +- .../classes/entities.ProductCollection.mdx | 392 +- .../classes/entities.ProductOption.mdx | 492 +- .../classes/entities.ProductOptionValue.mdx | 428 +- .../entities/classes/entities.ProductTag.mdx | 57 +- .../classes/entities.ProductTaxRate.mdx | 519 +- .../entities/classes/entities.ProductType.mdx | 57 +- .../classes/entities.ProductTypeTaxRate.mdx | 257 +- .../classes/entities.ProductVariant.mdx | 881 +- .../entities.ProductVariantInventoryItem.mdx | 328 +- .../entities.ProductVariantMoneyAmount.mdx | 57 +- .../classes/entities.PublishableApiKey.mdx | 66 +- ...entities.PublishableApiKeySalesChannel.mdx | 21 +- .../entities/classes/entities.Refund.mdx | 797 +- .../entities/classes/entities.Region.mdx | 352 +- .../entities/classes/entities.Return.mdx | 1423 +- .../entities/classes/entities.ReturnItem.mdx | 772 +- .../classes/entities.ReturnReason.mdx | 202 +- .../classes/entities.SalesChannel.mdx | 148 +- .../classes/entities.SalesChannelLocation.mdx | 148 +- .../classes/entities.ShippingMethod.mdx | 1911 +- .../entities.ShippingMethodTaxLine.mdx | 266 +- .../classes/entities.ShippingOption.mdx | 523 +- .../entities.ShippingOptionRequirement.mdx | 249 +- .../classes/entities.ShippingProfile.mdx | 602 +- .../classes/entities.ShippingTaxRate.mdx | 375 +- .../entities/classes/entities.StagedJob.mdx | 39 +- .../entities/classes/entities.Store.mdx | 305 +- .../entities/classes/entities.Swap.mdx | 219 +- .../entities/classes/entities.TaxProvider.mdx | 21 +- .../entities/classes/entities.TaxRate.mdx | 856 +- .../classes/entities.TrackingLink.mdx | 283 +- .../entities/classes/entities.User.mdx | 130 +- .../enums/entities.PaymentSessionStatus.mdx | 12 + ...fulfillment.AbstractFulfillmentService.mdx | 2531 +- .../fulfillment.FulfillmentService.mdx | 2491 +- ...tory.IInventoryService.adjustInventory.mdx | 45 + ...ory.IInventoryService.confirmInventory.mdx | 43 + ....IInventoryService.createInventoryItem.mdx | 42 + ...IInventoryService.createInventoryItems.mdx | 42 + ...IInventoryService.createInventoryLevel.mdx | 43 + ...InventoryService.createInventoryLevels.mdx | 43 + ...InventoryService.createReservationItem.mdx | 43 + ...nventoryService.createReservationItems.mdx | 43 + ....IInventoryService.deleteInventoryItem.mdx | 40 + ...e.deleteInventoryItemLevelByLocationId.mdx | 39 + ...IInventoryService.deleteInventoryLevel.mdx | 41 + ...InventoryService.deleteReservationItem.mdx | 39 + ...vice.deleteReservationItemByLocationId.mdx | 39 + ...rvice.deleteReservationItemsByLineItem.mdx | 39 + ...y.IInventoryService.listInventoryItems.mdx | 83 + ....IInventoryService.listInventoryLevels.mdx | 83 + ...IInventoryService.listReservationItems.mdx | 83 + ...IInventoryService.restoreInventoryItem.mdx | 39 + ...ntoryService.retrieveAvailableQuantity.mdx | 43 + ...InventoryService.retrieveInventoryItem.mdx | 57 + ...nventoryService.retrieveInventoryLevel.mdx | 43 + ...ventoryService.retrieveReservationItem.mdx | 37 + ...entoryService.retrieveReservedQuantity.mdx | 43 + ...ventoryService.retrieveStockedQuantity.mdx | 43 + ....IInventoryService.updateInventoryItem.mdx | 45 + ...IInventoryService.updateInventoryLevel.mdx | 47 + ...InventoryService.updateInventoryLevels.mdx | 43 + ...InventoryService.updateReservationItem.mdx | 45 + ...nventory.BulkUpdateInventoryLevelInput.mdx | 39 +- .../inventory.CreateInventoryItemInput.mdx | 129 +- .../inventory.CreateInventoryLevelInput.mdx | 48 +- .../inventory.CreateReservationItemInput.mdx | 75 +- ...inventory.FilterableInventoryItemProps.mdx | 66 +- ...nventory.FilterableInventoryLevelProps.mdx | 48 +- ...ventory.FilterableReservationItemProps.mdx | 66 +- .../interfaces/inventory.FindConfig.mdx | 69 +- .../inventory.IInventoryService.mdx | 56 +- .../inventory.JoinerServiceConfig.mdx | 231 +- .../inventory.JoinerServiceConfigAlias.mdx | 21 +- .../inventory.NumericalComparisonOperator.mdx | 39 +- .../interfaces/inventory.SharedContext.mdx | 21 +- .../inventory.StringComparisonOperator.mdx | 66 +- .../inventory.UpdateInventoryLevelInput.mdx | 21 +- .../inventory.UpdateReservationItemInput.mdx | 39 +- .../types/inventory.InventoryItemDTO.mdx | 165 +- .../types/inventory.InventoryLevelDTO.mdx | 93 +- .../types/inventory.JoinerRelationship.mdx | 75 +- .../types/inventory.ReservationItemDTO.mdx | 102 +- .../classes/js_client.AddressesResource.mdx | 3495 +- .../js_client/classes/js_client.Admin.mdx | 345 +- .../classes/js_client.AdminAuthResource.mdx | 420 +- .../js_client.AdminBatchJobsResource.mdx | 2163 +- .../js_client.AdminCollectionsResource.mdx | 2303 +- .../js_client.AdminCurrenciesResource.mdx | 284 +- .../classes/js_client.AdminCustomResource.mdx | 228 +- .../js_client.AdminCustomerGroupsResource.mdx | 2701 +- .../js_client.AdminCustomersResource.mdx | 3721 +- .../js_client.AdminDiscountsResource.mdx | 9875 +- .../js_client.AdminDraftOrdersResource.mdx | 11866 +- .../js_client.AdminGiftCardsResource.mdx | 3006 +- .../js_client.AdminInventoryItemsResource.mdx | 2378 +- .../js_client.AdminInvitesResource.mdx | 360 +- .../classes/js_client.AdminNotesResource.mdx | 1009 +- .../js_client.AdminNotificationsResource.mdx | 932 +- .../js_client.AdminOrderEditsResource.mdx | 14249 +- .../classes/js_client.AdminOrdersResource.mdx | 2113 +- ...client.AdminPaymentCollectionsResource.mdx | 2376 +- .../js_client.AdminPaymentsResource.mdx | 3700 +- .../js_client.AdminPriceListResource.mdx | 3707 +- ..._client.AdminProductCategoriesResource.mdx | 3859 +- .../js_client.AdminProductTagsResource.mdx | 282 +- .../js_client.AdminProductTypesResource.mdx | 291 +- .../js_client.AdminProductsResource.mdx | 15927 +- ..._client.AdminPublishableApiKeyResource.mdx | 1233 +- .../js_client.AdminRegionsResource.mdx | 4383 +- .../js_client.AdminReservationsResource.mdx | 945 +- .../js_client.AdminReturnReasonsResource.mdx | 1116 +- .../js_client.AdminReturnsResource.mdx | 6474 +- .../js_client.AdminSalesChannelsResource.mdx | 1931 +- ...js_client.AdminShippingOptionsResource.mdx | 2322 +- ...s_client.AdminShippingProfilesResource.mdx | 2767 +- .../js_client.AdminStockLocationsResource.mdx | 602 +- .../classes/js_client.AdminStoresResource.mdx | 1638 +- .../classes/js_client.AdminSwapsResource.mdx | 2874 +- .../js_client.AdminTaxRatesResource.mdx | 8930 +- .../js_client.AdminUploadsResource.mdx | 256 +- .../classes/js_client.AdminUsersResource.mdx | 942 +- .../js_client.AdminVariantsResource.mdx | 359 +- .../classes/js_client.AuthResource.mdx | 2341 +- .../classes/js_client.CartsResource.mdx | 22076 +-- .../classes/js_client.CollectionsResource.mdx | 706 +- .../classes/js_client.CustomersResource.mdx | 5621 +- .../classes/js_client.GiftCardsResource.mdx | 866 +- .../classes/js_client.LineItemsResource.mdx | 1297 +- .../classes/js_client.OrderEditsResource.mdx | 4437 +- .../classes/js_client.OrdersResource.mdx | 14185 +- .../js_client.PaymentCollectionsResource.mdx | 4442 +- .../js_client.PaymentMethodsResource.mdx | 53 +- .../js_client.ProductCategoriesResource.mdx | 976 +- .../classes/js_client.ProductTagsResource.mdx | 291 +- .../js_client.ProductTypesResource.mdx | 291 +- .../js_client.ProductVariantsResource.mdx | 195 +- .../classes/js_client.ProductsResource.mdx | 511 +- .../classes/js_client.RegionsResource.mdx | 639 +- .../js_client.ReturnReasonsResource.mdx | 477 +- .../classes/js_client.ReturnsResource.mdx | 1539 +- .../js_client.ShippingOptionsResource.mdx | 114 +- .../classes/js_client.SwapsResource.mdx | 5209 +- .../medusa.AbstractBatchJobStrategy.mdx | 974 +- .../medusa.AbstractCartCompletionStrategy.mdx | 454 +- .../classes/medusa.AbstractFileService.mdx | 616 +- .../medusa.AbstractFulfillmentService.mdx | 2580 +- .../medusa.AbstractNotificationService.mdx | 453 +- .../medusa.AbstractPaymentProcessor.mdx | 602 +- .../classes/medusa.AbstractPaymentService.mdx | 3580 +- .../medusa.AbstractPriceSelectionStrategy.mdx | 478 +- .../classes/medusa.AbstractTaxService.mdx | 169 +- .../classes/medusa.AdditionalItem-1.mdx | 21 +- .../classes/medusa.AdditionalItem-2.mdx | 21 +- .../medusa/classes/medusa.AdditionalItem.mdx | 21 +- .../classes/medusa.AddressCreatePayload.mdx | 102 +- .../medusa/classes/medusa.AddressPayload.mdx | 102 +- .../classes/medusa.AdminCreateCondition.mdx | 76 +- .../classes/medusa.AdminCreateUserRequest.mdx | 76 +- ...eteCustomerGroupsGroupCustomerBatchReq.mdx | 24 +- ...DiscountConditionsConditionBatchParams.mdx | 21 +- ...ntsDiscountConditionsConditionBatchReq.mdx | 22 +- ...ountsDiscountConditionsConditionParams.mdx | 21 +- ...sa.AdminDeletePriceListPricesPricesReq.mdx | 14 +- ...ceListsPriceListProductsPricesBatchReq.mdx | 14 +- ...tCategoriesCategoryProductsBatchParams.mdx | 21 +- ...ductCategoriesCategoryProductsBatchReq.mdx | 24 +- ...a.AdminDeleteProductsFromCollectionReq.mdx | 14 +- ...PublishableApiKeySalesChannelsBatchReq.mdx | 24 +- ...teSalesChannelsChannelProductsBatchReq.mdx | 24 +- ...eSalesChannelsChannelStockLocationsReq.mdx | 12 +- ...eleteTaxRatesTaxRateProductTypesParams.mdx | 21 +- ...inDeleteTaxRatesTaxRateProductTypesReq.mdx | 12 +- ...minDeleteTaxRatesTaxRateProductsParams.mdx | 21 +- ....AdminDeleteTaxRatesTaxRateProductsReq.mdx | 14 +- ...teTaxRatesTaxRateShippingOptionsParams.mdx | 21 +- ...eleteTaxRatesTaxRateShippingOptionsReq.mdx | 14 +- .../classes/medusa.AdminDeleteUploadsReq.mdx | 14 +- .../medusa.AdminGetBatchPaginationParams.mdx | 48 +- .../classes/medusa.AdminGetBatchParams.mdx | 203 +- ...sa.AdminGetCollectionsPaginationParams.mdx | 21 +- .../medusa.AdminGetCollectionsParams.mdx | 195 +- .../medusa.AdminGetCurrenciesParams.mdx | 49 +- ...dusa.AdminGetCustomerGroupsGroupParams.mdx | 21 +- .../medusa.AdminGetCustomerGroupsParams.mdx | 167 +- .../medusa.AdminGetCustomersParams.mdx | 57 +- .../classes/medusa.AdminGetDiscountParams.mdx | 21 +- ...sa.AdminGetDiscountsDiscountCodeParams.mdx | 21 +- ...ountsDiscountConditionsConditionParams.mdx | 21 +- ...sa.AdminGetDiscountsDiscountRuleParams.mdx | 68 +- .../medusa.AdminGetDiscountsParams.mdx | 94 +- .../medusa.AdminGetDraftOrdersParams.mdx | 30 +- .../medusa.AdminGetGiftCardsParams.mdx | 30 +- ...InventoryItemsItemLocationLevelsParams.mdx | 30 +- ...edusa.AdminGetInventoryItemsItemParams.mdx | 21 +- .../medusa.AdminGetInventoryItemsParams.mdx | 156 +- .../classes/medusa.AdminGetNotesParams.mdx | 30 +- .../medusa.AdminGetNotificationsParams.mdx | 84 +- .../medusa.AdminGetOrdersOrderParams.mdx | 21 +- .../classes/medusa.AdminGetOrdersParams.mdx | 294 +- ...edusa.AdminGetPaymentCollectionsParams.mdx | 21 +- ...dusa.AdminGetPriceListPaginationParams.mdx | 278 +- ...inGetPriceListsPriceListProductsParams.mdx | 313 +- ...medusa.AdminGetProductCategoriesParams.mdx | 93 +- .../medusa.AdminGetProductCategoryParams.mdx | 21 +- .../classes/medusa.AdminGetProductParams.mdx | 21 +- ...sa.AdminGetProductTagsPaginationParams.mdx | 21 +- .../medusa.AdminGetProductTagsParams.mdx | 158 +- .../medusa.AdminGetProductTypesParams.mdx | 158 +- .../classes/medusa.AdminGetProductsParams.mdx | 359 +- .../medusa.AdminGetProductsVariantsParams.mdx | 39 +- .../classes/medusa.AdminGetRegionsParams.mdx | 177 +- ...nGetRegionsRegionFulfillmentOptionsRes.mdx | 31 +- .../medusa.AdminGetReservationsParams.mdx | 176 +- .../classes/medusa.AdminGetReturnsParams.mdx | 21 +- .../medusa.AdminGetSalesChannelsParams.mdx | 222 +- .../medusa.AdminGetShippingOptionsParams.mdx | 30 +- ...a.AdminGetStockLocationsLocationParams.mdx | 21 +- .../medusa.AdminGetStockLocationsParams.mdx | 75 +- .../classes/medusa.AdminGetSwapsParams.mdx | 21 +- .../classes/medusa.AdminGetTaxRatesParams.mdx | 75 +- .../medusa.AdminGetTaxRatesTaxRateParams.mdx | 21 +- .../classes/medusa.AdminGetVariantParams.mdx | 21 +- .../classes/medusa.AdminGetVariantsParams.mdx | 111 +- .../medusa.AdminListCustomerSelector.mdx | 30 +- .../medusa.AdminListOrdersSelector.mdx | 258 +- ...nPostAnalyticsConfigAnalyticsConfigReq.mdx | 21 +- .../medusa.AdminPostAnalyticsConfigReq.mdx | 21 +- .../classes/medusa.AdminPostAuthReq.mdx | 23 +- .../classes/medusa.AdminPostBatchesReq.mdx | 32 +- ...dusa.AdminPostCollectionsCollectionReq.mdx | 32 +- .../medusa.AdminPostCollectionsReq.mdx | 32 +- .../medusa.AdminPostCurrenciesCurrencyReq.mdx | 15 +- ...stCustomerGroupsGroupCustomersBatchReq.mdx | 24 +- ...medusa.AdminPostCustomerGroupsGroupReq.mdx | 23 +- .../medusa.AdminPostCustomerGroupsReq.mdx | 23 +- .../medusa.AdminPostCustomersCustomerReq.mdx | 78 +- .../classes/medusa.AdminPostCustomersReq.mdx | 59 +- ...a.AdminPostDiscountsDiscountConditions.mdx | 76 +- ...stDiscountsDiscountConditionsCondition.mdx | 48 +- ...DiscountConditionsConditionBatchParams.mdx | 21 +- ...ntsDiscountConditionsConditionBatchReq.mdx | 24 +- ...ountsDiscountConditionsConditionParams.mdx | 21 +- ...nPostDiscountsDiscountConditionsParams.mdx | 21 +- ...inPostDiscountsDiscountDynamicCodesReq.mdx | 32 +- ...edusa.AdminPostDiscountsDiscountParams.mdx | 21 +- .../medusa.AdminPostDiscountsDiscountReq.mdx | 132 +- .../medusa.AdminPostDiscountsDiscountRule.mdx | 150 +- .../medusa.AdminPostDiscountsParams.mdx | 21 +- .../classes/medusa.AdminPostDiscountsReq.mdx | 141 +- ...tDraftOrdersDraftOrderLineItemsItemReq.mdx | 41 +- ...nPostDraftOrdersDraftOrderLineItemsReq.mdx | 50 +- ...dusa.AdminPostDraftOrdersDraftOrderReq.mdx | 87 +- .../medusa.AdminPostDraftOrdersReq.mdx | 188 +- .../medusa.AdminPostGiftCardsGiftCardReq.mdx | 50 +- .../classes/medusa.AdminPostGiftCardsReq.mdx | 50 +- ...nPostInventoryItemsInventoryItemParams.mdx | 21 +- ...dminPostInventoryItemsInventoryItemReq.mdx | 120 +- ...toryItemsItemLocationLevelsLevelParams.mdx | 21 +- ...ventoryItemsItemLocationLevelsLevelReq.mdx | 21 +- ...InventoryItemsItemLocationLevelsParams.mdx | 21 +- ...ostInventoryItemsItemLocationLevelsReq.mdx | 32 +- .../medusa.AdminPostInventoryItemsParams.mdx | 21 +- .../medusa.AdminPostInventoryItemsReq.mdx | 131 +- ...medusa.AdminPostInvitesInviteAcceptReq.mdx | 49 +- ...sa.AdminPostInvitesInviteAcceptUserReq.mdx | 30 +- .../classes/medusa.AdminPostInvitesReq.mdx | 49 +- .../classes/medusa.AdminPostNotesNoteReq.mdx | 14 +- .../classes/medusa.AdminPostNotesReq.mdx | 32 +- ...PostNotificationsNotificationResendReq.mdx | 14 +- ...PostOrderEditsEditLineItemsLineItemReq.mdx | 14 +- ...sa.AdminPostOrderEditsEditLineItemsReq.mdx | 32 +- ...medusa.AdminPostOrderEditsOrderEditReq.mdx | 14 +- .../classes/medusa.AdminPostOrderEditsReq.mdx | 32 +- ...inPostOrderEditsRequestConfirmationReq.mdx | 12 +- .../medusa.AdminPostOrdersClaimCancel.mdx | 21 +- ...ostOrdersClaimFulfillmentsCancelParams.mdx | 21 +- ...dusa.AdminPostOrdersOrderArchiveParams.mdx | 21 +- .../medusa.AdminPostOrdersOrderCancel.mdx | 21 +- ...dusa.AdminPostOrdersOrderCaptureParams.mdx | 21 +- ...dersOrderClaimsClaimFulfillmentsParams.mdx | 21 +- ...tOrdersOrderClaimsClaimFulfillmentsReq.mdx | 30 +- ....AdminPostOrdersOrderClaimsClaimParams.mdx | 21 +- ...usa.AdminPostOrdersOrderClaimsClaimReq.mdx | 131 +- ...tOrdersOrderClaimsClaimShipmentsParams.mdx | 21 +- ...PostOrdersOrderClaimsClaimShipmentsReq.mdx | 21 +- ...edusa.AdminPostOrdersOrderClaimsParams.mdx | 21 +- .../medusa.AdminPostOrdersOrderClaimsReq.mdx | 323 +- ...usa.AdminPostOrdersOrderCompleteParams.mdx | 21 +- ...stOrdersOrderFulfillementsCancelParams.mdx | 21 +- ...AdminPostOrdersOrderFulfillmentsParams.mdx | 21 +- ...sa.AdminPostOrdersOrderFulfillmentsReq.mdx | 58 +- .../medusa.AdminPostOrdersOrderParams.mdx | 21 +- ...dusa.AdminPostOrdersOrderRefundsParams.mdx | 21 +- .../medusa.AdminPostOrdersOrderRefundsReq.mdx | 41 +- .../medusa.AdminPostOrdersOrderReq.mdx | 360 +- ...dusa.AdminPostOrdersOrderReturnsParams.mdx | 21 +- .../medusa.AdminPostOrdersOrderReturnsReq.mdx | 124 +- ...usa.AdminPostOrdersOrderShipmentParams.mdx | 21 +- ...medusa.AdminPostOrdersOrderShipmentReq.mdx | 32 +- ...inPostOrdersOrderShippingMethodsParams.mdx | 21 +- ...AdminPostOrdersOrderShippingMethodsReq.mdx | 30 +- ...dersOrderSwapFulfillementsCancelParams.mdx | 21 +- ...medusa.AdminPostOrdersOrderSwapsParams.mdx | 21 +- .../medusa.AdminPostOrdersOrderSwapsReq.mdx | 171 +- ...OrdersOrderSwapsSwapFulfillmentsParams.mdx | 21 +- ...ostOrdersOrderSwapsSwapFulfillmentsReq.mdx | 30 +- ...dersOrderSwapsSwapProcessPaymentParams.mdx | 21 +- ...ostOrdersOrderSwapsSwapShipmentsParams.mdx | 21 +- ...inPostOrdersOrderSwapsSwapShipmentsReq.mdx | 30 +- ...medusa.AdminPostOrdersSwapCancelParams.mdx | 21 +- .../medusa.AdminPostPaymentRefundsReq.mdx | 78 +- ...dusa.AdminPostPriceListPricesPricesReq.mdx | 87 +- ...minPostPriceListsPriceListPriceListReq.mdx | 199 +- ...medusa.AdminPostPriceListsPriceListReq.mdx | 190 +- ...minPostProductCategoriesCategoryParams.mdx | 21 +- ...tCategoriesCategoryProductsBatchParams.mdx | 21 +- ...ductCategoriesCategoryProductsBatchReq.mdx | 24 +- ....AdminPostProductCategoriesCategoryReq.mdx | 77 +- ...edusa.AdminPostProductCategoriesParams.mdx | 21 +- .../medusa.AdminPostProductCategoriesReq.mdx | 68 +- ...sa.AdminPostProductsProductMetadataReq.mdx | 21 +- ....AdminPostProductsProductOptionsOption.mdx | 12 +- ...usa.AdminPostProductsProductOptionsReq.mdx | 14 +- .../medusa.AdminPostProductsProductReq.mdx | 479 +- ...sa.AdminPostProductsProductVariantsReq.mdx | 241 +- ...nPostProductsProductVariantsVariantReq.mdx | 248 +- .../classes/medusa.AdminPostProductsReq.mdx | 508 +- ...edusa.AdminPostProductsToCollectionReq.mdx | 14 +- ...PublishableApiKeySalesChannelsBatchReq.mdx | 24 +- ...PublishableApiKeysPublishableApiKeyReq.mdx | 14 +- .../medusa.AdminPostPublishableApiKeysReq.mdx | 14 +- ...usa.AdminPostRegionsRegionCountriesReq.mdx | 14 +- ...stRegionsRegionFulfillmentProvidersReq.mdx | 14 +- ...inPostRegionsRegionPaymentProvidersReq.mdx | 14 +- .../medusa.AdminPostRegionsRegionReq.mdx | 114 +- .../classes/medusa.AdminPostRegionsReq.mdx | 87 +- .../medusa.AdminPostReservationsReq.mdx | 59 +- ...sa.AdminPostReservationsReservationReq.mdx | 41 +- ...medusa.AdminPostReturnReasonsReasonReq.mdx | 41 +- .../medusa.AdminPostReturnReasonsReq.mdx | 50 +- ...edusa.AdminPostReturnsReturnReceiveReq.mdx | 51 +- ...stSalesChannelsChannelProductsBatchReq.mdx | 24 +- ...tSalesChannelsChannelStockLocationsReq.mdx | 12 +- .../medusa.AdminPostSalesChannelsReq.mdx | 32 +- ....AdminPostSalesChannelsSalesChannelReq.mdx | 32 +- ...dusa.AdminPostShippingOptionsOptionReq.mdx | 116 +- .../medusa.AdminPostShippingOptionsReq.mdx | 152 +- ...sa.AdminPostShippingProfilesProfileReq.mdx | 78 +- .../medusa.AdminPostShippingProfilesReq.mdx | 60 +- ....AdminPostStockLocationsLocationParams.mdx | 21 +- ...usa.AdminPostStockLocationsLocationReq.mdx | 114 +- .../medusa.AdminPostStockLocationsParams.mdx | 21 +- .../medusa.AdminPostStockLocationsReq.mdx | 114 +- .../classes/medusa.AdminPostStoreReq.mdx | 68 +- .../medusa.AdminPostTaxRatesParams.mdx | 21 +- .../classes/medusa.AdminPostTaxRatesReq.mdx | 68 +- .../medusa.AdminPostTaxRatesTaxRateParams.mdx | 21 +- ...nPostTaxRatesTaxRateProductTypesParams.mdx | 21 +- ...dminPostTaxRatesTaxRateProductTypesReq.mdx | 12 +- ...AdminPostTaxRatesTaxRateProductsParams.mdx | 21 +- ...sa.AdminPostTaxRatesTaxRateProductsReq.mdx | 14 +- .../medusa.AdminPostTaxRatesTaxRateReq.mdx | 68 +- ...stTaxRatesTaxRateShippingOptionsParams.mdx | 21 +- ...nPostTaxRatesTaxRateShippingOptionsReq.mdx | 14 +- .../medusa.AdminPostUploadsDownloadUrlReq.mdx | 14 +- .../medusa.AdminPriceListPricesCreateReq.mdx | 57 +- .../medusa.AdminPriceListPricesUpdateReq.mdx | 66 +- .../medusa.AdminPriceSelectionParams.mdx | 57 +- .../medusa.AdminProductCategoriesReqBase.mdx | 48 +- .../medusa.AdminResetPasswordRequest.mdx | 32 +- .../medusa.AdminResetPasswordTokenRequest.mdx | 14 +- .../medusa.AdminUpdateDiscountRule.mdx | 131 +- ...edusa.AdminUpdatePaymentCollectionsReq.mdx | 23 +- .../classes/medusa.AdminUpdateUserRequest.mdx | 76 +- .../classes/medusa.AdminUpsertCondition.mdx | 85 +- .../medusa.AdminUpsertConditionsReq.mdx | 48 +- .../classes/medusa.CustomShippingOption.mdx | 21 +- .../medusa/classes/medusa.CustomerGroup-1.mdx | 12 +- .../medusa/classes/medusa.CustomerGroup.mdx | 12 +- .../medusa.CustomerGroupsBatchCustomer.mdx | 12 +- .../classes/medusa.DateComparisonOperator.mdx | 39 +- .../medusa/classes/medusa.Discount-1.mdx | 12 +- .../medusa/classes/medusa.Discount-2.mdx | 12 +- .../medusa/classes/medusa.Discount.mdx | 12 +- .../medusa.FilterableBatchJobProps.mdx | 195 +- .../medusa.FilterableCustomerGroupProps.mdx | 131 +- .../medusa.FilterablePriceListProps.mdx | 242 +- .../classes/medusa.FilterableProductProps.mdx | 314 +- .../classes/medusa.FindPaginationParams.mdx | 21 +- .../medusa/classes/medusa.FindParams.mdx | 21 +- .../classes/medusa.FulfillmentOption.mdx | 21 +- .../medusa.GetOrderEditsOrderEditParams.mdx | 21 +- .../classes/medusa.GetOrderEditsParams.mdx | 69 +- .../classes/medusa.GetPaymentsParams.mdx | 21 +- ...etPublishableApiKeySalesChannelsParams.mdx | 60 +- .../medusa.GetPublishableApiKeysParams.mdx | 60 +- .../medusa/classes/medusa.GiftCard.mdx | 12 +- .../medusa/classes/medusa.Group.mdx | 12 +- .../medusa.IAdminPostUploadsFileReq.mdx | 21 +- .../medusa/classes/medusa.Image.mdx | 21 +- .../medusa/classes/medusa.Item-1.mdx | 48 +- .../medusa/classes/medusa.Item-2.mdx | 94 +- .../medusa/classes/medusa.Item-3.mdx | 21 +- .../medusa/classes/medusa.Item-4.mdx | 95 +- .../medusa/classes/medusa.Item-5.mdx | 21 +- .../medusa/classes/medusa.Item-6.mdx | 39 +- .../medusa/classes/medusa.Item-7.mdx | 39 +- .../references/medusa/classes/medusa.Item.mdx | 21 +- .../medusa/classes/medusa.MedusaError.mdx | 314 +- .../medusa.NumericalComparisonOperator.mdx | 39 +- .../classes/medusa.OptionRequirement-1.mdx | 30 +- .../classes/medusa.OptionRequirement.mdx | 40 +- .../classes/medusa.OrdersReturnItem.mdx | 39 +- .../medusa/classes/medusa.PaymentMethod.mdx | 21 +- .../classes/medusa.PriceSelectionParams.mdx | 48 +- .../medusa.ProductBatchProductCategory.mdx | 12 +- .../medusa.ProductBatchSalesChannel.mdx | 12 +- .../classes/medusa.ProductOptionReq.mdx | 12 +- .../medusa.ProductProductCategoryReq.mdx | 12 +- .../classes/medusa.ProductSalesChannelReq.mdx | 12 +- .../medusa/classes/medusa.ProductTagReq.mdx | 21 +- .../medusa/classes/medusa.ProductTypeReq.mdx | 21 +- .../medusa.ProductVariantOptionReq-1.mdx | 21 +- .../medusa.ProductVariantOptionReq-2.mdx | 12 +- .../medusa.ProductVariantOptionReq-3.mdx | 21 +- .../medusa.ProductVariantOptionReq.mdx | 21 +- .../medusa.ProductVariantPricesCreateReq.mdx | 48 +- .../medusa.ProductVariantPricesUpdateReq.mdx | 57 +- .../classes/medusa.ProductVariantReq-1.mdx | 257 +- .../classes/medusa.ProductVariantReq.mdx | 230 +- .../medusa/classes/medusa.ReturnItem.mdx | 39 +- .../classes/medusa.ReturnShipping-1.mdx | 21 +- .../classes/medusa.ReturnShipping-2.mdx | 21 +- .../classes/medusa.ReturnShipping-3.mdx | 12 +- .../medusa/classes/medusa.ReturnShipping.mdx | 21 +- .../classes/medusa.ShippingAddressPayload.mdx | 12 +- .../classes/medusa.ShippingMethod-1.mdx | 39 +- .../classes/medusa.ShippingMethod-2.mdx | 39 +- .../classes/medusa.ShippingMethod-3.mdx | 48 +- .../medusa/classes/medusa.ShippingMethod.mdx | 30 +- .../classes/medusa.StockLocationAddress-1.mdx | 75 +- .../classes/medusa.StockLocationAddress.mdx | 75 +- .../medusa.StoreGetCollectionsParams.mdx | 122 +- ...ustomersCustomerOrdersPaginationParams.mdx | 39 +- ....StoreGetCustomersCustomerOrdersParams.mdx | 468 +- .../classes/medusa.StoreGetOrdersParams.mdx | 58 +- ...edusa.StoreGetPaymentCollectionsParams.mdx | 21 +- ...toreGetProductCategoriesCategoryParams.mdx | 21 +- ...medusa.StoreGetProductCategoriesParams.mdx | 75 +- .../medusa.StoreGetProductTagsParams.mdx | 158 +- .../medusa.StoreGetProductTypesParams.mdx | 158 +- ...edusa.StoreGetProductsPaginationParams.mdx | 75 +- .../classes/medusa.StoreGetProductsParams.mdx | 276 +- .../classes/medusa.StoreGetRegionsParams.mdx | 131 +- .../medusa.StoreGetRegionsRegionParams.mdx | 21 +- .../medusa.StoreGetShippingOptionsParams.mdx | 30 +- .../classes/medusa.StoreGetVariantsParams.mdx | 111 +- .../medusa.StoreGetVariantsVariantParams.mdx | 57 +- ...dusa.StorePaymentCollectionSessionsReq.mdx | 14 +- .../classes/medusa.StorePostAuthReq.mdx | 21 +- .../classes/medusa.StorePostCartReq.mdx | 67 +- ...usa.StorePostCartsCartLineItemsItemReq.mdx | 23 +- .../medusa.StorePostCartsCartLineItemsReq.mdx | 32 +- ...sa.StorePostCartsCartPaymentSessionReq.mdx | 14 +- ...rePostCartsCartPaymentSessionUpdateReq.mdx | 12 +- .../classes/medusa.StorePostCartsCartReq.mdx | 115 +- ...sa.StorePostCartsCartShippingMethodReq.mdx | 23 +- ...orePostCustomersCustomerAcceptClaimReq.mdx | 14 +- ...stCustomersCustomerAddressesAddressReq.mdx | 102 +- ...StorePostCustomersCustomerAddressesReq.mdx | 112 +- ...torePostCustomersCustomerOrderClaimReq.mdx | 14 +- ...ePostCustomersCustomerPasswordTokenReq.mdx | 12 +- .../medusa.StorePostCustomersCustomerReq.mdx | 68 +- .../classes/medusa.StorePostCustomersReq.mdx | 50 +- ...usa.StorePostCustomersResetPasswordReq.mdx | 30 +- ...sa.StorePostOrderEditsOrderEditDecline.mdx | 14 +- ...ntCollectionsBatchSessionsAuthorizeReq.mdx | 14 +- ...PostPaymentCollectionsBatchSessionsReq.mdx | 42 +- ...StorePostPaymentCollectionsSessionsReq.mdx | 30 +- .../classes/medusa.StorePostReturnsReq.mdx | 79 +- .../classes/medusa.StorePostSearchReq.mdx | 39 +- .../classes/medusa.StorePostSwapsReq.mdx | 97 +- .../medusa.StringComparisonOperator.mdx | 66 +- .../references/medusa/classes/medusa.Tag.mdx | 21 +- .../classes/medusa.TransactionBaseService.mdx | 292 +- .../interfaces/medusa.CustomFindOptions.mdx | 69 +- .../interfaces/medusa.DeleteResponse.mdx | 32 +- .../medusa/interfaces/medusa.FindConfig.mdx | 60 +- .../interfaces/medusa.FulfillmentService.mdx | 2491 +- .../interfaces/medusa.IBatchJobStrategy.mdx | 430 +- .../medusa.ICartCompletionStrategy.mdx | 153 +- .../medusa/interfaces/medusa.IFileService.mdx | 577 +- .../medusa.INotificationService.mdx | 375 +- .../medusa.IPriceSelectionStrategy.mdx | 201 +- .../medusa.ITaxCalculationStrategy.mdx | 496 +- .../medusa/interfaces/medusa.ITaxService.mdx | 145 +- .../medusa.ITransactionBaseService.mdx | 24 +- .../interfaces/medusa.JoinerServiceConfig.mdx | 158 +- .../medusa.JoinerServiceConfigAlias.mdx | 21 +- .../interfaces/medusa.MedusaRequest.mdx | 287 +- .../interfaces/medusa.PaginatedResponse.mdx | 30 +- .../interfaces/medusa.PaymentProcessor.mdx | 513 +- .../medusa.PaymentProcessorContext.mdx | 220 +- .../medusa.PaymentProcessorError.mdx | 30 +- ...medusa.PaymentProcessorSessionResponse.mdx | 40 +- .../interfaces/medusa.PaymentService.mdx | 3532 +- .../interfaces/medusa.ProductCategoryDTO.mdx | 302 +- .../medusa.ProductCollectionDTO.mdx | 319 +- .../medusa/interfaces/medusa.ProductDTO.mdx | 748 +- .../interfaces/medusa.ProductImageDTO.mdx | 39 +- .../interfaces/medusa.ProductOptionDTO.mdx | 374 +- .../medusa.ProductOptionValueDTO.mdx | 338 +- .../interfaces/medusa.ProductTagDTO.mdx | 301 +- .../interfaces/medusa.ProductTypeDTO.mdx | 39 +- .../interfaces/medusa.ProductVariantDTO.mdx | 545 +- .../interfaces/medusa.RequestQueryFields.mdx | 48 +- .../interfaces/medusa.SubscriberContext.mdx | 12 +- .../medusa._medusa_interfaces_.mdx | 0 .../types/medusa.AdminAnalyticsConfigRes.mdx | 76 +- .../medusa/types/medusa.AdminAuthRes.mdx | 103 +- .../medusa/types/medusa.AdminBatchJobRes.mdx | 166 +- .../types/medusa.AdminBearerAuthRes.mdx | 12 +- .../types/medusa.AdminCollectionsRes.mdx | 85 +- .../types/medusa.AdminCurrenciesRes.mdx | 59 +- .../types/medusa.AdminCustomerGroupsRes.mdx | 85 +- .../medusa/types/medusa.AdminCustomersRes.mdx | 157 +- ...a.AdminDeleteProductsFromCollectionRes.mdx | 30 +- .../medusa.AdminDiscountConditionsRes.mdx | 139 +- .../medusa/types/medusa.AdminDiscountsRes.mdx | 175 +- .../types/medusa.AdminDraftOrdersRes.mdx | 139 +- .../types/medusa.AdminExtendedStoresRes.mdx | 175 +- ...sa.AdminGetVariantsVariantInventoryRes.mdx | 40 +- .../medusa/types/medusa.AdminGiftCardsRes.mdx | 148 +- ...a.AdminInventoryItemsLocationLevelsRes.mdx | 31 +- .../types/medusa.AdminInventoryItemsRes.mdx | 175 +- .../types/medusa.AdminListInvitesRes.mdx | 103 +- .../medusa/types/medusa.AdminNotesRes.mdx | 103 +- .../types/medusa.AdminNotificationsRes.mdx | 148 +- ...dusa.AdminOrderEditItemChangeDeleteRes.mdx | 30 +- .../types/medusa.AdminOrderEditsRes.mdx | 274 +- .../medusa/types/medusa.AdminOrdersRes.mdx | 526 +- ...medusa.AdminPaymentCollectionDeleteRes.mdx | 30 +- .../medusa.AdminPaymentCollectionsRes.mdx | 168 +- .../medusa.AdminPaymentProvidersList.mdx | 31 +- .../medusa/types/medusa.AdminPaymentRes.mdx | 184 +- ...raftOrdersDraftOrderRegisterPaymentRes.mdx | 526 +- .../medusa.AdminPriceListDeleteBatchRes.mdx | 30 +- .../medusa/types/medusa.AdminPriceListRes.mdx | 131 +- ...dusa.AdminProductCategoriesCategoryRes.mdx | 157 +- .../medusa.AdminProductsDeleteOptionRes.mdx | 356 +- .../types/medusa.AdminProductsDeleteRes.mdx | 30 +- .../medusa.AdminProductsDeleteVariantRes.mdx | 356 +- .../types/medusa.AdminProductsListTagsRes.mdx | 22 +- .../medusa.AdminProductsListTypesRes.mdx | 67 +- .../medusa/types/medusa.AdminProductsRes.mdx | 329 +- ...PublishableApiKeysListSalesChannelsRes.mdx | 94 +- .../medusa.AdminPublishableApiKeysRes.mdx | 76 +- .../medusa/types/medusa.AdminRefundRes.mdx | 121 +- .../medusa/types/medusa.AdminRegionsRes.mdx | 185 +- .../types/medusa.AdminReservationsRes.mdx | 112 +- .../medusa.AdminReturnReasonsListRes.mdx | 112 +- .../types/medusa.AdminReturnReasonsRes.mdx | 112 +- .../types/medusa.AdminReturnsCancelRes.mdx | 526 +- .../medusa/types/medusa.AdminReturnsRes.mdx | 184 +- .../types/medusa.AdminSalesChannelsRes.mdx | 94 +- .../types/medusa.AdminShippingOptionsRes.mdx | 185 +- .../medusa.AdminShippingProfilesListRes.mdx | 94 +- .../types/medusa.AdminShippingProfilesRes.mdx | 94 +- .../types/medusa.AdminStockLocationsRes.mdx | 22 +- .../medusa/types/medusa.AdminStoresRes.mdx | 139 +- .../medusa/types/medusa.AdminSwapsRes.mdx | 229 +- .../types/medusa.AdminTaxProvidersList.mdx | 31 +- .../medusa/types/medusa.AdminTaxRatesRes.mdx | 148 +- .../medusa.AdminUploadsDownloadUrlRes.mdx | 12 +- .../medusa/types/medusa.AdminUploadsRes.mdx | 31 +- .../medusa/types/medusa.AdminUserRes.mdx | 103 +- .../medusa/types/medusa.AdminUsersListRes.mdx | 103 +- .../medusa/types/medusa.AdminVariantsRes.mdx | 12 +- .../types/medusa.BatchJobResultError.mdx | 21 +- .../medusa.BatchJobResultStatDescriptor.mdx | 30 +- .../types/medusa.CartCompletionResponse.mdx | 21 +- .../medusa/types/medusa.ClassConstructor.mdx | 36 +- .../medusa/types/medusa.ConfigModule-1.mdx | 175 +- .../medusa/types/medusa.Constructor-1.mdx | 24 +- .../medusa/types/medusa.Constructor.mdx | 24 +- .../types/medusa.CreateBatchJobInput.mdx | 30 +- .../types/medusa.CreatePriceListInput.mdx | 187 +- .../medusa/types/medusa.DeleteFileType.mdx | 12 +- .../medusa/types/medusa.DeleteResponse-1.mdx | 30 +- .../types/medusa.DiscountAllocation.mdx | 21 +- .../types/medusa.ExtendedFindConfig.mdx | 12 +- .../medusa/types/medusa.ExtendedRequest.mdx | 12 +- .../medusa.ExternalModuleDeclaration.mdx | 176 +- ...edusa.FileServiceGetUploadStreamResult.mdx | 39 +- .../types/medusa.FileServiceUploadResult.mdx | 21 +- .../types/medusa.GetUploadedFileType.mdx | 21 +- .../types/medusa.GiftCardAllocation.mdx | 21 +- .../types/medusa.HttpCompressionOptions.mdx | 39 +- .../medusa/types/medusa.InnerSelector.mdx | 12 +- .../medusa.InternalModuleDeclaration.mdx | 185 +- .../medusa/types/medusa.InventoryItemDTO.mdx | 165 +- .../medusa/types/medusa.InventoryLevelDTO.mdx | 93 +- .../types/medusa.ItemTaxCalculationLine.mdx | 438 +- .../types/medusa.JoinerRelationship.mdx | 75 +- .../references/medusa/types/medusa.Logger.mdx | 120 +- .../medusa.MedusaErrorHandlerFunction.mdx | 142 +- .../types/medusa.MedusaRequestHandler.mdx | 133 +- .../medusa/types/medusa.MiddlewareRoute.mdx | 39 +- .../medusa/types/medusa.MiddlewaresConfig.mdx | 58 +- .../medusa/types/medusa.ModuleDefinition.mdx | 93 +- .../types/medusa.PaginatedResponse-1.mdx | 30 +- .../medusa/types/medusa.PartialPick.mdx | 21 +- .../medusa/types/medusa.PaymentContext.mdx | 257 +- .../types/medusa.PaymentSessionResponse.mdx | 31 +- .../types/medusa.PriceListLoadConfig.mdx | 48 +- .../medusa.PriceListPriceCreateInput.mdx | 57 +- .../medusa.PriceListPriceUpdateInput.mdx | 66 +- .../types/medusa.PriceSelectionContext.mdx | 103 +- .../types/medusa.PriceSelectionResult.mdx | 230 +- .../types/medusa.ProjectConfigOptions.mdx | 240 +- .../types/medusa.ProviderLineItemTaxLine.mdx | 48 +- .../medusa.ProviderShippingMethodTaxLine.mdx | 48 +- .../medusa/types/medusa.QueryConfig.mdx | 69 +- .../medusa/types/medusa.QuerySelector.mdx | 12 +- .../medusa/types/medusa.RequestContext.mdx | 12 +- .../types/medusa.ReservationItemDTO.mdx | 102 +- .../medusa/types/medusa.ReturnedData.mdx | 30 +- .../medusa/types/medusa.ScheduledJobArgs.mdx | 61 +- .../types/medusa.ScheduledJobConfig.mdx | 42 +- .../medusa/types/medusa.Selector.mdx | 12 +- .../medusa/types/medusa.SessionOptions.mdx | 57 +- .../types/medusa.ShippingOptionPricing.mdx | 30 +- .../medusa.ShippingTaxCalculationLine.mdx | 231 +- .../types/medusa.StockLocationAddressDTO.mdx | 120 +- .../medusa/types/medusa.StockLocationDTO.mdx | 193 +- .../medusa/types/medusa.StoreAuthRes.mdx | 157 +- .../types/medusa.StoreBearerAuthRes.mdx | 12 +- ...medusa.StoreCartShippingOptionsListRes.mdx | 12 +- .../medusa/types/medusa.StoreCartsRes.mdx | 373 +- .../types/medusa.StoreCollectionsRes.mdx | 85 +- ...sa.StoreCustomersListPaymentMethodsRes.mdx | 31 +- .../medusa/types/medusa.StoreCustomersRes.mdx | 148 +- .../medusa.StoreCustomersResetPasswordRes.mdx | 148 +- .../types/medusa.StoreGetAuthEmailRes.mdx | 12 +- ...a.StoreGetProductCategoriesCategoryRes.mdx | 157 +- .../medusa/types/medusa.StoreGiftCardsRes.mdx | 148 +- .../types/medusa.StoreOrderEditsRes.mdx | 238 +- .../medusa/types/medusa.StoreOrdersRes.mdx | 526 +- .../medusa.StorePaymentCollectionsRes.mdx | 166 +- ...dusa.StorePaymentCollectionsSessionRes.mdx | 132 +- .../medusa/types/medusa.StoreProductsRes.mdx | 22 +- .../medusa/types/medusa.StoreRegionsRes.mdx | 185 +- .../medusa.StoreReturnReasonsListRes.mdx | 112 +- .../types/medusa.StoreReturnReasonsRes.mdx | 112 +- .../medusa/types/medusa.StoreReturnsRes.mdx | 184 +- .../medusa.StoreShippingOptionsListRes.mdx | 12 +- .../medusa/types/medusa.StoreSwapsRes.mdx | 229 +- .../types/medusa.StoreVariantsListRes.mdx | 12 +- .../medusa/types/medusa.StoreVariantsRes.mdx | 12 +- .../medusa/types/medusa.SubscriberArgs.mdx | 70 +- .../medusa/types/medusa.SubscriberConfig.mdx | 31 +- .../types/medusa.TaxCalculationContext.mdx | 557 +- .../medusa/types/medusa.TaxServiceRate.mdx | 30 +- .../medusa/types/medusa.TaxedPricing.mdx | 48 +- .../medusa/types/medusa.TreeQuerySelector.mdx | 12 +- .../medusa.UploadStreamDescriptorType.mdx | 30 +- .../medusa/types/medusa.VariantInventory.mdx | 58 +- .../types/medusa.WithRequiredProperty.mdx | 21 +- .../medusa/types/medusa.Writable.mdx | 12 +- .../medusa/types/medusa.handler.mdx | 33 +- .../medusa/types/medusa.payload.mdx | 30 +- .../Admin/medusa_react.Hooks.Admin.Auth.mdx | 124 + .../medusa_react.Hooks.Admin.Batch_Jobs.mdx | 264 + .../Admin/medusa_react.Hooks.Admin.Claims.mdx | 309 + .../medusa_react.Hooks.Admin.Currencies.mdx | 145 + .../Admin/medusa_react.Hooks.Admin.Custom.mdx | 181 + ...dusa_react.Hooks.Admin.Customer_Groups.mdx | 462 + .../medusa_react.Hooks.Admin.Customers.mdx | 231 + .../medusa_react.Hooks.Admin.Discounts.mdx | 899 + .../medusa_react.Hooks.Admin.Draft_Orders.mdx | 466 + .../medusa_react.Hooks.Admin.Gift_Cards.mdx | 272 + ...dusa_react.Hooks.Admin.Inventory_Items.mdx | 474 + .../medusa_react.Hooks.Admin.Invites.mdx | 182 + .../Admin/medusa_react.Hooks.Admin.Notes.mdx | 257 + ...medusa_react.Hooks.Admin.Notifications.mdx | 180 + .../medusa_react.Hooks.Admin.Order_Edits.mdx | 675 + .../Admin/medusa_react.Hooks.Admin.Orders.mdx | 706 + ..._react.Hooks.Admin.Payment_Collections.mdx | 196 + .../medusa_react.Hooks.Admin.Payments.mdx | 157 + .../medusa_react.Hooks.Admin.Price_Lists.mdx | 712 + ...a_react.Hooks.Admin.Product_Categories.mdx | 480 + ..._react.Hooks.Admin.Product_Collections.mdx | 349 + .../medusa_react.Hooks.Admin.Product_Tags.mdx | 105 + ...medusa_react.Hooks.Admin.Product_Types.mdx | 105 + ...usa_react.Hooks.Admin.Product_Variants.mdx | 246 + .../medusa_react.Hooks.Admin.Products.mdx | 680 + ...react.Hooks.Admin.Publishable_API_Keys.mdx | 511 + .../medusa_react.Hooks.Admin.Regions.mdx | 640 + .../medusa_react.Hooks.Admin.Reservations.mdx | 314 + ...edusa_react.Hooks.Admin.Return_Reasons.mdx | 234 + .../medusa_react.Hooks.Admin.Returns.mdx | 157 + ...edusa_react.Hooks.Admin.Sales_Channels.mdx | 511 + ...usa_react.Hooks.Admin.Shipping_Options.mdx | 260 + ...sa_react.Hooks.Admin.Shipping_Profiles.mdx | 244 + ...dusa_react.Hooks.Admin.Stock_Locations.mdx | 318 + .../Admin/medusa_react.Hooks.Admin.Stores.mdx | 246 + .../Admin/medusa_react.Hooks.Admin.Swaps.mdx | 447 + .../medusa_react.Hooks.Admin.Tax_Rates.mdx | 634 + .../medusa_react.Hooks.Admin.Uploads.mdx | 166 + .../Admin/medusa_react.Hooks.Admin.Users.mdx | 304 + .../Store/medusa_react.Hooks.Store.Carts.mdx | 524 + .../medusa_react.Hooks.Store.Customers.mdx | 182 + .../medusa_react.Hooks.Store.Gift_Cards.mdx | 55 + .../medusa_react.Hooks.Store.Line_Items.mdx | 160 + .../medusa_react.Hooks.Store.Order_Edits.mdx | 154 + .../Store/medusa_react.Hooks.Store.Orders.mdx | 227 + ..._react.Hooks.Store.Payment_Collections.mdx | 361 + ...a_react.Hooks.Store.Product_Categories.mdx | 259 + ..._react.Hooks.Store.Product_Collections.mdx | 132 + .../medusa_react.Hooks.Store.Product_Tags.mdx | 103 + ...medusa_react.Hooks.Store.Product_Types.mdx | 103 + .../medusa_react.Hooks.Store.Products.mdx | 170 + .../medusa_react.Hooks.Store.Regions.mdx | 91 + ...edusa_react.Hooks.Store.Return_Reasons.mdx | 94 + .../medusa_react.Hooks.Store.Returns.mdx | 69 + ...usa_react.Hooks.Store.Shipping_Options.mdx | 110 + .../Store/medusa_react.Hooks.Store.Swaps.mdx | 125 + .../Hooks/medusa_react.Hooks.Admin.mdx | 49 + .../Hooks/medusa_react.Hooks.Store.mdx | 27 + .../Providers/medusa_react.Providers.Cart.mdx | 112 + .../medusa_react.Providers.Medusa.mdx | 93 + .../medusa_react.Providers.Session_Cart.mdx | 81 + .../medusa_react.Utilities.computeAmount.mdx | 40 + ...sa_react.Utilities.computeVariantPrice.mdx | 50 + .../medusa_react.Utilities.formatAmount.mdx | 51 + ...usa_react.Utilities.formatVariantPrice.mdx | 49 + ...medusa_react.Utilities.getVariantPrice.mdx | 50 + .../interfaces/medusa_react.CartContext.mdx | 13 + .../interfaces/medusa_react.CartProps.mdx | 11 + ...medusa_react.ComputeVariantPriceParams.mdx | 13 + .../medusa_react.FormatVariantPriceParams.mdx | 13 + .../interfaces/medusa_react.Item.mdx | 13 + .../medusa_react.MedusaContextState.mdx | 11 + .../medusa_react.MedusaProviderProps.mdx | 11 + .../medusa_react.SessionCartContextState.mdx | 11 + .../medusa_react.SessionCartProviderProps.mdx | 11 + .../medusa_react.SessionCartState.mdx | 11 + .../medusa_react/medusa_react.Hooks.mdx | 13 + .../medusa_react/medusa_react.Providers.mdx | 22 + .../medusa_react/medusa_react.Utilities.mdx | 18 + ...a_react.AdminCancelClaimFulfillmentReq.mdx | 15 + ...sa_react.AdminCancelSwapFulfillmentReq.mdx | 15 + ...edusa_react.AdminCreateSwapShipmentReq.mdx | 9 + ...react.AdminDraftOrderUpdateLineItemReq.mdx | 11 + .../medusa_react.AdminFulfillSwapReq.mdx | 9 + .../medusa_react.AdminUpdateClaimReq.mdx | 9 + ...dusa_react.AdminUpdateLocationLevelReq.mdx | 9 + ...dusa_react.AdminUpdateProductOptionReq.mdx | 9 + .../medusa_react.AdminUpdateVariantReq.mdx | 9 + .../medusa_react.ComputeAmountParams.mdx | 15 + .../types/medusa_react.CreateCartReq.mdx | 11 + ...react.DeletePaymentSessionMutationData.mdx | 15 + .../types/medusa_react.FormatAmountParams.mdx | 15 + .../types/medusa_react.ProductVariantInfo.mdx | 9 + ...eact.RefreshPaymentSessionMutationData.mdx | 15 + .../types/medusa_react.RegionInfo.mdx | 9 + .../types/medusa_react.UpdateLineItemReq.mdx | 9 + .../types/medusa_react.UpdateMeReq.mdx | 9 + .../content/references/modules/medusa.mdx | 14899 +- .../references/modules/medusa_react.mdx | 47 + .../content/references/modules/payment.mdx | 48 +- .../content/references/modules/pricing.mdx | 1 + .../docs/content/references/modules/types.mdx | 25 +- .../payment.AbstractPaymentProcessor.mdx | 553 +- .../interfaces/payment.PaymentProcessor.mdx | 513 +- .../payment.PaymentProcessorContext.mdx | 220 +- .../payment.PaymentProcessorError.mdx | 30 +- ...ayment.PaymentProcessorSessionResponse.mdx | 40 +- ...ricingModuleService.addPriceListPrices.mdx | 47 + ...ricing.IPricingModuleService.addPrices.mdx | 180 + ...pricing.IPricingModuleService.addRules.mdx | 80 + ....IPricingModuleService.calculatePrices.mdx | 94 + .../pricing.IPricingModuleService.create.mdx | 195 + ...IPricingModuleService.createCurrencies.mdx | 47 + ...ricingModuleService.createMoneyAmounts.mdx | 51 + ...cingModuleService.createPriceListRules.mdx | 43 + ...IPricingModuleService.createPriceLists.mdx | 45 + ...IPricingModuleService.createPriceRules.mdx | 56 + ...Service.createPriceSetMoneyAmountRules.mdx | 47 + ....IPricingModuleService.createRuleTypes.mdx | 45 + .../pricing.IPricingModuleService.delete.mdx | 38 + ...IPricingModuleService.deleteCurrencies.mdx | 39 + ...ricingModuleService.deleteMoneyAmounts.mdx | 40 + ...cingModuleService.deletePriceListRules.mdx | 38 + ...IPricingModuleService.deletePriceLists.mdx | 38 + ...IPricingModuleService.deletePriceRules.mdx | 40 + ...Service.deletePriceSetMoneyAmountRules.mdx | 38 + ....IPricingModuleService.deleteRuleTypes.mdx | 38 + .../pricing.IPricingModuleService.list.mdx | 128 + ...ing.IPricingModuleService.listAndCount.mdx | 128 + ...ngModuleService.listAndCountCurrencies.mdx | 94 + ...ModuleService.listAndCountMoneyAmounts.mdx | 126 + ...duleService.listAndCountPriceListRules.mdx | 126 + ...ngModuleService.listAndCountPriceLists.mdx | 126 + ...ngModuleService.listAndCountPriceRules.mdx | 115 + ...e.listAndCountPriceSetMoneyAmountRules.mdx | 116 + ...rvice.listAndCountPriceSetMoneyAmounts.mdx | 116 + ...ingModuleService.listAndCountRuleTypes.mdx | 121 + ...g.IPricingModuleService.listCurrencies.mdx | 94 + ...IPricingModuleService.listMoneyAmounts.mdx | 126 + ...ricingModuleService.listPriceListRules.mdx | 126 + ...g.IPricingModuleService.listPriceLists.mdx | 126 + ...g.IPricingModuleService.listPriceRules.mdx | 115 + ...leService.listPriceSetMoneyAmountRules.mdx | 115 + ...ModuleService.listPriceSetMoneyAmounts.mdx | 115 + ...ng.IPricingModuleService.listRuleTypes.mdx | 121 + ...cingModuleService.removePriceListRules.mdx | 43 + ...cing.IPricingModuleService.removeRules.mdx | 43 + ...pricing.IPricingModuleService.retrieve.mdx | 65 + ...IPricingModuleService.retrieveCurrency.mdx | 65 + ...icingModuleService.retrieveMoneyAmount.mdx | 65 + ...PricingModuleService.retrievePriceList.mdx | 65 + ...ingModuleService.retrievePriceListRule.mdx | 65 + ...PricingModuleService.retrievePriceRule.mdx | 60 + ...rvice.retrievePriceSetMoneyAmountRules.mdx | 60 + ...IPricingModuleService.retrieveRuleType.mdx | 60 + ...PricingModuleService.setPriceListRules.mdx | 45 + ...IPricingModuleService.updateCurrencies.mdx | 45 + ...ricingModuleService.updateMoneyAmounts.mdx | 45 + ...cingModuleService.updatePriceListRules.mdx | 44 + ...IPricingModuleService.updatePriceLists.mdx | 46 + ...IPricingModuleService.updatePriceRules.mdx | 48 + ...Service.updatePriceSetMoneyAmountRules.mdx | 45 + ....IPricingModuleService.updateRuleTypes.mdx | 45 + .../pricing.AddPriceListPricesDTO.mdx | 122 +- .../interfaces/pricing.AddPricesDTO.mdx | 122 +- .../interfaces/pricing.AddRulesDTO.mdx | 31 +- .../interfaces/pricing.BaseFilterable.mdx | 33 +- .../interfaces/pricing.CalculatedPriceSet.mdx | 257 +- .../pricing/interfaces/pricing.Context.mdx | 60 +- .../interfaces/pricing.CreateCurrencyDTO.mdx | 39 +- .../pricing.CreateMoneyAmountDTO.mdx | 94 +- .../interfaces/pricing.CreatePriceListDTO.mdx | 223 +- .../pricing.CreatePriceListRuleDTO.mdx | 39 +- .../interfaces/pricing.CreatePriceRuleDTO.mdx | 57 +- .../interfaces/pricing.CreatePriceSetDTO.mdx | 132 +- ...cing.CreatePriceSetMoneyAmountRulesDTO.mdx | 30 +- .../pricing.CreatePriceSetPriceRules.mdx | 12 + .../interfaces/pricing.CreatePricesDTO.mdx | 103 +- .../interfaces/pricing.CreateRuleTypeDTO.mdx | 39 +- .../interfaces/pricing.CurrencyDTO.mdx | 39 +- .../pricing.FilterableCurrencyProps.mdx | 30 +- .../pricing.FilterableMoneyAmountProps.mdx | 39 +- .../pricing.FilterablePriceListProps.mdx | 85 +- .../pricing.FilterablePriceListRuleProps.mdx | 57 +- .../pricing.FilterablePriceRuleProps.mdx | 57 +- ...ing.FilterablePriceSetMoneyAmountProps.mdx | 48 +- ...ilterablePriceSetMoneyAmountRulesProps.mdx | 57 +- .../pricing.FilterablePriceSetProps.mdx | 76 +- .../pricing.FilterableRuleTypeProps.mdx | 48 +- .../pricing/interfaces/pricing.FindConfig.mdx | 69 +- .../pricing.IPricingModuleService.mdx | 112 +- .../pricing.JoinerServiceConfig.mdx | 231 +- .../pricing.JoinerServiceConfigAlias.mdx | 21 +- .../interfaces/pricing.MoneyAmountDTO.mdx | 441 +- .../interfaces/pricing.PriceListDTO.mdx | 1083 +- .../interfaces/pricing.PriceListPriceDTO.mdx | 103 +- .../interfaces/pricing.PriceListRuleDTO.mdx | 535 +- .../pricing.PriceListRuleValueDTO.mdx | 241 +- .../interfaces/pricing.PriceRuleDTO.mdx | 250 +- .../interfaces/pricing.PriceSetDTO.mdx | 232 +- .../pricing.PriceSetMoneyAmountDTO.mdx | 883 +- .../pricing.PriceSetMoneyAmountRulesDTO.mdx | 414 +- .../interfaces/pricing.PricingContext.mdx | 12 +- .../interfaces/pricing.PricingFilters.mdx | 12 +- .../pricing.RemovePriceListRulesDTO.mdx | 21 +- .../pricing.RemovePriceSetRulesDTO.mdx | 21 +- .../interfaces/pricing.RuleTypeDTO.mdx | 39 +- .../pricing.SetPriceListRulesDTO.mdx | 21 +- .../interfaces/pricing.UpdateCurrencyDTO.mdx | 39 +- .../pricing.UpdateMoneyAmountDTO.mdx | 48 +- .../interfaces/pricing.UpdatePriceListDTO.mdx | 85 +- .../pricing.UpdatePriceListRuleDTO.mdx | 48 +- .../interfaces/pricing.UpdatePriceRuleDTO.mdx | 66 +- .../interfaces/pricing.UpdatePriceSetDTO.mdx | 12 +- ...cing.UpdatePriceSetMoneyAmountRulesDTO.mdx | 39 +- .../interfaces/pricing.UpdateRuleTypeDTO.mdx | 39 +- .../types/pricing.JoinerRelationship.mdx | 75 +- .../product.IProductModuleService.create.mdx | 44 + ...t.IProductModuleService.createCategory.mdx | 43 + ...ProductModuleService.createCollections.mdx | 44 + ...ct.IProductModuleService.createOptions.mdx | 45 + ...oduct.IProductModuleService.createTags.mdx | 44 + ...duct.IProductModuleService.createTypes.mdx | 44 + ...t.IProductModuleService.createVariants.mdx | 43 + .../product.IProductModuleService.delete.mdx | 38 + ...t.IProductModuleService.deleteCategory.mdx | 38 + ...ProductModuleService.deleteCollections.mdx | 38 + ...ct.IProductModuleService.deleteOptions.mdx | 38 + ...oduct.IProductModuleService.deleteTags.mdx | 39 + ...duct.IProductModuleService.deleteTypes.mdx | 38 + ...t.IProductModuleService.deleteVariants.mdx | 38 + .../product.IProductModuleService.list.mdx | 115 + ...uct.IProductModuleService.listAndCount.mdx | 115 + ...ctModuleService.listAndCountCategories.mdx | 115 + ...tModuleService.listAndCountCollections.mdx | 115 + ...oductModuleService.listAndCountOptions.mdx | 115 + ...IProductModuleService.listAndCountTags.mdx | 115 + ...ProductModuleService.listAndCountTypes.mdx | 115 + ...ductModuleService.listAndCountVariants.mdx | 115 + ...t.IProductModuleService.listCategories.mdx | 115 + ....IProductModuleService.listCollections.mdx | 115 + ...duct.IProductModuleService.listOptions.mdx | 115 + ...product.IProductModuleService.listTags.mdx | 115 + ...roduct.IProductModuleService.listTypes.mdx | 115 + ...uct.IProductModuleService.listVariants.mdx | 115 + .../product.IProductModuleService.restore.mdx | 42 + ....IProductModuleService.restoreVariants.mdx | 39 + ...product.IProductModuleService.retrieve.mdx | 60 + ...IProductModuleService.retrieveCategory.mdx | 60 + ...roductModuleService.retrieveCollection.mdx | 60 + ...t.IProductModuleService.retrieveOption.mdx | 60 + ...duct.IProductModuleService.retrieveTag.mdx | 60 + ...uct.IProductModuleService.retrieveType.mdx | 60 + ....IProductModuleService.retrieveVariant.mdx | 60 + ...oduct.IProductModuleService.softDelete.mdx | 42 + .../product.IProductModuleService.update.mdx | 45 + ...t.IProductModuleService.updateCategory.mdx | 42 + ...ProductModuleService.updateCollections.mdx | 45 + ...ct.IProductModuleService.updateOptions.mdx | 45 + ...oduct.IProductModuleService.updateTags.mdx | 45 + ...duct.IProductModuleService.updateTypes.mdx | 45 + ...t.IProductModuleService.updateVariants.mdx | 43 + .../interfaces/product.BaseFilterable.mdx | 33 +- .../product/interfaces/product.Context.mdx | 60 +- .../product.CreateProductCategoryDTO.mdx | 66 +- .../product.CreateProductCollectionDTO.mdx | 39 +- .../interfaces/product.CreateProductDTO.mdx | 523 +- .../product.CreateProductOptionDTO.mdx | 21 +- .../product.CreateProductTagDTO.mdx | 12 +- .../product.CreateProductTypeDTO.mdx | 30 +- .../product.CreateProductVariantDTO.mdx | 193 +- .../product.CreateProductVariantOptionDTO.mdx | 21 +- ...product.FilterableProductCategoryProps.mdx | 84 +- ...oduct.FilterableProductCollectionProps.mdx | 48 +- .../product.FilterableProductOptionProps.mdx | 48 +- .../product.FilterableProductProps.mdx | 158 +- .../product.FilterableProductTagProps.mdx | 39 +- .../product.FilterableProductTypeProps.mdx | 39 +- .../product.FilterableProductVariantProps.mdx | 76 +- .../product/interfaces/product.FindConfig.mdx | 69 +- .../product.IProductModuleService.mdx | 90 +- .../product.JoinerServiceConfig.mdx | 231 +- .../product.JoinerServiceConfigAlias.mdx | 21 +- .../interfaces/product.ProductCategoryDTO.mdx | 702 +- .../product.ProductCollectionDTO.mdx | 803 +- .../product/interfaces/product.ProductDTO.mdx | 1906 +- .../interfaces/product.ProductImageDTO.mdx | 39 +- .../interfaces/product.ProductOptionDTO.mdx | 1139 +- .../product.ProductOptionValueDTO.mdx | 972 +- .../interfaces/product.ProductTagDTO.mdx | 785 +- .../interfaces/product.ProductTypeDTO.mdx | 39 +- .../interfaces/product.ProductVariantDTO.mdx | 1310 +- .../interfaces/product.RestoreReturn.mdx | 24 +- .../interfaces/product.SoftDeleteReturn.mdx | 24 +- .../product.UpdateProductCategoryDTO.mdx | 66 +- .../product.UpdateProductCollectionDTO.mdx | 57 +- .../interfaces/product.UpdateProductDTO.mdx | 341 +- .../product.UpdateProductOptionDTO.mdx | 30 +- .../product.UpdateProductTagDTO.mdx | 21 +- .../product.UpdateProductTypeDTO.mdx | 30 +- .../product.UpdateProductVariantDTO.mdx | 193 +- .../types/product.JoinerRelationship.mdx | 75 +- .../product/types/product.OperatorMap.mdx | 174 +- .../services.AnalyticsConfigService.mdx | 315 +- .../services/classes/services.AuthService.mdx | 324 +- .../classes/services.BatchJobService.mdx | 642 +- .../services/classes/services.CartService.mdx | 1902 +- .../classes/services.ClaimItemService.mdx | 387 +- .../classes/services.ClaimService.mdx | 771 +- .../classes/services.CurrencyService.mdx | 318 +- .../services.CustomShippingOptionService.mdx | 303 +- .../classes/services.CustomerGroupService.mdx | 489 +- .../classes/services.CustomerService.mdx | 825 +- .../services.DiscountConditionService.mdx | 339 +- .../classes/services.DiscountService.mdx | 999 +- .../classes/services.DraftOrderService.mdx | 546 +- .../classes/services.EventBusService.mdx | 492 +- .../services.FulfillmentProviderService.mdx | 558 +- .../classes/services.FulfillmentService.mdx | 495 +- .../classes/services.GiftCardService.mdx | 552 +- .../services.IdempotencyKeyService.mdx | 381 +- .../services.LineItemAdjustmentService.mdx | 456 +- .../classes/services.LineItemService.mdx | 822 +- .../classes/services.MiddlewareService.mdx | 270 +- .../classes/services.NewTotalsService.mdx | 1028 +- .../services/classes/services.NoteService.mdx | 435 +- .../classes/services.NotificationService.mdx | 549 +- .../classes/services.OauthService.mdx | 456 +- .../services.OrderEditItemChangeService.mdx | 360 +- .../classes/services.OrderEditService.mdx | 1011 +- .../classes/services.OrderService.mdx | 1637 +- .../services.PaymentCollectionService.mdx | 603 +- .../services.PaymentProviderService.mdx | 1182 +- .../classes/services.PaymentService.mdx | 456 +- .../classes/services.PriceListService.mdx | 795 +- .../classes/services.PricingService.mdx | 795 +- .../services.ProductCategoryService.mdx | 702 +- .../services.ProductCollectionService.mdx | 561 +- .../classes/services.ProductService.mdx | 1076 +- .../classes/services.ProductTypeService.mdx | 291 +- ...ervices.ProductVariantInventoryService.mdx | 882 +- .../services.ProductVariantService.mdx | 1068 +- .../classes/services.RegionService.mdx | 879 +- .../classes/services.ReturnReasonService.mdx | 339 +- .../classes/services.ReturnService.mdx | 714 +- .../services.SalesChannelInventoryService.mdx | 246 +- .../services.SalesChannelLocationService.mdx | 327 +- .../classes/services.SalesChannelService.mdx | 589 +- .../classes/services.SearchService.mdx | 336 +- .../services.ShippingOptionService.mdx | 780 +- .../services.ShippingProfileService.mdx | 660 +- .../classes/services.StagedJobService.mdx | 264 +- .../classes/services.StoreService.mdx | 342 +- .../services.StrategyResolverService.mdx | 216 +- .../services/classes/services.SwapService.mdx | 1005 +- .../services.SystemPaymentProviderService.mdx | 432 +- .../classes/services.TaxProviderService.mdx | 618 +- .../classes/services.TaxRateService.mdx | 681 +- .../classes/services.TokenService.mdx | 99 +- .../classes/services.TotalsService.mdx | 1032 +- .../services/classes/services.UserService.mdx | 567 +- ..._location.IStockLocationService.create.mdx | 31 + ..._location.IStockLocationService.delete.mdx | 27 + ...ck_location.IStockLocationService.list.mdx | 75 + ...ion.IStockLocationService.listAndCount.mdx | 75 + ...ocation.IStockLocationService.retrieve.mdx | 49 + ..._location.IStockLocationService.update.mdx | 31 + ..._location.FilterableStockLocationProps.mdx | 21 +- .../interfaces/stock_location.FindConfig.mdx | 69 +- .../stock_location.IStockLocationService.mdx | 12 +- .../stock_location.JoinerServiceConfig.mdx | 231 +- ...tock_location.JoinerServiceConfigAlias.mdx | 21 +- .../stock_location.SharedContext.mdx | 21 +- ...tock_location.StringComparisonOperator.mdx | 66 +- ...tock_location.CreateStockLocationInput.mdx | 39 +- .../stock_location.JoinerRelationship.mdx | 75 +- ...stock_location.StockLocationAddressDTO.mdx | 120 +- ...ock_location.StockLocationAddressInput.mdx | 75 +- .../types/stock_location.StockLocationDTO.mdx | 193 +- ...tock_location.UpdateStockLocationInput.mdx | 112 +- .../types.CacheTypes.ICacheService.mdx | 43 + ...types.CommonTypes.AddressCreatePayload.mdx | 7 + .../types.CommonTypes.AddressPayload.mdx | 7 + .../types.CommonTypes.BaseEntity.mdx | 7 + .../types.CommonTypes.CustomFindOptions.mdx | 11 + ...pes.CommonTypes.DateComparisonOperator.mdx | 7 + .../types.CommonTypes.EmptyQueryParams.mdx | 0 .../types.CommonTypes.FindConfig.mdx | 14 + ...types.CommonTypes.FindPaginationParams.mdx | 7 + .../types.CommonTypes.FindParams.mdx | 7 + ...ommonTypes.NumericalComparisonOperator.mdx | 7 + ...CommonTypes.RepositoryTransformOptions.mdx | 0 .../types.CommonTypes.SoftDeletableEntity.mdx | 7 + ...s.CommonTypes.StringComparisonOperator.mdx | 7 + .../types/types.CommonTypes.ConfigModule.mdx | 9 + .../types/types.CommonTypes.ContainerLike.mdx | 9 + .../types.CommonTypes.DeleteResponse.mdx | 11 + .../types.CommonTypes.ExtendedFindConfig.mdx | 12 +- ...pes.CommonTypes.HttpCompressionOptions.mdx | 9 + .../types.CommonTypes.MedusaContainer.mdx | 0 .../types.CommonTypes.PaginatedResponse.mdx | 9 + .../types/types.CommonTypes.PartialPick.mdx | 9 + ...types.CommonTypes.ProjectConfigOptions.mdx | 9 + .../types/types.CommonTypes.QueryConfig.mdx | 13 + .../types/types.CommonTypes.QuerySelector.mdx | 9 + .../types.CommonTypes.RequestQueryFields.mdx | 9 + .../types/types.CommonTypes.Selector.mdx | 12 +- .../types/types.CommonTypes.TotalField.mdx | 0 .../types.CommonTypes.TreeQuerySelector.mdx | 12 +- ...types.CommonTypes.WithRequiredProperty.mdx | 11 + .../types/types.CommonTypes.Writable.mdx | 12 +- .../types.CustomerTypes.CustomerDTO.mdx | 7 + .../interfaces/types.DAL.BaseFilterable.mdx | 13 + .../DAL/interfaces/types.DAL.OptionsQuery.mdx | 11 + .../types.DAL.RepositoryService.mdx | 153 + .../interfaces/types.DAL.RestoreReturn.mdx | 13 + .../interfaces/types.DAL.SoftDeleteReturn.mdx | 13 + .../types.DAL.TreeRepositoryService.mdx | 115 + .../DAL/types/types.DAL.EntityDateColumns.mdx | 0 .../DAL/types/types.DAL.FilterQuery.mdx | 21 +- .../types/DAL/types/types.DAL.FindOptions.mdx | 13 + ...pes.DAL.SoftDeletableEntityDateColumns.mdx | 0 ...s.EventBusTypes.IEventBusModuleService.mdx | 59 + .../types.EventBusTypes.IEventBusService.mdx | 55 + .../types/types.EventBusTypes.EmitData.mdx | 13 + .../types.EventBusTypes.EventHandler.mdx | 19 + .../types/types.EventBusTypes.Subscriber.mdx | 19 + .../types.EventBusTypes.SubscriberContext.mdx | 9 + ...pes.EventBusTypes.SubscriberDescriptor.mdx | 9 + .../types.FeatureFlagTypes.IFlagRouter.mdx | 7 + ....FeatureFlagTypes.FeatureFlagsResponse.mdx | 0 .../types.FeatureFlagTypes.FlagSettings.mdx | 9 + .../interfaces/types.LoggerTypes.Logger.mdx | 7 + ...s.ModulesSdkTypes.MODULE_RESOURCE_TYPE.mdx | 0 .../types.ModulesSdkTypes.MODULE_SCOPE.mdx | 0 ...dkTypes.ModuleServiceInitializeOptions.mdx | 7 + .../types.ModulesSdkTypes.Constructor.mdx | 15 + ...ulesSdkTypes.ExternalModuleDeclaration.mdx | 9 + ...ulesSdkTypes.InternalModuleDeclaration.mdx | 9 + ...s.ModulesSdkTypes.LinkModuleDefinition.mdx | 9 + .../types.ModulesSdkTypes.LoadedModule.mdx | 0 .../types.ModulesSdkTypes.LoaderOptions.mdx | 13 + .../types/types.ModulesSdkTypes.LogLevel.mdx | 0 .../types.ModulesSdkTypes.LoggerOptions.mdx | 0 .../types.ModulesSdkTypes.ModuleConfig.mdx | 5 + ...types.ModulesSdkTypes.ModuleDefinition.mdx | 9 + .../types.ModulesSdkTypes.ModuleExports.mdx | 9 + ...pes.ModulesSdkTypes.ModuleJoinerConfig.mdx | 5 + ...dulesSdkTypes.ModuleJoinerRelationship.mdx | 2 +- ...s.ModulesSdkTypes.ModuleLoaderFunction.mdx | 15 + ...types.ModulesSdkTypes.ModuleResolution.mdx | 9 + ...erviceInitializeCustomDataLayerOptions.mdx | 9 + .../types.ModulesSdkTypes.ModulesResponse.mdx | 0 ...es.ModulesSdkTypes.RemoteQueryFunction.mdx | 15 + .../types/types.RegionTypes.RegionDTO.mdx | 9 + ...ypes.SalesChannelTypes.SalesChannelDTO.mdx | 7 + ...esChannelTypes.SalesChannelLocationDTO.mdx | 7 + .../types.SearchTypes.ISearchService.mdx | 121 + .../types/types.SearchTypes.IndexSettings.mdx | 9 + ...ctionBaseTypes.ITransactionBaseService.mdx | 15 + ...artWorkflow.CreateCartWorkflowInputDTO.mdx | 7 + ...es.CartWorkflow.CreateLineItemInputDTO.mdx | 7 + ...pes.CommonWorkflow.WorkflowInputConfig.mdx | 7 + ...s.PriceListWorkflow.CreatePriceListDTO.mdx | 7 + ...ceListWorkflow.CreatePriceListPriceDTO.mdx | 7 + ...iceListWorkflow.CreatePriceListRuleDTO.mdx | 7 + ...istWorkflow.CreatePriceListWorkflowDTO.mdx | 7 + ...rkflow.CreatePriceListWorkflowInputDTO.mdx | 7 + ....RemovePriceListPricesWorkflowInputDTO.mdx | 7 + ...emovePriceListProductsWorkflowInputDTO.mdx | 7 + ...emovePriceListVariantsWorkflowInputDTO.mdx | 7 + ...rkflow.RemovePriceListWorkflowInputDTO.mdx | 7 + ...istWorkflow.UpdatePriceListWorkflowDTO.mdx | 7 + ...rkflow.UpdatePriceListWorkflowInputDTO.mdx | 7 + ...eListWorkflow.PriceListVariantPriceDTO.mdx | 0 .../types.WorkflowTypes.CartWorkflow.mdx | 8 + .../types.WorkflowTypes.CommonWorkflow.mdx | 7 + .../types.WorkflowTypes.PriceListWorkflow.mdx | 21 + .../types.AddPriceListPricesDTO.mdx | 122 +- .../types/interfaces/types.AddPricesDTO.mdx | 122 +- .../types/interfaces/types.AddRulesDTO.mdx | 31 +- .../types.BaseRepositoryService.mdx | 225 +- .../interfaces/types.CalculatedPriceSet.mdx | 257 +- .../types.CalculatedPriceSetDTO.mdx | 75 +- .../types/interfaces/types.Context.mdx | 60 +- .../interfaces/types.CreateCurrencyDTO.mdx | 39 +- .../interfaces/types.CreateMoneyAmountDTO.mdx | 94 +- .../interfaces/types.CreatePriceListDTO.mdx | 223 +- .../types.CreatePriceListRuleDTO.mdx | 39 +- .../types.CreatePriceListRuleValueDTO.mdx | 30 +- .../interfaces/types.CreatePriceRuleDTO.mdx | 57 +- .../interfaces/types.CreatePriceSetDTO.mdx | 132 +- .../types.CreatePriceSetMoneyAmountDTO.mdx | 39 +- ...ypes.CreatePriceSetMoneyAmountRulesDTO.mdx | 30 +- .../types.CreatePriceSetPriceRules.mdx | 8 + .../types.CreatePriceSetRuleTypeDTO.mdx | 187 +- .../interfaces/types.CreatePricesDTO.mdx | 103 +- .../interfaces/types.CreateRuleTypeDTO.mdx | 39 +- .../types/interfaces/types.CurrencyDTO.mdx | 39 +- .../types.FilterableCurrencyProps.mdx | 30 +- .../types.FilterableMoneyAmountProps.mdx | 39 +- .../types.FilterablePriceListProps.mdx | 85 +- .../types.FilterablePriceListRuleProps.mdx | 57 +- ...ypes.FilterablePriceListRuleValueProps.mdx | 48 +- .../types.FilterablePriceRuleProps.mdx | 57 +- ...pes.FilterablePriceSetMoneyAmountProps.mdx | 48 +- ...ilterablePriceSetMoneyAmountRulesProps.mdx | 57 +- .../types.FilterablePriceSetProps.mdx | 76 +- .../types.FilterablePriceSetRuleTypeProps.mdx | 48 +- .../types.FilterableRuleTypeProps.mdx | 48 +- .../types/interfaces/types.ILinkModule.mdx | 1032 +- .../types/interfaces/types.InputPrice.mdx | 57 +- .../types/interfaces/types.JoinerArgument.mdx | 21 +- .../interfaces/types.JoinerDirective.mdx | 21 +- .../interfaces/types.JoinerServiceConfig.mdx | 231 +- .../types.JoinerServiceConfigAlias.mdx | 21 +- .../types/interfaces/types.MoneyAmountDTO.mdx | 441 +- .../types/interfaces/types.PriceListDTO.mdx | 1083 +- .../interfaces/types.PriceListPriceDTO.mdx | 103 +- .../interfaces/types.PriceListRuleDTO.mdx | 535 +- .../types.PriceListRuleValueDTO.mdx | 241 +- .../types/interfaces/types.PriceRuleDTO.mdx | 250 +- .../types/interfaces/types.PriceSetDTO.mdx | 232 +- .../types.PriceSetMoneyAmountDTO.mdx | 883 +- .../types.PriceSetMoneyAmountRulesDTO.mdx | 414 +- .../interfaces/types.PriceSetRuleTypeDTO.mdx | 205 +- .../types/interfaces/types.PricingContext.mdx | 12 +- .../types/interfaces/types.PricingFilters.mdx | 12 +- .../types.ProductCategoryTransformOptions.mdx | 12 +- .../interfaces/types.RemoteExpandProperty.mdx | 397 +- .../interfaces/types.RemoteJoinerQuery.mdx | 132 +- .../types.RemovePriceListRulesDTO.mdx | 21 +- .../types.RemovePriceSetRulesDTO.mdx | 21 +- .../types/interfaces/types.RuleTypeDTO.mdx | 39 +- .../interfaces/types.SetPriceListRulesDTO.mdx | 21 +- .../types/interfaces/types.SharedContext.mdx | 21 +- .../interfaces/types.UpdateCurrencyDTO.mdx | 39 +- .../interfaces/types.UpdateMoneyAmountDTO.mdx | 48 +- .../interfaces/types.UpdatePriceListDTO.mdx | 85 +- .../types.UpdatePriceListRuleDTO.mdx | 48 +- .../types.UpdatePriceListRuleValueDTO.mdx | 30 +- .../interfaces/types.UpdatePriceRuleDTO.mdx | 66 +- .../interfaces/types.UpdatePriceSetDTO.mdx | 12 +- .../types.UpdatePriceSetMoneyAmountDTO.mdx | 333 +- ...ypes.UpdatePriceSetMoneyAmountRulesDTO.mdx | 39 +- .../types.UpdatePriceSetRuleTypeDTO.mdx | 30 +- .../interfaces/types.UpdateRuleTypeDTO.mdx | 39 +- .../types/modules/types.CommonTypes.mdx | 38 - .../references/types/modules/types.DAL.mdx | 19 - .../types/modules/types.EventBusTypes.mdx | 16 - .../types/modules/types.FeatureFlagTypes.mdx | 12 - .../types/modules/types.ModulesSdkTypes.mdx | 33 - .../types/modules/types.SalesChannelTypes.mdx | 8 - .../types/modules/types.SearchTypes.mdx | 11 - .../modules/types.TransactionBaseTypes.mdx | 7 - .../types/modules/types.WorkflowTypes.mdx | 9 - .../types/{modules => }/types.CacheTypes.mdx | 2 +- .../references/types/types.CommonTypes.mdx | 39 + .../references/types/types.CustomerTypes.mdx | 7 + .../content/references/types/types.DAL.mdx | 19 + .../references/types/types.EventBusTypes.mdx | 16 + .../types/types.FeatureFlagTypes.mdx | 12 + .../types/{modules => }/types.LoggerTypes.mdx | 2 +- .../types/types.ModulesSdkTypes.mdx | 33 + .../references/types/types.RegionTypes.mdx | 7 + .../types/types.SalesChannelTypes.mdx | 8 + .../references/types/types.SearchTypes.mdx | 11 + .../types/types.TransactionBaseTypes.mdx | 7 + .../references/types/types.WorkflowTypes.mdx | 9 + .../types/types/types.AddressDTO.mdx | 120 +- .../references/types/types/types.CartDTO.mdx | 228 +- .../types/types/types.DeleteFileType.mdx | 12 +- .../types/types/types.Dictionary.mdx | 12 +- .../types/types/types.ExpandScalar.mdx | 12 +- ...types.FileServiceGetUploadStreamResult.mdx | 39 +- .../types/types.FileServiceUploadResult.mdx | 21 +- .../types/types/types.FilterValue.mdx | 12 +- .../types/types/types.FilterValue2.mdx | 12 +- .../types/types/types.GetUploadedFileType.mdx | 21 +- .../types/types/types.JoinerRelationship.mdx | 75 +- .../types/types/types.ModuleDeclaration.mdx | 2 +- .../types/types/types.OperatorMap.mdx | 186 +- .../references/types/types/types.Order.mdx | 12 +- .../references/types/types/types.Primary.mdx | 12 +- .../references/types/types/types.Query.mdx | 14 +- .../types/types/types.ReadonlyPrimary.mdx | 12 +- .../types/types/types.SessionOptions.mdx | 57 +- .../types.UploadStreamDescriptorType.mdx | 30 +- .../classes/workflows.StepResponse.mdx | 63 +- .../functions/workflows.createStep.mdx | 72 +- .../functions/workflows.createWorkflow.mdx | 63 +- .../functions/workflows.parallelize.mdx | 36 +- .../functions/workflows.transform.mdx | 54 +- .../workflows.StepExecutionContext.mdx | 95 +- ...orkflows.CreateWorkflowComposerContext.mdx | 75 +- .../types/workflows.StepFunction.mdx | 21 +- .../types/workflows.StepFunctionResult.mdx | 109 +- .../types/workflows.WorkflowData.mdx | 12 +- .../workflows.WorkflowDataProperties.mdx | 33 +- www/apps/docs/docusaurus.config.js | 17 + www/apps/docs/package.json | 2 + www/apps/docs/sidebars.js | 108 +- .../src/components/ParameterTypes/index.tsx | 16 +- www/packages/docs-ui/package.json | 2 +- .../src/components/CodeBlock/index.tsx | 6 +- www/yarn.lock | 158 +- 2811 files changed, 220947 insertions(+), 444154 deletions(-) create mode 100644 .changeset/clean-timers-hunt.md create mode 100644 docs-util/packages/typedoc-config/extended-tsconfig/medusa-react.json create mode 100644 docs-util/packages/typedoc-config/medusa-react.js create mode 100644 docs-util/packages/typedoc-plugin-custom/src/generate-namespace.ts create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-hook-params.ts create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-mutation-params.ts create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-mutation-return.ts create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-query-return.ts create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-react-query-type.ts create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-hook-params.ts create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-mutation-params.ts create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-mutation-return.ts create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-query-return.ts create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.react-query.signature.hbs create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature-wrapper.hbs create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/format-parameter-component.ts create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/react-query-utils.ts rename docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/{return-reflection-formatter.ts => reflection-type-parameters.ts} (53%) create mode 100644 docs-util/typedoc-json-output/medusa-react.json create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_auth/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_auth/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_auth/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs_{id}_cancel/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs_{id}_confirm/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}_products_batch/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}_products_batch/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_currencies/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_currencies_{code}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}_customers/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}_customers_batch/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}_customers_batch/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_code_{code}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}_batch/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}_batch/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_dynamic-codes/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_dynamic-codes_{code}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_regions_{region_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_regions_{region_id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_line-items/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_line-items_{line_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_line-items_{line_id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_pay/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels_{location_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels_{location_id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_invites_accept/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_invites_{invite_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_invites_{invite_id}_resend/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_notifications/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_notifications_{id}_resend/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_cancel/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_changes_{change_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_confirm/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_items/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_items_{item_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_items_{item_id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_request/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_archive/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_cancel/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_capture/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_cancel/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_fulfillments/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_shipments/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_complete/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_fulfillment/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_refund/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_return/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_shipment/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_shipping-methods/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_cancel/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_fulfillments/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_process-payment/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_shipments/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}_authorize/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_payments_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_payments_{id}_capture/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_payments_{id}_refund/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_prices_batch/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_prices_batch/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_products/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_products_prices_batch/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_products_{product_id}_prices/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_variants_{variant_id}_prices/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}_products_batch/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}_products_batch/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-tags/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-types/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_products/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_products/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_tag-usage/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_options/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_options_{option_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_options_{option_id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_variants/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_variants_{variant_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_variants_{variant_id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_revoke/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels_batch/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels_batch/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_countries/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_countries_{country_code}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_fulfillment-options/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_fulfillment-providers/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_fulfillment-providers_{provider_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_payment-providers/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_payment-providers_{provider_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_returns/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_returns_{id}_cancel/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_returns_{id}_receive/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_products_batch/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_products_batch/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_stock-locations/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_stock-locations/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_store/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_store/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_currencies_{code}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_currencies_{code}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_payment-providers/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_tax-providers/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_swaps/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_swaps_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_product-types_batch/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_product-types_batch/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_products_batch/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_products_batch/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_shipping-options_batch/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_shipping-options_batch/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads_download-url/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads_protected/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_users/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_users/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_password-token/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_reset-password/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_{id}/deleteundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_{id}/postundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_variants/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_variants_{id}/getundefined create mode 100644 www/apps/api-reference/specs/admin/code_samples/tsx/admin_variants_{id}_inventory/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_complete/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_line-items/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_line-items_{line_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_line-items_{line_id}/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-session/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/deleteundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}_refresh/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_shipping-methods/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_collections/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_collections_{id}/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_customers/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_customers_me/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_customers_me/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_customers_me_orders/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_gift-cards_{code}/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_order-edits_{id}/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_order-edits_{id}_complete/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_order-edits_{id}_decline/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_orders/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_orders_batch_customer_token/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_orders_cart_{cart_id}/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_orders_customer_confirm/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_orders_{id}/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_batch/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_batch_authorize/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}_authorize/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_product-categories/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_product-categories_{id}/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_product-tags/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_product-types/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_products/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_products_{id}/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_regions/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_regions_{id}/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_return-reasons/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_return-reasons_{id}/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_returns/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_shipping-options/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_shipping-options_{cart_id}/getundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_swaps/postundefined create mode 100644 www/apps/api-reference/specs/store/code_samples/tsx/store_swaps_{cart_id}/getundefined delete mode 100644 www/apps/docs/content/references/CacheTypes/interfaces/types.CacheTypes.ICacheService.mdx delete mode 100644 www/apps/docs/content/references/CartWorkflow/interfaces/types.WorkflowTypes.CartWorkflow.CreateCartWorkflowInputDTO.mdx delete mode 100644 www/apps/docs/content/references/CartWorkflow/interfaces/types.WorkflowTypes.CartWorkflow.CreateLineItemInputDTO.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.AddressCreatePayload.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.AddressPayload.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.BaseEntity.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.CustomFindOptions.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.DateComparisonOperator.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.FindConfig.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.FindPaginationParams.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.FindParams.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.NumericalComparisonOperator.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.SoftDeletableEntity.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.StringComparisonOperator.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.ConfigModule.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.DeleteResponse.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.HttpCompressionOptions.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.PaginatedResponse.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.PartialPick.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.ProjectConfigOptions.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.QueryConfig.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.QuerySelector.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.RequestQueryFields.mdx delete mode 100644 www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.WithRequiredProperty.mdx delete mode 100644 www/apps/docs/content/references/CommonWorkflow/interfaces/types.WorkflowTypes.CommonWorkflow.WorkflowInputConfig.mdx delete mode 100644 www/apps/docs/content/references/DAL/interfaces/types.DAL.BaseFilterable.mdx delete mode 100644 www/apps/docs/content/references/DAL/interfaces/types.DAL.OptionsQuery.mdx delete mode 100644 www/apps/docs/content/references/DAL/interfaces/types.DAL.RepositoryService.mdx delete mode 100644 www/apps/docs/content/references/DAL/interfaces/types.DAL.RestoreReturn.mdx delete mode 100644 www/apps/docs/content/references/DAL/interfaces/types.DAL.SoftDeleteReturn.mdx delete mode 100644 www/apps/docs/content/references/DAL/interfaces/types.DAL.TreeRepositoryService.mdx delete mode 100644 www/apps/docs/content/references/DAL/types/types.DAL.FindOptions.mdx delete mode 100644 www/apps/docs/content/references/EventBusTypes/interfaces/types.EventBusTypes.IEventBusModuleService.mdx delete mode 100644 www/apps/docs/content/references/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService.mdx delete mode 100644 www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.EmitData.mdx delete mode 100644 www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.EventHandler.mdx delete mode 100644 www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.Subscriber.mdx delete mode 100644 www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.SubscriberContext.mdx delete mode 100644 www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.SubscriberDescriptor.mdx delete mode 100644 www/apps/docs/content/references/FeatureFlagTypes/interfaces/types.FeatureFlagTypes.IFlagRouter.mdx delete mode 100644 www/apps/docs/content/references/FeatureFlagTypes/types/types.FeatureFlagTypes.FlagSettings.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.adjustInventory.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.confirmInventory.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryItem.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryItems.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryLevel.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryLevels.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createReservationItem.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createReservationItems.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteInventoryItem.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteInventoryItemLevelByLocationId.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteInventoryLevel.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteReservationItem.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteReservationItemByLocationId.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteReservationItemsByLineItem.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.listInventoryItems.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.listInventoryLevels.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.listReservationItems.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.restoreInventoryItem.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveAvailableQuantity.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryItem.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryLevel.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveReservationItem.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveReservedQuantity.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveStockedQuantity.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateInventoryItem.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevel.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevels.mdx delete mode 100644 www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateReservationItem.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.create.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createCurrencies.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createMoneyAmounts.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceListRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSetMoneyAmountRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createRuleTypes.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.delete.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deleteCurrencies.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deleteMoneyAmounts.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSetMoneyAmountRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deleteRuleTypes.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.list.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCount.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountCurrencies.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountMoneyAmounts.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountRuleTypes.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listCurrencies.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listMoneyAmounts.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmountRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmounts.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listRuleTypes.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.removeRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieve.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveCurrency.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveMoneyAmount.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveRuleType.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updateCurrencies.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updateMoneyAmounts.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSetMoneyAmountRules.mdx delete mode 100644 www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updateRuleTypes.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.create.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createCategory.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createCollections.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createOptions.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createTags.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createTypes.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createVariants.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.delete.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteCategory.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteCollections.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteOptions.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteTags.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteTypes.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteVariants.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.list.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCount.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountCategories.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountCollections.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountOptions.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountTags.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountTypes.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountVariants.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listCategories.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listCollections.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listOptions.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listTags.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listTypes.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listVariants.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.restore.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.restoreVariants.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieve.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveCategory.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveCollection.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveOption.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveTag.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveType.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveVariant.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.softDelete.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.update.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateCategory.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateCollections.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateOptions.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateTags.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateTypes.mdx delete mode 100644 www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateVariants.mdx delete mode 100644 www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.create.mdx delete mode 100644 www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.delete.mdx delete mode 100644 www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.list.mdx delete mode 100644 www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.listAndCount.mdx delete mode 100644 www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.retrieve.mdx delete mode 100644 www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.update.mdx delete mode 100644 www/apps/docs/content/references/LoggerTypes/interfaces/types.LoggerTypes.Logger.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkModuleDefinition.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.LoaderOptions.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleConfig.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleLoaderFunction.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions.mdx delete mode 100644 www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction.mdx delete mode 100644 www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListDTO.mdx delete mode 100644 www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListPriceDTO.mdx delete mode 100644 www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListRuleDTO.mdx delete mode 100644 www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowDTO.mdx delete mode 100644 www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowInputDTO.mdx delete mode 100644 www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListPricesWorkflowInputDTO.mdx delete mode 100644 www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListProductsWorkflowInputDTO.mdx delete mode 100644 www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListVariantsWorkflowInputDTO.mdx delete mode 100644 www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListWorkflowInputDTO.mdx delete mode 100644 www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowDTO.mdx delete mode 100644 www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowInputDTO.mdx delete mode 100644 www/apps/docs/content/references/SalesChannelTypes/interfaces/types.SalesChannelTypes.SalesChannelDTO.mdx delete mode 100644 www/apps/docs/content/references/SalesChannelTypes/interfaces/types.SalesChannelTypes.SalesChannelLocationDTO.mdx delete mode 100644 www/apps/docs/content/references/SearchTypes/interfaces/types.SearchTypes.ISearchService.mdx delete mode 100644 www/apps/docs/content/references/SearchTypes/types/types.SearchTypes.IndexSettings.mdx delete mode 100644 www/apps/docs/content/references/TransactionBaseTypes/interfaces/types.TransactionBaseTypes.ITransactionBaseService.mdx delete mode 100644 www/apps/docs/content/references/WorkflowTypes/modules/types.WorkflowTypes.CartWorkflow.mdx delete mode 100644 www/apps/docs/content/references/WorkflowTypes/modules/types.WorkflowTypes.CommonWorkflow.mdx delete mode 100644 www/apps/docs/content/references/WorkflowTypes/modules/types.WorkflowTypes.PriceListWorkflow.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.adjustInventory.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.confirmInventory.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createInventoryItem.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createInventoryItems.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createInventoryLevel.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createInventoryLevels.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createReservationItem.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createReservationItems.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.deleteInventoryItem.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.deleteInventoryItemLevelByLocationId.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.deleteInventoryLevel.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.deleteReservationItem.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.deleteReservationItemByLocationId.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.deleteReservationItemsByLineItem.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.listInventoryItems.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.listInventoryLevels.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.listReservationItems.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.restoreInventoryItem.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveAvailableQuantity.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryItem.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryLevel.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveReservationItem.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveReservedQuantity.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveStockedQuantity.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateInventoryItem.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevel.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevels.mdx create mode 100644 www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateReservationItem.mdx rename www/apps/docs/content/references/medusa/{modules => }/medusa._medusa_interfaces_.mdx (100%) create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Auth.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Batch_Jobs.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Claims.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Currencies.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Custom.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Customer_Groups.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Customers.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Discounts.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Draft_Orders.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Gift_Cards.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Inventory_Items.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Invites.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Notes.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Notifications.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Order_Edits.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Orders.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Payment_Collections.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Payments.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Price_Lists.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Product_Categories.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Product_Collections.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Product_Tags.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Product_Types.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Product_Variants.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Products.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Publishable_API_Keys.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Regions.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Reservations.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Return_Reasons.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Returns.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Sales_Channels.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Shipping_Options.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Shipping_Profiles.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Stock_Locations.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Stores.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Swaps.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Tax_Rates.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Uploads.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Users.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Carts.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Customers.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Gift_Cards.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Line_Items.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Order_Edits.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Orders.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Payment_Collections.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Product_Categories.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Product_Collections.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Product_Tags.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Product_Types.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Products.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Regions.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Return_Reasons.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Returns.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Shipping_Options.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/Store/medusa_react.Hooks.Store.Swaps.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/medusa_react.Hooks.Admin.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Hooks/medusa_react.Hooks.Store.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Providers/medusa_react.Providers.Cart.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Providers/medusa_react.Providers.Medusa.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Providers/medusa_react.Providers.Session_Cart.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Utilities/functions/medusa_react.Utilities.computeAmount.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Utilities/functions/medusa_react.Utilities.computeVariantPrice.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Utilities/functions/medusa_react.Utilities.formatAmount.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Utilities/functions/medusa_react.Utilities.formatVariantPrice.mdx create mode 100644 www/apps/docs/content/references/medusa_react/Utilities/functions/medusa_react.Utilities.getVariantPrice.mdx create mode 100644 www/apps/docs/content/references/medusa_react/interfaces/medusa_react.CartContext.mdx create mode 100644 www/apps/docs/content/references/medusa_react/interfaces/medusa_react.CartProps.mdx create mode 100644 www/apps/docs/content/references/medusa_react/interfaces/medusa_react.ComputeVariantPriceParams.mdx create mode 100644 www/apps/docs/content/references/medusa_react/interfaces/medusa_react.FormatVariantPriceParams.mdx create mode 100644 www/apps/docs/content/references/medusa_react/interfaces/medusa_react.Item.mdx create mode 100644 www/apps/docs/content/references/medusa_react/interfaces/medusa_react.MedusaContextState.mdx create mode 100644 www/apps/docs/content/references/medusa_react/interfaces/medusa_react.MedusaProviderProps.mdx create mode 100644 www/apps/docs/content/references/medusa_react/interfaces/medusa_react.SessionCartContextState.mdx create mode 100644 www/apps/docs/content/references/medusa_react/interfaces/medusa_react.SessionCartProviderProps.mdx create mode 100644 www/apps/docs/content/references/medusa_react/interfaces/medusa_react.SessionCartState.mdx create mode 100644 www/apps/docs/content/references/medusa_react/medusa_react.Hooks.mdx create mode 100644 www/apps/docs/content/references/medusa_react/medusa_react.Providers.mdx create mode 100644 www/apps/docs/content/references/medusa_react/medusa_react.Utilities.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.AdminCancelClaimFulfillmentReq.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.AdminCancelSwapFulfillmentReq.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.AdminCreateSwapShipmentReq.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.AdminDraftOrderUpdateLineItemReq.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.AdminFulfillSwapReq.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.AdminUpdateClaimReq.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.AdminUpdateLocationLevelReq.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.AdminUpdateProductOptionReq.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.AdminUpdateVariantReq.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.ComputeAmountParams.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.CreateCartReq.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.DeletePaymentSessionMutationData.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.FormatAmountParams.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.ProductVariantInfo.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.RefreshPaymentSessionMutationData.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.RegionInfo.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.UpdateLineItemReq.mdx create mode 100644 www/apps/docs/content/references/medusa_react/types/medusa_react.UpdateMeReq.mdx create mode 100644 www/apps/docs/content/references/modules/medusa_react.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.addRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.create.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createCurrencies.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createMoneyAmounts.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSetMoneyAmountRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.createRuleTypes.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.delete.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deleteCurrencies.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deleteMoneyAmounts.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSetMoneyAmountRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.deleteRuleTypes.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.list.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCount.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountCurrencies.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountMoneyAmounts.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountRuleTypes.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listCurrencies.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listMoneyAmounts.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmountRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmounts.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.listRuleTypes.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.removeRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrieve.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveCurrency.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveMoneyAmount.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveRuleType.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updateCurrencies.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updateMoneyAmounts.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSetMoneyAmountRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updateRuleTypes.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/pricing.CreatePriceSetPriceRules.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.create.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.createCategory.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.createCollections.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.createOptions.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.createTags.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.createTypes.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.createVariants.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.delete.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.deleteCategory.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.deleteCollections.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.deleteOptions.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.deleteTags.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.deleteTypes.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.deleteVariants.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.list.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCount.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountCategories.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountCollections.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountOptions.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountTags.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountTypes.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listAndCountVariants.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listCategories.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listCollections.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listOptions.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listTags.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listTypes.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.listVariants.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.restore.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.restoreVariants.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.retrieve.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.retrieveCategory.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.retrieveCollection.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.retrieveOption.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.retrieveTag.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.retrieveType.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.retrieveVariant.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.softDelete.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.update.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.updateCategory.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.updateCollections.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.updateOptions.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.updateTags.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.updateTypes.mdx create mode 100644 www/apps/docs/content/references/product/IProductModuleService/methods/product.IProductModuleService.updateVariants.mdx create mode 100644 www/apps/docs/content/references/stock_location/IStockLocationService/methods/stock_location.IStockLocationService.create.mdx create mode 100644 www/apps/docs/content/references/stock_location/IStockLocationService/methods/stock_location.IStockLocationService.delete.mdx create mode 100644 www/apps/docs/content/references/stock_location/IStockLocationService/methods/stock_location.IStockLocationService.list.mdx create mode 100644 www/apps/docs/content/references/stock_location/IStockLocationService/methods/stock_location.IStockLocationService.listAndCount.mdx create mode 100644 www/apps/docs/content/references/stock_location/IStockLocationService/methods/stock_location.IStockLocationService.retrieve.mdx create mode 100644 www/apps/docs/content/references/stock_location/IStockLocationService/methods/stock_location.IStockLocationService.update.mdx create mode 100644 www/apps/docs/content/references/types/CacheTypes/interfaces/types.CacheTypes.ICacheService.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/interfaces/types.CommonTypes.AddressCreatePayload.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/interfaces/types.CommonTypes.AddressPayload.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/interfaces/types.CommonTypes.BaseEntity.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/interfaces/types.CommonTypes.CustomFindOptions.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/interfaces/types.CommonTypes.DateComparisonOperator.mdx rename www/apps/docs/content/references/{ => types}/CommonTypes/interfaces/types.CommonTypes.EmptyQueryParams.mdx (100%) create mode 100644 www/apps/docs/content/references/types/CommonTypes/interfaces/types.CommonTypes.FindConfig.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/interfaces/types.CommonTypes.FindPaginationParams.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/interfaces/types.CommonTypes.FindParams.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/interfaces/types.CommonTypes.NumericalComparisonOperator.mdx rename www/apps/docs/content/references/{ => types}/CommonTypes/interfaces/types.CommonTypes.RepositoryTransformOptions.mdx (100%) create mode 100644 www/apps/docs/content/references/types/CommonTypes/interfaces/types.CommonTypes.SoftDeletableEntity.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/interfaces/types.CommonTypes.StringComparisonOperator.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/types/types.CommonTypes.ConfigModule.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/types/types.CommonTypes.ContainerLike.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/types/types.CommonTypes.DeleteResponse.mdx rename www/apps/docs/content/references/{ => types}/CommonTypes/types/types.CommonTypes.ExtendedFindConfig.mdx (60%) create mode 100644 www/apps/docs/content/references/types/CommonTypes/types/types.CommonTypes.HttpCompressionOptions.mdx rename www/apps/docs/content/references/{ => types}/CommonTypes/types/types.CommonTypes.MedusaContainer.mdx (100%) create mode 100644 www/apps/docs/content/references/types/CommonTypes/types/types.CommonTypes.PaginatedResponse.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/types/types.CommonTypes.PartialPick.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/types/types.CommonTypes.ProjectConfigOptions.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/types/types.CommonTypes.QueryConfig.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/types/types.CommonTypes.QuerySelector.mdx create mode 100644 www/apps/docs/content/references/types/CommonTypes/types/types.CommonTypes.RequestQueryFields.mdx rename www/apps/docs/content/references/{ => types}/CommonTypes/types/types.CommonTypes.Selector.mdx (61%) rename www/apps/docs/content/references/{ => types}/CommonTypes/types/types.CommonTypes.TotalField.mdx (100%) rename www/apps/docs/content/references/{ => types}/CommonTypes/types/types.CommonTypes.TreeQuerySelector.mdx (50%) create mode 100644 www/apps/docs/content/references/types/CommonTypes/types/types.CommonTypes.WithRequiredProperty.mdx rename www/apps/docs/content/references/{ => types}/CommonTypes/types/types.CommonTypes.Writable.mdx (56%) create mode 100644 www/apps/docs/content/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerDTO.mdx create mode 100644 www/apps/docs/content/references/types/DAL/interfaces/types.DAL.BaseFilterable.mdx create mode 100644 www/apps/docs/content/references/types/DAL/interfaces/types.DAL.OptionsQuery.mdx create mode 100644 www/apps/docs/content/references/types/DAL/interfaces/types.DAL.RepositoryService.mdx create mode 100644 www/apps/docs/content/references/types/DAL/interfaces/types.DAL.RestoreReturn.mdx create mode 100644 www/apps/docs/content/references/types/DAL/interfaces/types.DAL.SoftDeleteReturn.mdx create mode 100644 www/apps/docs/content/references/types/DAL/interfaces/types.DAL.TreeRepositoryService.mdx rename www/apps/docs/content/references/{ => types}/DAL/types/types.DAL.EntityDateColumns.mdx (100%) rename www/apps/docs/content/references/{ => types}/DAL/types/types.DAL.FilterQuery.mdx (54%) create mode 100644 www/apps/docs/content/references/types/DAL/types/types.DAL.FindOptions.mdx rename www/apps/docs/content/references/{ => types}/DAL/types/types.DAL.SoftDeletableEntityDateColumns.mdx (100%) create mode 100644 www/apps/docs/content/references/types/EventBusTypes/interfaces/types.EventBusTypes.IEventBusModuleService.mdx create mode 100644 www/apps/docs/content/references/types/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService.mdx create mode 100644 www/apps/docs/content/references/types/EventBusTypes/types/types.EventBusTypes.EmitData.mdx create mode 100644 www/apps/docs/content/references/types/EventBusTypes/types/types.EventBusTypes.EventHandler.mdx create mode 100644 www/apps/docs/content/references/types/EventBusTypes/types/types.EventBusTypes.Subscriber.mdx create mode 100644 www/apps/docs/content/references/types/EventBusTypes/types/types.EventBusTypes.SubscriberContext.mdx create mode 100644 www/apps/docs/content/references/types/EventBusTypes/types/types.EventBusTypes.SubscriberDescriptor.mdx create mode 100644 www/apps/docs/content/references/types/FeatureFlagTypes/interfaces/types.FeatureFlagTypes.IFlagRouter.mdx rename www/apps/docs/content/references/{ => types}/FeatureFlagTypes/types/types.FeatureFlagTypes.FeatureFlagsResponse.mdx (100%) create mode 100644 www/apps/docs/content/references/types/FeatureFlagTypes/types/types.FeatureFlagTypes.FlagSettings.mdx create mode 100644 www/apps/docs/content/references/types/LoggerTypes/interfaces/types.LoggerTypes.Logger.mdx rename www/apps/docs/content/references/{ => types}/ModulesSdkTypes/enums/types.ModulesSdkTypes.MODULE_RESOURCE_TYPE.mdx (100%) rename www/apps/docs/content/references/{ => types}/ModulesSdkTypes/enums/types.ModulesSdkTypes.MODULE_SCOPE.mdx (100%) create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions.mdx create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor.mdx create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration.mdx create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration.mdx create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkModuleDefinition.mdx rename www/apps/docs/content/references/{ => types}/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule.mdx (100%) create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoaderOptions.mdx rename www/apps/docs/content/references/{ => types}/ModulesSdkTypes/types/types.ModulesSdkTypes.LogLevel.mdx (100%) rename www/apps/docs/content/references/{ => types}/ModulesSdkTypes/types/types.ModulesSdkTypes.LoggerOptions.mdx (100%) create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleConfig.mdx create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition.mdx create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports.mdx create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig.mdx rename www/apps/docs/content/references/{ => types}/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship.mdx (77%) create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleLoaderFunction.mdx create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution.mdx create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions.mdx rename www/apps/docs/content/references/{ => types}/ModulesSdkTypes/types/types.ModulesSdkTypes.ModulesResponse.mdx (100%) create mode 100644 www/apps/docs/content/references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction.mdx create mode 100644 www/apps/docs/content/references/types/RegionTypes/types/types.RegionTypes.RegionDTO.mdx create mode 100644 www/apps/docs/content/references/types/SalesChannelTypes/interfaces/types.SalesChannelTypes.SalesChannelDTO.mdx create mode 100644 www/apps/docs/content/references/types/SalesChannelTypes/interfaces/types.SalesChannelTypes.SalesChannelLocationDTO.mdx create mode 100644 www/apps/docs/content/references/types/SearchTypes/interfaces/types.SearchTypes.ISearchService.mdx create mode 100644 www/apps/docs/content/references/types/SearchTypes/types/types.SearchTypes.IndexSettings.mdx create mode 100644 www/apps/docs/content/references/types/TransactionBaseTypes/interfaces/types.TransactionBaseTypes.ITransactionBaseService.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/CartWorkflow/interfaces/types.WorkflowTypes.CartWorkflow.CreateCartWorkflowInputDTO.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/CartWorkflow/interfaces/types.WorkflowTypes.CartWorkflow.CreateLineItemInputDTO.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/CommonWorkflow/interfaces/types.WorkflowTypes.CommonWorkflow.WorkflowInputConfig.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListDTO.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListPriceDTO.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListRuleDTO.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowDTO.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowInputDTO.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListPricesWorkflowInputDTO.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListProductsWorkflowInputDTO.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListVariantsWorkflowInputDTO.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListWorkflowInputDTO.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowDTO.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowInputDTO.mdx rename www/apps/docs/content/references/{ => types/WorkflowTypes}/PriceListWorkflow/types/types.WorkflowTypes.PriceListWorkflow.PriceListVariantPriceDTO.mdx (100%) create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/types.WorkflowTypes.CartWorkflow.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/types.WorkflowTypes.CommonWorkflow.mdx create mode 100644 www/apps/docs/content/references/types/WorkflowTypes/types.WorkflowTypes.PriceListWorkflow.mdx create mode 100644 www/apps/docs/content/references/types/interfaces/types.CreatePriceSetPriceRules.mdx delete mode 100644 www/apps/docs/content/references/types/modules/types.CommonTypes.mdx delete mode 100644 www/apps/docs/content/references/types/modules/types.DAL.mdx delete mode 100644 www/apps/docs/content/references/types/modules/types.EventBusTypes.mdx delete mode 100644 www/apps/docs/content/references/types/modules/types.FeatureFlagTypes.mdx delete mode 100644 www/apps/docs/content/references/types/modules/types.ModulesSdkTypes.mdx delete mode 100644 www/apps/docs/content/references/types/modules/types.SalesChannelTypes.mdx delete mode 100644 www/apps/docs/content/references/types/modules/types.SearchTypes.mdx delete mode 100644 www/apps/docs/content/references/types/modules/types.TransactionBaseTypes.mdx delete mode 100644 www/apps/docs/content/references/types/modules/types.WorkflowTypes.mdx rename www/apps/docs/content/references/types/{modules => }/types.CacheTypes.mdx (53%) create mode 100644 www/apps/docs/content/references/types/types.CommonTypes.mdx create mode 100644 www/apps/docs/content/references/types/types.CustomerTypes.mdx create mode 100644 www/apps/docs/content/references/types/types.DAL.mdx create mode 100644 www/apps/docs/content/references/types/types.EventBusTypes.mdx create mode 100644 www/apps/docs/content/references/types/types.FeatureFlagTypes.mdx rename www/apps/docs/content/references/types/{modules => }/types.LoggerTypes.mdx (57%) create mode 100644 www/apps/docs/content/references/types/types.ModulesSdkTypes.mdx create mode 100644 www/apps/docs/content/references/types/types.RegionTypes.mdx create mode 100644 www/apps/docs/content/references/types/types.SalesChannelTypes.mdx create mode 100644 www/apps/docs/content/references/types/types.SearchTypes.mdx create mode 100644 www/apps/docs/content/references/types/types.TransactionBaseTypes.mdx create mode 100644 www/apps/docs/content/references/types/types.WorkflowTypes.mdx diff --git a/.changeset/clean-timers-hunt.md b/.changeset/clean-timers-hunt.md new file mode 100644 index 0000000000000..b2d558f536efd --- /dev/null +++ b/.changeset/clean-timers-hunt.md @@ -0,0 +1,5 @@ +--- +"medusa-react": patch +--- + +fix(medusa-react): general type fixes related to generating reference documentation diff --git a/docs-util/packages/react-docs-generator/src/classes/typedoc-manager.ts b/docs-util/packages/react-docs-generator/src/classes/typedoc-manager.ts index 0751755b95089..368c01e1d2c5e 100644 --- a/docs-util/packages/react-docs-generator/src/classes/typedoc-manager.ts +++ b/docs-util/packages/react-docs-generator/src/classes/typedoc-manager.ts @@ -128,10 +128,10 @@ export default class TypedocManager { const signature = mappedSignature.signatures[0] // get the props of the component from the // first parameter in the signature. - const props = getTypeChildren( - signature.parameters![0].type!, - this.project - ) + const props = getTypeChildren({ + reflectionType: signature.parameters![0].type!, + project: this.project, + }) // this stores props that should be removed from the // spec @@ -482,7 +482,10 @@ export default class TypedocManager { childName ) as DeclarationReflection } else if (reflection.type) { - getTypeChildren(reflection.type, this.project).some((child) => { + getTypeChildren({ + reflectionType: reflection.type, + project: this.project, + }).some((child) => { if (child.name === childName) { childReflection = child return true diff --git a/docs-util/packages/scripts/generate-reference.ts b/docs-util/packages/scripts/generate-reference.ts index 7cd7f080a1a2d..3d507f0227e09 100644 --- a/docs-util/packages/scripts/generate-reference.ts +++ b/docs-util/packages/scripts/generate-reference.ts @@ -61,6 +61,7 @@ export function generateReference(referenceName: string) { formatColoredLog(colorLog, referenceName, chunk.trim()) }) typedocProcess.on("exit", (code) => { + formatColoredLog(colorLog, referenceName, "Finished Generating reference.") generatedCount++ if (generatedCount >= totalCount && !ranMerger && code !== 1) { runMerger() @@ -81,7 +82,6 @@ export function generateReference(referenceName: string) { ) }) }) - formatColoredLog(colorLog, referenceName, "Finished Generating reference.") } function formatColoredLog( diff --git a/docs-util/packages/typedoc-config/_merger.js b/docs-util/packages/typedoc-config/_merger.js index 7ac1d9d678eb3..3c218924556bf 100644 --- a/docs-util/packages/typedoc-config/_merger.js +++ b/docs-util/packages/typedoc-config/_merger.js @@ -64,6 +64,7 @@ module.exports = { "stock-location", "workflows", ], + allReflectionsHaveOwnDocumentInNamespace: ["Utilities"], formatting: { "*": { showCommentsAsHeader: true, @@ -131,7 +132,7 @@ module.exports = { displayed_sidebar: "inventoryReference", }, }, - "^IInventoryService/methods": { + "^inventory/IInventoryService/methods": { reflectionDescription: "This documentation provides a reference to the `{{alias}}` {{kind}}. This belongs to the Inventory Module.", frontmatterData: { @@ -189,29 +190,118 @@ module.exports = { "^js_client/.*LineItemsResource": { maxLevel: 3, }, - "^(js_client/.*modules/.*internal|internal.*/modules)": { + + // MEDUSA REACT CONFIG + "^medusa_react": { + frontmatterData: { + displayed_sidebar: "medusaReactSidebar", + }, + parameterComponentExtraProps: { + expandUrl: + "https://docs.medusajs.com/medusa-react/overview#expanding-fields", + }, + }, + "^modules/medusa_react\\.mdx": { + frontmatterData: { + displayed_sidebar: "medusaReactSidebar", + }, reflectionGroups: { - Constructors: false, - "Type Aliases": false, - Enumerations: false, - "Enumeration Members": false, - Classes: false, + Variables: false, Functions: false, - Interfaces: false, - References: false, + }, + reflectionCategories: { + Mutations: false, + Queries: false, + Other: false, }, }, - "^internal.*/.*js_client.*": { - reflectionGroups: { - Constructors: false, + "^medusa_react/(medusa_react\\.Hooks\\.mdx|.*medusa_react\\.Hooks\\.Admin\\.mdx|.*medusa_react\\.Hooks\\.Store\\.mdx|medusa_react\\.Providers\\.mdx)": + { + reflectionGroups: { + Functions: false, + }, }, + "^medusa_react/Providers/.*": { + expandMembers: true, frontmatterData: { - displayed_sidebar: "jsClientSidebar", + displayed_sidebar: "medusaReactSidebar", + slug: "/references/medusa-react/providers/{{alias-lower}}", + sidebar_label: "{{alias}}", + }, + reflectionTitle: { + suffix: " Provider Overview", + }, + }, + "^medusa_react/medusa_react\\.Utilities": { + expandMembers: true, + reflectionTitle: { + prefix: "Medusa React ", + }, + }, + "^medusa_react/Utilities/.*": { + expandMembers: true, + frontmatterData: { + displayed_sidebar: "medusaReactSidebar", + slug: "/references/medusa-react/utilities/{{alias}}", + }, + }, + "^medusa_react/medusa_react\\.Hooks\\.mdx": { + frontmatterData: { + displayed_sidebar: "medusaReactSidebar", + slug: "/references/medusa-react/hooks", + }, + }, + "^medusa_react/Hooks/Admin/.*Admin\\.mdx": { + frontmatterData: { + displayed_sidebar: "medusaReactSidebar", + slug: "/references/medusa-react/hooks/admin", + }, + }, + "^medusa_react/Hooks/Admin/.*": { + frontmatterData: { + displayed_sidebar: "medusaReactSidebar", + slug: "/references/medusa-react/hooks/admin/{{alias-lower}}", + }, + }, + "^medusa_react/Hooks/Store/.*Store\\.mdx": { + frontmatterData: { + displayed_sidebar: "medusaReactSidebar", + slug: "/references/medusa-react/hooks/store", }, }, + "^medusa_react/Hooks/Store/.*": { + frontmatterData: { + displayed_sidebar: "medusaReactSidebar", + slug: "/references/medusa-react/hooks/store/{{alias-lower}}", + }, + }, + "^medusa_react/medusa_react\\.Providers\\.mdx": { + frontmatterData: { + displayed_sidebar: "medusaReactSidebar", + slug: "/references/medusa-react/providers", + }, + }, + "^medusa_react/medusa_react\\.Utilities\\.mdx": { + frontmatterData: { + displayed_sidebar: "medusaReactSidebar", + slug: "/references/medusa-react/utilities", + }, + }, + "^medusa_react/Hooks/.*Admin\\.Inventory_Items": { + maxLevel: 4, + }, + "^medusa_react/Hooks/.*Admin\\.Products": { + maxLevel: 4, + }, + "^medusa_react/Hooks/.*Admin\\.Stock_Locations": { + maxLevel: 5, + }, + "^medusa_react/Hooks/.*Admin\\.Users": { + maxLevel: 5, + }, // MEDUSA CONFIG - "^medusa": { + "^medusa/": { frontmatterData: { displayed_sidebar: "homepage", }, @@ -249,13 +339,13 @@ module.exports = { }, // PRICING CONFIG - "^(pricing|IPricingModuleService)": { + "^pricing": { ...modulesOptions, frontmatterData: { displayed_sidebar: "pricingReference", }, }, - "^IPricingModuleService/methods": { + "^pricing/IPricingModuleService/methods": { reflectionDescription: "This documentation provides a reference to the `{{alias}}` {{kind}}. This belongs to the Pricing Module.", frontmatterData: { @@ -298,7 +388,7 @@ module.exports = { displayed_sidebar: "productReference", }, }, - "^IProductModuleService/methods": { + "^product/IProductModuleService/methods": { reflectionDescription: "This documentation provides a reference to the {{alias}} {{kind}}. This belongs to the Product Module.", frontmatterData: { @@ -349,7 +439,7 @@ module.exports = { displayed_sidebar: "stockLocationReference", }, }, - "^IStockLocationService/methods": { + "^stock-location/IStockLocationService/methods": { reflectionDescription: "This documentation provides a reference to the `{{alias}}` {{kind}}. This belongs to the Stock Location Module.", frontmatterData: { diff --git a/docs-util/packages/typedoc-config/extended-tsconfig/medusa-react.json b/docs-util/packages/typedoc-config/extended-tsconfig/medusa-react.json new file mode 100644 index 0000000000000..fd4931b2dce10 --- /dev/null +++ b/docs-util/packages/typedoc-config/extended-tsconfig/medusa-react.json @@ -0,0 +1,9 @@ +{ + "$schema": "http://json.schemastore.org/tsconfig", + "extends": [ + "../../../../packages/medusa-react/tsconfig.json" + ], + "compilerOptions": { + "noImplicitReturns": false, + } +} \ No newline at end of file diff --git a/docs-util/packages/typedoc-config/extended-tsconfig/tsdoc.json b/docs-util/packages/typedoc-config/extended-tsconfig/tsdoc.json index f8aaecc581292..e58d7ccc796c2 100644 --- a/docs-util/packages/typedoc-config/extended-tsconfig/tsdoc.json +++ b/docs-util/packages/typedoc-config/extended-tsconfig/tsdoc.json @@ -33,6 +33,18 @@ { "tagName": "@excludeExternal", "syntaxKind": "modifier" + }, + { + "tagName": "@customNamespace", + "syntaxKind": "block" + }, + { + "tagName": "@namespaceMember", + "syntaxKind": "modifier" + }, + { + "tagName": "@typeParamDefinition", + "syntaxKind": "block" } ] } \ No newline at end of file diff --git a/docs-util/packages/typedoc-config/medusa-react.js b/docs-util/packages/typedoc-config/medusa-react.js new file mode 100644 index 0000000000000..00177e6ad09b9 --- /dev/null +++ b/docs-util/packages/typedoc-config/medusa-react.js @@ -0,0 +1,10 @@ +/* eslint-disable @typescript-eslint/no-var-requires */ +const getConfig = require("./utils/get-config") + +module.exports = getConfig({ + entryPointPath: "packages/medusa-react/src/index.ts", + tsConfigName: "medusa-react.json", + name: "medusa-react", + generateNamespaces: true, + ignoreApi: true, +}) diff --git a/docs-util/packages/typedoc-plugin-custom/README.md b/docs-util/packages/typedoc-plugin-custom/README.md index ccaf3451926ff..371e46c6b36f8 100644 --- a/docs-util/packages/typedoc-plugin-custom/README.md +++ b/docs-util/packages/typedoc-plugin-custom/README.md @@ -35,6 +35,15 @@ The following options are useful for linting: - `eslintPathName`: The path to the ESLint configuration file. - `pluginsResolvePath`: The path to resolve plugins used in the ESLint configuration files. +### Generate Namespace Plugin + +If the `generateNamespaces` option is enabled, Namespaces are created from reflections having the `@customNamespace` tag. It also attaches categories (using the `@category` tag) of the same reflection to its generated parent namespace. + +It also accepts the following options: + +- `parentNamespace`: The name of a parent namespace to make the generated namespaces as its children. +- `namePrefix`: A prefix to add to the name of the generated namespaces. + --- ## Build the Plugin diff --git a/docs-util/packages/typedoc-plugin-custom/src/generate-namespace.ts b/docs-util/packages/typedoc-plugin-custom/src/generate-namespace.ts new file mode 100644 index 0000000000000..0737e638605c5 --- /dev/null +++ b/docs-util/packages/typedoc-plugin-custom/src/generate-namespace.ts @@ -0,0 +1,258 @@ +import { + Application, + Comment, + CommentDisplayPart, + CommentTag, + Context, + Converter, + DeclarationReflection, + ParameterType, + ReflectionCategory, + ReflectionKind, +} from "typedoc" + +type PluginOptions = { + generateNamespaces: boolean + parentNamespace: string + namePrefix: string +} + +export class GenerateNamespacePlugin { + private options?: PluginOptions + private app: Application + private parentNamespace?: DeclarationReflection + private currentNamespaceHeirarchy: DeclarationReflection[] + private currentContext?: Context + private scannedComments = false + + constructor(app: Application) { + this.app = app + this.currentNamespaceHeirarchy = [] + this.declareOptions() + + this.app.converter.on( + Converter.EVENT_CREATE_DECLARATION, + this.handleCreateDeclarationEvent.bind(this) + ) + this.app.converter.on( + Converter.EVENT_CREATE_DECLARATION, + this.scanComments.bind(this) + ) + } + + declareOptions() { + this.app.options.addDeclaration({ + name: "generateNamespaces", + type: ParameterType.Boolean, + defaultValue: false, + help: "Whether to enable conversion of categories to namespaces.", + }) + this.app.options.addDeclaration({ + name: "parentNamespace", + type: ParameterType.String, + defaultValue: "", + help: "Optionally specify a parent namespace to place all generated namespaces in.", + }) + this.app.options.addDeclaration({ + name: "namePrefix", + type: ParameterType.String, + defaultValue: "", + help: "Optionally specify a name prefix for all namespaces.", + }) + } + + readOptions() { + if (this.options) { + return + } + + this.options = { + generateNamespaces: this.app.options.getValue("generateNamespaces"), + parentNamespace: this.app.options.getValue("parentNamespace"), + namePrefix: this.app.options.getValue("namePrefix"), + } + } + + loadNamespace(namespaceName: string): DeclarationReflection { + const formattedName = this.formatName(namespaceName) + return this.currentContext?.project + .getReflectionsByKind(ReflectionKind.Namespace) + .find( + (m) => + m.name === formattedName && + (!this.currentNamespaceHeirarchy.length || + m.parent?.id === + this.currentNamespaceHeirarchy[ + this.currentNamespaceHeirarchy.length - 1 + ].id) + ) as DeclarationReflection + } + + createNamespace(namespaceName: string): DeclarationReflection | undefined { + if (!this.currentContext) { + return + } + const formattedName = this.formatName(namespaceName) + const namespace = this.currentContext?.createDeclarationReflection( + ReflectionKind.Namespace, + void 0, + void 0, + formattedName + ) + + namespace.children = [] + + return namespace + } + + formatName(namespaceName: string): string { + return `${this.options?.namePrefix}${namespaceName}` + } + + generateNamespaceFromTag({ + tag, + summary, + }: { + tag: CommentTag + reflection?: DeclarationReflection + summary?: CommentDisplayPart[] + }) { + const categoryHeirarchy = tag.content[0].text.split(".") + categoryHeirarchy.forEach((cat, index) => { + // check whether a namespace exists with the category name. + let namespace = this.loadNamespace(cat) + + if (!namespace) { + // add a namespace for this category + namespace = this.createNamespace(cat) || namespace + + namespace.comment = new Comment() + if (this.currentNamespaceHeirarchy.length) { + namespace.comment.modifierTags.add("@namespaceMember") + } + if (summary && index === categoryHeirarchy.length - 1) { + namespace.comment.summary = summary + } + } + this.currentContext = + this.currentContext?.withScope(namespace) || this.currentContext + + this.currentNamespaceHeirarchy.push(namespace) + }) + } + + /** + * create categories in the last namespace if the + * reflection has a category + */ + attachCategories(reflection: DeclarationReflection) { + if (!this.currentNamespaceHeirarchy.length) { + return + } + + const parentNamespace = + this.currentNamespaceHeirarchy[this.currentNamespaceHeirarchy.length - 1] + reflection.comment?.blockTags + .filter((tag) => tag.tag === "@category") + .forEach((tag) => { + const categoryName = tag.content[0].text + if (!parentNamespace.categories) { + parentNamespace.categories = [] + } + let category = parentNamespace.categories.find( + (category) => category.title === categoryName + ) + if (!category) { + category = new ReflectionCategory(categoryName) + parentNamespace.categories.push(category) + } + category.children.push(reflection) + }) + } + + handleCreateDeclarationEvent( + context: Context, + reflection: DeclarationReflection + ) { + this.readOptions() + if (this.options?.parentNamespace && !this.parentNamespace) { + this.parentNamespace = + this.loadNamespace(this.options.parentNamespace) || + this.createNamespace(this.options.parentNamespace) + } + this.currentNamespaceHeirarchy = [] + if (this.parentNamespace) { + this.currentNamespaceHeirarchy.push(this.parentNamespace) + } + this.currentContext = context + reflection.comment?.blockTags + .filter((tag) => tag.tag === "@customNamespace") + .forEach((tag) => { + this.generateNamespaceFromTag({ + tag, + }) + if ( + reflection.parent instanceof DeclarationReflection || + reflection.parent?.isProject() + ) { + reflection.parent.children = reflection.parent.children?.filter( + (child) => child.id !== reflection.id + ) + } + this.currentContext?.addChild(reflection) + }) + + reflection.comment?.removeTags("@customNamespace") + this.attachCategories(reflection) + this.currentContext = undefined + this.currentNamespaceHeirarchy = [] + } + + /** + * Scan all source files for `@customNamespace` tag to generate namespaces + * This is mainly helpful to pull summaries of the namespaces. + */ + scanComments(context: Context) { + if (this.scannedComments) { + return + } + this.currentContext = context + const fileNames = context.program.getRootFileNames() + + fileNames.forEach((fileName) => { + const sourceFile = context.program.getSourceFile(fileName) + if (!sourceFile) { + return + } + + const comments = context.getFileComment(sourceFile) + comments?.blockTags + .filter((tag) => tag.tag === "@customNamespace") + .forEach((tag) => { + this.generateNamespaceFromTag({ tag, summary: comments.summary }) + if (this.currentNamespaceHeirarchy.length) { + // add comments of the file to the last created namespace + this.currentNamespaceHeirarchy[ + this.currentNamespaceHeirarchy.length - 1 + ].comment = comments + + this.currentNamespaceHeirarchy[ + this.currentNamespaceHeirarchy.length - 1 + ].comment!.blockTags = this.currentNamespaceHeirarchy[ + this.currentNamespaceHeirarchy.length - 1 + ].comment!.blockTags.filter((tag) => tag.tag !== "@customNamespace") + } + // reset values + this.currentNamespaceHeirarchy = [] + this.currentContext = context + }) + }) + + this.scannedComments = true + } + + // for debugging + printCurrentHeirarchy() { + return this.currentNamespaceHeirarchy.map((heirarchy) => heirarchy.name) + } +} diff --git a/docs-util/packages/typedoc-plugin-custom/src/index.ts b/docs-util/packages/typedoc-plugin-custom/src/index.ts index 8525ebdd9451b..9d430eca20731 100644 --- a/docs-util/packages/typedoc-plugin-custom/src/index.ts +++ b/docs-util/packages/typedoc-plugin-custom/src/index.ts @@ -5,6 +5,7 @@ import { load as parseOasSchemaPlugin } from "./parse-oas-schema-plugin" import { load as apiIgnorePlugin } from "./api-ignore" import { load as eslintExamplePlugin } from "./eslint-example" import { load as signatureModifierPlugin } from "./signature-modifier" +import { GenerateNamespacePlugin } from "./generate-namespace" export function load(app: Application) { resolveReferencesPluginLoad(app) @@ -13,4 +14,6 @@ export function load(app: Application) { apiIgnorePlugin(app) eslintExamplePlugin(app) signatureModifierPlugin(app) + + new GenerateNamespacePlugin(app) } diff --git a/docs-util/packages/typedoc-plugin-custom/src/parse-oas-schema-plugin.ts b/docs-util/packages/typedoc-plugin-custom/src/parse-oas-schema-plugin.ts index c470eb9b55c6e..cfbdf7b19d292 100644 --- a/docs-util/packages/typedoc-plugin-custom/src/parse-oas-schema-plugin.ts +++ b/docs-util/packages/typedoc-plugin-custom/src/parse-oas-schema-plugin.ts @@ -178,7 +178,10 @@ function addComments(schema: Schema, reflection: Reflection) { } const children = "type" in reflection - ? getTypeChildren(reflection.type as SomeType, reflection.project) + ? getTypeChildren({ + reflectionType: reflection.type as SomeType, + project: reflection.project, + }) : "children" in reflection ? (reflection.children as DeclarationReflection[]) : [] diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/README.md b/docs-util/packages/typedoc-plugin-markdown-medusa/README.md index ce2195712e2d7..126bdefcf6af1 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/README.md +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/README.md @@ -6,6 +6,7 @@ A plugin that forks and customizes the [typedoc-plugin-markdown](https://github. Aside from the options detailed in [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown#options), the following options are accepted: +- `allReflectionsHaveOwnDocumentInNamespace`: An array of namespace names whose child members should have their own documents. - `mdxImports`: A boolean value indicating whether the outputted files should be MDX files with the `.mdx` extension. - `formatting`: An object whose keys are string patterns used to target specific files. You can also use the string `*` to target all files. The values are objects having the following properties: - `sections`: (optional) an object whose keys are of type [`SectionKey`](./src/types.ts#L19) and values are boolean. This property is used to enable/disable certain sections in the outputted generated docs. diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/index.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/index.ts index cef38e03497e6..98727f588bf55 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/index.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/index.ts @@ -40,6 +40,13 @@ export function load(app: Application) { defaultValue: [], }) + app.options.addDeclaration({ + help: "[Markdown Plugin] Specify namespace names where all reflections are outputted into seperate files.", + name: "allReflectionsHaveOwnDocumentInNamespace", + type: ParameterType.Array, + defaultValue: [], + }) + app.options.addDeclaration({ help: "[Markdown Plugin] Separator used to format filenames.", name: "filenameSeparator", 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 7bc755f05690a..c6cfe87a84a5a 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 @@ -49,10 +49,17 @@ import decrementCurrentTitleLevelHelper from "./resources/helpers/decrement-curr import incrementCurrentTitleLevelHelper from "./resources/helpers/increment-current-title-level" import hasMoreThanOneSignatureHelper from "./resources/helpers/has-more-than-one-signature" import ifCanShowConstructorsTitleHelper from "./resources/helpers/if-can-show-constructors-title" +import ifReactQueryTypeHelper from "./resources/helpers/if-react-query-type" +import ifHasHookParamsHelper from "./resources/helpers/if-has-hook-params" +import reactQueryHookParamsHelper from "./resources/helpers/react-query-hook-params" +import ifHasMutationParamsHelper from "./resources/helpers/if-has-mutation-params" +import reactQueryMutationParamsHelper from "./resources/helpers/react-query-mutation-params" +import ifHasMutationReturnHelper from "./resources/helpers/if-has-mutation-return" +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 { MarkdownTheme } from "./theme" -// test - const TEMPLATE_PATH = path.join(__dirname, "resources", "templates") export const indexTemplate = Handlebars.compile( @@ -128,4 +135,13 @@ export function registerHelpers(theme: MarkdownTheme) { incrementCurrentTitleLevelHelper(theme) hasMoreThanOneSignatureHelper(theme) ifCanShowConstructorsTitleHelper() + ifReactQueryTypeHelper() + ifHasHookParamsHelper() + reactQueryHookParamsHelper() + ifHasMutationParamsHelper(theme) + reactQueryMutationParamsHelper(theme) + ifHasMutationReturnHelper(theme) + reactQueryMutationReturnHelper(theme) + ifHasQueryReturnHelper(theme) + reactQueryQueryReturnHelper(theme) } diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comments.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comments.ts index c41d41a5c311b..17f5de2fba1df 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comments.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comments.ts @@ -1,7 +1,13 @@ import * as Handlebars from "handlebars" import { Comment } from "typedoc" -const EXCLUDED_TAGS = ["@returns", "@example", "@featureFlag"] +const EXCLUDED_TAGS = [ + "@returns", + "@example", + "@featureFlag", + "@category", + "@typeParamDefinition", +] export default function () { Handlebars.registerHelper( diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-hook-params.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-hook-params.ts new file mode 100644 index 0000000000000..117588ef34c3c --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-hook-params.ts @@ -0,0 +1,14 @@ +import * as Handlebars from "handlebars" +import { SignatureReflection } from "typedoc" +import { getHookParams } from "../../utils/react-query-utils" + +export default function () { + Handlebars.registerHelper( + "ifHasHookParams", + function (this: SignatureReflection, options: Handlebars.HelperOptions) { + return getHookParams(this).length + ? options.fn(this) + : options.inverse(this) + } + ) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-mutation-params.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-mutation-params.ts new file mode 100644 index 0000000000000..ea9f7b6dce98e --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-mutation-params.ts @@ -0,0 +1,23 @@ +import * as Handlebars from "handlebars" +import { SignatureReflection } from "typedoc" +import { getMutationParams } from "../../utils/react-query-utils" +import { MarkdownTheme } from "../../theme" + +export default function (theme: MarkdownTheme) { + Handlebars.registerHelper( + "ifHasMutationParams", + function (this: SignatureReflection, options: Handlebars.HelperOptions) { + return getMutationParams({ + signatureReflection: this, + project: theme.project || this.project, + reflectionTypeGetterOptions: { + // we only need to check if there are mutation parameters, + // so no need to get all the children + maxLevel: 1, + }, + }).length + ? options.fn(this) + : options.inverse(this) + } + ) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-mutation-return.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-mutation-return.ts new file mode 100644 index 0000000000000..e528cdd6ac316 --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-mutation-return.ts @@ -0,0 +1,23 @@ +import * as Handlebars from "handlebars" +import { SignatureReflection } from "typedoc" +import { getMutationReturn } from "../../utils/react-query-utils" +import { MarkdownTheme } from "../../theme" + +export default function (theme: MarkdownTheme) { + Handlebars.registerHelper( + "ifHasMutationReturn", + function (this: SignatureReflection, options: Handlebars.HelperOptions) { + return getMutationReturn({ + signatureReflection: this, + project: theme.project || this.project, + reflectionTypeGetterOptions: { + // we only need to check if there are mutation returns, + // so no need to get all the children + maxLevel: 1, + }, + }).length + ? options.fn(this) + : options.inverse(this) + } + ) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-query-return.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-query-return.ts new file mode 100644 index 0000000000000..61a5b6b095518 --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-has-query-return.ts @@ -0,0 +1,23 @@ +import * as Handlebars from "handlebars" +import { SignatureReflection } from "typedoc" +import { getQueryReturn } from "../../utils/react-query-utils" +import { MarkdownTheme } from "../../theme" + +export default function (theme: MarkdownTheme) { + Handlebars.registerHelper( + "ifHasQueryReturn", + function (this: SignatureReflection, options: Handlebars.HelperOptions) { + return getQueryReturn({ + signatureReflection: this, + project: theme.project || this.project, + reflectionTypeGetterOptions: { + // we only need to check if there are query returns, + // so no need to get all the children + maxLevel: 1, + }, + }).length + ? options.fn(this) + : options.inverse(this) + } + ) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-react-query-type.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-react-query-type.ts new file mode 100644 index 0000000000000..34e1129e7afdd --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-react-query-type.ts @@ -0,0 +1,17 @@ +import * as Handlebars from "handlebars" +import { SignatureReflection } from "typedoc" +import { + isReactQueryMutation, + isReactQueryQuery, +} from "../../utils/react-query-utils" + +export default function () { + Handlebars.registerHelper( + "ifReactQueryType", + function (this: SignatureReflection, options: Handlebars.HelperOptions) { + return isReactQueryMutation(this) || isReactQueryQuery(this) + ? options.fn(this) + : options.inverse(this) + } + ) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/parameter-component.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/parameter-component.ts index 307fe4cf7e9c8..c9d64aef3e8fe 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/parameter-component.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/parameter-component.ts @@ -3,6 +3,7 @@ import { ReflectionParameterType } from "../../types" import { parseParams } from "../../utils/params-utils" import { MarkdownTheme } from "../../theme" import { reflectionComponentFormatter } from "../../utils/reflection-formatter" +import { formatParameterComponent } from "../../utils/format-parameter-component" export default function (theme: MarkdownTheme) { Handlebars.registerHelper( @@ -21,19 +22,11 @@ export default function (theme: MarkdownTheme) { }) ) - let extraProps: string[] = [] - - if (parameterComponentExtraProps) { - extraProps = Object.entries(parameterComponentExtraProps).map( - ([key, value]) => `${key}=${JSON.stringify(value)}` - ) - } - - return `<${parameterComponent} parameters={${JSON.stringify( - parameters, - null, - 2 - )}} ${extraProps.join(" ")}/>` + return formatParameterComponent({ + parameterComponent, + componentItems: parameters, + extraProps: parameterComponentExtraProps, + }) } ) } diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-hook-params.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-hook-params.ts new file mode 100644 index 0000000000000..a189d6a4ff50d --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-hook-params.ts @@ -0,0 +1,19 @@ +import * as Handlebars from "handlebars" +import { SignatureReflection } from "typedoc" +import { getHookParams } from "../../utils/react-query-utils" + +export default function () { + Handlebars.registerHelper( + "reactQueryHookParams", + function (this: SignatureReflection) { + let parametersStr = "" + const hookParameters = getHookParams(this) + + if (hookParameters?.length) { + parametersStr = Handlebars.helpers.parameter.call(hookParameters) + } + + return parametersStr + } + ) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-mutation-params.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-mutation-params.ts new file mode 100644 index 0000000000000..f05180e21e742 --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-mutation-params.ts @@ -0,0 +1,37 @@ +import * as Handlebars from "handlebars" +import { SignatureReflection } from "typedoc" +import { getMutationParams } from "../../utils/react-query-utils" +import { MarkdownTheme } from "../../theme" +import { formatParameterComponent } from "../../utils/format-parameter-component" + +export default function (theme: MarkdownTheme) { + Handlebars.registerHelper( + "reactQueryMutationParams", + function (this: SignatureReflection) { + const { + parameterStyle, + parameterComponent, + maxLevel, + parameterComponentExtraProps, + } = theme.getFormattingOptionsForLocation() + const mutationParameters = getMutationParams({ + signatureReflection: this, + project: theme.project || this.project, + reflectionTypeGetterOptions: { + maxLevel, + }, + }) + + if (parameterStyle !== "component") { + // TODO maybe handle other cases? But for now it's not important + return "" + } + + return formatParameterComponent({ + parameterComponent, + componentItems: mutationParameters, + extraProps: parameterComponentExtraProps, + }) + } + ) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-mutation-return.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-mutation-return.ts new file mode 100644 index 0000000000000..d7bcac313d1d4 --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-mutation-return.ts @@ -0,0 +1,37 @@ +import * as Handlebars from "handlebars" +import { SignatureReflection } from "typedoc" +import { getMutationReturn } from "../../utils/react-query-utils" +import { MarkdownTheme } from "../../theme" +import { formatParameterComponent } from "../../utils/format-parameter-component" + +export default function (theme: MarkdownTheme) { + Handlebars.registerHelper( + "reactQueryMutationReturn", + function (this: SignatureReflection) { + const { + parameterStyle, + parameterComponent, + maxLevel, + parameterComponentExtraProps, + } = theme.getFormattingOptionsForLocation() + const mutationParameters = getMutationReturn({ + signatureReflection: this, + project: theme.project || this.project, + reflectionTypeGetterOptions: { + maxLevel, + }, + }) + + if (parameterStyle !== "component") { + // TODO maybe handle other cases? But for now it's not important + return "" + } + + return formatParameterComponent({ + parameterComponent, + componentItems: mutationParameters, + extraProps: parameterComponentExtraProps, + }) + } + ) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-query-return.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-query-return.ts new file mode 100644 index 0000000000000..8c9b5e1f88a32 --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/react-query-query-return.ts @@ -0,0 +1,37 @@ +import * as Handlebars from "handlebars" +import { SignatureReflection } from "typedoc" +import { getQueryReturn } from "../../utils/react-query-utils" +import { MarkdownTheme } from "../../theme" +import { formatParameterComponent } from "../../utils/format-parameter-component" + +export default function (theme: MarkdownTheme) { + Handlebars.registerHelper( + "reactQueryQueryReturn", + function (this: SignatureReflection) { + const { + parameterStyle, + parameterComponent, + maxLevel, + parameterComponentExtraProps, + } = theme.getFormattingOptionsForLocation() + const mutationParameters = getQueryReturn({ + signatureReflection: this, + project: theme.project || this.project, + reflectionTypeGetterOptions: { + maxLevel, + }, + }) + + if (parameterStyle !== "component") { + // TODO maybe handle other cases? But for now it's not important + return "" + } + + return formatParameterComponent({ + parameterComponent, + componentItems: mutationParameters, + extraProps: parameterComponentExtraProps, + }) + } + ) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/reflection-title.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/reflection-title.ts index eb8f16d9f820b..b67ada60e5700 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/reflection-title.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/reflection-title.ts @@ -3,6 +3,7 @@ import { PageEvent, ParameterReflection, ReflectionKind } from "typedoc" import { MarkdownTheme } from "../../theme" import { getDisplayName } from "../../utils" import { escapeChars } from "utils" +import { replaceTemplateVariables } from "../../utils/reflection-template-strings" export default function (theme: MarkdownTheme) { Handlebars.registerHelper( @@ -12,10 +13,16 @@ export default function (theme: MarkdownTheme) { const { reflectionTitle } = theme.getFormattingOptionsForLocation() if (reflectionTitle?.fullReplacement?.length) { - return reflectionTitle.fullReplacement + return theme.reflection + ? replaceTemplateVariables( + theme.reflection, + reflectionTitle.fullReplacement + ) + : reflectionTitle.fullReplacement } - const title: string[] = [""] + const title: string[] = [reflectionTitle?.prefix || ""] + if ( reflectionTitle?.kind && this.model?.kind && diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/returns.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/returns.ts index 7d1f04878a1ca..7811ab3278229 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/returns.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/returns.ts @@ -2,8 +2,9 @@ import * as Handlebars from "handlebars" import { Comment, DeclarationReflection, SignatureReflection } from "typedoc" import { MarkdownTheme } from "../../theme" import reflectionFormatter from "../../utils/reflection-formatter" -import { returnReflectionComponentFormatter } from "../../utils/return-reflection-formatter" +import { getReflectionTypeParameters } from "../../utils/reflection-type-parameters" import { Parameter } from "../../types" +import { formatParameterComponent } from "../../utils/format-parameter-component" export default function (theme: MarkdownTheme) { Handlebars.registerHelper( @@ -24,14 +25,18 @@ function getReturnFromType( theme: MarkdownTheme, reflection: SignatureReflection ) { - const { parameterStyle, parameterComponent, maxLevel } = - theme.getFormattingOptionsForLocation() + const { + parameterStyle, + parameterComponent, + maxLevel, + parameterComponentExtraProps, + } = theme.getFormattingOptionsForLocation() if (!reflection.type) { return "" } - const componentItems = returnReflectionComponentFormatter({ + const componentItems = getReflectionTypeParameters({ reflectionType: reflection.type, project: reflection.project || theme.project, comment: reflection.comment, @@ -40,11 +45,11 @@ function getReturnFromType( }) if (parameterStyle === "component") { - return `<${parameterComponent} parameters={${JSON.stringify( + return formatParameterComponent({ + parameterComponent, componentItems, - null, - 2 - )}} />` + extraProps: parameterComponentExtraProps, + }) } else { return formatReturnAsList(componentItems) } @@ -74,8 +79,12 @@ function formatReturnAsList(componentItems: Parameter[], level = 1): string { function getReturnFromComment(theme: MarkdownTheme, comment: Comment) { const md: string[] = [] - const { parameterStyle, parameterComponent, maxLevel } = - theme.getFormattingOptionsForLocation() + const { + parameterStyle, + parameterComponent, + maxLevel, + parameterComponentExtraProps, + } = theme.getFormattingOptionsForLocation() if (comment.blockTags?.length) { const tags = comment.blockTags @@ -97,11 +106,14 @@ function getReturnFromComment(theme: MarkdownTheme, comment: Comment) { ) result += parameterStyle === "component" - ? `\n\n<${parameterComponent} parameters={${JSON.stringify( - content, - null, - 2 - )}} title={"${commentPart.target.name}"} />\n\n` + ? `\n\n${formatParameterComponent({ + parameterComponent, + componentItems: content as Parameter[], + extraProps: { + ...parameterComponentExtraProps, + title: commentPart.target.name, + }, + })}\n\n` : `\n\n
\n\n${ commentPart.target.name }\n\n\n${content?.join("\n")}\n\n
` 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-object-literal.ts index c4e47e7250b5a..9bdb3af7dd869 100644 --- 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-object-literal.ts @@ -2,15 +2,16 @@ import * as Handlebars from "handlebars" import { DeclarationReflection, ReflectionType } from "typedoc" import { MarkdownTheme } from "../../theme" import { parseParams } from "../../utils/params-utils" -import { ReflectionParameterType } from "../../types" +import { Parameter, ReflectionParameterType } from "../../types" import reflectionFormatter from "../../utils/reflection-formatter" import { escapeChars, stripLineBreaks } from "utils" +import { formatParameterComponent } from "../../utils/format-parameter-component" export default function (theme: MarkdownTheme) { Handlebars.registerHelper( "typeDeclarationMembers", function (this: DeclarationReflection[]) { - const { parameterComponent, maxLevel } = + const { parameterComponent, maxLevel, parameterComponentExtraProps } = theme.getFormattingOptionsForLocation() const comments = this.map( (param) => !!param.comment?.hasVisibleComponent() @@ -30,11 +31,12 @@ export default function (theme: MarkdownTheme) { break } case "component": { - result = getComponentMarkdownContent( + result = getComponentMarkdownContent({ properties, parameterComponent, - maxLevel - ) + maxLevel, + parameterComponentExtraProps, + }) break } case "table": { @@ -58,11 +60,17 @@ function getListMarkdownContent(properties: DeclarationReflection[]) { return items.join("\n") } -function getComponentMarkdownContent( - properties: DeclarationReflection[], - parameterComponent?: string, +function getComponentMarkdownContent({ + properties, + parameterComponent, + maxLevel, + parameterComponentExtraProps, +}: { + properties: DeclarationReflection[] + parameterComponent?: string maxLevel?: number | undefined -) { + parameterComponentExtraProps?: Record +}) { const parameters = properties.map((property) => reflectionFormatter({ reflection: property, @@ -72,11 +80,11 @@ function getComponentMarkdownContent( }) ) - return `<${parameterComponent} parameters={${JSON.stringify( - parameters, - null, - 2 - )}} />` + return formatParameterComponent({ + parameterComponent, + componentItems: parameters as Parameter[], + extraProps: parameterComponentExtraProps, + }) } function getTableMarkdownContent( diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/type-parameter-component.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/type-parameter-component.ts index d29d71575ae59..c2b99279efab7 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/type-parameter-component.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/type-parameter-component.ts @@ -2,12 +2,13 @@ import * as Handlebars from "handlebars" import { TypeParameterReflection } from "typedoc" import { reflectionComponentFormatter } from "../../utils/reflection-formatter" import { MarkdownTheme } from "../../theme" +import { formatParameterComponent } from "../../utils/format-parameter-component" export default function (theme: MarkdownTheme) { Handlebars.registerHelper( "typeParameterComponent", function (this: TypeParameterReflection[]) { - const { parameterComponent, maxLevel } = + const { parameterComponent, maxLevel, parameterComponentExtraProps } = theme.getFormattingOptionsForLocation() const parameters = this.map((parameter) => reflectionComponentFormatter({ @@ -17,11 +18,11 @@ export default function (theme: MarkdownTheme) { }) ) - return `<${parameterComponent} parameters={${JSON.stringify( - parameters, - null, - 2 - )}} />` + return formatParameterComponent({ + parameterComponent, + componentItems: parameters, + extraProps: parameterComponentExtraProps, + }) } ) } 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 695a8c19c9dcc..1b4eb4b2b916f 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 @@ -70,7 +70,7 @@ {{incrementCurrentTitleLevel}} -{{> member.signature showSources=false parent=../type.declaration }} +{{> member.signature-wrapper showSources=false parent=../type.declaration }} {{decrementCurrentTitleLevel}} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.getterSetter.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.getterSetter.hbs index 0657dc1fbda8e..cc52c8af32f8f 100755 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.getterSetter.hbs +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.getterSetter.hbs @@ -4,7 +4,7 @@ {{#with getSignature}} -{{> member.signature accessor="get" showSources=true }} +{{> member.signature-wrapper accessor="get" showSources=true }} {{/with}} @@ -18,7 +18,7 @@ {{#with setSignature}} -{{> member.signature accessor="set" showSources=true }} +{{> member.signature-wrapper accessor="set" showSources=true }} {{/with}} 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 004ee436288e4..630d4ed779631 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 @@ -16,7 +16,7 @@ {{#each signatures}} -{{> member.signature showSources=true parent=.. }} +{{> member.signature-wrapper showSources=true parent=.. }} {{/each}} @@ -58,9 +58,11 @@ {{#unless @last}} {{#unless hasOwnDocument}} +{{#unless removeSeparator}} ___ {{/unless}} {{/unless}} +{{/unless}} {{#unless hasOwnDocument}} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.react-query.signature.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.react-query.signature.hbs new file mode 100644 index 0000000000000..b46093cbdda32 --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.react-query.signature.hbs @@ -0,0 +1,125 @@ +{{{signatureTitle accessor parent}}} + +{{#if (getFormattingOption "expandMembers")}} + +{{#if (hasMoreThanOneSignature parent)}} + +{{incrementCurrentTitleLevel}} + +{{/if}} + +{{/if}} + +{{#if (sectionEnabled "member_signature_comment")}} + +{{#with comment}} + +{{#if hasVisibleComponent}} + +{{{comments this true false}}} + +{{/if}} + +{{/with}} + +{{/if}} + +{{#if (sectionEnabled "member_signature_example")}} + +{{{example this}}} + +{{/if}} + +{{#if (sectionEnabled "member_signature_typeParameters")}} + +{{#if typeParameters}} + +{{{titleLevel}}} Type Parameters + +{{#with typeParameters}} + +{{{typeParameter}}} + +{{/with}} + +{{/if}} + +{{/if}} + +{{#if (sectionEnabled "member_signature_parameters")}} + +{{#ifHasHookParams}} + +{{{titleLevel}}} Hook Parameters + +{{{reactQueryHookParams}}} + +{{/ifHasHookParams}} + +{{#ifHasMutationParams}} + +{{{titleLevel}}} Mutation Function Parameters + +{{{reactQueryMutationParams}}} + +{{/ifHasMutationParams}} + +{{/if}} + +{{#ifShowReturns}} + +{{#ifHasMutationReturn}} + +{{{titleLevel}}} Mutation Function Returned Data + +{{{reactQueryMutationReturn}}} + +{{/ifHasMutationReturn}} + +{{#ifHasQueryReturn}} + +{{{titleLevel}}} Query Returned Data + +{{{reactQueryQueryReturn}}} + +{{/ifHasQueryReturn}} + +{{/ifShowReturns}} + +{{#if (sectionEnabled "member_signature_comment")}} + +{{#with comment}} + +{{#if hasVisibleComponent}} + +{{{comments this false true ..}}} + +{{/if}} + +{{/with}} + +{{/if}} + +{{#if (sectionEnabled "member_signature_sources")}} + +{{#if showSources}} + +{{incrementCurrentTitleLevel}} + +{{> member.sources}} + +{{decrementCurrentTitleLevel}} + +{{/if}} + +{{/if}} + +{{#if (getFormattingOption "expandMembers")}} + +{{#if (hasMoreThanOneSignature parent)}} + +{{decrementCurrentTitleLevel}} + +{{/if}} + +{{/if}} \ No newline at end of file diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature-wrapper.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature-wrapper.hbs new file mode 100644 index 0000000000000..b8620ae5d43a1 --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature-wrapper.hbs @@ -0,0 +1,9 @@ +{{#ifReactQueryType}} + +{{> member.react-query.signature}} + +{{else}} + +{{> member.signature}} + +{{/ifReactQueryType}} \ No newline at end of file diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature.hbs index fc3de65f07955..5c8f207bd1d3e 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature.hbs +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature.hbs @@ -90,7 +90,7 @@ {{#each declaration.signatures}} -{{> member.signature showSources=false parent=../declaration }} +{{> member.signature-wrapper showSources=false parent=../declaration }} {{/each}} 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 19279a9042879..4625f906dfab8 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,6 +4,10 @@ {{#each categories}} +{{#unless @first}} +___ +{{/unless}} + {{#unless allChildrenHaveOwnDocument}} {{#unless (getFormattingOption "expandMembers")}} @@ -18,7 +22,7 @@ {{#unless hasOwnDocument}} -{{> member}} +{{> member removeSeparator=true}} {{/unless}} 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 7f1e57e8b377e..f716dfc8acfc8 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 @@ -100,7 +100,7 @@ {{incrementCurrentTitleLevel}} -{{> member.signature showSources=true }} +{{> member.signature-wrapper showSources=true }} {{decrementCurrentTitleLevel}} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/theme.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/theme.ts index 9f0c04d63a7d2..95f2b225d6ccd 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/theme.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/theme.ts @@ -30,6 +30,7 @@ import { Mapping } from "./types" export class MarkdownTheme extends Theme { allReflectionsHaveOwnDocument!: string[] + allReflectionsHaveOwnDocumentInNamespace: string[] entryDocument: string entryPoints!: string[] filenameSeparator!: string @@ -66,6 +67,9 @@ export class MarkdownTheme extends Theme { // prettier-ignore this.allReflectionsHaveOwnDocument = this.getOption("allReflectionsHaveOwnDocument") as string[] + this.allReflectionsHaveOwnDocumentInNamespace = this.getOption( + "allReflectionsHaveOwnDocumentInNamespace" + ) as string[] this.entryDocument = this.getOption("entryDocument") as string this.entryPoints = this.getOption("entryPoints") as string[] this.filenameSeparator = this.getOption("filenameSeparator") as string @@ -143,14 +147,36 @@ export class MarkdownTheme extends Theme { return urls } + getAliasPath(reflection: Reflection): string { + return path.join( + reflection.parent && !reflection.parent.isProject() + ? this.getAliasPath(reflection.parent) + : "", + reflection.getAlias() + ) + } + buildUrls( reflection: DeclarationReflection, urls: UrlMapping[] ): UrlMapping[] { const mapping = this.getMappings( reflection, - reflection.parent?.isProject() ? "" : reflection.parent?.getAlias() - ).find((mapping) => reflection.kindOf(mapping.kind)) + reflection.parent?.isProject() || !reflection.parent + ? "" + : this.getAliasPath(reflection.parent) + ).find( + (mapping) => + reflection.kindOf(mapping.kind) && + mapping.modifiers.has.every( + (modifier) => reflection.comment?.hasModifier(modifier) || false + ) && + mapping.modifiers.not.every((modifier) => { + return reflection.comment + ? !reflection.comment.hasModifier(modifier) + : true + }) + ) if (mapping) { if (!reflection.url || !MarkdownTheme.URL_PREFIX.test(reflection.url)) { const url = this.toUrl(mapping, reflection) @@ -176,12 +202,23 @@ export class MarkdownTheme extends Theme { return ( mapping.directory + "/" + - this.getUrl(reflection) + + this.getUrl({ + reflection, + directory: mapping.directory, + }) + (this.mdxOutput ? ".mdx" : ".md") ) } - getUrl(reflection: Reflection, relative?: Reflection): string { + getUrl({ + reflection, + directory, + relative, + }: { + reflection: Reflection + directory: string + relative?: Reflection + }): string { let url = reflection.getAlias() if ( @@ -189,8 +226,15 @@ export class MarkdownTheme extends Theme { reflection.parent !== relative && !(reflection.parent instanceof ProjectReflection) ) { - url = - this.getUrl(reflection.parent, relative) + this.filenameSeparator + url + const urlPrefix = this.getUrl({ + reflection: reflection.parent, + directory, + relative, + }) + const fileNameSeparator = this.getFileNameSeparator( + `${directory}/${urlPrefix}` + ) + url = urlPrefix + fileNameSeparator + url } return url.replace(/^_/, "") @@ -280,11 +324,14 @@ export class MarkdownTheme extends Theme { } } - getModuleParents(reflection: DeclarationReflection): DeclarationReflection[] { + getParentsOfKind( + reflection: DeclarationReflection, + kind: ReflectionKind + ): DeclarationReflection[] { const parents: DeclarationReflection[] = [] let currentParent = reflection?.parent as DeclarationReflection | undefined do { - if (currentParent?.kind === ReflectionKind.Module) { + if (currentParent?.kind === kind) { parents.push(currentParent) } currentParent = currentParent?.parent as DeclarationReflection | undefined @@ -294,13 +341,30 @@ export class MarkdownTheme extends Theme { } getAllReflectionsHaveOwnDocument(reflection: DeclarationReflection): boolean { - const moduleParents = this.getModuleParents(reflection) + const moduleParents = this.getParentsOfKind( + reflection, + ReflectionKind.Module + ) + const namespaceParents = this.getParentsOfKind( + reflection, + ReflectionKind.Namespace + ) - return moduleParents.some((parent) => - this.allReflectionsHaveOwnDocument.includes(parent.name) + return ( + moduleParents.some((parent) => + this.allReflectionsHaveOwnDocument.includes(parent.name) + ) || + namespaceParents.some((parent) => + this.allReflectionsHaveOwnDocumentInNamespace.includes(parent.name) + ) ) } + getFileNameSeparator(pathPrefix: string): string { + const formattingOptions = this.getFormattingOptions(pathPrefix) + return formattingOptions.fileNameSeparator || this.filenameSeparator + } + getMappings( reflection: DeclarationReflection, directoryPrefix?: string @@ -308,36 +372,60 @@ export class MarkdownTheme extends Theme { return [ { kind: [ReflectionKind.Module], + modifiers: { + has: [], + not: [], + }, isLeaf: false, directory: path.join(directoryPrefix || "", "modules"), template: this.getReflectionTemplate(), }, { kind: [ReflectionKind.Namespace], + modifiers: { + has: [], + not: [], + }, isLeaf: false, - directory: path.join(directoryPrefix || "", "modules"), + directory: path.join(directoryPrefix || ""), template: this.getReflectionTemplate(), }, { kind: [ReflectionKind.Enum], + modifiers: { + has: [], + not: [], + }, isLeaf: false, directory: path.join(directoryPrefix || "", "enums"), template: this.getReflectionTemplate(), }, { kind: [ReflectionKind.Class], + modifiers: { + has: [], + not: [], + }, isLeaf: false, directory: path.join(directoryPrefix || "", "classes"), template: this.getReflectionTemplate(), }, { kind: [ReflectionKind.Interface], + modifiers: { + has: [], + not: [], + }, isLeaf: false, directory: path.join(directoryPrefix || "", "interfaces"), template: this.getReflectionTemplate(), }, { kind: [ReflectionKind.TypeAlias], + modifiers: { + has: [], + not: [], + }, isLeaf: true, directory: path.join(directoryPrefix || "", "types"), template: this.getReflectionMemberTemplate(), @@ -346,18 +434,30 @@ export class MarkdownTheme extends Theme { ? [ { kind: [ReflectionKind.Variable], + modifiers: { + has: [], + not: [], + }, isLeaf: true, directory: path.join(directoryPrefix || "", "variables"), template: this.getReflectionMemberTemplate(), }, { kind: [ReflectionKind.Function], + modifiers: { + has: [], + not: [], + }, isLeaf: true, directory: path.join(directoryPrefix || "", "functions"), template: this.getReflectionMemberTemplate(), }, { kind: [ReflectionKind.Method], + modifiers: { + has: [], + not: [], + }, isLeaf: true, directory: path.join(directoryPrefix || "", "methods"), template: this.getReflectionMemberTemplate(), @@ -393,6 +493,25 @@ export class MarkdownTheme extends Theme { page.model instanceof ProjectReflection ) { this.removeGroups(page.model) + this.removeCategories(page.model) + this.sortCategories(page.model) + } + + if ( + this.reflection instanceof DeclarationReflection && + this.reflection.parent instanceof ProjectReflection + ) { + const namespacesGroup = this.reflection.groups?.find( + (group) => group.title === "Namespaces" + ) + if (namespacesGroup) { + // remove the namespaces that have the `@namespaceMember` modifier + namespacesGroup.children = namespacesGroup.children.filter((child) => { + return child.comment + ? !child.comment.hasModifier("@namespaceMember") + : true + }) + } } if ( @@ -428,6 +547,34 @@ export class MarkdownTheme extends Theme { }) } + protected removeCategories( + model?: DeclarationReflection | ProjectReflection + ) { + if (!model?.categories) { + return + } + + const options = this.getFormattingOptionsForLocation() + + model.categories = model.categories.filter((category) => { + return ( + !options.reflectionCategories || + !(category.title in options.reflectionCategories) || + options.reflectionCategories[category.title] + ) + }) + } + + protected sortCategories(model?: DeclarationReflection | ProjectReflection) { + if (!model?.categories) { + return + } + + model.categories.sort((categoryA, categoryB) => { + return categoryA.title.localeCompare(categoryB.title) + }) + } + get globalsFile() { return `modules.${this.mdxOutput ? "mdx" : "md"}` } @@ -441,10 +588,14 @@ export class MarkdownTheme extends Theme { return {} } + return this.getFormattingOptions(this.location) + } + + getFormattingOptions(location: string): FormattingOptionType { const applicableOptions: FormattingOptionType[] = [] Object.keys(this.formattingOptions).forEach((key) => { - if (key === "*" || new RegExp(key).test(this.location)) { + if (key === "*" || new RegExp(key).test(location)) { applicableOptions.push(this.formattingOptions[key]) } }) diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/types.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/types.ts index 69e8c07d57fc0..db3e027806af6 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/types.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/types.ts @@ -16,6 +16,10 @@ export type ReflectionParameterType = export type Mapping = { kind: ReflectionKind[] + modifiers: { + has: `@${string}`[] + not: `@${string}`[] + } isLeaf: boolean directory: string template: (pageEvent: PageEvent) => string diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/format-parameter-component.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/format-parameter-component.ts new file mode 100644 index 0000000000000..8eb1e9d685b8b --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/format-parameter-component.ts @@ -0,0 +1,58 @@ +import { Parameter } from "../types" + +type FormatParameterComponentProps = { + parameterComponent: string | undefined + componentItems: Parameter[] + extraProps?: Record +} + +/** + * Function passed to an a Parameter array's sort method. It sorts + * parameter items by whether they're optional or not. So, required items + * are placed first in the array. + */ +function componentItemsSorter(a: Parameter, b: Parameter): number { + if (a.optional) { + return 1 + } + if (b.optional) { + return -1 + } + + return 0 +} + +/** + * Function that goes through items and their children to apply the + * {@link componentItemsSorter} function on them and sort the items. + */ +function sortComponentItems(items: Parameter[]): Parameter[] { + items.sort(componentItemsSorter) + items = items.map((item) => { + if (item.children) { + item.children = sortComponentItems(item.children) + } + + return item + }) + + return items +} + +export function formatParameterComponent({ + parameterComponent, + componentItems, + extraProps, +}: FormatParameterComponentProps): string { + let extraPropsArr: string[] = [] + if (extraProps) { + extraPropsArr = Object.entries(extraProps).map( + ([key, value]) => `${key}=${JSON.stringify(value)}` + ) + } + // reorder component items to show required items first + componentItems = sortComponentItems(componentItems) + return `<${parameterComponent} parameters={${JSON.stringify( + componentItems + )}} ${extraPropsArr.join(" ")}/>` +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/react-query-utils.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/react-query-utils.ts new file mode 100644 index 0000000000000..5f6ec63ca2f7e --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/react-query-utils.ts @@ -0,0 +1,263 @@ +import { + Comment, + ParameterReflection, + ProjectReflection, + ReferenceType, + SignatureReflection, + SomeType, +} from "typedoc" +import { Parameter } from "../types" +import { + GetReflectionTypeParametersParams, + getReflectionTypeParameters, +} from "./reflection-type-parameters" + +const MUTATION_PARAM_TYPE_NAME = "UseMutationOptions" +const MUTATION_RETURN_TYPE_NAME = "UseMutationResult" +const QUERY_PARAM_TYPE_NAME = "UseQueryOptionsWrapper" +const BLACKLISTED_PARAM_NAMES = ["constructor", "void"] + +export function isReactQueryMutation( + signatureReflection: SignatureReflection +): boolean { + return ( + signatureReflection.type?.type === "reference" && + signatureReflection.type.name === MUTATION_RETURN_TYPE_NAME + ) +} + +export function getReactQueryQueryParameterType( + signatureReflection: SignatureReflection +): ReferenceType | undefined { + let parameterType: ReferenceType | undefined + signatureReflection.parameters?.some((parameter) => { + if ( + parameter.type?.type === "reference" && + parameter.type.name === QUERY_PARAM_TYPE_NAME + ) { + parameterType = parameter.type + return true + } + + return false + }) + + return parameterType +} + +export function isReactQueryQuery( + signatureReflection: SignatureReflection +): boolean { + return getReactQueryQueryParameterType(signatureReflection) !== undefined +} + +/** + * Some parameter types are declared as classes which shows their constructor as + * an accepted parameter. This removes the constructor from the list of parameters. + */ +export function cleanUpParameterTypes(parameters: Parameter[]): Parameter[] { + return parameters.filter((parameter, index) => { + const keep = !BLACKLISTED_PARAM_NAMES.includes(parameter.name) + + if (keep && parameter.children) { + parameters[index].children = cleanUpParameterTypes(parameter.children) + } + + return keep + }) +} + +export function getHookParams( + signatureReflection: SignatureReflection +): ParameterReflection[] { + let hookParameters: ParameterReflection[] = [] + if (isReactQueryMutation(signatureReflection)) { + /** + * check parameters before the options parameter having the {@link MUTATION_PARAM_TYPE_NAME} type + */ + hookParameters = + signatureReflection.parameters?.filter((parameter) => { + return ( + parameter.type?.type !== "reference" || + parameter.type.name !== MUTATION_PARAM_TYPE_NAME + ) + }) || [] + } else if (isReactQueryQuery(signatureReflection)) { + /** + * check parameters before the options parameter having the {@link QUERY_PARAM_TYPE_NAME} type + */ + hookParameters = + signatureReflection.parameters?.filter((parameter) => { + return ( + parameter.type?.type !== "reference" || + parameter.type.name !== QUERY_PARAM_TYPE_NAME + ) + }) || [] + } + + return hookParameters +} + +/** + * Load comments of a type param from the signature's comments if it has the + * `@typeParamDefinition` tag. + */ +function loadTypeComments( + signatureReflection: SignatureReflection, + typeName: string +): Comment | undefined { + const tagRegex = /^(?\w+) - (?.*)$/ + const typeComment = new Comment() + signatureReflection.comment?.blockTags + .filter((tag) => tag.tag === "@typeParamDefinition") + .some((tag) => { + return tag.content.some((tagContent) => { + const match = tagContent.text.match(tagRegex) + if (match?.groups?.typeName === typeName && match?.groups?.typeDef) { + typeComment.summary.push({ + kind: "text", + text: match.groups.typeDef, + }) + + return true + } + + return false + }) + }) + + return typeComment.summary.length > 0 ? typeComment : undefined +} + +type GetMutationParamsParams = { + signatureReflection: SignatureReflection + project: ProjectReflection + reflectionTypeGetterOptions?: Partial +} + +type GetParamsOptions = GetMutationParamsParams & { + reflectionType: SomeType +} + +function getParams({ + signatureReflection, + reflectionType, + reflectionTypeGetterOptions, + ...rest +}: GetParamsOptions): Parameter[] { + const comment = + "name" in reflectionType + ? loadTypeComments(signatureReflection, reflectionType.name) + : reflectionTypeGetterOptions?.comment + + return cleanUpParameterTypes( + getReflectionTypeParameters({ + reflectionType, + comment, + isReturn: false, + ...reflectionTypeGetterOptions, + ...rest, + }) + ) +} + +export function getMutationParams({ + signatureReflection, + reflectionTypeGetterOptions, + project, +}: GetMutationParamsParams): Parameter[] { + let mutationParameters: Parameter[] = [] + if (isReactQueryMutation(signatureReflection)) { + const mutationOptionParam = signatureReflection.parameters?.find( + (parameter) => { + return ( + parameter.type?.type === "reference" && + parameter.type.name === MUTATION_PARAM_TYPE_NAME + ) + } + ) + + if ( + mutationOptionParam?.type?.type === "reference" && + (mutationOptionParam.type.typeArguments?.length || 0) >= 3 + ) { + mutationParameters = getParams({ + signatureReflection, + project, + reflectionType: mutationOptionParam.type.typeArguments![2], + reflectionTypeGetterOptions: { + ...reflectionTypeGetterOptions, + wrapObject: + mutationOptionParam.type.typeArguments![2].type === "reference", + }, + }) + } + } + + return mutationParameters +} + +export function hasResponseTypeArgument(type: ReferenceType): boolean { + return ( + (type.typeArguments?.length || 0) >= 1 && + type.typeArguments![0].type === "reference" && + type.typeArguments![0].name === "Response" && + (type.typeArguments![0].typeArguments?.length || 0) >= 1 + ) +} + +type GetMutationReturnParams = GetMutationParamsParams + +export function getMutationReturn({ + signatureReflection, + reflectionTypeGetterOptions, + project, +}: GetMutationReturnParams): Parameter[] { + let returnParams: Parameter[] = [] + if (!isReactQueryMutation(signatureReflection)) { + return returnParams + } + + const returnType = signatureReflection.type! as ReferenceType + + if (hasResponseTypeArgument(returnType)) { + returnParams = getParams({ + signatureReflection, + project, + reflectionType: (returnType.typeArguments![0] as ReferenceType) + .typeArguments![0], + reflectionTypeGetterOptions: { + ...reflectionTypeGetterOptions, + wrapObject: + (returnType.typeArguments![0] as ReferenceType).typeArguments![0] + .type === "reference", + }, + }) + } + + return returnParams +} + +type GetQueryReturnParams = GetMutationParamsParams + +export function getQueryReturn({ + signatureReflection, + reflectionTypeGetterOptions, + project, +}: GetQueryReturnParams): Parameter[] { + let returnParams: Parameter[] = [] + + const parameterType = getReactQueryQueryParameterType(signatureReflection) + + if (parameterType && hasResponseTypeArgument(parameterType)) { + returnParams = getParams({ + signatureReflection, + project, + reflectionType: (parameterType.typeArguments![0] as ReferenceType) + .typeArguments![0], + reflectionTypeGetterOptions, + }) + } + + return returnParams +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-formatter.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-formatter.ts index 45648f14886c1..b14d49d3abae5 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-formatter.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-formatter.ts @@ -85,7 +85,10 @@ export function reflectionListFormatter({ ) { const children = hasChildren ? reflection.children - : getTypeChildren(reflection.type!, reflection.project) + : getTypeChildren({ + reflectionType: reflection.type!, + project: reflection.project, + }) const itemChildren: string[] = [] let itemChildrenKind: ReflectionKind | null = null children?.forEach((childItem: DeclarationReflection) => { @@ -156,7 +159,11 @@ export function reflectionComponentFormatter({ ) { const children = hasChildren ? reflection.children - : getTypeChildren(reflection.type!, project || reflection.project) + : getTypeChildren({ + reflectionType: reflection.type!, + project: project || reflection.project, + maxLevel, + }) children ?.filter((childItem: DeclarationReflection) => diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-template-strings.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-template-strings.ts index 7ed3f3345496e..c3b2b19dc45b4 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-template-strings.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-template-strings.ts @@ -10,6 +10,16 @@ export function replaceTemplateVariables( return text .replaceAll("{{alias}}", reflection.getAlias()) + .replaceAll("{{alias-lower}}", reflection.getAlias().toLowerCase()) + .replaceAll("{{parent.alias}}", reflection.parent?.getAlias() || "") + .replaceAll( + "{{parent.alias-lower}}", + reflection.parent?.getAlias().toLowerCase() || "" + ) + .replaceAll( + "{{parent.parent.alias}}", + reflection.parent?.parent?.getAlias() || "" + ) .replaceAll("{{kind}}", getKindAsText(reflection.kind)) } diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/return-reflection-formatter.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-type-parameters.ts similarity index 53% rename from docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/return-reflection-formatter.ts rename to docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-type-parameters.ts index 6139d1eea06f9..e56b6dca81b54 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/return-reflection-formatter.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-type-parameters.ts @@ -15,21 +15,25 @@ import { import { MarkdownTheme } from "../theme" import { getProjectChild, getType, getTypeChildren } from "utils" -type ReturnReflectionComponentFormatterParams = { +export type GetReflectionTypeParametersParams = { reflectionType: SomeType project: ProjectReflection comment?: Comment - level: number + level?: number maxLevel?: number | undefined + wrapObject?: boolean + isReturn?: boolean } -export function returnReflectionComponentFormatter({ +export function getReflectionTypeParameters({ reflectionType, project, comment, level = 1, maxLevel, -}: ReturnReflectionComponentFormatterParams): Parameter[] { + wrapObject = false, + isReturn = true, +}: GetReflectionTypeParametersParams): Parameter[] { const typeName = getType({ reflectionType, collapse: "object", @@ -39,11 +43,6 @@ export function returnReflectionComponentFormatter({ project, getRelativeUrlMethod: Handlebars.helpers.relativeURL, }) - // if ( - // typeName === "Record<string, unknown> \\| PaymentProcessorError" - // ) { - // console.log(reflectionType) - // } const type = getType({ reflectionType: reflectionType, collapse: "object", @@ -51,28 +50,39 @@ export function returnReflectionComponentFormatter({ escape: true, getRelativeUrlMethod: Handlebars.helpers.relativeURL, }) + + const formatParameter = () => { + return { + name: "name" in reflectionType ? reflectionType.name : typeName, + type, + optional: + "flags" in reflectionType + ? (reflectionType.flags as ReflectionFlags).isOptional + : false, + defaultValue: + "declaration" in reflectionType + ? getDefaultValue( + reflectionType.declaration as DeclarationReflection + ) || "" + : "", + description: comment + ? isReturn + ? getReturnComment(comment) + : Handlebars.helpers.comment(comment.summary) + : !comment && !isReturn + ? loadComment(typeName, project) + : "", + expandable: comment?.hasModifier(`@expandable`) || false, + featureFlag: Handlebars.helpers.featureFlag(comment), + children: [], + } + } + const componentItem: Parameter[] = [] const canRetrieveChildren = level + 1 <= (maxLevel || MarkdownTheme.MAX_LEVEL) if (reflectionType.type === "reference") { if (reflectionType.typeArguments || reflectionType.refersToTypeParameter) { - const parentKey = componentItem.push({ - name: "name" in reflectionType ? reflectionType.name : typeName, - type, - optional: - "flags" in reflectionType - ? (reflectionType.flags as ReflectionFlags).isOptional - : false, - defaultValue: - "declaration" in reflectionType - ? getDefaultValue( - reflectionType.declaration as DeclarationReflection - ) || "" - : "", - description: comment ? getReturnComment(comment) : "", - expandable: comment?.hasModifier(`@expandable`) || false, - featureFlag: Handlebars.helpers.featureFlag(comment), - children: [], - }) + const parentKey = componentItem.push(formatParameter()) const typeArgs = reflectionType.typeArguments ? reflectionType.typeArguments : "typeParameters" in reflectionType @@ -89,7 +99,7 @@ export function returnReflectionComponentFormatter({ if (!reflectionTypeArg) { return } - const typeArgComponent = returnReflectionComponentFormatter({ + const typeArgComponent = getReflectionTypeParameters({ reflectionType: reflectionTypeArg, project, level: level + 1, @@ -102,75 +112,53 @@ export function returnReflectionComponentFormatter({ } else { const reflection = (reflectionType.reflection || getProjectChild(project, reflectionType.name)) as DeclarationReflection + const parentKey = wrapObject + ? componentItem.push(formatParameter()) + : undefined if (reflection) { const reflectionChildren = canRetrieveChildren ? reflection.children || - getTypeChildren(reflectionType, project, level) + getTypeChildren({ + reflectionType, + project, + level, + maxLevel, + }) : undefined if (reflectionChildren?.length) { reflectionChildren.forEach((childItem) => { - componentItem.push( - reflectionComponentFormatter({ - reflection: childItem as DeclarationReflection, - level, - maxLevel, - project, - }) - ) - }) - } else { - componentItem.push( - reflectionComponentFormatter({ - reflection, + const childParameter = reflectionComponentFormatter({ + reflection: childItem as DeclarationReflection, level, maxLevel, project, }) - ) + parentKey + ? componentItem[parentKey - 1].children?.push(childParameter) + : componentItem.push(childParameter) + }) + } else { + const childParameter = reflectionComponentFormatter({ + reflection, + level, + maxLevel, + project, + }) + + parentKey + ? componentItem[parentKey - 1].children?.push(childParameter) + : componentItem.push(childParameter) } } else { - componentItem.push({ - name: "name" in reflectionType ? reflectionType.name : typeName, - type, - optional: - "flags" in reflectionType - ? (reflectionType.flags as ReflectionFlags).isOptional - : false, - defaultValue: - "declaration" in reflectionType - ? getDefaultValue( - reflectionType.declaration as DeclarationReflection - ) || "" - : "", - description: comment ? getReturnComment(comment) : "", - expandable: comment?.hasModifier(`@expandable`) || false, - featureFlag: Handlebars.helpers.featureFlag(comment), - children: [], - }) + parentKey + ? componentItem[parentKey - 1].children?.push(formatParameter()) + : componentItem.push(formatParameter()) } } } else if (reflectionType.type === "array") { - const parentKey = componentItem.push({ - name: - "name" in reflectionType ? (reflectionType.name as string) : typeName, - type, - optional: - "flags" in reflectionType - ? (reflectionType.flags as ReflectionFlags).isOptional - : false, - defaultValue: - "declaration" in reflectionType - ? getDefaultValue( - reflectionType.declaration as DeclarationReflection - ) || "" - : "", - description: comment ? getReturnComment(comment) : "", - expandable: comment?.hasModifier(`@expandable`) || false, - featureFlag: Handlebars.helpers.featureFlag(comment), - children: [], - }) + const parentKey = componentItem.push(formatParameter()) if (canRetrieveChildren) { - const elementTypeItem = returnReflectionComponentFormatter({ + const elementTypeItem = getReflectionTypeParameters({ reflectionType: reflectionType.elementType, project, level: level + 1, @@ -181,32 +169,19 @@ export function returnReflectionComponentFormatter({ } else if (reflectionType.type === "tuple") { let pushTo: Parameter[] = [] if (level === 1) { - const parentKey = componentItem.push({ - name: - "name" in reflectionType ? (reflectionType.name as string) : typeName, - type, - optional: - "flags" in reflectionType - ? (reflectionType.flags as ReflectionFlags).isOptional - : false, - defaultValue: - "declaration" in reflectionType - ? getDefaultValue( - reflectionType.declaration as DeclarationReflection - ) || "" - : "", - description: comment ? getReturnComment(comment) : "", - expandable: comment?.hasModifier(`@expandable`) || false, - featureFlag: Handlebars.helpers.featureFlag(comment), - children: [], - }) + const parentKey = componentItem.push(formatParameter()) pushTo = componentItem[parentKey - 1].children! } else { - pushTo = componentItem + const parentKey = wrapObject + ? componentItem.push(formatParameter()) + : undefined + pushTo = parentKey + ? componentItem[parentKey - 1].children! + : componentItem } if (canRetrieveChildren) { reflectionType.elements.forEach((element) => { - const elementTypeItem = returnReflectionComponentFormatter({ + const elementTypeItem = getReflectionTypeParameters({ reflectionType: element, project, level: level + 1, @@ -215,24 +190,47 @@ export function returnReflectionComponentFormatter({ pushTo.push(...elementTypeItem) }) } + } else if (reflectionType.type === "intersection") { + const parentKey = wrapObject + ? componentItem.push(formatParameter()) + : undefined + reflectionType.types.forEach((childType) => { + const childParameter = getReflectionTypeParameters({ + reflectionType: childType, + project, + level: level + 1, + maxLevel, + }) + + parentKey + ? componentItem[parentKey - 1].children?.push(...childParameter) + : componentItem.push(...childParameter) + }) + } else if (reflectionType.type === "reflection") { + const parentKey = + type === "`object`" && typeName === "object" + ? undefined + : componentItem.push(formatParameter()) + reflectionType.declaration.children?.forEach((childItem) => { + const childParameter = reflectionComponentFormatter({ + reflection: childItem as DeclarationReflection, + level, + maxLevel, + project, + }) + + parentKey + ? componentItem[parentKey - 1].children?.push(childParameter) + : componentItem.push(childParameter) + }) } else { + const parentKey = wrapObject + ? componentItem.push(formatParameter()) + : undefined // put type as the only component. - componentItem.push({ - name: "name" in reflectionType ? reflectionType.name : typeName, - type, - optional: - "flags" in reflectionType - ? (reflectionType.flags as ReflectionFlags).isOptional - : true, - defaultValue: - "declaration" in reflectionType - ? getDefaultValue(reflectionType.declaration) || "" - : "", - description: comment ? getReturnComment(comment) : "", - expandable: comment?.hasModifier(`@expandable`) || false, - featureFlag: Handlebars.helpers.featureFlag(comment), - children: [], - }) + parentKey + ? componentItem[parentKey - 1].children?.push(formatParameter()) + : componentItem.push(formatParameter()) } return componentItem @@ -249,6 +247,23 @@ export function getReturnComment(comment: Comment): string { .join("\n\n") } +export function loadComment( + reflectionTypeName: string, + project: ProjectReflection +): string { + // try to load reflection from project + const reflection = getProjectChild(project, reflectionTypeName) + if (reflection) { + return ( + reflection.comment?.summary + .map((summaryPart) => summaryPart.text) + .join("\n\n") || "" + ) + } + + return "" +} + export function isOnlyVoid(reflectionTypes: SomeType[]) { return reflectionTypes.every( (type) => type.type === "intrinsic" && type.name === "void" diff --git a/docs-util/packages/types/lib/index.d.ts b/docs-util/packages/types/lib/index.d.ts index d7acc4eb39f5b..a0192232edaa2 100644 --- a/docs-util/packages/types/lib/index.d.ts +++ b/docs-util/packages/types/lib/index.d.ts @@ -50,9 +50,13 @@ export type FormattingOptionType = { reflectionGroups?: { [k: string]: boolean } + reflectionCategories?: { + [k: string]: boolean + } reflectionTitle?: { kind: boolean typeParameters: boolean + prefix?: string suffix?: string fullReplacement?: string } @@ -66,6 +70,7 @@ export type FormattingOptionType = { parameterComponentExtraProps?: Record mdxImports?: string[] maxLevel?: number + fileNameSeparator?: string } export declare module "typedoc" { @@ -178,5 +183,27 @@ export declare module "typedoc" { * @defaultValue true */ outputModules: boolean + /** + * Whether to enable category to namespace conversion. + * @defaultValue false + */ + generateNamespaces: boolean + /** + * Optionally specify a parent namespace to place all generated namespaces in. + */ + parentNamespace: string + /** + * Optionally specify a name prefix for all generated namespaces. + */ + namePrefix: string + /** + * Whether to enable the React Query manipulator. + * @defaultValue false + */ + enableReactQueryManipulator: boolean + /** + * Namespace names whose child members should have their own documents. + */ + allReflectionsHaveOwnDocumentInNamespace: string[] } } diff --git a/docs-util/packages/utils/src/get-type-children.ts b/docs-util/packages/utils/src/get-type-children.ts index 547c7193b5e27..1a31c7808be11 100644 --- a/docs-util/packages/utils/src/get-type-children.ts +++ b/docs-util/packages/utils/src/get-type-children.ts @@ -1,23 +1,37 @@ +/* eslint-disable no-case-declarations */ import { DeclarationReflection, ProjectReflection, SomeType } from "typedoc" import { getProjectChild } from "./get-project-child" -const MAX_LEVEL = 3 +type GetTypeChildrenOptions = { + reflectionType: SomeType + project: ProjectReflection | undefined + level?: number + maxLevel?: number +} -export function getTypeChildren( - reflectionType: SomeType, - project: ProjectReflection | undefined, - level = 1 -): DeclarationReflection[] { +export function getTypeChildren({ + reflectionType, + project, + level = 1, + maxLevel = 3, +}: GetTypeChildrenOptions): DeclarationReflection[] { let children: DeclarationReflection[] = [] - if (level > MAX_LEVEL) { + if (level > maxLevel) { return children } switch (reflectionType.type) { case "intersection": reflectionType.types.forEach((intersectionType) => { - children.push(...getTypeChildren(intersectionType, project, level + 1)) + children.push( + ...getTypeChildren({ + reflectionType: intersectionType, + project, + level: level + 1, + maxLevel, + }) + ) }) break case "reference": @@ -36,13 +50,16 @@ export function getTypeChildren( if (referencedReflection.children) { children = referencedReflection.children } else if (referencedReflection.type) { - children = getTypeChildren( - referencedReflection.type, + children = getTypeChildren({ + reflectionType: referencedReflection.type, project, - level + 1 - ) + level: level + 1, + maxLevel, + }) } } else if (reflectionType.typeArguments?.length) { + // Only useful if the reflection type is `Pick<...>`. + const toKeepChildren: string[] = [] reflectionType.typeArguments.forEach((typeArgument, index) => { if (reflectionType.name === "Omit" && index > 0) { switch (typeArgument.type) { @@ -54,23 +71,69 @@ export function getTypeChildren( if (childItem.type === "literal") { removeChild(childItem.value?.toString(), children) } else { - getTypeChildren(childItem, project, level + 1).forEach( - (child) => { - removeChild(child.name, children) - } - ) + getTypeChildren({ + reflectionType: childItem, + project, + level: level + 1, + maxLevel, + }).forEach((child) => { + removeChild(child.name, children) + }) } }) } + } else if (reflectionType.name === "Pick") { + if (index === 0 && !children.length) { + children = getTypeChildren({ + reflectionType: typeArgument, + project, + level: level + 1, + maxLevel, + }) + } else { + switch (typeArgument.type) { + case "literal": + if (typeArgument.value) { + toKeepChildren.push(typeArgument.value?.toString()) + } + break + case "union": + typeArgument.types.forEach((childItem) => { + if (childItem.type === "literal") { + if (childItem.value) { + toKeepChildren.push(childItem.value?.toString()) + } + } else { + getTypeChildren({ + reflectionType: childItem, + project, + level: level + 1, + maxLevel, + }).forEach((child) => { + if (child.name) { + toKeepChildren.push(child.name) + } + }) + } + }) + } + } } else { - const typeArgumentChildren = getTypeChildren( - typeArgument, + const typeArgumentChildren = getTypeChildren({ + reflectionType: typeArgument, project, - level + 1 - ) + level: level + 1, + maxLevel, + }) children.push(...typeArgumentChildren) } }) + + if (toKeepChildren.length) { + children = children.filter((child) => + toKeepChildren.includes(child.name) + ) + } } break case "reflection": @@ -79,7 +142,12 @@ export function getTypeChildren( ] break case "array": - children = getTypeChildren(reflectionType.elementType, project, level + 1) + children = getTypeChildren({ + reflectionType: reflectionType.elementType, + project, + level: level + 1, + maxLevel, + }) } return filterChildren(children) diff --git a/docs-util/typedoc-json-output/0-medusa.json b/docs-util/typedoc-json-output/0-medusa.json index e56eb238abf04..a35ce53f47438 100644 --- a/docs-util/typedoc-json-output/0-medusa.json +++ b/docs-util/typedoc-json-output/0-medusa.json @@ -14176,6 +14176,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customers to remove from the customer group." + } + ] + }, "children": [ { "id": 151, @@ -14190,6 +14198,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customers to remove from the customer group." + } + ] + }, "type": { "type": "reference", "target": 150, @@ -14611,6 +14627,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the prices to delete." + } + ] + }, "children": [ { "id": 1100, @@ -14625,6 +14649,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the prices to delete." + } + ] + }, "type": { "type": "reference", "target": 1099, @@ -14644,7 +14676,7 @@ "summary": [ { "kind": "text", - "text": "The price IDs of the Money Amounts to delete." + "text": "The IDs of the prices to delete." } ] }, @@ -14678,6 +14710,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products' prices to delete." + } + ] + }, "children": [ { "id": 1104, @@ -14692,6 +14732,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products' prices to delete." + } + ] + }, "type": { "type": "reference", "target": 1103, @@ -14869,6 +14917,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to delete from the product category." + } + ] + }, "children": [ { "id": 1228, @@ -14883,6 +14939,14 @@ "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, @@ -14902,7 +14966,7 @@ "summary": [ { "kind": "text", - "text": "The IDs of the products to delete from the Product Category." + "text": "The IDs of the products to delete from the product category." } ] }, @@ -14938,6 +15002,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to remove from the collection." + } + ] + }, "children": [ { "id": 106, @@ -14952,6 +15024,14 @@ "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, @@ -15005,6 +15085,14 @@ "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": 1512, @@ -15019,6 +15107,14 @@ "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": 1511, @@ -15074,6 +15170,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to delete from the sales channel." + } + ] + }, "children": [ { "id": 1720, @@ -15088,6 +15192,14 @@ "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": 1719, @@ -15107,7 +15219,7 @@ "summary": [ { "kind": "text", - "text": "The IDs of the products to remove from the Sales Channel." + "text": "The IDs of the products to remove from the sales channel." } ] }, @@ -15494,6 +15606,14 @@ "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": 1936, @@ -15508,6 +15628,14 @@ "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": 1935, @@ -15663,6 +15791,14 @@ "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": 1945, @@ -15677,6 +15813,14 @@ "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": 1944, @@ -15730,6 +15874,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to delete." + } + ] + }, "children": [ { "id": 2023, @@ -15744,6 +15896,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to delete." + } + ] + }, "type": { "type": "reference", "target": 2022, @@ -28589,6 +28749,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The admin's credentials used to log in." + } + ] + }, "children": [ { "id": 22, @@ -28603,6 +28771,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The admin's credentials used to log in." + } + ] + }, "type": { "type": "reference", "target": 21, @@ -28673,6 +28849,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the batch job to create." + } + ] + }, "children": [ { "id": 34, @@ -28687,6 +28871,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the batch job to create." + } + ] + }, "type": { "type": "reference", "target": 33, @@ -28793,6 +28985,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection's details to update." + } + ] + }, "children": [ { "id": 110, @@ -28807,6 +29007,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection's details to update." + } + ] + }, "type": { "type": "reference", "target": 109, @@ -28918,6 +29126,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection's details." + } + ] + }, "children": [ { "id": 83, @@ -28932,6 +29148,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection's details." + } + ] + }, "type": { "type": "reference", "target": 82, @@ -29041,6 +29265,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update in the currency" + } + ] + }, "children": [ { "id": 130, @@ -29055,6 +29287,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update in the currency" + } + ] + }, "type": { "type": "reference", "target": 129, @@ -29129,6 +29369,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customers to add to the customer group." + } + ] + }, "children": [ { "id": 142, @@ -29143,6 +29391,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customers to add to the customer group." + } + ] + }, "type": { "type": "reference", "target": 141, @@ -29198,6 +29454,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update in the customer group." + } + ] + }, "children": [ { "id": 173, @@ -29212,6 +29476,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update in the customer group." + } + ] + }, "type": { "type": "reference", "target": 172, @@ -29301,6 +29573,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the customer group to create." + } + ] + }, "children": [ { "id": 146, @@ -29315,6 +29595,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the customer group to create." + } + ] + }, "type": { "type": "reference", "target": 145, @@ -29402,6 +29690,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the customer to update." + } + ] + }, "children": [ { "id": 203, @@ -29416,6 +29712,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the customer to update." + } + ] + }, "type": { "type": "reference", "target": 202, @@ -29620,6 +29924,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the customer to create." + } + ] + }, "children": [ { "id": 185, @@ -29634,6 +29946,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the customer to create." + } + ] + }, "type": { "type": "reference", "target": 184, @@ -30456,6 +30776,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the resources to add." + } + ] + }, "children": [ { "id": 365, @@ -30470,6 +30798,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the resources to add." + } + ] + }, "type": { "type": "reference", "target": 364, @@ -30806,6 +31142,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the dynamic discount to create." + } + ] + }, "children": [ { "id": 279, @@ -30820,6 +31164,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the dynamic discount to create." + } + ] + }, "type": { "type": "reference", "target": 278, @@ -31052,6 +31404,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the discount to update." + } + ] + }, "children": [ { "id": 330, @@ -31066,6 +31426,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the discount to update." + } + ] + }, "type": { "type": "reference", "target": 329, @@ -31646,6 +32014,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the discount to create." + } + ] + }, "children": [ { "id": 244, @@ -31660,6 +32036,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the discount to create." + } + ] + }, "type": { "type": "reference", "target": 243, @@ -31932,6 +32316,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the line item." + } + ] + }, "children": [ { "id": 447, @@ -31946,6 +32338,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the line item." + } + ] + }, "type": { "type": "reference", "target": 446, @@ -32080,6 +32480,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the line item to create." + } + ] + }, "children": [ { "id": 415, @@ -32094,6 +32502,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the line item to create." + } + ] + }, "type": { "type": "reference", "target": 414, @@ -32249,6 +32665,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the draft order to update." + } + ] + }, "children": [ { "id": 436, @@ -32263,6 +32687,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the draft order to update." + } + ] + }, "type": { "type": "reference", "target": 435, @@ -32496,6 +32928,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the draft order to create." + } + ] + }, "children": [ { "id": 401, @@ -32510,6 +32950,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the draft order to create." + } + ] + }, "type": { "type": "reference", "target": 400, @@ -32829,6 +33277,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the gift card." + } + ] + }, "children": [ { "id": 477, @@ -32843,6 +33299,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the gift card." + } + ] + }, "type": { "type": "reference", "target": 476, @@ -33012,6 +33476,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the gift card to create." + } + ] + }, "children": [ { "id": 463, @@ -33026,6 +33498,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the gift card to create." + } + ] + }, "type": { "type": "reference", "target": 462, @@ -33982,6 +34462,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the location level to create." + } + ] + }, "children": [ { "id": 532, @@ -33996,6 +34484,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the location level to create." + } + ] + }, "type": { "type": "reference", "target": 531, @@ -34212,6 +34708,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the inventory item to create." + } + ] + }, "children": [ { "id": 510, @@ -34226,6 +34730,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the inventory item to create." + } + ] + }, "type": { "type": "reference", "target": 509, @@ -34880,6 +35392,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the note." + } + ] + }, "children": [ { "id": 648, @@ -34894,6 +35414,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the note." + } + ] + }, "type": { "type": "reference", "target": 647, @@ -34944,6 +35472,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the note to be created." + } + ] + }, "children": [ { "id": 636, @@ -34958,6 +35494,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the note to be created." + } + ] + }, "type": { "type": "reference", "target": 635, @@ -35048,6 +35592,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The resend details." + } + ] + }, "children": [ { "id": 672, @@ -35062,6 +35614,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The resend details." + } + ] + }, "type": { "type": "reference", "target": 671, @@ -35114,6 +35674,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to create or update of the line item change." + } + ] + }, "children": [ { "id": 723, @@ -35128,6 +35696,14 @@ "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, @@ -35178,6 +35754,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the line item change to create." + } + ] + }, "children": [ { "id": 688, @@ -35192,6 +35776,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the line item change to create." + } + ] + }, "type": { "type": "reference", "target": 687, @@ -35299,6 +35891,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the order edit." + } + ] + }, "children": [ { "id": 719, @@ -35313,6 +35913,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the order edit." + } + ] + }, "type": { "type": "reference", "target": 718, @@ -35365,6 +35973,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the order edit to create." + } + ] + }, "children": [ { "id": 694, @@ -35379,6 +35995,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the order edit to create." + } + ] + }, "type": { "type": "reference", "target": 693, @@ -38115,6 +38739,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the order refund." + } + ] + }, "children": [ { "id": 940, @@ -38129,6 +38761,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the order refund." + } + ] + }, "type": { "type": "reference", "target": 939, @@ -38243,6 +38883,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the order." + } + ] + }, "children": [ { "id": 979, @@ -38257,6 +38905,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the order." + } + ] + }, "type": { "type": "reference", "target": 978, @@ -38678,6 +39334,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the requested return." + } + ] + }, "children": [ { "id": 952, @@ -38692,6 +39356,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the requested return." + } + ] + }, "type": { "type": "reference", "target": 951, @@ -39006,6 +39678,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipment to create." + } + ] + }, "children": [ { "id": 847, @@ -39020,6 +39700,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipment to create." + } + ] + }, "type": { "type": "reference", "target": 846, @@ -39627,6 +40315,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the swap to create." + } + ] + }, "children": [ { "id": 858, @@ -39641,6 +40337,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the swap to create." + } + ] + }, "type": { "type": "reference", "target": 857, @@ -40597,6 +41301,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the refund to create." + } + ] + }, "children": [ { "id": 1029, @@ -40611,6 +41323,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the refund to create." + } + ] + }, "type": { "type": "reference", "target": 1028, @@ -40708,6 +41428,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the prices to add." + } + ] + }, "children": [ { "id": 1083, @@ -40722,6 +41450,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the prices to add." + } + ] + }, "type": { "type": "reference", "target": 1082, @@ -40799,6 +41535,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the payment collection." + } + ] + }, "children": [ { "id": 1147, @@ -40813,6 +41557,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the payment collection." + } + ] + }, "type": { "type": "reference", "target": 1146, @@ -41105,6 +41857,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the price list to create." + } + ] + }, "children": [ { "id": 1088, @@ -41119,6 +41879,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the price list to create." + } + ] + }, "type": { "type": "reference", "target": 1087, @@ -41633,6 +42401,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to add to the product category." + } + ] + }, "children": [ { "id": 1219, @@ -41647,6 +42423,14 @@ "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, @@ -41666,7 +42450,7 @@ "summary": [ { "kind": "text", - "text": "The IDs of the products to add to the Product Category" + "text": "The IDs of the products to add to the product category" } ] }, @@ -41702,6 +42486,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the product category." + } + ] + }, "children": [ { "id": 1203, @@ -41716,6 +42508,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the product category." + } + ] + }, "type": { "type": "reference", "target": 1202, @@ -42113,6 +42913,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product category to create." + } + ] + }, "children": [ { "id": 1188, @@ -42127,6 +42935,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product category to create." + } + ] + }, "type": { "type": "reference", "target": 1187, @@ -42524,6 +43340,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product option to create." + } + ] + }, "children": [ { "id": 1349, @@ -42538,6 +43362,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product option to create." + } + ] + }, "type": { "type": "reference", "target": 1348, @@ -42588,6 +43420,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the product." + } + ] + }, "children": [ { "id": 1450, @@ -42602,6 +43442,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the product." + } + ] + }, "type": { "type": "reference", "target": 1449, @@ -43214,6 +44062,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product variant to create." + } + ] + }, "children": [ { "id": 1381, @@ -43228,6 +44084,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product variant to create." + } + ] + }, "type": { "type": "reference", "target": 1380, @@ -44188,6 +45052,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product to create." + } + ] + }, "children": [ { "id": 1353, @@ -44202,6 +45074,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product to create." + } + ] + }, "type": { "type": "reference", "target": 1352, @@ -44851,6 +45731,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to add to the collection." + } + ] + }, "children": [ { "id": 79, @@ -44865,6 +45753,14 @@ "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, @@ -44918,6 +45814,14 @@ "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, @@ -44932,6 +45836,14 @@ "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, @@ -44987,6 +45899,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the publishable API key." + } + ] + }, "children": [ { "id": 1538, @@ -45001,6 +45921,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the publishable API key." + } + ] + }, "type": { "type": "reference", "target": 1537, @@ -45053,6 +45981,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the publishable API key to create." + } + ] + }, "children": [ { "id": 1534, @@ -45067,6 +46003,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the publishable API key to create." + } + ] + }, "type": { "type": "reference", "target": 1533, @@ -45117,6 +46061,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the country to add to the region." + } + ] + }, "children": [ { "id": 1560, @@ -45131,6 +46083,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the country to add to the region." + } + ] + }, "type": { "type": "reference", "target": 1559, @@ -45181,6 +46141,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the fulfillment provider to add to the region." + } + ] + }, "children": [ { "id": 1564, @@ -45195,6 +46163,14 @@ "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": 1563, @@ -45245,6 +46221,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment provider to add to the region." + } + ] + }, "children": [ { "id": 1568, @@ -45259,6 +46243,14 @@ "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": 1567, @@ -45309,6 +46301,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the regions." + } + ] + }, "children": [ { "id": 1595, @@ -45323,6 +46323,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the regions." + } + ] + }, "type": { "type": "reference", "target": 1594, @@ -45664,6 +46672,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the region to create." + } + ] + }, "children": [ { "id": 1572, @@ -45678,6 +46694,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the region to create." + } + ] + }, "type": { "type": "reference", "target": 1571, @@ -45932,6 +46956,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the reservation to create." + } + ] + }, "children": [ { "id": 1671, @@ -45946,6 +46978,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the reservation to create." + } + ] + }, "type": { "type": "reference", "target": 1670, @@ -46117,6 +47157,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the reservation." + } + ] + }, "children": [ { "id": 1695, @@ -46131,6 +47179,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the reservation." + } + ] + }, "type": { "type": "reference", "target": 1694, @@ -46264,6 +47320,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the return reason." + } + ] + }, "children": [ { "id": 1627, @@ -46278,6 +47342,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the return reason." + } + ] + }, "type": { "type": "reference", "target": 1626, @@ -46411,6 +47483,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the return reason to create." + } + ] + }, "children": [ { "id": 1619, @@ -46425,6 +47505,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the return reason to create." + } + ] + }, "type": { "type": "reference", "target": 1618, @@ -46576,6 +47664,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the received return." + } + ] + }, "children": [ { "id": 1652, @@ -46590,6 +47686,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the received return." + } + ] + }, "type": { "type": "reference", "target": 1651, @@ -46689,6 +47793,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to add to the sales channel." + } + ] + }, "children": [ { "id": 1710, @@ -46703,6 +47815,14 @@ "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": 1709, @@ -46722,7 +47842,7 @@ "summary": [ { "kind": "text", - "text": "The IDs of the products to add to the Sales Channel" + "text": "The IDs of the products to add to the sales channel" } ] }, @@ -46822,6 +47942,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the sales channel to create." + } + ] + }, "children": [ { "id": 1714, @@ -46836,6 +47964,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the sales channel to create." + } + ] + }, "type": { "type": "reference", "target": 1713, @@ -46928,6 +48064,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the sales channel." + } + ] + }, "children": [ { "id": 1740, @@ -46942,6 +48086,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the sales channel." + } + ] + }, "type": { "type": "reference", "target": 1739, @@ -47038,6 +48190,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the shipping option." + } + ] + }, "children": [ { "id": 1783, @@ -47052,6 +48212,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the shipping option." + } + ] + }, "type": { "type": "reference", "target": 1782, @@ -47271,6 +48439,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping option to create." + } + ] + }, "children": [ { "id": 1762, @@ -47285,6 +48461,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping option to create." + } + ] + }, "type": { "type": "reference", "target": 1761, @@ -47633,6 +48817,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The detail to update of the shipping profile." + } + ] + }, "children": [ { "id": 1808, @@ -47647,6 +48839,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The detail to update of the shipping profile." + } + ] + }, "type": { "type": "reference", "target": 1807, @@ -47813,6 +49013,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping profile to create." + } + ] + }, "children": [ { "id": 1802, @@ -47827,6 +49035,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping profile to create." + } + ] + }, "type": { "type": "reference", "target": 1801, @@ -48063,6 +49279,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the stock location." + } + ] + }, "children": [ { "id": 1854, @@ -48077,6 +49301,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the stock location." + } + ] + }, "type": { "type": "reference", "target": 1853, @@ -48336,6 +49568,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the stock location to create." + } + ] + }, "children": [ { "id": 1825, @@ -48350,6 +49590,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the stock location to create." + } + ] + }, "type": { "type": "reference", "target": 1824, @@ -48483,6 +49731,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the store." + } + ] + }, "children": [ { "id": 1879, @@ -48497,6 +49753,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the store." + } + ] + }, "type": { "type": "reference", "target": 1878, @@ -48801,6 +50065,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the tax rate to create." + } + ] + }, "children": [ { "id": 1981, @@ -48815,6 +50087,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the tax rate to create." + } + ] + }, "type": { "type": "reference", "target": 1980, @@ -49400,6 +50680,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to associat with the tax rate." + } + ] + }, "children": [ { "id": 1963, @@ -49414,6 +50702,14 @@ "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": 1962, @@ -49467,6 +50763,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the tax rate." + } + ] + }, "children": [ { "id": 1996, @@ -49481,6 +50785,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the tax rate." + } + ] + }, "type": { "type": "reference", "target": 1995, @@ -49785,6 +51097,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping options to associate with the tax rate." + } + ] + }, "children": [ { "id": 1972, @@ -49799,6 +51119,14 @@ "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": 1971, @@ -49852,6 +51180,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to retrieve its download URL." + } + ] + }, "children": [ { "id": 2027, @@ -49866,6 +51202,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to retrieve its download URL." + } + ] + }, "type": { "type": "reference", "target": 2026, @@ -50651,6 +51995,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the password reset request." + } + ] + }, "children": [ { "id": 2046, @@ -50665,6 +52017,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the password reset request." + } + ] + }, "type": { "type": "reference", "target": 2045, @@ -50757,6 +52117,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the password reset token request." + } + ] + }, "children": [ { "id": 2052, @@ -50771,6 +52139,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the password reset token request." + } + ] + }, "type": { "type": "reference", "target": 2051, @@ -50991,6 +52367,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the payment collection." + } + ] + }, "children": [ { "id": 1012, @@ -51005,6 +52389,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the payment collection." + } + ] + }, "type": { "type": "reference", "target": 1011, @@ -66506,6 +67898,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment session to manage." + } + ] + }, "children": [ { "id": 2373, @@ -66520,6 +67920,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment session to manage." + } + ] + }, "type": { "type": "reference", "target": 2372, @@ -66829,6 +68237,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the line item." + } + ] + }, "children": [ { "id": 2188, @@ -66843,6 +68259,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the line item." + } + ] + }, "type": { "type": "reference", "target": 2187, @@ -66930,6 +68354,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the line item to create." + } + ] + }, "children": [ { "id": 2165, @@ -66944,6 +68376,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the line item to create." + } + ] + }, "type": { "type": "reference", "target": 2164, @@ -67051,6 +68491,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment session to set." + } + ] + }, "children": [ { "id": 2171, @@ -67065,6 +68513,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment session to set." + } + ] + }, "type": { "type": "reference", "target": 2170, @@ -67194,6 +68650,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the cart." + } + ] + }, "children": [ { "id": 2175, @@ -67208,6 +68672,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the cart." + } + ] + }, "type": { "type": "reference", "target": 2174, @@ -67490,6 +68962,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping method to add to the cart." + } + ] + }, "children": [ { "id": 2147, @@ -67504,6 +68984,14 @@ "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": 2146, @@ -67592,6 +69080,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details necessary to grant order access." + } + ] + }, "children": [ { "id": 2327, @@ -67606,6 +69102,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details necessary to grant order access." + } + ] + }, "type": { "type": "reference", "target": 2326, @@ -68096,6 +69600,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the orders to claim." + } + ] + }, "children": [ { "id": 2343, @@ -68110,6 +69622,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the orders to claim." + } + ] + }, "type": { "type": "reference", "target": 2342, @@ -68227,6 +69747,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the customer." + } + ] + }, "children": [ { "id": 2296, @@ -68241,6 +69769,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the customer." + } + ] + }, "type": { "type": "reference", "target": 2295, @@ -68451,6 +69987,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the customer to create." + } + ] + }, "children": [ { "id": 2236, @@ -68465,6 +70009,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the customer to create." + } + ] + }, "type": { "type": "reference", "target": 2235, @@ -68701,6 +70253,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the order edit's decline." + } + ] + }, "children": [ { "id": 2316, @@ -68715,6 +70275,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the order edit's decline." + } + ] + }, "type": { "type": "reference", "target": 2315, @@ -68767,6 +70335,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment sessions to authorize." + } + ] + }, "children": [ { "id": 2354, @@ -68781,6 +70357,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment sessions to authorize." + } + ] + }, "type": { "type": "reference", "target": 2353, @@ -68834,6 +70418,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment sessions to manage." + } + ] + }, "children": [ { "id": 2369, @@ -68848,6 +70440,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment sessions to manage." + } + ] + }, "type": { "type": "reference", "target": 2368, @@ -69009,6 +70609,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the return to create." + } + ] + }, "children": [ { "id": 2566, @@ -69023,6 +70631,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the return to create." + } + ] + }, "type": { "type": "reference", "target": 2565, @@ -69254,6 +70870,14 @@ "variant": "declaration", "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the swap to create." + } + ] + }, "children": [ { "id": 2589, @@ -69268,6 +70892,14 @@ "variant": "signature", "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the swap to create." + } + ] + }, "type": { "type": "reference", "target": 2588, @@ -70737,7 +72369,15 @@ "summary": [ { "kind": "text", - "text": "The response returned for a DELETE request." + "text": "The response returned for a " + }, + { + "kind": "code", + "text": "`DELETE`" + }, + { + "kind": "text", + "text": " request." } ] }, @@ -87204,7 +88844,12 @@ "kind": 2097152, "flags": {}, "comment": { - "summary": [], + "summary": [ + { + "kind": "text", + "text": "The payment collection's details." + } + ], "modifierTags": [ "@interface" ] @@ -90343,6 +91988,14 @@ "variant": "declaration", "kind": 1024, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of stock locations." + } + ] + }, "type": { "type": "array", "elementType": { @@ -103914,7 +105567,12 @@ "kind": 2097152, "flags": {}, "comment": { - "summary": [], + "summary": [ + { + "kind": "text", + "text": "The details of the payment session." + } + ], "modifierTags": [ "@interface" ] diff --git a/docs-util/typedoc-json-output/0-types.json b/docs-util/typedoc-json-output/0-types.json index 2555cf63300e6..b35c159a50d55 100644 --- a/docs-util/typedoc-json-output/0-types.json +++ b/docs-util/typedoc-json-output/0-types.json @@ -1449,7 +1449,7 @@ "extendedBy": [ { "type": "reference", - "target": 1290, + "target": 1335, "name": "ProductCategoryTransformOptions" } ] @@ -1767,13 +1767,13 @@ "types": [ { "type": "reference", - "target": 497, + "target": 525, "name": "InternalModuleDeclaration", "package": "@medusajs/types" }, { "type": "reference", - "target": 507, + "target": 535, "name": "ExternalModuleDeclaration", "package": "@medusajs/types" } @@ -1895,6 +1895,81 @@ } } }, + { + "id": 210, + "name": "ContainerLike", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 211, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 212, + "name": "resolve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 213, + "name": "resolve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "typeParameter": [ + { + "id": 214, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "parameters": [ + { + "id": 215, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 212 + ] + } + ] + } + } + }, { "id": 108, "name": "DeleteResponse", @@ -2918,7 +2993,7 @@ }, "type": { "type": "reference", - "target": 1302, + "target": 1347, "name": "SessionOptions", "package": "@medusajs/types" } @@ -3752,6 +3827,7 @@ "title": "Type Aliases", "children": [ 190, + 210, 108, 59, 163, @@ -3772,220 +3848,86 @@ ] }, { - "id": 210, - "name": "DAL", + "id": 216, + "name": "CustomerTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { "id": 217, - "name": "BaseFilterable", + "name": "CustomerDTO", "variant": "declaration", "kind": 256, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object used to allow specifying flexible queries with and/or conditions." - } - ] - }, "children": [ { - "id": 218, - "name": "$and", + "id": 224, + "name": "billing_address", "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": -1, - "name": "T", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 217, - "typeArguments": [ - { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } + "type": "reference", + "target": 1, + "name": "AddressDTO", + "package": "@medusajs/types" } }, { - "id": 219, - "name": "$or", + "id": 220, + "name": "billing_address_id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, - "comment": { - "summary": [ + "type": { + "type": "union", + "types": [ { - "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": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" } ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 217, - "typeArguments": [ - { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 218, - 219 - ] - } - ], - "typeParameters": [ - { - "id": 220, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 971, - "name": "FilterableCurrencyProps" - }, - { - "type": "reference", - "target": 996, - "name": "FilterableMoneyAmountProps" - }, - { - "type": "reference", - "target": 1026, - "name": "FilterablePriceRuleProps" - }, - { - "type": "reference", - "target": 1097, - "name": "FilterablePriceSetProps" - }, - { - "type": "reference", - "target": 1120, - "name": "FilterablePriceSetMoneyAmountProps" - }, - { - "type": "reference", - "target": 1140, - "name": "FilterablePriceSetMoneyAmountRulesProps" - }, - { - "type": "reference", - "target": 1159, - "name": "FilterablePriceSetRuleTypeProps" - }, - { - "type": "reference", - "target": 1180, - "name": "FilterableRuleTypeProps" - }, - { - "type": "reference", - "target": 1231, - "name": "FilterablePriceListProps" - }, - { - "type": "reference", - "target": 1239, - "name": "FilterablePriceListRuleProps" }, { - "type": "reference", - "target": 1246, - "name": "FilterablePriceListRuleValueProps" - } - ] - }, - { - "id": 221, - "name": "OptionsQuery", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 226, - "name": "fields", + "id": 236, + "name": "created_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } + "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": 228, - "name": "filters", + "id": 235, + "name": "deleted_at", "variant": "declaration", "kind": 1024, "flags": { @@ -3996,10 +3938,559 @@ "types": [ { "type": "intrinsic", - "name": "boolean" + "name": "string" }, { - "type": "array", + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 219, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 222, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 228, + "name": "groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 229, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 230, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 230 + ] + } + ] + } + } + } + }, + { + "id": 227, + "name": "has_account", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 218, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 223, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 234, + "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": 231, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 232, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 233, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 233 + ] + } + ] + } + } + } + }, + { + "id": 226, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 225, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1, + "name": "AddressDTO", + "package": "@medusajs/types" + } + }, + { + "id": 221, + "name": "shipping_address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 237, + "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": [ + 224, + 220, + 236, + 235, + 219, + 222, + 228, + 227, + 218, + 223, + 234, + 231, + 226, + 225, + 221, + 237 + ] + } + ] + } + ], + "groups": [ + { + "title": "Interfaces", + "children": [ + 217 + ] + } + ] + }, + { + "id": 238, + "name": "DAL", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 245, + "name": "BaseFilterable", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 246, + "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": -1, + "name": "T", + "refersToTypeParameter": true + }, + { + "type": "reference", + "target": 245, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + } + }, + { + "id": 247, + "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": -1, + "name": "T", + "refersToTypeParameter": true + }, + { + "type": "reference", + "target": 245, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 246, + 247 + ] + } + ], + "typeParameters": [ + { + "id": 248, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 1011, + "name": "FilterableCurrencyProps" + }, + { + "type": "reference", + "target": 1036, + "name": "FilterableMoneyAmountProps" + }, + { + "type": "reference", + "target": 1068, + "name": "FilterablePriceRuleProps" + }, + { + "type": "reference", + "target": 1139, + "name": "FilterablePriceSetProps" + }, + { + "type": "reference", + "target": 1163, + "name": "FilterablePriceSetMoneyAmountProps" + }, + { + "type": "reference", + "target": 1183, + "name": "FilterablePriceSetMoneyAmountRulesProps" + }, + { + "type": "reference", + "target": 1202, + "name": "FilterablePriceSetRuleTypeProps" + }, + { + "type": "reference", + "target": 1223, + "name": "FilterableRuleTypeProps" + }, + { + "type": "reference", + "target": 1276, + "name": "FilterablePriceListProps" + }, + { + "type": "reference", + "target": 1284, + "name": "FilterablePriceListRuleProps" + }, + { + "type": "reference", + "target": 1291, + "name": "FilterablePriceListRuleValueProps" + } + ] + }, + { + "id": 249, + "name": "OptionsQuery", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 254, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 256, + "name": "filters", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "array", "elementType": { "type": "intrinsic", "name": "string" @@ -4007,7 +4498,7 @@ }, { "type": "reference", - "target": 1335, + "target": 1380, "typeArguments": [ { "type": "union", @@ -4018,7 +4509,7 @@ }, { "type": "reference", - "target": 1335, + "target": 1380, "name": "Dictionary", "package": "@medusajs/types" } @@ -4032,7 +4523,7 @@ } }, { - "id": 227, + "id": 255, "name": "groupBy", "variant": "declaration", "kind": 1024, @@ -4057,7 +4548,7 @@ } }, { - "id": 224, + "id": 252, "name": "limit", "variant": "declaration", "kind": 1024, @@ -4070,7 +4561,7 @@ } }, { - "id": 225, + "id": 253, "name": "offset", "variant": "declaration", "kind": 1024, @@ -4083,7 +4574,7 @@ } }, { - "id": 223, + "id": 251, "name": "orderBy", "variant": "declaration", "kind": 1024, @@ -4095,7 +4586,7 @@ "types": [ { "type": "reference", - "target": 1333, + "target": 1378, "typeArguments": [ { "type": "reference", @@ -4111,7 +4602,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1333, + "target": 1378, "typeArguments": [ { "type": "reference", @@ -4128,7 +4619,7 @@ } }, { - "id": 222, + "id": 250, "name": "populate", "variant": "declaration", "kind": 1024, @@ -4148,26 +4639,26 @@ { "title": "Properties", "children": [ - 226, - 228, - 227, - 224, - 225, - 223, - 222 + 254, + 256, + 255, + 252, + 253, + 251, + 250 ] } ], "typeParameters": [ { - "id": 229, + "id": 257, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 230, + "id": 258, "name": "P", "variant": "typeParam", "kind": 131072, @@ -4184,7 +4675,7 @@ ] }, { - "id": 236, + "id": 264, "name": "RepositoryService", "variant": "declaration", "kind": 256, @@ -4199,21 +4690,21 @@ }, "children": [ { - "id": 245, + "id": 273, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 246, + "id": 274, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 247, + "id": 275, "name": "data", "variant": "param", "kind": 32768, @@ -4227,7 +4718,7 @@ } }, { - "id": 248, + "id": 276, "name": "context", "variant": "param", "kind": 32768, @@ -4236,7 +4727,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -4266,21 +4757,21 @@ ] }, { - "id": 253, + "id": 281, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 254, + "id": 282, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 255, + "id": 283, "name": "ids", "variant": "param", "kind": 32768, @@ -4294,7 +4785,7 @@ } }, { - "id": 256, + "id": 284, "name": "context", "variant": "param", "kind": 32768, @@ -4303,7 +4794,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -4328,21 +4819,21 @@ ] }, { - "id": 237, + "id": 265, "name": "find", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 238, + "id": 266, "name": "find", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 239, + "id": 267, "name": "options", "variant": "param", "kind": 32768, @@ -4351,7 +4842,7 @@ }, "type": { "type": "reference", - "target": 231, + "target": 259, "typeArguments": [ { "type": "reference", @@ -4365,7 +4856,7 @@ } }, { - "id": 240, + "id": 268, "name": "context", "variant": "param", "kind": 32768, @@ -4374,7 +4865,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -4404,21 +4895,21 @@ ] }, { - "id": 241, + "id": 269, "name": "findAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 242, + "id": 270, "name": "findAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 243, + "id": 271, "name": "options", "variant": "param", "kind": 32768, @@ -4427,7 +4918,7 @@ }, "type": { "type": "reference", - "target": 231, + "target": 259, "typeArguments": [ { "type": "reference", @@ -4441,7 +4932,7 @@ } }, { - "id": 244, + "id": 272, "name": "context", "variant": "param", "kind": 32768, @@ -4450,7 +4941,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -4489,21 +4980,21 @@ ] }, { - "id": 280, + "id": 308, "name": "getActiveManager", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 281, + "id": 309, "name": "getActiveManager", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 282, + "id": 310, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -4522,33 +5013,33 @@ }, "inheritedFrom": { "type": "reference", - "target": 1357, + "target": 1402, "name": "BaseRepositoryService.getActiveManager" } } ], "inheritedFrom": { "type": "reference", - "target": 1356, + "target": 1401, "name": "BaseRepositoryService.getActiveManager" } }, { - "id": 277, + "id": 305, "name": "getFreshManager", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 278, + "id": 306, "name": "getFreshManager", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 279, + "id": 307, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -4567,33 +5058,33 @@ }, "inheritedFrom": { "type": "reference", - "target": 1354, + "target": 1399, "name": "BaseRepositoryService.getFreshManager" } } ], "inheritedFrom": { "type": "reference", - "target": 1353, + "target": 1398, "name": "BaseRepositoryService.getFreshManager" } }, { - "id": 261, + "id": 289, "name": "restore", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 262, + "id": 290, "name": "restore", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 263, + "id": 291, "name": "ids", "variant": "param", "kind": 32768, @@ -4607,7 +5098,7 @@ } }, { - "id": 264, + "id": 292, "name": "context", "variant": "param", "kind": 32768, @@ -4616,7 +5107,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -4673,21 +5164,21 @@ ] }, { - "id": 283, + "id": 311, "name": "serialize", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 284, + "id": 312, "name": "serialize", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 285, + "id": 313, "name": "TOutput", "variant": "typeParam", "kind": 131072, @@ -4712,7 +5203,7 @@ ], "parameters": [ { - "id": 286, + "id": 314, "name": "data", "variant": "param", "kind": 32768, @@ -4723,7 +5214,7 @@ } }, { - "id": 287, + "id": 315, "name": "options", "variant": "param", "kind": 32768, @@ -4755,26 +5246,26 @@ }, "inheritedFrom": { "type": "reference", - "target": 1360, + "target": 1405, "name": "BaseRepositoryService.serialize" } } ], "inheritedFrom": { "type": "reference", - "target": 1359, + "target": 1404, "name": "BaseRepositoryService.serialize" } }, { - "id": 257, + "id": 285, "name": "softDelete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 258, + "id": 286, "name": "softDelete", "variant": "signature", "kind": 4096, @@ -4800,7 +5291,7 @@ }, "parameters": [ { - "id": 259, + "id": 287, "name": "ids", "variant": "param", "kind": 32768, @@ -4814,7 +5305,7 @@ } }, { - "id": 260, + "id": 288, "name": "context", "variant": "param", "kind": 32768, @@ -4823,7 +5314,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -4880,21 +5371,21 @@ ] }, { - "id": 265, + "id": 293, "name": "transaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 266, + "id": 294, "name": "transaction", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 267, + "id": 295, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -4907,7 +5398,7 @@ ], "parameters": [ { - "id": 268, + "id": 296, "name": "task", "variant": "param", "kind": 32768, @@ -4915,21 +5406,21 @@ "type": { "type": "reflection", "declaration": { - "id": 269, + "id": 297, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 270, + "id": 298, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 271, + "id": 299, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -4963,7 +5454,7 @@ } }, { - "id": 272, + "id": 300, "name": "context", "variant": "param", "kind": 32768, @@ -4973,14 +5464,14 @@ "type": { "type": "reflection", "declaration": { - "id": 273, + "id": 301, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 276, + "id": 304, "name": "enableNestedTransactions", "variant": "declaration", "kind": 1024, @@ -4993,7 +5484,7 @@ } }, { - "id": 274, + "id": 302, "name": "isolationLevel", "variant": "declaration", "kind": 1024, @@ -5006,7 +5497,7 @@ } }, { - "id": 275, + "id": 303, "name": "transaction", "variant": "declaration", "kind": 1024, @@ -5025,9 +5516,9 @@ { "title": "Properties", "children": [ - 276, - 274, - 275 + 304, + 302, + 303 ] } ] @@ -5052,33 +5543,33 @@ }, "inheritedFrom": { "type": "reference", - "target": 1342, + "target": 1387, "name": "BaseRepositoryService.transaction" } } ], "inheritedFrom": { "type": "reference", - "target": 1341, + "target": 1386, "name": "BaseRepositoryService.transaction" } }, { - "id": 249, + "id": 277, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 250, + "id": 278, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 251, + "id": 279, "name": "data", "variant": "param", "kind": 32768, @@ -5092,7 +5583,7 @@ } }, { - "id": 252, + "id": 280, "name": "context", "variant": "param", "kind": 32768, @@ -5101,7 +5592,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -5135,23 +5626,23 @@ { "title": "Methods", "children": [ - 245, - 253, - 237, - 241, - 280, - 277, - 261, - 283, - 257, + 273, + 281, 265, - 249 + 269, + 308, + 305, + 289, + 311, + 285, + 293, + 277 ] } ], "typeParameters": [ { - "id": 288, + "id": 316, "name": "T", "variant": "typeParam", "kind": 131072, @@ -5165,7 +5656,7 @@ "extendedTypes": [ { "type": "reference", - "target": 1340, + "target": 1385, "typeArguments": [ { "type": "reference", @@ -5180,7 +5671,7 @@ ] }, { - "id": 335, + "id": 363, "name": "RestoreReturn", "variant": "declaration", "kind": 256, @@ -5195,7 +5686,7 @@ }, "children": [ { - "id": 336, + "id": 364, "name": "returnLinkableKeys", "variant": "declaration", "kind": 1024, @@ -5225,13 +5716,13 @@ { "title": "Properties", "children": [ - 336 + 364 ] } ], "typeParameters": [ { - "id": 337, + "id": 365, "name": "TReturnableLinkableKeys", "variant": "typeParam", "kind": 131072, @@ -5244,7 +5735,7 @@ ] }, { - "id": 332, + "id": 360, "name": "SoftDeleteReturn", "variant": "declaration", "kind": 256, @@ -5259,7 +5750,7 @@ }, "children": [ { - "id": 333, + "id": 361, "name": "returnLinkableKeys", "variant": "declaration", "kind": 1024, @@ -5289,13 +5780,13 @@ { "title": "Properties", "children": [ - 333 + 361 ] } ], "typeParameters": [ { - "id": 334, + "id": 362, "name": "TReturnableLinkableKeys", "variant": "typeParam", "kind": 131072, @@ -5308,7 +5799,7 @@ ] }, { - "id": 289, + "id": 317, "name": "TreeRepositoryService", "variant": "declaration", "kind": 256, @@ -5323,21 +5814,21 @@ }, "children": [ { - "id": 300, + "id": 328, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 301, + "id": 329, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 302, + "id": 330, "name": "data", "variant": "param", "kind": 32768, @@ -5348,7 +5839,7 @@ } }, { - "id": 303, + "id": 331, "name": "context", "variant": "param", "kind": 32768, @@ -5357,7 +5848,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -5384,21 +5875,21 @@ ] }, { - "id": 304, + "id": 332, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 305, + "id": 333, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 306, + "id": 334, "name": "id", "variant": "param", "kind": 32768, @@ -5409,7 +5900,7 @@ } }, { - "id": 307, + "id": 335, "name": "context", "variant": "param", "kind": 32768, @@ -5418,7 +5909,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -5443,21 +5934,21 @@ ] }, { - "id": 290, + "id": 318, "name": "find", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 291, + "id": 319, "name": "find", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 292, + "id": 320, "name": "options", "variant": "param", "kind": 32768, @@ -5466,7 +5957,7 @@ }, "type": { "type": "reference", - "target": 231, + "target": 259, "typeArguments": [ { "type": "reference", @@ -5480,7 +5971,7 @@ } }, { - "id": 293, + "id": 321, "name": "transformOptions", "variant": "param", "kind": 32768, @@ -5495,7 +5986,7 @@ } }, { - "id": 294, + "id": 322, "name": "context", "variant": "param", "kind": 32768, @@ -5504,7 +5995,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -5534,21 +6025,21 @@ ] }, { - "id": 295, + "id": 323, "name": "findAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 296, + "id": 324, "name": "findAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 297, + "id": 325, "name": "options", "variant": "param", "kind": 32768, @@ -5557,7 +6048,7 @@ }, "type": { "type": "reference", - "target": 231, + "target": 259, "typeArguments": [ { "type": "reference", @@ -5571,7 +6062,7 @@ } }, { - "id": 298, + "id": 326, "name": "transformOptions", "variant": "param", "kind": 32768, @@ -5586,7 +6077,7 @@ } }, { - "id": 299, + "id": 327, "name": "context", "variant": "param", "kind": 32768, @@ -5595,7 +6086,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -5634,21 +6125,21 @@ ] }, { - "id": 323, + "id": 351, "name": "getActiveManager", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 324, + "id": 352, "name": "getActiveManager", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 325, + "id": 353, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -5667,33 +6158,33 @@ }, "inheritedFrom": { "type": "reference", - "target": 1357, + "target": 1402, "name": "BaseRepositoryService.getActiveManager" } } ], "inheritedFrom": { "type": "reference", - "target": 1356, + "target": 1401, "name": "BaseRepositoryService.getActiveManager" } }, { - "id": 320, + "id": 348, "name": "getFreshManager", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 321, + "id": 349, "name": "getFreshManager", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 322, + "id": 350, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -5712,33 +6203,33 @@ }, "inheritedFrom": { "type": "reference", - "target": 1354, + "target": 1399, "name": "BaseRepositoryService.getFreshManager" } } ], "inheritedFrom": { "type": "reference", - "target": 1353, + "target": 1398, "name": "BaseRepositoryService.getFreshManager" } }, { - "id": 326, + "id": 354, "name": "serialize", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 327, + "id": 355, "name": "serialize", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 328, + "id": 356, "name": "TOutput", "variant": "typeParam", "kind": 131072, @@ -5763,7 +6254,7 @@ ], "parameters": [ { - "id": 329, + "id": 357, "name": "data", "variant": "param", "kind": 32768, @@ -5774,7 +6265,7 @@ } }, { - "id": 330, + "id": 358, "name": "options", "variant": "param", "kind": 32768, @@ -5806,33 +6297,33 @@ }, "inheritedFrom": { "type": "reference", - "target": 1360, + "target": 1405, "name": "BaseRepositoryService.serialize" } } ], "inheritedFrom": { "type": "reference", - "target": 1359, + "target": 1404, "name": "BaseRepositoryService.serialize" } }, { - "id": 308, + "id": 336, "name": "transaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 309, + "id": 337, "name": "transaction", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 310, + "id": 338, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -5845,7 +6336,7 @@ ], "parameters": [ { - "id": 311, + "id": 339, "name": "task", "variant": "param", "kind": 32768, @@ -5853,21 +6344,21 @@ "type": { "type": "reflection", "declaration": { - "id": 312, + "id": 340, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 313, + "id": 341, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 314, + "id": 342, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -5901,7 +6392,7 @@ } }, { - "id": 315, + "id": 343, "name": "context", "variant": "param", "kind": 32768, @@ -5911,14 +6402,14 @@ "type": { "type": "reflection", "declaration": { - "id": 316, + "id": 344, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 319, + "id": 347, "name": "enableNestedTransactions", "variant": "declaration", "kind": 1024, @@ -5931,7 +6422,7 @@ } }, { - "id": 317, + "id": 345, "name": "isolationLevel", "variant": "declaration", "kind": 1024, @@ -5944,7 +6435,7 @@ } }, { - "id": 318, + "id": 346, "name": "transaction", "variant": "declaration", "kind": 1024, @@ -5963,9 +6454,9 @@ { "title": "Properties", "children": [ - 319, - 317, - 318 + 347, + 345, + 346 ] } ] @@ -5990,14 +6481,14 @@ }, "inheritedFrom": { "type": "reference", - "target": 1342, + "target": 1387, "name": "BaseRepositoryService.transaction" } } ], "inheritedFrom": { "type": "reference", - "target": 1341, + "target": 1386, "name": "BaseRepositoryService.transaction" } } @@ -6006,20 +6497,20 @@ { "title": "Methods", "children": [ - 300, - 304, - 290, - 295, + 328, + 332, + 318, 323, - 320, - 326, - 308 + 351, + 348, + 354, + 336 ] } ], "typeParameters": [ { - "id": 331, + "id": 359, "name": "T", "variant": "typeParam", "kind": 131072, @@ -6033,7 +6524,7 @@ "extendedTypes": [ { "type": "reference", - "target": 1340, + "target": 1385, "typeArguments": [ { "type": "reference", @@ -6048,7 +6539,7 @@ ] }, { - "id": 338, + "id": 366, "name": "EntityDateColumns", "variant": "declaration", "kind": 2097152, @@ -6068,14 +6559,14 @@ } }, { - "id": 211, + "id": 239, "name": "FilterQuery", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 215, + "id": 243, "name": "T", "variant": "typeParam", "kind": 131072, @@ -6086,7 +6577,7 @@ } }, { - "id": 216, + "id": 244, "name": "Prev", "variant": "typeParam", "kind": 131072, @@ -6201,7 +6692,7 @@ }, { "type": "reference", - "target": 1310, + "target": 1355, "typeArguments": [ { "type": "indexedAccess", @@ -6256,20 +6747,20 @@ "extendsType": { "type": "reflection", "declaration": { - "id": 212, + "id": 240, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 213, + "id": 241, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 214, + "id": 242, "name": "x", "variant": "param", "kind": 32768, @@ -6301,7 +6792,7 @@ }, "trueType": { "type": "reference", - "target": 211, + "target": 239, "typeArguments": [ { "type": "reference", @@ -6330,7 +6821,7 @@ }, "objectType": { "type": "reference", - "target": 1332, + "target": 1377, "name": "PrevLimit", "package": "@medusajs/types" } @@ -6360,14 +6851,14 @@ } }, { - "id": 231, + "id": 259, "name": "FindOptions", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 235, + "id": 263, "name": "T", "variant": "typeParam", "kind": 131072, @@ -6381,14 +6872,14 @@ "type": { "type": "reflection", "declaration": { - "id": 232, + "id": 260, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 234, + "id": 262, "name": "options", "variant": "declaration", "kind": 1024, @@ -6397,7 +6888,7 @@ }, "type": { "type": "reference", - "target": 221, + "target": 249, "typeArguments": [ { "type": "reference", @@ -6415,7 +6906,7 @@ } }, { - "id": 233, + "id": 261, "name": "where", "variant": "declaration", "kind": 1024, @@ -6425,7 +6916,7 @@ "types": [ { "type": "reference", - "target": 211, + "target": 239, "typeArguments": [ { "type": "reference", @@ -6439,11 +6930,11 @@ }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 211, + "target": 239, "typeArguments": [ { "type": "reference", @@ -6467,8 +6958,8 @@ { "title": "Properties", "children": [ - 234, - 233 + 262, + 261 ] } ] @@ -6476,7 +6967,7 @@ } }, { - "id": 339, + "id": 367, "name": "SoftDeletableEntityDateColumns", "variant": "declaration", "kind": 2097152, @@ -6490,7 +6981,7 @@ }, { "type": "reference", - "target": 338, + "target": 366, "name": "EntityDateColumns", "package": "@medusajs/types" } @@ -6502,55 +6993,55 @@ { "title": "Interfaces", "children": [ - 217, - 221, - 236, - 335, - 332, - 289 + 245, + 249, + 264, + 363, + 360, + 317 ] }, { "title": "Type Aliases", "children": [ - 338, - 211, - 231, - 339 + 366, + 239, + 259, + 367 ] } ] }, { - "id": 340, + "id": 368, "name": "EventBusTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 386, + "id": 414, "name": "IEventBusModuleService", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 387, + "id": 415, "name": "emit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 388, + "id": 416, "name": "emit", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 389, + "id": 417, "name": "T", "variant": "typeParam", "kind": 131072, @@ -6559,7 +7050,7 @@ ], "parameters": [ { - "id": 390, + "id": 418, "name": "eventName", "variant": "param", "kind": 32768, @@ -6570,7 +7061,7 @@ } }, { - "id": 391, + "id": 419, "name": "data", "variant": "param", "kind": 32768, @@ -6583,7 +7074,7 @@ } }, { - "id": 392, + "id": 420, "name": "options", "variant": "param", "kind": 32768, @@ -6628,14 +7119,14 @@ } }, { - "id": 393, + "id": 421, "name": "emit", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 394, + "id": 422, "name": "T", "variant": "typeParam", "kind": 131072, @@ -6644,7 +7135,7 @@ ], "parameters": [ { - "id": 395, + "id": 423, "name": "data", "variant": "param", "kind": 32768, @@ -6653,7 +7144,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 360, + "target": 388, "typeArguments": [ { "type": "reference", @@ -6687,21 +7178,21 @@ ] }, { - "id": 396, + "id": 424, "name": "subscribe", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 397, + "id": 425, "name": "subscribe", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 398, + "id": 426, "name": "eventName", "variant": "param", "kind": 32768, @@ -6721,20 +7212,20 @@ } }, { - "id": 399, + "id": 427, "name": "subscriber", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 341, + "target": 369, "name": "Subscriber", "package": "@medusajs/types" } }, { - "id": 400, + "id": 428, "name": "context", "variant": "param", "kind": 32768, @@ -6743,7 +7234,7 @@ }, "type": { "type": "reference", - "target": 347, + "target": 375, "name": "SubscriberContext", "package": "@medusajs/types" } @@ -6751,7 +7242,7 @@ ], "type": { "type": "reference", - "target": 386, + "target": 414, "name": "IEventBusModuleService", "package": "@medusajs/types" } @@ -6759,21 +7250,21 @@ ] }, { - "id": 401, + "id": 429, "name": "unsubscribe", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 402, + "id": 430, "name": "unsubscribe", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 403, + "id": 431, "name": "eventName", "variant": "param", "kind": 32768, @@ -6793,20 +7284,20 @@ } }, { - "id": 404, + "id": 432, "name": "subscriber", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 341, + "target": 369, "name": "Subscriber", "package": "@medusajs/types" } }, { - "id": 405, + "id": 433, "name": "context", "variant": "param", "kind": 32768, @@ -6815,7 +7306,7 @@ }, "type": { "type": "reference", - "target": 347, + "target": 375, "name": "SubscriberContext", "package": "@medusajs/types" } @@ -6823,7 +7314,7 @@ ], "type": { "type": "reference", - "target": 386, + "target": 414, "name": "IEventBusModuleService", "package": "@medusajs/types" } @@ -6835,36 +7326,36 @@ { "title": "Methods", "children": [ - 387, - 396, - 401 + 415, + 424, + 429 ] } ] }, { - "id": 366, + "id": 394, "name": "IEventBusService", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 377, + "id": 405, "name": "emit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 378, + "id": 406, "name": "emit", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 379, + "id": 407, "name": "T", "variant": "typeParam", "kind": 131072, @@ -6873,7 +7364,7 @@ ], "parameters": [ { - "id": 380, + "id": 408, "name": "event", "variant": "param", "kind": 32768, @@ -6884,7 +7375,7 @@ } }, { - "id": 381, + "id": 409, "name": "data", "variant": "param", "kind": 32768, @@ -6897,7 +7388,7 @@ } }, { - "id": 382, + "id": 410, "name": "options", "variant": "param", "kind": 32768, @@ -6929,21 +7420,21 @@ ] }, { - "id": 367, + "id": 395, "name": "subscribe", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 368, + "id": 396, "name": "subscribe", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 369, + "id": 397, "name": "eventName", "variant": "param", "kind": 32768, @@ -6963,20 +7454,20 @@ } }, { - "id": 370, + "id": 398, "name": "subscriber", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 341, + "target": 369, "name": "Subscriber", "package": "@medusajs/types" } }, { - "id": 371, + "id": 399, "name": "context", "variant": "param", "kind": 32768, @@ -6985,7 +7476,7 @@ }, "type": { "type": "reference", - "target": 347, + "target": 375, "name": "SubscriberContext", "package": "@medusajs/types" } @@ -6993,7 +7484,7 @@ ], "type": { "type": "reference", - "target": 366, + "target": 394, "name": "IEventBusService", "package": "@medusajs/types" } @@ -7001,21 +7492,21 @@ ] }, { - "id": 372, + "id": 400, "name": "unsubscribe", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 373, + "id": 401, "name": "unsubscribe", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 374, + "id": 402, "name": "eventName", "variant": "param", "kind": 32768, @@ -7035,20 +7526,20 @@ } }, { - "id": 375, + "id": 403, "name": "subscriber", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 341, + "target": 369, "name": "Subscriber", "package": "@medusajs/types" } }, { - "id": 376, + "id": 404, "name": "context", "variant": "param", "kind": 32768, @@ -7057,7 +7548,7 @@ }, "type": { "type": "reference", - "target": 347, + "target": 375, "name": "SubscriberContext", "package": "@medusajs/types" } @@ -7065,7 +7556,7 @@ ], "type": { "type": "reference", - "target": 366, + "target": 394, "name": "IEventBusService", "package": "@medusajs/types" } @@ -7073,21 +7564,21 @@ ] }, { - "id": 383, + "id": 411, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 384, + "id": 412, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 385, + "id": 413, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -7107,20 +7598,20 @@ ], "type": { "type": "reference", - "target": 366, + "target": 394, "name": "IEventBusService", "package": "@medusajs/types" }, "inheritedFrom": { "type": "reference", - "target": 699, + "target": 739, "name": "ITransactionBaseService.withTransaction" } } ], "inheritedFrom": { "type": "reference", - "target": 698, + "target": 738, "name": "ITransactionBaseService.withTransaction" } } @@ -7129,31 +7620,31 @@ { "title": "Methods", "children": [ - 377, - 367, - 372, - 383 + 405, + 395, + 400, + 411 ] } ], "extendedTypes": [ { "type": "reference", - "target": 697, + "target": 737, "name": "ITransactionBaseService", "package": "@medusajs/types" } ] }, { - "id": 360, + "id": 388, "name": "EmitData", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 365, + "id": 393, "name": "T", "variant": "typeParam", "kind": 131072, @@ -7167,14 +7658,14 @@ "type": { "type": "reflection", "declaration": { - "id": 361, + "id": 389, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 363, + "id": 391, "name": "data", "variant": "declaration", "kind": 1024, @@ -7187,7 +7678,7 @@ } }, { - "id": 362, + "id": 390, "name": "eventName", "variant": "declaration", "kind": 1024, @@ -7198,7 +7689,7 @@ } }, { - "id": 364, + "id": 392, "name": "options", "variant": "declaration", "kind": 1024, @@ -7230,9 +7721,9 @@ { "title": "Properties", "children": [ - 363, - 362, - 364 + 391, + 390, + 392 ] } ] @@ -7240,14 +7731,14 @@ } }, { - "id": 354, + "id": 382, "name": "EventHandler", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 359, + "id": 387, "name": "T", "variant": "typeParam", "kind": 131072, @@ -7261,21 +7752,21 @@ "type": { "type": "reflection", "declaration": { - "id": 355, + "id": 383, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 356, + "id": 384, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 357, + "id": 385, "name": "data", "variant": "param", "kind": 32768, @@ -7288,7 +7779,7 @@ } }, { - "id": 358, + "id": 386, "name": "eventName", "variant": "param", "kind": 32768, @@ -7320,14 +7811,14 @@ } }, { - "id": 341, + "id": 369, "name": "Subscriber", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 346, + "id": 374, "name": "T", "variant": "typeParam", "kind": 131072, @@ -7341,21 +7832,21 @@ "type": { "type": "reflection", "declaration": { - "id": 342, + "id": 370, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 343, + "id": 371, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 344, + "id": 372, "name": "data", "variant": "param", "kind": 32768, @@ -7368,7 +7859,7 @@ } }, { - "id": 345, + "id": 373, "name": "eventName", "variant": "param", "kind": 32768, @@ -7400,7 +7891,7 @@ } }, { - "id": 347, + "id": 375, "name": "SubscriberContext", "variant": "declaration", "kind": 2097152, @@ -7408,14 +7899,14 @@ "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 376, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 349, + "id": 377, "name": "subscriberId", "variant": "declaration", "kind": 1024, @@ -7430,7 +7921,7 @@ { "title": "Properties", "children": [ - 349 + 377 ] } ] @@ -7438,7 +7929,7 @@ } }, { - "id": 350, + "id": 378, "name": "SubscriberDescriptor", "variant": "declaration", "kind": 2097152, @@ -7446,14 +7937,14 @@ "type": { "type": "reflection", "declaration": { - "id": 351, + "id": 379, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 352, + "id": 380, "name": "id", "variant": "declaration", "kind": 1024, @@ -7464,14 +7955,14 @@ } }, { - "id": 353, + "id": 381, "name": "subscriber", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 341, + "target": 369, "name": "Subscriber", "package": "@medusajs/types" } @@ -7481,8 +7972,8 @@ { "title": "Properties", "children": [ - 352, - 353 + 380, + 381 ] } ] @@ -7494,38 +7985,38 @@ { "title": "Interfaces", "children": [ - 386, - 366 + 414, + 394 ] }, { "title": "Type Aliases", "children": [ - 360, - 354, - 341, - 347, - 350 + 388, + 382, + 369, + 375, + 378 ] } ] }, { - "id": 406, + "id": 434, "name": "FeatureFlagTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 407, + "id": 435, "name": "IFlagRouter", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 408, + "id": 436, "name": "isFeatureEnabled", "variant": "declaration", "kind": 1024, @@ -7533,21 +8024,21 @@ "type": { "type": "reflection", "declaration": { - "id": 409, + "id": 437, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 410, + "id": 438, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 411, + "id": 439, "name": "key", "variant": "param", "kind": 32768, @@ -7568,7 +8059,7 @@ } }, { - "id": 412, + "id": 440, "name": "listFlags", "variant": "declaration", "kind": 1024, @@ -7576,21 +8067,21 @@ "type": { "type": "reflection", "declaration": { - "id": 413, + "id": 441, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 414, + "id": 442, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "reference", - "target": 415, + "target": 443, "name": "FeatureFlagsResponse", "package": "@medusajs/types" } @@ -7604,14 +8095,14 @@ { "title": "Properties", "children": [ - 408, - 412 + 436, + 440 ] } ] }, { - "id": 415, + "id": 443, "name": "FeatureFlagsResponse", "variant": "declaration", "kind": 2097152, @@ -7627,14 +8118,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 416, + "id": 444, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 417, + "id": 445, "name": "key", "variant": "declaration", "kind": 1024, @@ -7645,7 +8136,7 @@ } }, { - "id": 418, + "id": 446, "name": "value", "variant": "declaration", "kind": 1024, @@ -7684,8 +8175,8 @@ { "title": "Properties", "children": [ - 417, - 418 + 445, + 446 ] } ] @@ -7694,7 +8185,7 @@ } }, { - "id": 419, + "id": 447, "name": "FlagSettings", "variant": "declaration", "kind": 2097152, @@ -7702,14 +8193,14 @@ "type": { "type": "reflection", "declaration": { - "id": 420, + "id": 448, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 424, + "id": 452, "name": "default_val", "variant": "declaration", "kind": 1024, @@ -7720,7 +8211,7 @@ } }, { - "id": 422, + "id": 450, "name": "description", "variant": "declaration", "kind": 1024, @@ -7731,7 +8222,7 @@ } }, { - "id": 423, + "id": 451, "name": "env_key", "variant": "declaration", "kind": 1024, @@ -7742,7 +8233,7 @@ } }, { - "id": 421, + "id": 449, "name": "key", "variant": "declaration", "kind": 1024, @@ -7757,10 +8248,10 @@ { "title": "Properties", "children": [ - 424, - 422, - 423, - 421 + 452, + 450, + 451, + 449 ] } ] @@ -7772,34 +8263,34 @@ { "title": "Interfaces", "children": [ - 407 + 435 ] }, { "title": "Type Aliases", "children": [ - 415, - 419 + 443, + 447 ] } ] }, { - "id": 425, + "id": 453, "name": "LoggerTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 426, + "id": 454, "name": "Logger", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 442, + "id": 470, "name": "activity", "variant": "declaration", "kind": 1024, @@ -7807,21 +8298,21 @@ "type": { "type": "reflection", "declaration": { - "id": 443, + "id": 471, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 444, + "id": 472, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 445, + "id": 473, "name": "message", "variant": "param", "kind": 32768, @@ -7832,7 +8323,7 @@ } }, { - "id": 446, + "id": 474, "name": "config", "variant": "param", "kind": 32768, @@ -7855,7 +8346,7 @@ } }, { - "id": 467, + "id": 495, "name": "debug", "variant": "declaration", "kind": 1024, @@ -7863,21 +8354,21 @@ "type": { "type": "reflection", "declaration": { - "id": 468, + "id": 496, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 469, + "id": 497, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 470, + "id": 498, "name": "message", "variant": "param", "kind": 32768, @@ -7898,7 +8389,7 @@ } }, { - "id": 452, + "id": 480, "name": "error", "variant": "declaration", "kind": 1024, @@ -7906,21 +8397,21 @@ "type": { "type": "reflection", "declaration": { - "id": 453, + "id": 481, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 454, + "id": 482, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 455, + "id": 483, "name": "messageOrError", "variant": "param", "kind": 32768, @@ -7931,7 +8422,7 @@ } }, { - "id": 456, + "id": 484, "name": "error", "variant": "param", "kind": 32768, @@ -7954,7 +8445,7 @@ } }, { - "id": 457, + "id": 485, "name": "failure", "variant": "declaration", "kind": 1024, @@ -7962,21 +8453,21 @@ "type": { "type": "reflection", "declaration": { - "id": 458, + "id": 486, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 459, + "id": 487, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 460, + "id": 488, "name": "activityId", "variant": "param", "kind": 32768, @@ -7987,7 +8478,7 @@ } }, { - "id": 461, + "id": 489, "name": "message", "variant": "param", "kind": 32768, @@ -8008,7 +8499,7 @@ } }, { - "id": 471, + "id": 499, "name": "info", "variant": "declaration", "kind": 1024, @@ -8016,21 +8507,21 @@ "type": { "type": "reflection", "declaration": { - "id": 472, + "id": 500, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 473, + "id": 501, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 474, + "id": 502, "name": "message", "variant": "param", "kind": 32768, @@ -8051,7 +8542,7 @@ } }, { - "id": 479, + "id": 507, "name": "log", "variant": "declaration", "kind": 1024, @@ -8059,21 +8550,21 @@ "type": { "type": "reflection", "declaration": { - "id": 480, + "id": 508, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 481, + "id": 509, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 482, + "id": 510, "name": "args", "variant": "param", "kind": 32768, @@ -8099,7 +8590,7 @@ } }, { - "id": 427, + "id": 455, "name": "panic", "variant": "declaration", "kind": 1024, @@ -8107,21 +8598,21 @@ "type": { "type": "reflection", "declaration": { - "id": 428, + "id": 456, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 429, + "id": 457, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 430, + "id": 458, "name": "data", "variant": "param", "kind": 32768, @@ -8142,7 +8633,7 @@ } }, { - "id": 447, + "id": 475, "name": "progress", "variant": "declaration", "kind": 1024, @@ -8150,21 +8641,21 @@ "type": { "type": "reflection", "declaration": { - "id": 448, + "id": 476, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 449, + "id": 477, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 450, + "id": 478, "name": "activityId", "variant": "param", "kind": 32768, @@ -8175,7 +8666,7 @@ } }, { - "id": 451, + "id": 479, "name": "message", "variant": "param", "kind": 32768, @@ -8196,7 +8687,7 @@ } }, { - "id": 435, + "id": 463, "name": "setLogLevel", "variant": "declaration", "kind": 1024, @@ -8204,21 +8695,21 @@ "type": { "type": "reflection", "declaration": { - "id": 436, + "id": 464, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 437, + "id": 465, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 438, + "id": 466, "name": "level", "variant": "param", "kind": 32768, @@ -8239,7 +8730,7 @@ } }, { - "id": 431, + "id": 459, "name": "shouldLog", "variant": "declaration", "kind": 1024, @@ -8247,21 +8738,21 @@ "type": { "type": "reflection", "declaration": { - "id": 432, + "id": 460, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 433, + "id": 461, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 434, + "id": 462, "name": "level", "variant": "param", "kind": 32768, @@ -8282,7 +8773,7 @@ } }, { - "id": 462, + "id": 490, "name": "success", "variant": "declaration", "kind": 1024, @@ -8290,21 +8781,21 @@ "type": { "type": "reflection", "declaration": { - "id": 463, + "id": 491, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 464, + "id": 492, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 465, + "id": 493, "name": "activityId", "variant": "param", "kind": 32768, @@ -8315,7 +8806,7 @@ } }, { - "id": 466, + "id": 494, "name": "message", "variant": "param", "kind": 32768, @@ -8336,7 +8827,7 @@ } }, { - "id": 439, + "id": 467, "name": "unsetLogLevel", "variant": "declaration", "kind": 1024, @@ -8344,14 +8835,14 @@ "type": { "type": "reflection", "declaration": { - "id": 440, + "id": 468, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 441, + "id": 469, "name": "__type", "variant": "signature", "kind": 4096, @@ -8366,7 +8857,7 @@ } }, { - "id": 475, + "id": 503, "name": "warn", "variant": "declaration", "kind": 1024, @@ -8374,21 +8865,21 @@ "type": { "type": "reflection", "declaration": { - "id": 476, + "id": 504, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 477, + "id": 505, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 478, + "id": 506, "name": "message", "variant": "param", "kind": 32768, @@ -8413,19 +8904,19 @@ { "title": "Properties", "children": [ - 442, + 470, + 495, + 480, + 485, + 499, + 507, + 455, + 475, + 463, + 459, + 490, 467, - 452, - 457, - 471, - 479, - 427, - 447, - 435, - 431, - 462, - 439, - 475 + 503 ] } ] @@ -8435,27 +8926,27 @@ { "title": "Interfaces", "children": [ - 426 + 454 ] } ] }, { - "id": 483, + "id": 511, "name": "ModulesSdkTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 494, + "id": 522, "name": "MODULE_RESOURCE_TYPE", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { - "id": 496, + "id": 524, "name": "ISOLATED", "variant": "declaration", "kind": 16, @@ -8466,7 +8957,7 @@ } }, { - "id": 495, + "id": 523, "name": "SHARED", "variant": "declaration", "kind": 16, @@ -8481,21 +8972,21 @@ { "title": "Enumeration Members", "children": [ - 496, - 495 + 524, + 523 ] } ] }, { - "id": 491, + "id": 519, "name": "MODULE_SCOPE", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { - "id": 493, + "id": 521, "name": "EXTERNAL", "variant": "declaration", "kind": 16, @@ -8506,7 +8997,7 @@ } }, { - "id": 492, + "id": 520, "name": "INTERNAL", "variant": "declaration", "kind": 16, @@ -8521,21 +9012,21 @@ { "title": "Enumeration Members", "children": [ - 493, - 492 + 521, + 520 ] } ] }, { - "id": 615, + "id": 643, "name": "ModuleServiceInitializeOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 616, + "id": 644, "name": "database", "variant": "declaration", "kind": 1024, @@ -8543,14 +9034,14 @@ "type": { "type": "reflection", "declaration": { - "id": 617, + "id": 645, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 619, + "id": 647, "name": "clientUrl", "variant": "declaration", "kind": 1024, @@ -8563,7 +9054,7 @@ } }, { - "id": 618, + "id": 646, "name": "connection", "variant": "declaration", "kind": 1024, @@ -8584,7 +9075,7 @@ } }, { - "id": 625, + "id": 653, "name": "database", "variant": "declaration", "kind": 1024, @@ -8597,7 +9088,7 @@ } }, { - "id": 627, + "id": 655, "name": "debug", "variant": "declaration", "kind": 1024, @@ -8610,7 +9101,7 @@ } }, { - "id": 626, + "id": 654, "name": "driverOptions", "variant": "declaration", "kind": 1024, @@ -8638,7 +9129,7 @@ } }, { - "id": 621, + "id": 649, "name": "host", "variant": "declaration", "kind": 1024, @@ -8651,7 +9142,7 @@ } }, { - "id": 624, + "id": 652, "name": "password", "variant": "declaration", "kind": 1024, @@ -8664,7 +9155,7 @@ } }, { - "id": 628, + "id": 656, "name": "pool", "variant": "declaration", "kind": 1024, @@ -8692,7 +9183,7 @@ } }, { - "id": 622, + "id": 650, "name": "port", "variant": "declaration", "kind": 1024, @@ -8705,7 +9196,7 @@ } }, { - "id": 620, + "id": 648, "name": "schema", "variant": "declaration", "kind": 1024, @@ -8718,7 +9209,7 @@ } }, { - "id": 623, + "id": 651, "name": "user", "variant": "declaration", "kind": 1024, @@ -8735,17 +9226,17 @@ { "title": "Properties", "children": [ - 619, - 618, - 625, - 627, - 626, - 621, - 624, - 628, - 622, - 620, - 623 + 647, + 646, + 653, + 655, + 654, + 649, + 652, + 656, + 650, + 648, + 651 ] } ] @@ -8757,20 +9248,20 @@ { "title": "Properties", "children": [ - 616 + 644 ] } ] }, { - "id": 484, + "id": 512, "name": "Constructor", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 488, + "id": 516, "name": "T", "variant": "typeParam", "kind": 131072, @@ -8780,21 +9271,21 @@ "type": { "type": "reflection", "declaration": { - "id": 485, + "id": 513, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 486, + "id": 514, "name": "__type", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 487, + "id": 515, "name": "args", "variant": "param", "kind": 32768, @@ -8822,7 +9313,7 @@ } }, { - "id": 507, + "id": 535, "name": "ExternalModuleDeclaration", "variant": "declaration", "kind": 2097152, @@ -8830,14 +9321,14 @@ "type": { "type": "reflection", "declaration": { - "id": 508, + "id": 536, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 517, + "id": 545, "name": "alias", "variant": "declaration", "kind": 1024, @@ -8858,7 +9349,7 @@ } }, { - "id": 510, + "id": 538, "name": "definition", "variant": "declaration", "kind": 1024, @@ -8867,13 +9358,13 @@ }, "type": { "type": "reference", - "target": 527, + "target": 555, "name": "ModuleDefinition", "package": "@medusajs/types" } }, { - "id": 518, + "id": 546, "name": "main", "variant": "declaration", "kind": 1024, @@ -8894,7 +9385,7 @@ } }, { - "id": 516, + "id": 544, "name": "options", "variant": "declaration", "kind": 1024, @@ -8922,20 +9413,20 @@ } }, { - "id": 509, + "id": 537, "name": "scope", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 493, + "target": 521, "name": "MODULE_SCOPE.EXTERNAL", "package": "@medusajs/types" } }, { - "id": 511, + "id": 539, "name": "server", "variant": "declaration", "kind": 1024, @@ -8945,14 +9436,14 @@ "type": { "type": "reflection", "declaration": { - "id": 512, + "id": 540, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 515, + "id": 543, "name": "keepAlive", "variant": "declaration", "kind": 1024, @@ -8963,7 +9454,7 @@ } }, { - "id": 513, + "id": 541, "name": "type", "variant": "declaration", "kind": 1024, @@ -8974,7 +9465,7 @@ } }, { - "id": 514, + "id": 542, "name": "url", "variant": "declaration", "kind": 1024, @@ -8989,9 +9480,9 @@ { "title": "Properties", "children": [ - 515, - 513, - 514 + 543, + 541, + 542 ] } ] @@ -9003,12 +9494,12 @@ { "title": "Properties", "children": [ - 517, - 510, - 518, - 516, - 509, - 511 + 545, + 538, + 546, + 544, + 537, + 539 ] } ] @@ -9016,7 +9507,7 @@ } }, { - "id": 497, + "id": 525, "name": "InternalModuleDeclaration", "variant": "declaration", "kind": 2097152, @@ -9024,14 +9515,14 @@ "type": { "type": "reflection", "declaration": { - "id": 498, + "id": 526, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 505, + "id": 533, "name": "alias", "variant": "declaration", "kind": 1024, @@ -9052,7 +9543,7 @@ } }, { - "id": 502, + "id": 530, "name": "definition", "variant": "declaration", "kind": 1024, @@ -9061,13 +9552,13 @@ }, "type": { "type": "reference", - "target": 527, + "target": 555, "name": "ModuleDefinition", "package": "@medusajs/types" } }, { - "id": 501, + "id": 529, "name": "dependencies", "variant": "declaration", "kind": 1024, @@ -9083,7 +9574,7 @@ } }, { - "id": 506, + "id": 534, "name": "main", "variant": "declaration", "kind": 1024, @@ -9104,7 +9595,7 @@ } }, { - "id": 504, + "id": 532, "name": "options", "variant": "declaration", "kind": 1024, @@ -9132,7 +9623,7 @@ } }, { - "id": 503, + "id": 531, "name": "resolve", "variant": "declaration", "kind": 1024, @@ -9145,27 +9636,27 @@ } }, { - "id": 500, + "id": 528, "name": "resources", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 494, + "target": 522, "name": "MODULE_RESOURCE_TYPE", "package": "@medusajs/types" } }, { - "id": 499, + "id": 527, "name": "scope", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 492, + "target": 520, "name": "MODULE_SCOPE.INTERNAL", "package": "@medusajs/types" } @@ -9175,14 +9666,14 @@ { "title": "Properties", "children": [ - 505, - 502, - 501, - 506, - 504, - 503, - 500, - 499 + 533, + 530, + 529, + 534, + 532, + 531, + 528, + 527 ] } ] @@ -9190,7 +9681,7 @@ } }, { - "id": 539, + "id": 567, "name": "LinkModuleDefinition", "variant": "declaration", "kind": 2097152, @@ -9198,27 +9689,27 @@ "type": { "type": "reflection", "declaration": { - "id": 540, + "id": 568, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 545, + "id": 573, "name": "defaultModuleDeclaration", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 497, + "target": 525, "name": "InternalModuleDeclaration", "package": "@medusajs/types" } }, { - "id": 544, + "id": 572, "name": "dependencies", "variant": "declaration", "kind": 1024, @@ -9234,7 +9725,7 @@ } }, { - "id": 541, + "id": 569, "name": "key", "variant": "declaration", "kind": 1024, @@ -9245,7 +9736,7 @@ } }, { - "id": 543, + "id": 571, "name": "label", "variant": "declaration", "kind": 1024, @@ -9256,7 +9747,7 @@ } }, { - "id": 542, + "id": 570, "name": "registrationName", "variant": "declaration", "kind": 1024, @@ -9271,11 +9762,11 @@ { "title": "Properties", "children": [ - 545, - 544, - 541, - 543, - 542 + 573, + 572, + 569, + 571, + 570 ] } ] @@ -9283,7 +9774,7 @@ } }, { - "id": 551, + "id": 579, "name": "LoadedModule", "variant": "declaration", "kind": 2097152, @@ -9298,34 +9789,34 @@ { "type": "reflection", "declaration": { - "id": 552, + "id": 580, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 554, + "id": 582, "name": "__definition", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 527, + "target": 555, "name": "ModuleDefinition", "package": "@medusajs/types" } }, { - "id": 553, + "id": 581, "name": "__joinerConfig", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 570, + "target": 598, "name": "ModuleJoinerConfig", "package": "@medusajs/types" } @@ -9335,8 +9826,8 @@ { "title": "Properties", "children": [ - 554, - 553 + 582, + 581 ] } ] @@ -9346,14 +9837,14 @@ } }, { - "id": 555, + "id": 583, "name": "LoaderOptions", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 560, + "id": 588, "name": "TOptions", "variant": "typeParam", "kind": 131072, @@ -9382,14 +9873,14 @@ "type": { "type": "reflection", "declaration": { - "id": 556, + "id": 584, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 557, + "id": 585, "name": "container", "variant": "declaration", "kind": 1024, @@ -9402,7 +9893,7 @@ } }, { - "id": 559, + "id": 587, "name": "logger", "variant": "declaration", "kind": 1024, @@ -9411,13 +9902,13 @@ }, "type": { "type": "reference", - "target": 426, + "target": 454, "name": "Logger", "package": "@medusajs/types" } }, { - "id": 558, + "id": 586, "name": "options", "variant": "declaration", "kind": 1024, @@ -9436,9 +9927,9 @@ { "title": "Properties", "children": [ - 557, - 559, - 558 + 585, + 587, + 586 ] } ] @@ -9446,7 +9937,7 @@ } }, { - "id": 489, + "id": 517, "name": "LogLevel", "variant": "declaration", "kind": 2097152, @@ -9486,7 +9977,7 @@ } }, { - "id": 490, + "id": 518, "name": "LoggerOptions", "variant": "declaration", "kind": 2097152, @@ -9506,7 +9997,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 489, + "target": 517, "name": "LogLevel", "package": "@medusajs/types" } @@ -9515,7 +10006,7 @@ } }, { - "id": 546, + "id": 574, "name": "ModuleConfig", "variant": "declaration", "kind": 2097152, @@ -9525,34 +10016,34 @@ "types": [ { "type": "reference", - "target": 1365, + "target": 1410, "name": "ModuleDeclaration", "package": "@medusajs/types" }, { "type": "reflection", "declaration": { - "id": 547, + "id": 575, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 550, + "id": 578, "name": "definition", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 527, + "target": 555, "name": "ModuleDefinition", "package": "@medusajs/types" } }, { - "id": 548, + "id": 576, "name": "module", "variant": "declaration", "kind": 1024, @@ -9563,7 +10054,7 @@ } }, { - "id": 549, + "id": 577, "name": "path", "variant": "declaration", "kind": 1024, @@ -9578,9 +10069,9 @@ { "title": "Properties", "children": [ - 550, - 548, - 549 + 578, + 576, + 577 ] } ] @@ -9590,7 +10081,7 @@ } }, { - "id": 527, + "id": 555, "name": "ModuleDefinition", "variant": "declaration", "kind": 2097152, @@ -9598,14 +10089,14 @@ "type": { "type": "reflection", "declaration": { - "id": 528, + "id": 556, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 533, + "id": 561, "name": "canOverride", "variant": "declaration", "kind": 1024, @@ -9632,7 +10123,7 @@ } }, { - "id": 538, + "id": 566, "name": "defaultModuleDeclaration", "variant": "declaration", "kind": 1024, @@ -9642,13 +10133,13 @@ "types": [ { "type": "reference", - "target": 497, + "target": 525, "name": "InternalModuleDeclaration", "package": "@medusajs/types" }, { "type": "reference", - "target": 507, + "target": 535, "name": "ExternalModuleDeclaration", "package": "@medusajs/types" } @@ -9656,7 +10147,7 @@ } }, { - "id": 531, + "id": 559, "name": "defaultPackage", "variant": "declaration", "kind": 1024, @@ -9676,7 +10167,7 @@ } }, { - "id": 537, + "id": 565, "name": "dependencies", "variant": "declaration", "kind": 1024, @@ -9692,7 +10183,7 @@ } }, { - "id": 536, + "id": 564, "name": "isLegacy", "variant": "declaration", "kind": 1024, @@ -9705,7 +10196,7 @@ } }, { - "id": 535, + "id": 563, "name": "isQueryable", "variant": "declaration", "kind": 1024, @@ -9718,7 +10209,7 @@ } }, { - "id": 534, + "id": 562, "name": "isRequired", "variant": "declaration", "kind": 1024, @@ -9745,7 +10236,7 @@ } }, { - "id": 529, + "id": 557, "name": "key", "variant": "declaration", "kind": 1024, @@ -9756,7 +10247,7 @@ } }, { - "id": 532, + "id": 560, "name": "label", "variant": "declaration", "kind": 1024, @@ -9767,7 +10258,7 @@ } }, { - "id": 530, + "id": 558, "name": "registrationName", "variant": "declaration", "kind": 1024, @@ -9782,16 +10273,16 @@ { "title": "Properties", "children": [ - 533, - 538, - 531, - 537, - 536, - 535, - 534, - 529, - 532, - 530 + 561, + 566, + 559, + 565, + 564, + 563, + 562, + 557, + 560, + 558 ] } ] @@ -9799,7 +10290,7 @@ } }, { - "id": 601, + "id": 629, "name": "ModuleExports", "variant": "declaration", "kind": 2097152, @@ -9807,14 +10298,14 @@ "type": { "type": "reflection", "declaration": { - "id": 602, + "id": 630, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 604, + "id": 632, "name": "loaders", "variant": "declaration", "kind": 1024, @@ -9825,14 +10316,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 561, + "target": 589, "name": "ModuleLoaderFunction", "package": "@medusajs/types" } } }, { - "id": 605, + "id": 633, "name": "migrations", "variant": "declaration", "kind": 1024, @@ -9848,7 +10339,7 @@ } }, { - "id": 606, + "id": 634, "name": "models", "variant": "declaration", "kind": 1024, @@ -9859,7 +10350,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 484, + "target": 512, "typeArguments": [ { "type": "intrinsic", @@ -9872,14 +10363,14 @@ } }, { - "id": 603, + "id": 631, "name": "service", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 484, + "target": 512, "typeArguments": [ { "type": "intrinsic", @@ -9891,7 +10382,7 @@ } }, { - "id": 611, + "id": 639, "name": "revertMigration", "variant": "declaration", "kind": 2048, @@ -9900,21 +10391,21 @@ }, "signatures": [ { - "id": 612, + "id": 640, "name": "revertMigration", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 613, + "id": 641, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 555, + "target": 583, "typeArguments": [ { "type": "reference", @@ -9941,7 +10432,7 @@ } }, { - "id": 614, + "id": 642, "name": "moduleDeclaration", "variant": "param", "kind": 32768, @@ -9950,7 +10441,7 @@ }, "type": { "type": "reference", - "target": 497, + "target": 525, "name": "InternalModuleDeclaration", "package": "@medusajs/types" } @@ -9975,7 +10466,7 @@ ] }, { - "id": 607, + "id": 635, "name": "runMigrations", "variant": "declaration", "kind": 2048, @@ -9984,21 +10475,21 @@ }, "signatures": [ { - "id": 608, + "id": 636, "name": "runMigrations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 609, + "id": 637, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 555, + "target": 583, "typeArguments": [ { "type": "reference", @@ -10025,7 +10516,7 @@ } }, { - "id": 610, + "id": 638, "name": "moduleDeclaration", "variant": "param", "kind": 32768, @@ -10034,7 +10525,7 @@ }, "type": { "type": "reference", - "target": 497, + "target": 525, "name": "InternalModuleDeclaration", "package": "@medusajs/types" } @@ -10063,17 +10554,17 @@ { "title": "Properties", "children": [ - 604, - 605, - 606, - 603 + 632, + 633, + 634, + 631 ] }, { "title": "Methods", "children": [ - 611, - 607 + 639, + 635 ] } ] @@ -10081,7 +10572,7 @@ } }, { - "id": 570, + "id": 598, "name": "ModuleJoinerConfig", "variant": "declaration", "kind": 2097152, @@ -10098,7 +10589,7 @@ "typeArguments": [ { "type": "reference", - "target": 866, + "target": 906, "name": "JoinerServiceConfig", "package": "@medusajs/types" }, @@ -10130,14 +10621,14 @@ { "type": "reflection", "declaration": { - "id": 571, + "id": 599, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 587, + "id": 615, "name": "databaseConfig", "variant": "declaration", "kind": 1024, @@ -10147,14 +10638,14 @@ "type": { "type": "reflection", "declaration": { - "id": 588, + "id": 616, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 591, + "id": 619, "name": "extraFields", "variant": "declaration", "kind": 1024, @@ -10175,14 +10666,14 @@ { "type": "reflection", "declaration": { - "id": 592, + "id": 620, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 594, + "id": 622, "name": "defaultValue", "variant": "declaration", "kind": 1024, @@ -10195,7 +10686,7 @@ } }, { - "id": 595, + "id": 623, "name": "nullable", "variant": "declaration", "kind": 1024, @@ -10208,7 +10699,7 @@ } }, { - "id": 596, + "id": 624, "name": "options", "variant": "declaration", "kind": 1024, @@ -10244,7 +10735,7 @@ } }, { - "id": 593, + "id": 621, "name": "type", "variant": "declaration", "kind": 1024, @@ -10344,10 +10835,10 @@ { "title": "Properties", "children": [ - 594, - 595, - 596, - 593 + 622, + 623, + 624, + 621 ] } ] @@ -10359,7 +10850,7 @@ } }, { - "id": 590, + "id": 618, "name": "idPrefix", "variant": "declaration", "kind": 1024, @@ -10380,7 +10871,7 @@ } }, { - "id": 589, + "id": 617, "name": "tableName", "variant": "declaration", "kind": 1024, @@ -10405,9 +10896,9 @@ { "title": "Properties", "children": [ - 591, - 590, - 589 + 619, + 618, + 617 ] } ] @@ -10415,7 +10906,7 @@ } }, { - "id": 574, + "id": 602, "name": "extends", "variant": "declaration", "kind": 1024, @@ -10427,14 +10918,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 575, + "id": 603, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 577, + "id": 605, "name": "fieldAlias", "variant": "declaration", "kind": 1024, @@ -10462,14 +10953,14 @@ { "type": "reflection", "declaration": { - "id": 578, + "id": 606, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 580, + "id": 608, "name": "forwardArgumentsOnPath", "variant": "declaration", "kind": 1024, @@ -10483,7 +10974,7 @@ } }, { - "id": 579, + "id": 607, "name": "path", "variant": "declaration", "kind": 1024, @@ -10498,8 +10989,8 @@ { "title": "Properties", "children": [ - 580, - 579 + 608, + 607 ] } ] @@ -10513,20 +11004,20 @@ } }, { - "id": 581, + "id": 609, "name": "relationship", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 597, + "target": 625, "name": "ModuleJoinerRelationship", "package": "@medusajs/types" } }, { - "id": 576, + "id": 604, "name": "serviceName", "variant": "declaration", "kind": 1024, @@ -10541,9 +11032,9 @@ { "title": "Properties", "children": [ - 577, - 581, - 576 + 605, + 609, + 604 ] } ] @@ -10552,7 +11043,7 @@ } }, { - "id": 584, + "id": 612, "name": "isLink", "variant": "declaration", "kind": 1024, @@ -10573,7 +11064,7 @@ } }, { - "id": 586, + "id": 614, "name": "isReadOnlyLink", "variant": "declaration", "kind": 1024, @@ -10594,7 +11085,7 @@ } }, { - "id": 585, + "id": 613, "name": "linkableKeys", "variant": "declaration", "kind": 1024, @@ -10630,7 +11121,7 @@ } }, { - "id": 583, + "id": 611, "name": "primaryKeys", "variant": "declaration", "kind": 1024, @@ -10646,7 +11137,7 @@ } }, { - "id": 573, + "id": 601, "name": "relationships", "variant": "declaration", "kind": 1024, @@ -10657,14 +11148,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 597, + "target": 625, "name": "ModuleJoinerRelationship", "package": "@medusajs/types" } } }, { - "id": 572, + "id": 600, "name": "schema", "variant": "declaration", "kind": 1024, @@ -10685,7 +11176,7 @@ } }, { - "id": 582, + "id": 610, "name": "serviceName", "variant": "declaration", "kind": 1024, @@ -10702,15 +11193,15 @@ { "title": "Properties", "children": [ - 587, - 574, - 584, - 586, - 585, - 583, - 573, - 572, - 582 + 615, + 602, + 612, + 614, + 613, + 611, + 601, + 600, + 610 ] } ] @@ -10720,7 +11211,7 @@ } }, { - "id": 597, + "id": 625, "name": "ModuleJoinerRelationship", "variant": "declaration", "kind": 2097152, @@ -10730,21 +11221,21 @@ "types": [ { "type": "reference", - "target": 853, + "target": 893, "name": "JoinerRelationship", "package": "@medusajs/types" }, { "type": "reflection", "declaration": { - "id": 598, + "id": 626, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 600, + "id": 628, "name": "deleteCascade", "variant": "declaration", "kind": 1024, @@ -10765,7 +11256,7 @@ } }, { - "id": 599, + "id": 627, "name": "isInternalService", "variant": "declaration", "kind": 1024, @@ -10790,8 +11281,8 @@ { "title": "Properties", "children": [ - 600, - 599 + 628, + 627 ] } ] @@ -10801,7 +11292,7 @@ } }, { - "id": 561, + "id": 589, "name": "ModuleLoaderFunction", "variant": "declaration", "kind": 2097152, @@ -10809,34 +11300,34 @@ "type": { "type": "reflection", "declaration": { - "id": 562, + "id": 590, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 563, + "id": 591, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 564, + "id": 592, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 555, + "target": 583, "name": "LoaderOptions", "package": "@medusajs/types" } }, { - "id": 565, + "id": 593, "name": "moduleDeclaration", "variant": "param", "kind": 32768, @@ -10845,7 +11336,7 @@ }, "type": { "type": "reference", - "target": 497, + "target": 525, "name": "InternalModuleDeclaration", "package": "@medusajs/types" } @@ -10872,7 +11363,7 @@ } }, { - "id": 519, + "id": 547, "name": "ModuleResolution", "variant": "declaration", "kind": 2097152, @@ -10880,27 +11371,27 @@ "type": { "type": "reflection", "declaration": { - "id": 520, + "id": 548, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 522, + "id": 550, "name": "definition", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 527, + "target": 555, "name": "ModuleDefinition", "package": "@medusajs/types" } }, { - "id": 524, + "id": 552, "name": "dependencies", "variant": "declaration", "kind": 1024, @@ -10916,7 +11407,7 @@ } }, { - "id": 525, + "id": 553, "name": "moduleDeclaration", "variant": "declaration", "kind": 1024, @@ -10928,13 +11419,13 @@ "types": [ { "type": "reference", - "target": 497, + "target": 525, "name": "InternalModuleDeclaration", "package": "@medusajs/types" }, { "type": "reference", - "target": 507, + "target": 535, "name": "ExternalModuleDeclaration", "package": "@medusajs/types" } @@ -10942,7 +11433,7 @@ } }, { - "id": 526, + "id": 554, "name": "moduleExports", "variant": "declaration", "kind": 1024, @@ -10951,13 +11442,13 @@ }, "type": { "type": "reference", - "target": 601, + "target": 629, "name": "ModuleExports", "package": "@medusajs/types" } }, { - "id": 523, + "id": 551, "name": "options", "variant": "declaration", "kind": 1024, @@ -10985,7 +11476,7 @@ } }, { - "id": 521, + "id": 549, "name": "resolutionPath", "variant": "declaration", "kind": 1024, @@ -11009,12 +11500,12 @@ { "title": "Properties", "children": [ - 522, - 524, - 525, - 526, - 523, - 521 + 550, + 552, + 553, + 554, + 551, + 549 ] } ] @@ -11022,7 +11513,7 @@ } }, { - "id": 629, + "id": 657, "name": "ModuleServiceInitializeCustomDataLayerOptions", "variant": "declaration", "kind": 2097152, @@ -11030,14 +11521,14 @@ "type": { "type": "reflection", "declaration": { - "id": 630, + "id": 658, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 631, + "id": 659, "name": "manager", "variant": "declaration", "kind": 1024, @@ -11050,7 +11541,7 @@ } }, { - "id": 632, + "id": 660, "name": "repositories", "variant": "declaration", "kind": 1024, @@ -11060,20 +11551,20 @@ "type": { "type": "reflection", "declaration": { - "id": 633, + "id": 661, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 634, + "id": 662, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 635, + "id": 663, "name": "key", "variant": "param", "kind": 32768, @@ -11086,11 +11577,11 @@ ], "type": { "type": "reference", - "target": 484, + "target": 512, "typeArguments": [ { "type": "reference", - "target": 236, + "target": 264, "name": "RepositoryService", "package": "@medusajs/types" } @@ -11107,8 +11598,8 @@ { "title": "Properties", "children": [ - 631, - 632 + 659, + 660 ] } ] @@ -11116,7 +11607,7 @@ } }, { - "id": 566, + "id": 594, "name": "ModulesResponse", "variant": "declaration", "kind": 2097152, @@ -11126,14 +11617,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 567, + "id": 595, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 568, + "id": 596, "name": "module", "variant": "declaration", "kind": 1024, @@ -11144,7 +11635,7 @@ } }, { - "id": 569, + "id": 597, "name": "resolution", "variant": "declaration", "kind": 1024, @@ -11168,8 +11659,8 @@ { "title": "Properties", "children": [ - 568, - 569 + 596, + 597 ] } ] @@ -11178,7 +11669,7 @@ } }, { - "id": 636, + "id": 664, "name": "RemoteQueryFunction", "variant": "declaration", "kind": 2097152, @@ -11186,91 +11677,290 @@ "type": { "type": "reflection", "declaration": { - "id": 637, + "id": 665, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 638, - "name": "__type", - "variant": "signature", - "kind": 4096, + "id": 666, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 667, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 926, + "name": "RemoteJoinerQuery", + "package": "@medusajs/types" + }, + { + "type": "intrinsic", + "name": "object" + } + ] + } + }, + { + "id": 668, + "name": "variables", + "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": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Enumerations", + "children": [ + 522, + 519 + ] + }, + { + "title": "Interfaces", + "children": [ + 643 + ] + }, + { + "title": "Type Aliases", + "children": [ + 512, + 535, + 525, + 567, + 579, + 583, + 517, + 518, + 574, + 555, + 629, + 598, + 625, + 589, + 547, + 657, + 594, + 664 + ] + } + ] + }, + { + "id": 669, + "name": "RegionTypes", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 670, + "name": "RegionDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 671, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 677, + "name": "automatic_taxes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 673, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 676, + "name": "gift_cards_taxable", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 680, + "name": "includes_tax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 679, + "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": 672, + "name": "name", + "variant": "declaration", + "kind": 1024, "flags": {}, - "parameters": [ - { - "id": 639, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 886, - "name": "RemoteJoinerQuery", - "package": "@medusajs/types" - }, - { - "type": "intrinsic", - "name": "object" - } - ] - } - }, - { - "id": 640, - "name": "variables", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 675, + "name": "tax_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" }, - "type": { - "type": "reference", - "target": { - "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": 678, + "name": "tax_provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, "type": { "type": "union", "types": [ { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" + "type": "intrinsic", + "name": "string" }, { "type": "literal", @@ -11278,6 +11968,35 @@ } ] } + }, + { + "id": 674, + "name": "tax_rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 677, + 673, + 676, + 680, + 679, + 672, + 675, + 678, + 674 + ] } ] } @@ -11285,60 +12004,30 @@ } ], "groups": [ - { - "title": "Enumerations", - "children": [ - 494, - 491 - ] - }, - { - "title": "Interfaces", - "children": [ - 615 - ] - }, { "title": "Type Aliases", "children": [ - 484, - 507, - 497, - 539, - 551, - 555, - 489, - 490, - 546, - 527, - 601, - 570, - 597, - 561, - 519, - 629, - 566, - 636 + 670 ] } ] }, { - "id": 641, + "id": 681, "name": "SalesChannelTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 646, + "id": 686, "name": "SalesChannelDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 648, + "id": 688, "name": "description", "variant": "declaration", "kind": 1024, @@ -11358,7 +12047,7 @@ } }, { - "id": 647, + "id": 687, "name": "id", "variant": "declaration", "kind": 1024, @@ -11369,7 +12058,7 @@ } }, { - "id": 649, + "id": 689, "name": "is_disabled", "variant": "declaration", "kind": 1024, @@ -11380,7 +12069,7 @@ } }, { - "id": 651, + "id": 691, "name": "locations", "variant": "declaration", "kind": 1024, @@ -11391,14 +12080,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 642, + "target": 682, "name": "SalesChannelLocationDTO", "package": "@medusajs/types" } } }, { - "id": 650, + "id": 690, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -11437,24 +12126,24 @@ { "title": "Properties", "children": [ - 648, - 647, - 649, - 651, - 650 + 688, + 687, + 689, + 691, + 690 ] } ] }, { - "id": 642, + "id": 682, "name": "SalesChannelLocationDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 644, + "id": 684, "name": "location_id", "variant": "declaration", "kind": 1024, @@ -11465,20 +12154,20 @@ } }, { - "id": 645, + "id": 685, "name": "sales_channel", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 646, + "target": 686, "name": "SalesChannelDTO", "package": "@medusajs/types" } }, { - "id": 643, + "id": 683, "name": "sales_channel_id", "variant": "declaration", "kind": 1024, @@ -11493,9 +12182,9 @@ { "title": "Properties", "children": [ - 644, - 645, - 643 + 684, + 685, + 683 ] } ] @@ -11505,28 +12194,28 @@ { "title": "Interfaces", "children": [ - 646, - 642 + 686, + 682 ] } ] }, { - "id": 652, + "id": 692, "name": "SearchTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 661, + "id": 701, "name": "ISearchService", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 662, + "id": 702, "name": "options", "variant": "declaration", "kind": 1024, @@ -11552,14 +12241,14 @@ } }, { - "id": 670, + "id": 710, "name": "addDocuments", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 671, + "id": 711, "name": "addDocuments", "variant": "signature", "kind": 4096, @@ -11585,7 +12274,7 @@ }, "parameters": [ { - "id": 672, + "id": 712, "name": "indexName", "variant": "param", "kind": 32768, @@ -11604,7 +12293,7 @@ } }, { - "id": 673, + "id": 713, "name": "documents", "variant": "param", "kind": 32768, @@ -11623,7 +12312,7 @@ } }, { - "id": 674, + "id": 714, "name": "type", "variant": "param", "kind": 32768, @@ -11650,14 +12339,14 @@ ] }, { - "id": 663, + "id": 703, "name": "createIndex", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 664, + "id": 704, "name": "createIndex", "variant": "signature", "kind": 4096, @@ -11683,7 +12372,7 @@ }, "parameters": [ { - "id": 665, + "id": 705, "name": "indexName", "variant": "param", "kind": 32768, @@ -11702,7 +12391,7 @@ } }, { - "id": 666, + "id": 706, "name": "options", "variant": "param", "kind": 32768, @@ -11729,14 +12418,14 @@ ] }, { - "id": 684, + "id": 724, "name": "deleteAllDocuments", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 685, + "id": 725, "name": "deleteAllDocuments", "variant": "signature", "kind": 4096, @@ -11762,7 +12451,7 @@ }, "parameters": [ { - "id": 686, + "id": 726, "name": "indexName", "variant": "param", "kind": 32768, @@ -11789,14 +12478,14 @@ ] }, { - "id": 680, + "id": 720, "name": "deleteDocument", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 681, + "id": 721, "name": "deleteDocument", "variant": "signature", "kind": 4096, @@ -11822,7 +12511,7 @@ }, "parameters": [ { - "id": 682, + "id": 722, "name": "indexName", "variant": "param", "kind": 32768, @@ -11841,7 +12530,7 @@ } }, { - "id": 683, + "id": 723, "name": "document_id", "variant": "param", "kind": 32768, @@ -11877,14 +12566,14 @@ ] }, { - "id": 667, + "id": 707, "name": "getIndex", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 668, + "id": 708, "name": "getIndex", "variant": "signature", "kind": 4096, @@ -11910,7 +12599,7 @@ }, "parameters": [ { - "id": 669, + "id": 709, "name": "indexName", "variant": "param", "kind": 32768, @@ -11937,14 +12626,14 @@ ] }, { - "id": 675, + "id": 715, "name": "replaceDocuments", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 676, + "id": 716, "name": "replaceDocuments", "variant": "signature", "kind": 4096, @@ -11970,7 +12659,7 @@ }, "parameters": [ { - "id": 677, + "id": 717, "name": "indexName", "variant": "param", "kind": 32768, @@ -11989,7 +12678,7 @@ } }, { - "id": 678, + "id": 718, "name": "documents", "variant": "param", "kind": 32768, @@ -12008,7 +12697,7 @@ } }, { - "id": 679, + "id": 719, "name": "type", "variant": "param", "kind": 32768, @@ -12035,14 +12724,14 @@ ] }, { - "id": 687, + "id": 727, "name": "search", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 688, + "id": 728, "name": "search", "variant": "signature", "kind": 4096, @@ -12068,7 +12757,7 @@ }, "parameters": [ { - "id": 689, + "id": 729, "name": "indexName", "variant": "param", "kind": 32768, @@ -12087,7 +12776,7 @@ } }, { - "id": 690, + "id": 730, "name": "query", "variant": "param", "kind": 32768, @@ -12115,7 +12804,7 @@ } }, { - "id": 691, + "id": 731, "name": "options", "variant": "param", "kind": 32768, @@ -12142,14 +12831,14 @@ ] }, { - "id": 692, + "id": 732, "name": "updateSettings", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 693, + "id": 733, "name": "updateSettings", "variant": "signature", "kind": 4096, @@ -12175,7 +12864,7 @@ }, "parameters": [ { - "id": 694, + "id": 734, "name": "indexName", "variant": "param", "kind": 32768, @@ -12194,7 +12883,7 @@ } }, { - "id": 695, + "id": 735, "name": "settings", "variant": "param", "kind": 32768, @@ -12225,26 +12914,26 @@ { "title": "Properties", "children": [ - 662 + 702 ] }, { "title": "Methods", "children": [ - 670, - 663, - 684, - 680, - 667, - 675, - 687, - 692 + 710, + 703, + 724, + 720, + 707, + 715, + 727, + 732 ] } ] }, { - "id": 653, + "id": 693, "name": "IndexSettings", "variant": "declaration", "kind": 2097152, @@ -12252,14 +12941,14 @@ "type": { "type": "reflection", "declaration": { - "id": 654, + "id": 694, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 655, + "id": 695, "name": "indexSettings", "variant": "declaration", "kind": 1024, @@ -12301,7 +12990,7 @@ } }, { - "id": 656, + "id": 696, "name": "primaryKey", "variant": "declaration", "kind": 1024, @@ -12322,7 +13011,7 @@ } }, { - "id": 657, + "id": 697, "name": "transformer", "variant": "declaration", "kind": 1024, @@ -12332,14 +13021,14 @@ "type": { "type": "reflection", "declaration": { - "id": 658, + "id": 698, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 659, + "id": 699, "name": "__type", "variant": "signature", "kind": 4096, @@ -12354,7 +13043,7 @@ }, "parameters": [ { - "id": 660, + "id": 700, "name": "document", "variant": "param", "kind": 32768, @@ -12379,9 +13068,9 @@ { "title": "Properties", "children": [ - 655, - 656, - 657 + 695, + 696, + 697 ] } ] @@ -12393,47 +13082,47 @@ { "title": "Interfaces", "children": [ - 661 + 701 ] }, { "title": "Type Aliases", "children": [ - 653 + 693 ] } ] }, { - "id": 696, + "id": 736, "name": "TransactionBaseTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 697, + "id": 737, "name": "ITransactionBaseService", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 698, + "id": 738, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 699, + "id": 739, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 700, + "id": 740, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -12453,7 +13142,7 @@ ], "type": { "type": "reference", - "target": 697, + "target": 737, "name": "ITransactionBaseService", "package": "@medusajs/types" } @@ -12465,14 +13154,14 @@ { "title": "Methods", "children": [ - 698 + 738 ] } ], "extendedBy": [ { "type": "reference", - "target": 366, + "target": 394, "name": "IEventBusService" } ] @@ -12482,34 +13171,34 @@ { "title": "Interfaces", "children": [ - 697 + 737 ] } ] }, { - "id": 701, + "id": 741, "name": "WorkflowTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 702, + "id": 742, "name": "CartWorkflow", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 706, + "id": 746, "name": "CreateCartWorkflowInputDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 714, + "id": 754, "name": "billing_address", "variant": "declaration", "kind": 1024, @@ -12524,7 +13213,7 @@ } }, { - "id": 713, + "id": 753, "name": "billing_address_id", "variant": "declaration", "kind": 1024, @@ -12537,7 +13226,7 @@ } }, { - "id": 710, + "id": 750, "name": "context", "variant": "declaration", "kind": 1024, @@ -12550,7 +13239,7 @@ } }, { - "id": 708, + "id": 748, "name": "country_code", "variant": "declaration", "kind": 1024, @@ -12563,7 +13252,7 @@ } }, { - "id": 716, + "id": 756, "name": "customer_id", "variant": "declaration", "kind": 1024, @@ -12576,7 +13265,7 @@ } }, { - "id": 717, + "id": 757, "name": "email", "variant": "declaration", "kind": 1024, @@ -12589,7 +13278,7 @@ } }, { - "id": 709, + "id": 749, "name": "items", "variant": "declaration", "kind": 1024, @@ -12600,14 +13289,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 703, + "target": 743, "name": "CreateLineItemInputDTO", "package": "@medusajs/types" } } }, { - "id": 707, + "id": 747, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -12620,7 +13309,7 @@ } }, { - "id": 711, + "id": 751, "name": "sales_channel_id", "variant": "declaration", "kind": 1024, @@ -12633,7 +13322,7 @@ } }, { - "id": 715, + "id": 755, "name": "shipping_address", "variant": "declaration", "kind": 1024, @@ -12648,7 +13337,7 @@ } }, { - "id": 712, + "id": 752, "name": "shipping_address_id", "variant": "declaration", "kind": 1024, @@ -12665,30 +13354,30 @@ { "title": "Properties", "children": [ - 714, - 713, - 710, - 708, - 716, - 717, - 709, - 707, - 711, - 715, - 712 + 754, + 753, + 750, + 748, + 756, + 757, + 749, + 747, + 751, + 755, + 752 ] } ] }, { - "id": 703, + "id": 743, "name": "CreateLineItemInputDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 705, + "id": 745, "name": "quantity", "variant": "declaration", "kind": 1024, @@ -12699,7 +13388,7 @@ } }, { - "id": 704, + "id": 744, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -12714,8 +13403,8 @@ { "title": "Properties", "children": [ - 705, - 704 + 745, + 744 ] } ] @@ -12725,28 +13414,28 @@ { "title": "Interfaces", "children": [ - 706, - 703 + 746, + 743 ] } ] }, { - "id": 718, + "id": 758, "name": "CommonWorkflow", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 719, + "id": 759, "name": "WorkflowInputConfig", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 720, + "id": 760, "name": "listConfig", "variant": "declaration", "kind": 1024, @@ -12756,14 +13445,14 @@ "type": { "type": "reflection", "declaration": { - "id": 721, + "id": 761, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 723, + "id": 763, "name": "relations", "variant": "declaration", "kind": 1024, @@ -12779,7 +13468,7 @@ } }, { - "id": 722, + "id": 762, "name": "select", "variant": "declaration", "kind": 1024, @@ -12799,8 +13488,8 @@ { "title": "Properties", "children": [ - 723, - 722 + 763, + 762 ] } ] @@ -12808,7 +13497,7 @@ } }, { - "id": 724, + "id": 764, "name": "retrieveConfig", "variant": "declaration", "kind": 1024, @@ -12818,14 +13507,14 @@ "type": { "type": "reflection", "declaration": { - "id": 725, + "id": 765, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 727, + "id": 767, "name": "relations", "variant": "declaration", "kind": 1024, @@ -12841,7 +13530,7 @@ } }, { - "id": 726, + "id": 766, "name": "select", "variant": "declaration", "kind": 1024, @@ -12861,8 +13550,8 @@ { "title": "Properties", "children": [ - 727, - 726 + 767, + 766 ] } ] @@ -12874,8 +13563,8 @@ { "title": "Properties", "children": [ - 720, - 724 + 760, + 764 ] } ] @@ -12885,27 +13574,27 @@ { "title": "Interfaces", "children": [ - 719 + 759 ] } ] }, { - "id": 728, + "id": 768, "name": "PriceListWorkflow", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 729, + "id": 769, "name": "CreatePriceListDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 742, + "id": 782, "name": "customer_groups", "variant": "declaration", "kind": 1024, @@ -12917,14 +13606,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 743, + "id": 783, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 744, + "id": 784, "name": "id", "variant": "declaration", "kind": 1024, @@ -12939,7 +13628,7 @@ { "title": "Properties", "children": [ - 744 + 784 ] } ] @@ -12948,7 +13637,7 @@ } }, { - "id": 731, + "id": 771, "name": "ends_at", "variant": "declaration", "kind": 1024, @@ -12961,20 +13650,7 @@ } }, { - "id": 733, - "name": "number_rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 735, + "id": 775, "name": "prices", "variant": "declaration", "kind": 1024, @@ -12986,14 +13662,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 736, + "id": 776, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 737, + "id": 777, "name": "amount", "variant": "declaration", "kind": 1024, @@ -13004,7 +13680,7 @@ } }, { - "id": 738, + "id": 778, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -13015,7 +13691,7 @@ } }, { - "id": 740, + "id": 780, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -13028,7 +13704,7 @@ } }, { - "id": 741, + "id": 781, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -13041,7 +13717,7 @@ } }, { - "id": 739, + "id": 779, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -13058,11 +13734,11 @@ { "title": "Properties", "children": [ - 737, - 738, - 740, - 741, - 739 + 777, + 778, + 780, + 781, + 779 ] } ] @@ -13071,7 +13747,7 @@ } }, { - "id": 734, + "id": 774, "name": "rules", "variant": "declaration", "kind": 1024, @@ -13082,14 +13758,27 @@ "type": "array", "elementType": { "type": "reference", - "target": 1252, + "target": 1297, "name": "PriceListRuleDTO", "package": "@medusajs/types" } } }, { - "id": 730, + "id": 773, + "name": "rules_count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 770, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -13102,7 +13791,7 @@ } }, { - "id": 732, + "id": 772, "name": "status", "variant": "declaration", "kind": 1024, @@ -13111,7 +13800,7 @@ }, "type": { "type": "reference", - "target": 1186, + "target": 1229, "name": "PriceListStatus", "package": "@medusajs/types" } @@ -13121,26 +13810,26 @@ { "title": "Properties", "children": [ - 742, - 731, - 733, - 735, - 734, - 730, - 732 + 782, + 771, + 775, + 774, + 773, + 770, + 772 ] } ] }, { - "id": 748, + "id": 788, "name": "CreatePriceListPriceDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 749, + "id": 789, "name": "amount", "variant": "declaration", "kind": 1024, @@ -13151,7 +13840,7 @@ } }, { - "id": 750, + "id": 790, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -13162,7 +13851,7 @@ } }, { - "id": 753, + "id": 793, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -13175,7 +13864,7 @@ } }, { - "id": 754, + "id": 794, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -13188,7 +13877,7 @@ } }, { - "id": 751, + "id": 791, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -13208,7 +13897,7 @@ } }, { - "id": 752, + "id": 792, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -13225,25 +13914,25 @@ { "title": "Properties", "children": [ - 749, - 750, - 753, - 754, - 751, - 752 + 789, + 790, + 793, + 794, + 791, + 792 ] } ] }, { - "id": 745, + "id": 785, "name": "CreatePriceListRuleDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 746, + "id": 786, "name": "rule_attribute", "variant": "declaration", "kind": 1024, @@ -13254,7 +13943,7 @@ } }, { - "id": 747, + "id": 787, "name": "value", "variant": "declaration", "kind": 1024, @@ -13272,21 +13961,21 @@ { "title": "Properties", "children": [ - 746, - 747 + 786, + 787 ] } ] }, { - "id": 766, + "id": 806, "name": "CreatePriceListWorkflowDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 769, + "id": 809, "name": "description", "variant": "declaration", "kind": 1024, @@ -13297,7 +13986,7 @@ } }, { - "id": 772, + "id": 812, "name": "ends_at", "variant": "declaration", "kind": 1024, @@ -13310,7 +13999,7 @@ } }, { - "id": 768, + "id": 808, "name": "name", "variant": "declaration", "kind": 1024, @@ -13321,20 +14010,7 @@ } }, { - "id": 774, - "name": "number_rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 775, + "id": 815, "name": "prices", "variant": "declaration", "kind": 1024, @@ -13343,29 +14019,42 @@ "type": "array", "elementType": { "type": "reference", - "target": 1366, + "target": 1411, "name": "InputPrice", "package": "@medusajs/types" } } }, { - "id": 776, - "name": "rules", + "id": 816, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1257, + "name": "CreatePriceListRules", + "package": "@medusajs/types" + } + }, + { + "id": 814, + "name": "rules_count", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { - "type": "reference", - "target": 1212, - "name": "CreatePriceListRules", - "package": "@medusajs/types" + "type": "intrinsic", + "name": "number" } }, { - "id": 771, + "id": 811, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -13378,7 +14067,7 @@ } }, { - "id": 773, + "id": 813, "name": "status", "variant": "declaration", "kind": 1024, @@ -13387,13 +14076,13 @@ }, "type": { "type": "reference", - "target": 1186, + "target": 1229, "name": "PriceListStatus", "package": "@medusajs/types" } }, { - "id": 767, + "id": 807, "name": "title", "variant": "declaration", "kind": 1024, @@ -13406,7 +14095,7 @@ } }, { - "id": 770, + "id": 810, "name": "type", "variant": "declaration", "kind": 1024, @@ -13423,29 +14112,29 @@ { "title": "Properties", "children": [ - 769, - 772, - 768, - 774, - 775, - 776, - 771, - 773, - 767, - 770 + 809, + 812, + 808, + 815, + 816, + 814, + 811, + 813, + 807, + 810 ] } ] }, { - "id": 755, + "id": 795, "name": "CreatePriceListWorkflowInputDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 756, + "id": 796, "name": "price_lists", "variant": "declaration", "kind": 1024, @@ -13454,7 +14143,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 766, + "target": 806, "name": "CreatePriceListWorkflowDTO", "package": "@medusajs/types" } @@ -13465,20 +14154,20 @@ { "title": "Properties", "children": [ - 756 + 796 ] } ] }, { - "id": 763, + "id": 803, "name": "RemovePriceListPricesWorkflowInputDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 764, + "id": 804, "name": "money_amount_ids", "variant": "declaration", "kind": 1024, @@ -13492,7 +14181,7 @@ } }, { - "id": 765, + "id": 805, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -13507,21 +14196,21 @@ { "title": "Properties", "children": [ - 764, - 765 + 804, + 805 ] } ] }, { - "id": 757, + "id": 797, "name": "RemovePriceListProductsWorkflowInputDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 759, + "id": 799, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -13532,7 +14221,7 @@ } }, { - "id": 758, + "id": 798, "name": "product_ids", "variant": "declaration", "kind": 1024, @@ -13550,21 +14239,21 @@ { "title": "Properties", "children": [ - 759, - 758 + 799, + 798 ] } ] }, { - "id": 760, + "id": 800, "name": "RemovePriceListVariantsWorkflowInputDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 762, + "id": 802, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -13575,7 +14264,7 @@ } }, { - "id": 761, + "id": 801, "name": "variant_ids", "variant": "declaration", "kind": 1024, @@ -13593,21 +14282,21 @@ { "title": "Properties", "children": [ - 762, - 761 + 802, + 801 ] } ] }, { - "id": 794, + "id": 834, "name": "RemovePriceListWorkflowInputDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 795, + "id": 835, "name": "price_lists", "variant": "declaration", "kind": 1024, @@ -13625,20 +14314,20 @@ { "title": "Properties", "children": [ - 795 + 835 ] } ] }, { - "id": 781, + "id": 821, "name": "UpdatePriceListWorkflowDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 789, + "id": 829, "name": "customer_groups", "variant": "declaration", "kind": 1024, @@ -13650,14 +14339,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 790, + "id": 830, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 791, + "id": 831, "name": "id", "variant": "declaration", "kind": 1024, @@ -13672,7 +14361,7 @@ { "title": "Properties", "children": [ - 791 + 831 ] } ] @@ -13681,7 +14370,7 @@ } }, { - "id": 785, + "id": 825, "name": "ends_at", "variant": "declaration", "kind": 1024, @@ -13694,7 +14383,7 @@ } }, { - "id": 782, + "id": 822, "name": "id", "variant": "declaration", "kind": 1024, @@ -13705,7 +14394,7 @@ } }, { - "id": 783, + "id": 823, "name": "name", "variant": "declaration", "kind": 1024, @@ -13718,7 +14407,7 @@ } }, { - "id": 788, + "id": 828, "name": "prices", "variant": "declaration", "kind": 1024, @@ -13729,14 +14418,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 777, + "target": 817, "name": "PriceListVariantPriceDTO", "package": "@medusajs/types" } } }, { - "id": 787, + "id": 827, "name": "rules", "variant": "declaration", "kind": 1024, @@ -13745,13 +14434,13 @@ }, "type": { "type": "reference", - "target": 1212, + "target": 1257, "name": "CreatePriceListRules", "package": "@medusajs/types" } }, { - "id": 784, + "id": 824, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -13764,7 +14453,7 @@ } }, { - "id": 786, + "id": 826, "name": "status", "variant": "declaration", "kind": 1024, @@ -13773,7 +14462,7 @@ }, "type": { "type": "reference", - "target": 1186, + "target": 1229, "name": "PriceListStatus", "package": "@medusajs/types" } @@ -13783,27 +14472,27 @@ { "title": "Properties", "children": [ - 789, - 785, - 782, - 783, - 788, - 787, - 784, - 786 + 829, + 825, + 822, + 823, + 828, + 827, + 824, + 826 ] } ] }, { - "id": 792, + "id": 832, "name": "UpdatePriceListWorkflowInputDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 793, + "id": 833, "name": "price_lists", "variant": "declaration", "kind": 1024, @@ -13812,7 +14501,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 781, + "target": 821, "name": "UpdatePriceListWorkflowDTO", "package": "@medusajs/types" } @@ -13823,13 +14512,13 @@ { "title": "Properties", "children": [ - 793 + 833 ] } ] }, { - "id": 777, + "id": 817, "name": "PriceListVariantPriceDTO", "variant": "declaration", "kind": 2097152, @@ -13849,14 +14538,14 @@ { "type": "reflection", "declaration": { - "id": 778, + "id": 818, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 780, + "id": 820, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -13869,7 +14558,7 @@ } }, { - "id": 779, + "id": 819, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -13886,8 +14575,8 @@ { "title": "Properties", "children": [ - 780, - 779 + 820, + 819 ] } ] @@ -13901,23 +14590,23 @@ { "title": "Interfaces", "children": [ - 729, - 748, - 745, - 766, - 755, - 763, - 757, - 760, - 794, - 781, - 792 + 769, + 788, + 785, + 806, + 795, + 803, + 797, + 800, + 834, + 821, + 832 ] }, { "title": "Type Aliases", "children": [ - 777 + 817 ] } ] @@ -13927,15 +14616,15 @@ { "title": "Namespaces", "children": [ - 702, - 718, - 728 + 742, + 758, + 768 ] } ] }, { - "id": 1186, + "id": 1229, "name": "PriceListStatus", "variant": "declaration", "kind": 8, @@ -13950,7 +14639,7 @@ }, "children": [ { - "id": 1187, + "id": 1230, "name": "ACTIVE", "variant": "declaration", "kind": 16, @@ -13969,7 +14658,7 @@ } }, { - "id": 1188, + "id": 1231, "name": "DRAFT", "variant": "declaration", "kind": 16, @@ -13992,14 +14681,14 @@ { "title": "Enumeration Members", "children": [ - 1187, - 1188 + 1230, + 1231 ] } ] }, { - "id": 1189, + "id": 1232, "name": "PriceListType", "variant": "declaration", "kind": 8, @@ -14014,7 +14703,7 @@ }, "children": [ { - "id": 1191, + "id": 1234, "name": "OVERRIDE", "variant": "declaration", "kind": 16, @@ -14033,7 +14722,7 @@ } }, { - "id": 1190, + "id": 1233, "name": "SALE", "variant": "declaration", "kind": 16, @@ -14056,14 +14745,14 @@ { "title": "Enumeration Members", "children": [ - 1191, - 1190 + 1234, + 1233 ] } ] }, { - "id": 1281, + "id": 1326, "name": "AddPriceListPricesDTO", "variant": "declaration", "kind": 256, @@ -14078,7 +14767,7 @@ }, "children": [ { - "id": 1282, + "id": 1327, "name": "priceListId", "variant": "declaration", "kind": 1024, @@ -14097,7 +14786,7 @@ } }, { - "id": 1283, + "id": 1328, "name": "prices", "variant": "declaration", "kind": 1024, @@ -14114,7 +14803,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1204, + "target": 1247, "name": "PriceListPriceDTO", "package": "@medusajs/types" } @@ -14125,14 +14814,14 @@ { "title": "Properties", "children": [ - 1282, - 1283 + 1327, + 1328 ] } ] }, { - "id": 1084, + "id": 1126, "name": "AddPricesDTO", "variant": "declaration", "kind": 256, @@ -14147,7 +14836,7 @@ }, "children": [ { - "id": 1085, + "id": 1127, "name": "priceSetId", "variant": "declaration", "kind": 1024, @@ -14166,7 +14855,7 @@ } }, { - "id": 1086, + "id": 1128, "name": "prices", "variant": "declaration", "kind": 1024, @@ -14183,7 +14872,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1076, + "target": 1118, "name": "CreatePricesDTO", "package": "@medusajs/types" } @@ -14194,14 +14883,14 @@ { "title": "Properties", "children": [ - 1085, - 1086 + 1127, + 1128 ] } ] }, { - "id": 1071, + "id": 1113, "name": "AddRulesDTO", "variant": "declaration", "kind": 256, @@ -14216,7 +14905,7 @@ }, "children": [ { - "id": 1072, + "id": 1114, "name": "priceSetId", "variant": "declaration", "kind": 1024, @@ -14235,7 +14924,7 @@ } }, { - "id": 1073, + "id": 1115, "name": "rules", "variant": "declaration", "kind": 1024, @@ -14253,14 +14942,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 1074, + "id": 1116, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1075, + "id": 1117, "name": "attribute", "variant": "declaration", "kind": 1024, @@ -14291,7 +14980,7 @@ { "title": "Properties", "children": [ - 1075 + 1117 ] } ] @@ -14304,14 +14993,14 @@ { "title": "Properties", "children": [ - 1072, - 1073 + 1114, + 1115 ] } ] }, { - "id": 1340, + "id": 1385, "name": "BaseRepositoryService", "variant": "declaration", "kind": 256, @@ -14326,21 +15015,21 @@ }, "children": [ { - "id": 1356, + "id": 1401, "name": "getActiveManager", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1357, + "id": 1402, "name": "getActiveManager", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 1358, + "id": 1403, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -14361,21 +15050,21 @@ ] }, { - "id": 1353, + "id": 1398, "name": "getFreshManager", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1354, + "id": 1399, "name": "getFreshManager", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 1355, + "id": 1400, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -14396,21 +15085,21 @@ ] }, { - "id": 1359, + "id": 1404, "name": "serialize", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1360, + "id": 1405, "name": "serialize", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 1361, + "id": 1406, "name": "TOutput", "variant": "typeParam", "kind": 131072, @@ -14435,7 +15124,7 @@ ], "parameters": [ { - "id": 1362, + "id": 1407, "name": "data", "variant": "param", "kind": 32768, @@ -14446,7 +15135,7 @@ } }, { - "id": 1363, + "id": 1408, "name": "options", "variant": "param", "kind": 32768, @@ -14480,21 +15169,21 @@ ] }, { - "id": 1341, + "id": 1386, "name": "transaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1342, + "id": 1387, "name": "transaction", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 1343, + "id": 1388, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -14507,7 +15196,7 @@ ], "parameters": [ { - "id": 1344, + "id": 1389, "name": "task", "variant": "param", "kind": 32768, @@ -14515,21 +15204,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1345, + "id": 1390, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1346, + "id": 1391, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1347, + "id": 1392, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -14563,7 +15252,7 @@ } }, { - "id": 1348, + "id": 1393, "name": "context", "variant": "param", "kind": 32768, @@ -14573,14 +15262,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1349, + "id": 1394, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1352, + "id": 1397, "name": "enableNestedTransactions", "variant": "declaration", "kind": 1024, @@ -14593,7 +15282,7 @@ } }, { - "id": 1350, + "id": 1395, "name": "isolationLevel", "variant": "declaration", "kind": 1024, @@ -14606,7 +15295,7 @@ } }, { - "id": 1351, + "id": 1396, "name": "transaction", "variant": "declaration", "kind": 1024, @@ -14625,9 +15314,9 @@ { "title": "Properties", "children": [ - 1352, - 1350, - 1351 + 1397, + 1395, + 1396 ] } ] @@ -14658,16 +15347,16 @@ { "title": "Methods", "children": [ - 1356, - 1353, - 1359, - 1341 + 1401, + 1398, + 1404, + 1386 ] } ], "typeParameters": [ { - "id": 1364, + "id": 1409, "name": "T", "variant": "typeParam", "kind": 131072, @@ -14681,18 +15370,18 @@ "extendedBy": [ { "type": "reference", - "target": 236, + "target": 264, "name": "RepositoryService" }, { "type": "reference", - "target": 289, + "target": 317, "name": "TreeRepositoryService" } ] }, { - "id": 1050, + "id": 1092, "name": "CalculatedPriceSet", "variant": "declaration", "kind": 256, @@ -14707,7 +15396,7 @@ }, "children": [ { - "id": 1053, + "id": 1095, "name": "calculated_amount", "variant": "declaration", "kind": 1024, @@ -14743,7 +15432,7 @@ } }, { - "id": 1057, + "id": 1099, "name": "calculated_price", "variant": "declaration", "kind": 1024, @@ -14761,14 +15450,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1058, + "id": 1100, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1063, + "id": 1105, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -14804,7 +15493,7 @@ } }, { - "id": 1062, + "id": 1104, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -14840,7 +15529,7 @@ } }, { - "id": 1059, + "id": 1101, "name": "money_amount_id", "variant": "declaration", "kind": 1024, @@ -14868,7 +15557,7 @@ } }, { - "id": 1060, + "id": 1102, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -14896,7 +15585,7 @@ } }, { - "id": 1061, + "id": 1103, "name": "price_list_type", "variant": "declaration", "kind": 1024, @@ -14928,11 +15617,11 @@ { "title": "Properties", "children": [ - 1063, - 1062, - 1059, - 1060, - 1061 + 1105, + 1104, + 1101, + 1102, + 1103 ] } ] @@ -14940,7 +15629,7 @@ } }, { - "id": 1056, + "id": 1098, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -14968,7 +15657,7 @@ } }, { - "id": 1051, + "id": 1093, "name": "id", "variant": "declaration", "kind": 1024, @@ -14987,7 +15676,7 @@ } }, { - "id": 1052, + "id": 1094, "name": "is_calculated_price_price_list", "variant": "declaration", "kind": 1024, @@ -14998,7 +15687,7 @@ "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 " + "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", @@ -15016,7 +15705,7 @@ } }, { - "id": 1054, + "id": 1096, "name": "is_original_price_price_list", "variant": "declaration", "kind": 1024, @@ -15027,7 +15716,7 @@ "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 " + "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", @@ -15045,7 +15734,7 @@ } }, { - "id": 1055, + "id": 1097, "name": "original_amount", "variant": "declaration", "kind": 1024, @@ -15081,7 +15770,7 @@ } }, { - "id": 1064, + "id": 1106, "name": "original_price", "variant": "declaration", "kind": 1024, @@ -15099,14 +15788,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1065, + "id": 1107, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1070, + "id": 1112, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -15142,7 +15831,7 @@ } }, { - "id": 1069, + "id": 1111, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -15178,7 +15867,7 @@ } }, { - "id": 1066, + "id": 1108, "name": "money_amount_id", "variant": "declaration", "kind": 1024, @@ -15206,7 +15895,7 @@ } }, { - "id": 1067, + "id": 1109, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -15234,7 +15923,7 @@ } }, { - "id": 1068, + "id": 1110, "name": "price_list_type", "variant": "declaration", "kind": 1024, @@ -15266,11 +15955,11 @@ { "title": "Properties", "children": [ - 1070, - 1069, - 1066, - 1067, - 1068 + 1112, + 1111, + 1108, + 1109, + 1110 ] } ] @@ -15282,20 +15971,20 @@ { "title": "Properties", "children": [ - 1053, - 1057, - 1056, - 1051, - 1052, - 1054, - 1055, - 1064 + 1095, + 1099, + 1098, + 1093, + 1094, + 1096, + 1097, + 1106 ] } ] }, { - "id": 1041, + "id": 1083, "name": "CalculatedPriceSetDTO", "variant": "declaration", "kind": 256, @@ -15310,7 +15999,7 @@ }, "children": [ { - "id": 1044, + "id": 1086, "name": "amount", "variant": "declaration", "kind": 1024, @@ -15346,7 +16035,7 @@ } }, { - "id": 1045, + "id": 1087, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -15382,7 +16071,7 @@ } }, { - "id": 1042, + "id": 1084, "name": "id", "variant": "declaration", "kind": 1024, @@ -15401,7 +16090,7 @@ } }, { - "id": 1047, + "id": 1089, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -15445,7 +16134,7 @@ } }, { - "id": 1046, + "id": 1088, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -15489,7 +16178,7 @@ } }, { - "id": 1049, + "id": 1091, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -15517,7 +16206,7 @@ } }, { - "id": 1048, + "id": 1090, "name": "price_list_type", "variant": "declaration", "kind": 1024, @@ -15545,7 +16234,7 @@ } }, { - "id": 1043, + "id": 1085, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -15568,20 +16257,20 @@ { "title": "Properties", "children": [ - 1044, - 1045, - 1042, - 1047, - 1046, - 1049, - 1048, - 1043 + 1086, + 1087, + 1084, + 1089, + 1088, + 1091, + 1090, + 1085 ] } ] }, { - "id": 1295, + "id": 1340, "name": "Context", "variant": "declaration", "kind": 256, @@ -15596,7 +16285,7 @@ }, "children": [ { - "id": 1299, + "id": 1344, "name": "enableNestedTransactions", "variant": "declaration", "kind": 1024, @@ -15617,7 +16306,7 @@ } }, { - "id": 1298, + "id": 1343, "name": "isolationLevel", "variant": "declaration", "kind": 1024, @@ -15670,7 +16359,7 @@ } }, { - "id": 1297, + "id": 1342, "name": "manager", "variant": "declaration", "kind": 1024, @@ -15709,7 +16398,7 @@ } }, { - "id": 1300, + "id": 1345, "name": "transactionId", "variant": "declaration", "kind": 1024, @@ -15730,7 +16419,7 @@ } }, { - "id": 1296, + "id": 1341, "name": "transactionManager", "variant": "declaration", "kind": 1024, @@ -15773,17 +16462,17 @@ { "title": "Properties", "children": [ - 1299, - 1298, - 1297, - 1300, - 1296 + 1344, + 1343, + 1342, + 1345, + 1341 ] } ], "typeParameters": [ { - "id": 1301, + "id": 1346, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -15796,7 +16485,7 @@ ] }, { - "id": 961, + "id": 1001, "name": "CreateCurrencyDTO", "variant": "declaration", "kind": 256, @@ -15811,7 +16500,7 @@ }, "children": [ { - "id": 962, + "id": 1002, "name": "code", "variant": "declaration", "kind": 1024, @@ -15830,7 +16519,7 @@ } }, { - "id": 965, + "id": 1005, "name": "name", "variant": "declaration", "kind": 1024, @@ -15849,7 +16538,7 @@ } }, { - "id": 963, + "id": 1003, "name": "symbol", "variant": "declaration", "kind": 1024, @@ -15868,7 +16557,7 @@ } }, { - "id": 964, + "id": 1004, "name": "symbol_native", "variant": "declaration", "kind": 1024, @@ -15891,16 +16580,16 @@ { "title": "Properties", "children": [ - 962, - 965, - 963, - 964 + 1002, + 1005, + 1003, + 1004 ] } ] }, { - "id": 983, + "id": 1023, "name": "CreateMoneyAmountDTO", "variant": "declaration", "kind": 256, @@ -15915,7 +16604,7 @@ }, "children": [ { - "id": 987, + "id": 1027, "name": "amount", "variant": "declaration", "kind": 1024, @@ -15934,7 +16623,7 @@ } }, { - "id": 986, + "id": 1026, "name": "currency", "variant": "declaration", "kind": 1024, @@ -15951,13 +16640,13 @@ }, "type": { "type": "reference", - "target": 961, + "target": 1001, "name": "CreateCurrencyDTO", "package": "@medusajs/types" } }, { - "id": 985, + "id": 1025, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -15976,7 +16665,7 @@ } }, { - "id": 984, + "id": 1024, "name": "id", "variant": "declaration", "kind": 1024, @@ -15997,7 +16686,7 @@ } }, { - "id": 989, + "id": 1029, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -16027,7 +16716,7 @@ } }, { - "id": 988, + "id": 1028, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -16061,30 +16750,30 @@ { "title": "Properties", "children": [ - 987, - 986, - 985, - 984, - 989, - 988 + 1027, + 1026, + 1025, + 1024, + 1029, + 1028 ] } ], "extendedBy": [ { "type": "reference", - "target": 1076, + "target": 1118, "name": "CreatePricesDTO" }, { "type": "reference", - "target": 1204, + "target": 1247, "name": "PriceListPriceDTO" } ] }, { - "id": 1213, + "id": 1258, "name": "CreatePriceListDTO", "variant": "declaration", "kind": 256, @@ -16099,7 +16788,7 @@ }, "children": [ { - "id": 1215, + "id": 1260, "name": "description", "variant": "declaration", "kind": 1024, @@ -16118,7 +16807,7 @@ } }, { - "id": 1217, + "id": 1262, "name": "ends_at", "variant": "declaration", "kind": 1024, @@ -16139,8 +16828,8 @@ } }, { - "id": 1220, - "name": "number_rules", + "id": 1267, + "name": "prices", "variant": "declaration", "kind": 1024, "flags": { @@ -16150,18 +16839,23 @@ "summary": [ { "kind": "text", - "text": "The number of rules associated with the price list." + "text": "The prices associated with the price list." } ] }, "type": { - "type": "intrinsic", - "name": "number" + "type": "array", + "elementType": { + "type": "reference", + "target": 1247, + "name": "PriceListPriceDTO", + "package": "@medusajs/types" + } } }, { - "id": 1222, - "name": "prices", + "id": 1266, + "name": "rules", "variant": "declaration", "kind": 1024, "flags": { @@ -16171,23 +16865,20 @@ "summary": [ { "kind": "text", - "text": "The prices associated with the price list." + "text": "The rules to be created and associated with the price list." } ] }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1204, - "name": "PriceListPriceDTO", - "package": "@medusajs/types" - } + "type": "reference", + "target": 1257, + "name": "CreatePriceListRules", + "package": "@medusajs/types" } }, { - "id": 1221, - "name": "rules", + "id": 1265, + "name": "rules_count", "variant": "declaration", "kind": 1024, "flags": { @@ -16197,19 +16888,17 @@ "summary": [ { "kind": "text", - "text": "The rules to be created and associated with the price list." + "text": "The number of rules associated with the price list." } ] }, "type": { - "type": "reference", - "target": 1212, - "name": "CreatePriceListRules", - "package": "@medusajs/types" + "type": "intrinsic", + "name": "number" } }, { - "id": 1216, + "id": 1261, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -16230,7 +16919,7 @@ } }, { - "id": 1218, + "id": 1263, "name": "status", "variant": "declaration", "kind": 1024, @@ -16247,13 +16936,13 @@ }, "type": { "type": "reference", - "target": 1186, + "target": 1229, "name": "PriceListStatus", "package": "@medusajs/types" } }, { - "id": 1214, + "id": 1259, "name": "title", "variant": "declaration", "kind": 1024, @@ -16272,7 +16961,7 @@ } }, { - "id": 1219, + "id": 1264, "name": "type", "variant": "declaration", "kind": 1024, @@ -16289,7 +16978,7 @@ }, "type": { "type": "reference", - "target": 1189, + "target": 1232, "name": "PriceListType", "package": "@medusajs/types" } @@ -16299,21 +16988,21 @@ { "title": "Properties", "children": [ - 1215, - 1217, - 1220, - 1222, - 1221, - 1216, - 1218, - 1214, - 1219 + 1260, + 1262, + 1267, + 1266, + 1265, + 1261, + 1263, + 1259, + 1264 ] } ] }, { - "id": 1258, + "id": 1303, "name": "CreatePriceListRuleDTO", "variant": "declaration", "kind": 256, @@ -16328,7 +17017,7 @@ }, "children": [ { - "id": 1262, + "id": 1307, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -16352,7 +17041,7 @@ }, { "type": "reference", - "target": 1192, + "target": 1235, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -16360,7 +17049,7 @@ } }, { - "id": 1261, + "id": 1306, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -16381,7 +17070,7 @@ } }, { - "id": 1260, + "id": 1305, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -16405,7 +17094,7 @@ }, { "type": "reference", - "target": 1165, + "target": 1208, "name": "RuleTypeDTO", "package": "@medusajs/types" } @@ -16413,7 +17102,7 @@ } }, { - "id": 1259, + "id": 1304, "name": "rule_type_id", "variant": "declaration", "kind": 1024, @@ -16438,23 +17127,23 @@ { "title": "Properties", "children": [ - 1262, - 1261, - 1260, - 1259 + 1307, + 1306, + 1305, + 1304 ] } ] }, { - "id": 1273, + "id": 1318, "name": "CreatePriceListRuleValueDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 1276, + "id": 1321, "name": "price_list_rule", "variant": "declaration", "kind": 1024, @@ -16470,7 +17159,7 @@ }, { "type": "reference", - "target": 1252, + "target": 1297, "name": "PriceListRuleDTO", "package": "@medusajs/types" } @@ -16478,7 +17167,7 @@ } }, { - "id": 1275, + "id": 1320, "name": "price_list_rule_id", "variant": "declaration", "kind": 1024, @@ -16491,7 +17180,7 @@ } }, { - "id": 1274, + "id": 1319, "name": "value", "variant": "declaration", "kind": 1024, @@ -16506,15 +17195,15 @@ { "title": "Properties", "children": [ - 1276, - 1275, - 1274 + 1321, + 1320, + 1319 ] } ] }, { - "id": 1212, + "id": 1257, "name": "CreatePriceListRules", "variant": "declaration", "kind": 256, @@ -16553,39 +17242,73 @@ "type": "intrinsic", "name": "string" } - } - ], - "name": "Record", - "package": "typescript" - } - ] - }, - { - "id": 1011, - "name": "CreatePriceRuleDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A price rule to create." + } + ], + "name": "Record", + "package": "typescript" + } + ] + }, + { + "id": 1051, + "name": "CreatePriceRuleDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A price rule to create." + } + ] + }, + "children": [ + { + "id": 1053, + "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": 1079, + "name": "PriceSetDTO", + "package": "@medusajs/types" + } + ] } - ] - }, - "children": [ + }, { - "id": 1012, - "name": "id", + "id": 1052, + "name": "price_set_id", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { "kind": "text", - "text": "The ID of the price rule." + "text": "The ID of the associated price set." } ] }, @@ -16595,54 +17318,119 @@ } }, { - "id": 1013, - "name": "price_set_id", + "id": 1059, + "name": "price_set_money_amount", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { "kind": "text", - "text": "The ID of the associated price set." + "text": "The ID or object of the associated price set money amount." } ] }, "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 1144, + "name": "PriceSetMoneyAmountDTO", + "package": "@medusajs/types" + } + ] } }, { - "id": 1017, + "id": 1058, "name": "price_set_money_amount_id", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price set money amount." + } + ] + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 1016, + "id": 1057, "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": 1014, + "id": 1055, + "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": 1208, + "name": "RuleTypeDTO", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 1054, "name": "rule_type_id", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { @@ -16657,7 +17445,7 @@ } }, { - "id": 1015, + "id": 1056, "name": "value", "variant": "declaration", "kind": 1024, @@ -16680,18 +17468,20 @@ { "title": "Properties", "children": [ - 1012, - 1013, - 1017, - 1016, - 1014, - 1015 + 1053, + 1052, + 1059, + 1058, + 1057, + 1055, + 1054, + 1056 ] } ] }, { - "id": 1090, + "id": 1132, "name": "CreatePriceSetDTO", "variant": "declaration", "kind": 256, @@ -16706,7 +17496,7 @@ }, "children": [ { - "id": 1094, + "id": 1136, "name": "prices", "variant": "declaration", "kind": 1024, @@ -16725,14 +17515,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 1076, + "target": 1118, "name": "CreatePricesDTO", "package": "@medusajs/types" } } }, { - "id": 1091, + "id": 1133, "name": "rules", "variant": "declaration", "kind": 1024, @@ -16752,14 +17542,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 1092, + "id": 1134, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1093, + "id": 1135, "name": "rule_attribute", "variant": "declaration", "kind": 1024, @@ -16790,7 +17580,7 @@ { "title": "Properties", "children": [ - 1093 + 1135 ] } ] @@ -16803,21 +17593,21 @@ { "title": "Properties", "children": [ - 1094, - 1091 + 1136, + 1133 ] } ] }, { - "id": 1115, + "id": 1157, "name": "CreatePriceSetMoneyAmountDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 1119, + "id": 1161, "name": "money_amount", "variant": "declaration", "kind": 1024, @@ -16833,7 +17623,7 @@ }, { "type": "reference", - "target": 975, + "target": 1015, "name": "MoneyAmountDTO", "package": "@medusajs/types" } @@ -16841,7 +17631,7 @@ } }, { - "id": 1118, + "id": 1160, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -16857,7 +17647,7 @@ }, { "type": "reference", - "target": 1192, + "target": 1235, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -16865,7 +17655,7 @@ } }, { - "id": 1117, + "id": 1159, "name": "price_set", "variant": "declaration", "kind": 1024, @@ -16881,7 +17671,7 @@ }, { "type": "reference", - "target": 1037, + "target": 1079, "name": "PriceSetDTO", "package": "@medusajs/types" } @@ -16889,7 +17679,20 @@ } }, { - "id": 1116, + "id": 1162, + "name": "rules_count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1158, "name": "title", "variant": "declaration", "kind": 1024, @@ -16906,16 +17709,17 @@ { "title": "Properties", "children": [ - 1119, - 1118, - 1117, - 1116 + 1161, + 1160, + 1159, + 1162, + 1158 ] } ] }, { - "id": 1131, + "id": 1174, "name": "CreatePriceSetMoneyAmountRulesDTO", "variant": "declaration", "kind": 256, @@ -16930,7 +17734,7 @@ }, "children": [ { - "id": 1132, + "id": 1175, "name": "price_set_money_amount", "variant": "declaration", "kind": 1024, @@ -16949,7 +17753,7 @@ } }, { - "id": 1133, + "id": 1176, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -16968,7 +17772,7 @@ } }, { - "id": 1134, + "id": 1177, "name": "value", "variant": "declaration", "kind": 1024, @@ -16991,42 +17795,86 @@ { "title": "Properties", "children": [ - 1132, - 1133, - 1134 + 1175, + 1176, + 1177 ] } ] }, { - "id": 1152, + "id": 1256, + "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": 1195, "name": "CreatePriceSetRuleTypeDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 1153, + "id": 1196, "name": "price_set", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 1037, + "target": 1079, "name": "PriceSetDTO", "package": "@medusajs/types" } }, { - "id": 1154, + "id": 1197, "name": "rule_type", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 1165, + "target": 1208, "name": "RuleTypeDTO", "package": "@medusajs/types" } @@ -17036,14 +17884,14 @@ { "title": "Properties", "children": [ - 1153, - 1154 + 1196, + 1197 ] } ] }, { - "id": 1076, + "id": 1118, "name": "CreatePricesDTO", "variant": "declaration", "kind": 256, @@ -17058,7 +17906,7 @@ }, "children": [ { - "id": 1081, + "id": 1123, "name": "amount", "variant": "declaration", "kind": 1024, @@ -17077,12 +17925,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 987, + "target": 1027, "name": "CreateMoneyAmountDTO.amount" } }, { - "id": 1080, + "id": 1122, "name": "currency", "variant": "declaration", "kind": 1024, @@ -17099,18 +17947,18 @@ }, "type": { "type": "reference", - "target": 961, + "target": 1001, "name": "CreateCurrencyDTO", "package": "@medusajs/types" }, "inheritedFrom": { "type": "reference", - "target": 986, + "target": 1026, "name": "CreateMoneyAmountDTO.currency" } }, { - "id": 1079, + "id": 1121, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -17129,12 +17977,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 985, + "target": 1025, "name": "CreateMoneyAmountDTO.currency_code" } }, { - "id": 1078, + "id": 1120, "name": "id", "variant": "declaration", "kind": 1024, @@ -17155,12 +18003,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 984, + "target": 1024, "name": "CreateMoneyAmountDTO.id" } }, { - "id": 1083, + "id": 1125, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -17190,12 +18038,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 989, + "target": 1029, "name": "CreateMoneyAmountDTO.max_quantity" } }, { - "id": 1082, + "id": 1124, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -17225,16 +18073,18 @@ }, "inheritedFrom": { "type": "reference", - "target": 988, + "target": 1028, "name": "CreateMoneyAmountDTO.min_quantity" } }, { - "id": 1077, + "id": 1119, "name": "rules", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { @@ -17253,22 +18103,9 @@ }, "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" + "target": 1256, + "name": "CreatePriceSetPriceRules", + "package": "@medusajs/types" } } ], @@ -17276,27 +18113,27 @@ { "title": "Properties", "children": [ - 1081, - 1080, - 1079, - 1078, - 1083, - 1082, - 1077 + 1123, + 1122, + 1121, + 1120, + 1125, + 1124, + 1119 ] } ], "extendedTypes": [ { "type": "reference", - "target": 983, + "target": 1023, "name": "CreateMoneyAmountDTO", "package": "@medusajs/types" } ] }, { - "id": 1170, + "id": 1213, "name": "CreateRuleTypeDTO", "variant": "declaration", "kind": 256, @@ -17311,7 +18148,7 @@ }, "children": [ { - "id": 1174, + "id": 1217, "name": "default_priority", "variant": "declaration", "kind": 1024, @@ -17332,7 +18169,7 @@ } }, { - "id": 1171, + "id": 1214, "name": "id", "variant": "declaration", "kind": 1024, @@ -17353,7 +18190,7 @@ } }, { - "id": 1172, + "id": 1215, "name": "name", "variant": "declaration", "kind": 1024, @@ -17372,7 +18209,7 @@ } }, { - "id": 1173, + "id": 1216, "name": "rule_attribute", "variant": "declaration", "kind": 1024, @@ -17411,16 +18248,16 @@ { "title": "Properties", "children": [ - 1174, - 1171, - 1172, - 1173 + 1217, + 1214, + 1215, + 1216 ] } ] }, { - "id": 956, + "id": 996, "name": "CurrencyDTO", "variant": "declaration", "kind": 256, @@ -17435,7 +18272,7 @@ }, "children": [ { - "id": 957, + "id": 997, "name": "code", "variant": "declaration", "kind": 1024, @@ -17454,7 +18291,7 @@ } }, { - "id": 960, + "id": 1000, "name": "name", "variant": "declaration", "kind": 1024, @@ -17475,7 +18312,7 @@ } }, { - "id": 958, + "id": 998, "name": "symbol", "variant": "declaration", "kind": 1024, @@ -17496,7 +18333,7 @@ } }, { - "id": 959, + "id": 999, "name": "symbol_native", "variant": "declaration", "kind": 1024, @@ -17521,16 +18358,16 @@ { "title": "Properties", "children": [ - 957, - 960, - 958, - 959 + 997, + 1000, + 998, + 999 ] } ] }, { - "id": 971, + "id": 1011, "name": "FilterableCurrencyProps", "variant": "declaration", "kind": 256, @@ -17545,7 +18382,7 @@ }, "children": [ { - "id": 973, + "id": 1013, "name": "$and", "variant": "declaration", "kind": 1024, @@ -17567,17 +18404,17 @@ "types": [ { "type": "reference", - "target": 971, + "target": 1011, "name": "FilterableCurrencyProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 971, + "target": 1011, "name": "FilterableCurrencyProps", "package": "@medusajs/types" } @@ -17590,12 +18427,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 218, + "target": 246, "name": "BaseFilterable.$and" } }, { - "id": 974, + "id": 1014, "name": "$or", "variant": "declaration", "kind": 1024, @@ -17617,17 +18454,17 @@ "types": [ { "type": "reference", - "target": 971, + "target": 1011, "name": "FilterableCurrencyProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 971, + "target": 1011, "name": "FilterableCurrencyProps", "package": "@medusajs/types" } @@ -17640,12 +18477,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 219, + "target": 247, "name": "BaseFilterable.$or" } }, { - "id": 972, + "id": 1012, "name": "code", "variant": "declaration", "kind": 1024, @@ -17673,20 +18510,20 @@ { "title": "Properties", "children": [ - 973, - 974, - 972 + 1013, + 1014, + 1012 ] } ], "extendedTypes": [ { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 971, + "target": 1011, "name": "FilterableCurrencyProps", "package": "@medusajs/types" } @@ -17697,7 +18534,7 @@ ] }, { - "id": 996, + "id": 1036, "name": "FilterableMoneyAmountProps", "variant": "declaration", "kind": 256, @@ -17712,7 +18549,7 @@ }, "children": [ { - "id": 999, + "id": 1039, "name": "$and", "variant": "declaration", "kind": 1024, @@ -17734,17 +18571,17 @@ "types": [ { "type": "reference", - "target": 996, + "target": 1036, "name": "FilterableMoneyAmountProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 996, + "target": 1036, "name": "FilterableMoneyAmountProps", "package": "@medusajs/types" } @@ -17757,12 +18594,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 218, + "target": 246, "name": "BaseFilterable.$and" } }, { - "id": 1000, + "id": 1040, "name": "$or", "variant": "declaration", "kind": 1024, @@ -17784,17 +18621,17 @@ "types": [ { "type": "reference", - "target": 996, + "target": 1036, "name": "FilterableMoneyAmountProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 996, + "target": 1036, "name": "FilterableMoneyAmountProps", "package": "@medusajs/types" } @@ -17807,12 +18644,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 219, + "target": 247, "name": "BaseFilterable.$or" } }, { - "id": 998, + "id": 1038, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -17845,7 +18682,7 @@ } }, { - "id": 997, + "id": 1037, "name": "id", "variant": "declaration", "kind": 1024, @@ -17873,21 +18710,21 @@ { "title": "Properties", "children": [ - 999, - 1000, - 998, - 997 + 1039, + 1040, + 1038, + 1037 ] } ], "extendedTypes": [ { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 996, + "target": 1036, "name": "FilterableMoneyAmountProps", "package": "@medusajs/types" } @@ -17898,7 +18735,7 @@ ] }, { - "id": 1231, + "id": 1276, "name": "FilterablePriceListProps", "variant": "declaration", "kind": 256, @@ -17913,7 +18750,7 @@ }, "children": [ { - "id": 1237, + "id": 1282, "name": "$and", "variant": "declaration", "kind": 1024, @@ -17935,17 +18772,17 @@ "types": [ { "type": "reference", - "target": 1231, + "target": 1276, "name": "FilterablePriceListProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1231, + "target": 1276, "name": "FilterablePriceListProps", "package": "@medusajs/types" } @@ -17958,12 +18795,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 218, + "target": 246, "name": "BaseFilterable.$and" } }, { - "id": 1238, + "id": 1283, "name": "$or", "variant": "declaration", "kind": 1024, @@ -17985,17 +18822,17 @@ "types": [ { "type": "reference", - "target": 1231, + "target": 1276, "name": "FilterablePriceListProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1231, + "target": 1276, "name": "FilterablePriceListProps", "package": "@medusajs/types" } @@ -18008,12 +18845,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 219, + "target": 247, "name": "BaseFilterable.$or" } }, { - "id": 1234, + "id": 1279, "name": "ends_at", "variant": "declaration", "kind": 1024, @@ -18037,7 +18874,7 @@ } }, { - "id": 1232, + "id": 1277, "name": "id", "variant": "declaration", "kind": 1024, @@ -18061,8 +18898,8 @@ } }, { - "id": 1236, - "name": "number_rules", + "id": 1281, + "name": "rules_count", "variant": "declaration", "kind": 1024, "flags": { @@ -18085,7 +18922,7 @@ } }, { - "id": 1233, + "id": 1278, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -18109,7 +18946,7 @@ } }, { - "id": 1235, + "id": 1280, "name": "status", "variant": "declaration", "kind": 1024, @@ -18128,7 +18965,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1186, + "target": 1229, "name": "PriceListStatus", "package": "@medusajs/types" } @@ -18139,24 +18976,24 @@ { "title": "Properties", "children": [ - 1237, - 1238, - 1234, - 1232, - 1236, - 1233, - 1235 + 1282, + 1283, + 1279, + 1277, + 1281, + 1278, + 1280 ] } ], "extendedTypes": [ { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1231, + "target": 1276, "name": "FilterablePriceListProps", "package": "@medusajs/types" } @@ -18167,7 +19004,7 @@ ] }, { - "id": 1239, + "id": 1284, "name": "FilterablePriceListRuleProps", "variant": "declaration", "kind": 256, @@ -18182,7 +19019,7 @@ }, "children": [ { - "id": 1244, + "id": 1289, "name": "$and", "variant": "declaration", "kind": 1024, @@ -18204,17 +19041,17 @@ "types": [ { "type": "reference", - "target": 1239, + "target": 1284, "name": "FilterablePriceListRuleProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1239, + "target": 1284, "name": "FilterablePriceListRuleProps", "package": "@medusajs/types" } @@ -18227,12 +19064,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 218, + "target": 246, "name": "BaseFilterable.$and" } }, { - "id": 1245, + "id": 1290, "name": "$or", "variant": "declaration", "kind": 1024, @@ -18254,17 +19091,17 @@ "types": [ { "type": "reference", - "target": 1239, + "target": 1284, "name": "FilterablePriceListRuleProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1239, + "target": 1284, "name": "FilterablePriceListRuleProps", "package": "@medusajs/types" } @@ -18277,12 +19114,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 219, + "target": 247, "name": "BaseFilterable.$or" } }, { - "id": 1240, + "id": 1285, "name": "id", "variant": "declaration", "kind": 1024, @@ -18306,7 +19143,7 @@ } }, { - "id": 1243, + "id": 1288, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -18330,7 +19167,7 @@ } }, { - "id": 1242, + "id": 1287, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -18354,7 +19191,7 @@ } }, { - "id": 1241, + "id": 1286, "name": "value", "variant": "declaration", "kind": 1024, @@ -18382,23 +19219,23 @@ { "title": "Properties", "children": [ - 1244, - 1245, - 1240, - 1243, - 1242, - 1241 + 1289, + 1290, + 1285, + 1288, + 1287, + 1286 ] } ], "extendedTypes": [ { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1239, + "target": 1284, "name": "FilterablePriceListRuleProps", "package": "@medusajs/types" } @@ -18409,7 +19246,7 @@ ] }, { - "id": 1246, + "id": 1291, "name": "FilterablePriceListRuleValueProps", "variant": "declaration", "kind": 256, @@ -18424,7 +19261,7 @@ }, "children": [ { - "id": 1250, + "id": 1295, "name": "$and", "variant": "declaration", "kind": 1024, @@ -18446,17 +19283,17 @@ "types": [ { "type": "reference", - "target": 1246, + "target": 1291, "name": "FilterablePriceListRuleValueProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1246, + "target": 1291, "name": "FilterablePriceListRuleValueProps", "package": "@medusajs/types" } @@ -18469,12 +19306,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 218, + "target": 246, "name": "BaseFilterable.$and" } }, { - "id": 1251, + "id": 1296, "name": "$or", "variant": "declaration", "kind": 1024, @@ -18496,17 +19333,17 @@ "types": [ { "type": "reference", - "target": 1246, + "target": 1291, "name": "FilterablePriceListRuleValueProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1246, + "target": 1291, "name": "FilterablePriceListRuleValueProps", "package": "@medusajs/types" } @@ -18519,12 +19356,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 219, + "target": 247, "name": "BaseFilterable.$or" } }, { - "id": 1247, + "id": 1292, "name": "id", "variant": "declaration", "kind": 1024, @@ -18540,7 +19377,7 @@ } }, { - "id": 1249, + "id": 1294, "name": "price_list_rule_id", "variant": "declaration", "kind": 1024, @@ -18556,7 +19393,7 @@ } }, { - "id": 1248, + "id": 1293, "name": "value", "variant": "declaration", "kind": 1024, @@ -18576,22 +19413,22 @@ { "title": "Properties", "children": [ - 1250, - 1251, - 1247, - 1249, - 1248 + 1295, + 1296, + 1292, + 1294, + 1293 ] } ], "extendedTypes": [ { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1246, + "target": 1291, "name": "FilterablePriceListRuleValueProps", "package": "@medusajs/types" } @@ -18602,7 +19439,7 @@ ] }, { - "id": 1026, + "id": 1068, "name": "FilterablePriceRuleProps", "variant": "declaration", "kind": 256, @@ -18617,7 +19454,7 @@ }, "children": [ { - "id": 1031, + "id": 1073, "name": "$and", "variant": "declaration", "kind": 1024, @@ -18639,17 +19476,17 @@ "types": [ { "type": "reference", - "target": 1026, + "target": 1068, "name": "FilterablePriceRuleProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1026, + "target": 1068, "name": "FilterablePriceRuleProps", "package": "@medusajs/types" } @@ -18662,12 +19499,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 218, + "target": 246, "name": "BaseFilterable.$and" } }, { - "id": 1032, + "id": 1074, "name": "$or", "variant": "declaration", "kind": 1024, @@ -18689,17 +19526,17 @@ "types": [ { "type": "reference", - "target": 1026, + "target": 1068, "name": "FilterablePriceRuleProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1026, + "target": 1068, "name": "FilterablePriceRuleProps", "package": "@medusajs/types" } @@ -18712,12 +19549,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 219, + "target": 247, "name": "BaseFilterable.$or" } }, { - "id": 1027, + "id": 1069, "name": "id", "variant": "declaration", "kind": 1024, @@ -18741,7 +19578,7 @@ } }, { - "id": 1028, + "id": 1070, "name": "name", "variant": "declaration", "kind": 1024, @@ -18765,7 +19602,7 @@ } }, { - "id": 1029, + "id": 1071, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -18789,7 +19626,7 @@ } }, { - "id": 1030, + "id": 1072, "name": "rule_type_id", "variant": "declaration", "kind": 1024, @@ -18817,23 +19654,23 @@ { "title": "Properties", "children": [ - 1031, - 1032, - 1027, - 1028, - 1029, - 1030 + 1073, + 1074, + 1069, + 1070, + 1071, + 1072 ] } ], "extendedTypes": [ { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1026, + "target": 1068, "name": "FilterablePriceRuleProps", "package": "@medusajs/types" } @@ -18844,7 +19681,7 @@ ] }, { - "id": 1120, + "id": 1163, "name": "FilterablePriceSetMoneyAmountProps", "variant": "declaration", "kind": 256, @@ -18859,7 +19696,7 @@ }, "children": [ { - "id": 1124, + "id": 1167, "name": "$and", "variant": "declaration", "kind": 1024, @@ -18881,17 +19718,17 @@ "types": [ { "type": "reference", - "target": 1120, + "target": 1163, "name": "FilterablePriceSetMoneyAmountProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1120, + "target": 1163, "name": "FilterablePriceSetMoneyAmountProps", "package": "@medusajs/types" } @@ -18904,12 +19741,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 218, + "target": 246, "name": "BaseFilterable.$and" } }, { - "id": 1125, + "id": 1168, "name": "$or", "variant": "declaration", "kind": 1024, @@ -18931,17 +19768,17 @@ "types": [ { "type": "reference", - "target": 1120, + "target": 1163, "name": "FilterablePriceSetMoneyAmountProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1120, + "target": 1163, "name": "FilterablePriceSetMoneyAmountProps", "package": "@medusajs/types" } @@ -18954,12 +19791,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 219, + "target": 247, "name": "BaseFilterable.$or" } }, { - "id": 1121, + "id": 1164, "name": "id", "variant": "declaration", "kind": 1024, @@ -18983,7 +19820,7 @@ } }, { - "id": 1123, + "id": 1166, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -19007,7 +19844,7 @@ } }, { - "id": 1122, + "id": 1165, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -19035,22 +19872,22 @@ { "title": "Properties", "children": [ - 1124, - 1125, - 1121, - 1123, - 1122 + 1167, + 1168, + 1164, + 1166, + 1165 ] } ], "extendedTypes": [ { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1120, + "target": 1163, "name": "FilterablePriceSetMoneyAmountProps", "package": "@medusajs/types" } @@ -19061,7 +19898,7 @@ ] }, { - "id": 1140, + "id": 1183, "name": "FilterablePriceSetMoneyAmountRulesProps", "variant": "declaration", "kind": 256, @@ -19076,7 +19913,7 @@ }, "children": [ { - "id": 1145, + "id": 1188, "name": "$and", "variant": "declaration", "kind": 1024, @@ -19098,17 +19935,17 @@ "types": [ { "type": "reference", - "target": 1140, + "target": 1183, "name": "FilterablePriceSetMoneyAmountRulesProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1140, + "target": 1183, "name": "FilterablePriceSetMoneyAmountRulesProps", "package": "@medusajs/types" } @@ -19121,12 +19958,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 218, + "target": 246, "name": "BaseFilterable.$and" } }, { - "id": 1146, + "id": 1189, "name": "$or", "variant": "declaration", "kind": 1024, @@ -19148,17 +19985,17 @@ "types": [ { "type": "reference", - "target": 1140, + "target": 1183, "name": "FilterablePriceSetMoneyAmountRulesProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1140, + "target": 1183, "name": "FilterablePriceSetMoneyAmountRulesProps", "package": "@medusajs/types" } @@ -19171,12 +20008,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 219, + "target": 247, "name": "BaseFilterable.$or" } }, { - "id": 1141, + "id": 1184, "name": "id", "variant": "declaration", "kind": 1024, @@ -19200,7 +20037,7 @@ } }, { - "id": 1143, + "id": 1186, "name": "price_set_money_amount_id", "variant": "declaration", "kind": 1024, @@ -19224,7 +20061,7 @@ } }, { - "id": 1142, + "id": 1185, "name": "rule_type_id", "variant": "declaration", "kind": 1024, @@ -19248,7 +20085,7 @@ } }, { - "id": 1144, + "id": 1187, "name": "value", "variant": "declaration", "kind": 1024, @@ -19276,23 +20113,23 @@ { "title": "Properties", "children": [ - 1145, - 1146, - 1141, - 1143, - 1142, - 1144 + 1188, + 1189, + 1184, + 1186, + 1185, + 1187 ] } ], "extendedTypes": [ { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1140, + "target": 1183, "name": "FilterablePriceSetMoneyAmountRulesProps", "package": "@medusajs/types" } @@ -19303,7 +20140,7 @@ ] }, { - "id": 1097, + "id": 1139, "name": "FilterablePriceSetProps", "variant": "declaration", "kind": 256, @@ -19318,7 +20155,7 @@ }, "children": [ { - "id": 1100, + "id": 1142, "name": "$and", "variant": "declaration", "kind": 1024, @@ -19340,17 +20177,17 @@ "types": [ { "type": "reference", - "target": 1097, + "target": 1139, "name": "FilterablePriceSetProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1097, + "target": 1139, "name": "FilterablePriceSetProps", "package": "@medusajs/types" } @@ -19363,12 +20200,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 218, + "target": 246, "name": "BaseFilterable.$and" } }, { - "id": 1101, + "id": 1143, "name": "$or", "variant": "declaration", "kind": 1024, @@ -19390,17 +20227,17 @@ "types": [ { "type": "reference", - "target": 1097, + "target": 1139, "name": "FilterablePriceSetProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1097, + "target": 1139, "name": "FilterablePriceSetProps", "package": "@medusajs/types" } @@ -19413,12 +20250,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 219, + "target": 247, "name": "BaseFilterable.$or" } }, { - "id": 1098, + "id": 1140, "name": "id", "variant": "declaration", "kind": 1024, @@ -19442,7 +20279,7 @@ } }, { - "id": 1099, + "id": 1141, "name": "money_amounts", "variant": "declaration", "kind": 1024, @@ -19459,7 +20296,7 @@ }, "type": { "type": "reference", - "target": 996, + "target": 1036, "name": "FilterableMoneyAmountProps", "package": "@medusajs/types" } @@ -19469,21 +20306,21 @@ { "title": "Properties", "children": [ - 1100, - 1101, - 1098, - 1099 + 1142, + 1143, + 1140, + 1141 ] } ], "extendedTypes": [ { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1097, + "target": 1139, "name": "FilterablePriceSetProps", "package": "@medusajs/types" } @@ -19494,7 +20331,7 @@ ] }, { - "id": 1159, + "id": 1202, "name": "FilterablePriceSetRuleTypeProps", "variant": "declaration", "kind": 256, @@ -19509,7 +20346,7 @@ }, "children": [ { - "id": 1163, + "id": 1206, "name": "$and", "variant": "declaration", "kind": 1024, @@ -19531,17 +20368,17 @@ "types": [ { "type": "reference", - "target": 1159, + "target": 1202, "name": "FilterablePriceSetRuleTypeProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1159, + "target": 1202, "name": "FilterablePriceSetRuleTypeProps", "package": "@medusajs/types" } @@ -19554,12 +20391,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 218, + "target": 246, "name": "BaseFilterable.$and" } }, { - "id": 1164, + "id": 1207, "name": "$or", "variant": "declaration", "kind": 1024, @@ -19581,17 +20418,17 @@ "types": [ { "type": "reference", - "target": 1159, + "target": 1202, "name": "FilterablePriceSetRuleTypeProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1159, + "target": 1202, "name": "FilterablePriceSetRuleTypeProps", "package": "@medusajs/types" } @@ -19604,12 +20441,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 219, + "target": 247, "name": "BaseFilterable.$or" } }, { - "id": 1160, + "id": 1203, "name": "id", "variant": "declaration", "kind": 1024, @@ -19625,7 +20462,7 @@ } }, { - "id": 1162, + "id": 1205, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -19641,7 +20478,7 @@ } }, { - "id": 1161, + "id": 1204, "name": "rule_type_id", "variant": "declaration", "kind": 1024, @@ -19661,22 +20498,22 @@ { "title": "Properties", "children": [ - 1163, - 1164, - 1160, - 1162, - 1161 + 1206, + 1207, + 1203, + 1205, + 1204 ] } ], "extendedTypes": [ { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1159, + "target": 1202, "name": "FilterablePriceSetRuleTypeProps", "package": "@medusajs/types" } @@ -19687,7 +20524,7 @@ ] }, { - "id": 1180, + "id": 1223, "name": "FilterableRuleTypeProps", "variant": "declaration", "kind": 256, @@ -19702,7 +20539,7 @@ }, "children": [ { - "id": 1184, + "id": 1227, "name": "$and", "variant": "declaration", "kind": 1024, @@ -19724,17 +20561,17 @@ "types": [ { "type": "reference", - "target": 1180, + "target": 1223, "name": "FilterableRuleTypeProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1180, + "target": 1223, "name": "FilterableRuleTypeProps", "package": "@medusajs/types" } @@ -19747,12 +20584,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 218, + "target": 246, "name": "BaseFilterable.$and" } }, { - "id": 1185, + "id": 1228, "name": "$or", "variant": "declaration", "kind": 1024, @@ -19774,17 +20611,17 @@ "types": [ { "type": "reference", - "target": 1180, + "target": 1223, "name": "FilterableRuleTypeProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1180, + "target": 1223, "name": "FilterableRuleTypeProps", "package": "@medusajs/types" } @@ -19797,12 +20634,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 219, + "target": 247, "name": "BaseFilterable.$or" } }, { - "id": 1181, + "id": 1224, "name": "id", "variant": "declaration", "kind": 1024, @@ -19826,7 +20663,7 @@ } }, { - "id": 1182, + "id": 1225, "name": "name", "variant": "declaration", "kind": 1024, @@ -19850,7 +20687,7 @@ } }, { - "id": 1183, + "id": 1226, "name": "rule_attribute", "variant": "declaration", "kind": 1024, @@ -19878,22 +20715,22 @@ { "title": "Properties", "children": [ - 1184, - 1185, - 1181, - 1182, - 1183 + 1227, + 1228, + 1224, + 1225, + 1226 ] } ], "extendedTypes": [ { "type": "reference", - "target": 217, + "target": 245, "typeArguments": [ { "type": "reference", - "target": 1180, + "target": 1223, "name": "FilterableRuleTypeProps", "package": "@medusajs/types" } @@ -19904,28 +20741,28 @@ ] }, { - "id": 919, + "id": 959, "name": "ILinkModule", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 920, + "id": 960, "name": "__joinerConfig", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 921, + "id": 961, "name": "__joinerConfig", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "reference", - "target": 570, + "target": 598, "name": "ModuleJoinerConfig", "package": "@medusajs/types" } @@ -19933,21 +20770,21 @@ ] }, { - "id": 932, + "id": 972, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 933, + "id": 973, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 934, + "id": 974, "name": "primaryKeyOrBulkData", "variant": "param", "kind": 32768, @@ -20020,7 +20857,7 @@ } }, { - "id": 935, + "id": 975, "name": "foreignKeyData", "variant": "param", "kind": 32768, @@ -20033,7 +20870,7 @@ } }, { - "id": 936, + "id": 976, "name": "sharedContext", "variant": "param", "kind": 32768, @@ -20042,7 +20879,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -20070,21 +20907,21 @@ ] }, { - "id": 942, + "id": 982, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 943, + "id": 983, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 944, + "id": 984, "name": "data", "variant": "param", "kind": 32768, @@ -20095,7 +20932,7 @@ } }, { - "id": 945, + "id": 985, "name": "sharedContext", "variant": "param", "kind": 32768, @@ -20104,7 +20941,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -20129,21 +20966,21 @@ ] }, { - "id": 937, + "id": 977, "name": "dismiss", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 938, + "id": 978, "name": "dismiss", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 939, + "id": 979, "name": "primaryKeyOrBulkData", "variant": "param", "kind": 32768, @@ -20194,7 +21031,7 @@ } }, { - "id": 940, + "id": 980, "name": "foreignKeyData", "variant": "param", "kind": 32768, @@ -20207,7 +21044,7 @@ } }, { - "id": 941, + "id": 981, "name": "sharedContext", "variant": "param", "kind": 32768, @@ -20216,7 +21053,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -20244,21 +21081,21 @@ ] }, { - "id": 922, + "id": 962, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 923, + "id": 963, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 924, + "id": 964, "name": "filters", "variant": "param", "kind": 32768, @@ -20286,7 +21123,7 @@ } }, { - "id": 925, + "id": 965, "name": "config", "variant": "param", "kind": 32768, @@ -20307,7 +21144,7 @@ } }, { - "id": 926, + "id": 966, "name": "sharedContext", "variant": "param", "kind": 32768, @@ -20316,7 +21153,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -20344,21 +21181,21 @@ ] }, { - "id": 927, + "id": 967, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 928, + "id": 968, "name": "listAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 929, + "id": 969, "name": "filters", "variant": "param", "kind": 32768, @@ -20386,7 +21223,7 @@ } }, { - "id": 930, + "id": 970, "name": "config", "variant": "param", "kind": 32768, @@ -20407,7 +21244,7 @@ } }, { - "id": 931, + "id": 971, "name": "sharedContext", "variant": "param", "kind": 32768, @@ -20416,7 +21253,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -20453,21 +21290,21 @@ ] }, { - "id": 951, + "id": 991, "name": "restore", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 952, + "id": 992, "name": "restore", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 953, + "id": 993, "name": "data", "variant": "param", "kind": 32768, @@ -20478,7 +21315,7 @@ } }, { - "id": 954, + "id": 994, "name": "config", "variant": "param", "kind": 32768, @@ -20487,13 +21324,13 @@ }, "type": { "type": "reference", - "target": 335, + "target": 363, "name": "RestoreReturn", "package": "@medusajs/types" } }, { - "id": 955, + "id": 995, "name": "sharedContext", "variant": "param", "kind": 32768, @@ -20502,7 +21339,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -20554,21 +21391,21 @@ ] }, { - "id": 946, + "id": 986, "name": "softDelete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 947, + "id": 987, "name": "softDelete", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 948, + "id": 988, "name": "data", "variant": "param", "kind": 32768, @@ -20579,7 +21416,7 @@ } }, { - "id": 949, + "id": 989, "name": "config", "variant": "param", "kind": 32768, @@ -20588,13 +21425,13 @@ }, "type": { "type": "reference", - "target": 332, + "target": 360, "name": "SoftDeleteReturn", "package": "@medusajs/types" } }, { - "id": 950, + "id": 990, "name": "sharedContext", "variant": "param", "kind": 32768, @@ -20603,7 +21440,7 @@ }, "type": { "type": "reference", - "target": 1295, + "target": 1340, "name": "Context", "package": "@medusajs/types" } @@ -20659,27 +21496,27 @@ { "title": "Methods", "children": [ - 920, - 932, - 942, - 937, - 922, - 927, - 951, - 946 + 960, + 972, + 982, + 977, + 962, + 967, + 991, + 986 ] } ] }, { - "id": 1366, + "id": 1411, "name": "InputPrice", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 1369, + "id": 1414, "name": "amount", "variant": "declaration", "kind": 1024, @@ -20690,7 +21527,7 @@ } }, { - "id": 1368, + "id": 1413, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -20701,7 +21538,7 @@ } }, { - "id": 1372, + "id": 1417, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -20714,7 +21551,7 @@ } }, { - "id": 1371, + "id": 1416, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -20727,7 +21564,7 @@ } }, { - "id": 1367, + "id": 1412, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -20740,7 +21577,7 @@ } }, { - "id": 1370, + "id": 1415, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -20755,25 +21592,25 @@ { "title": "Properties", "children": [ - 1369, - 1368, - 1372, - 1371, - 1367, - 1370 + 1414, + 1413, + 1417, + 1416, + 1412, + 1415 ] } ] }, { - "id": 880, + "id": 920, "name": "JoinerArgument", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 881, + "id": 921, "name": "name", "variant": "declaration", "kind": 1024, @@ -20784,7 +21621,7 @@ } }, { - "id": 882, + "id": 922, "name": "value", "variant": "declaration", "kind": 1024, @@ -20801,21 +21638,21 @@ { "title": "Properties", "children": [ - 881, - 882 + 921, + 922 ] } ] }, { - "id": 883, + "id": 923, "name": "JoinerDirective", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 884, + "id": 924, "name": "name", "variant": "declaration", "kind": 1024, @@ -20826,7 +21663,7 @@ } }, { - "id": 885, + "id": 925, "name": "value", "variant": "declaration", "kind": 1024, @@ -20843,21 +21680,21 @@ { "title": "Properties", "children": [ - 884, - 885 + 924, + 925 ] } ] }, { - "id": 866, + "id": 906, "name": "JoinerServiceConfig", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 868, + "id": 908, "name": "alias", "variant": "declaration", "kind": 1024, @@ -20877,7 +21714,7 @@ "types": [ { "type": "reference", - "target": 863, + "target": 903, "name": "JoinerServiceConfigAlias", "package": "@medusajs/types" }, @@ -20885,7 +21722,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 863, + "target": 903, "name": "JoinerServiceConfigAlias", "package": "@medusajs/types" } @@ -20894,7 +21731,7 @@ } }, { - "id": 879, + "id": 919, "name": "args", "variant": "declaration", "kind": 1024, @@ -20930,7 +21767,7 @@ } }, { - "id": 875, + "id": 915, "name": "extends", "variant": "declaration", "kind": 1024, @@ -20942,27 +21779,27 @@ "elementType": { "type": "reflection", "declaration": { - "id": 876, + "id": 916, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 878, + "id": 918, "name": "relationship", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 853, + "target": 893, "name": "JoinerRelationship", "package": "@medusajs/types" } }, { - "id": 877, + "id": 917, "name": "serviceName", "variant": "declaration", "kind": 1024, @@ -20977,8 +21814,8 @@ { "title": "Properties", "children": [ - 878, - 877 + 918, + 917 ] } ] @@ -20987,7 +21824,7 @@ } }, { - "id": 869, + "id": 909, "name": "fieldAlias", "variant": "declaration", "kind": 1024, @@ -21023,14 +21860,14 @@ { "type": "reflection", "declaration": { - "id": 870, + "id": 910, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 872, + "id": 912, "name": "forwardArgumentsOnPath", "variant": "declaration", "kind": 1024, @@ -21044,7 +21881,7 @@ } }, { - "id": 871, + "id": 911, "name": "path", "variant": "declaration", "kind": 1024, @@ -21059,8 +21896,8 @@ { "title": "Properties", "children": [ - 872, - 871 + 912, + 911 ] } ] @@ -21074,7 +21911,7 @@ } }, { - "id": 873, + "id": 913, "name": "primaryKeys", "variant": "declaration", "kind": 1024, @@ -21088,7 +21925,7 @@ } }, { - "id": 874, + "id": 914, "name": "relationships", "variant": "declaration", "kind": 1024, @@ -21099,14 +21936,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 853, + "target": 893, "name": "JoinerRelationship", "package": "@medusajs/types" } } }, { - "id": 867, + "id": 907, "name": "serviceName", "variant": "declaration", "kind": 1024, @@ -21121,26 +21958,26 @@ { "title": "Properties", "children": [ - 868, - 879, - 875, - 869, - 873, - 874, - 867 + 908, + 919, + 915, + 909, + 913, + 914, + 907 ] } ] }, { - "id": 863, + "id": 903, "name": "JoinerServiceConfigAlias", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 865, + "id": 905, "name": "args", "variant": "declaration", "kind": 1024, @@ -21176,7 +22013,7 @@ } }, { - "id": 864, + "id": 904, "name": "name", "variant": "declaration", "kind": 1024, @@ -21203,14 +22040,14 @@ { "title": "Properties", "children": [ - 865, - 864 + 905, + 904 ] } ] }, { - "id": 975, + "id": 1015, "name": "MoneyAmountDTO", "variant": "declaration", "kind": 256, @@ -21225,7 +22062,7 @@ }, "children": [ { - "id": 979, + "id": 1019, "name": "amount", "variant": "declaration", "kind": 1024, @@ -21246,7 +22083,7 @@ } }, { - "id": 978, + "id": 1018, "name": "currency", "variant": "declaration", "kind": 1024, @@ -21266,13 +22103,13 @@ }, "type": { "type": "reference", - "target": 956, + "target": 996, "name": "CurrencyDTO", "package": "@medusajs/types" } }, { - "id": 977, + "id": 1017, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -21293,7 +22130,7 @@ } }, { - "id": 976, + "id": 1016, "name": "id", "variant": "declaration", "kind": 1024, @@ -21312,7 +22149,7 @@ } }, { - "id": 981, + "id": 1021, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -21333,7 +22170,7 @@ } }, { - "id": 980, + "id": 1020, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -21354,7 +22191,7 @@ } }, { - "id": 982, + "id": 1022, "name": "price_set_money_amount", "variant": "declaration", "kind": 1024, @@ -21371,7 +22208,7 @@ }, "type": { "type": "reference", - "target": 1102, + "target": 1144, "name": "PriceSetMoneyAmountDTO", "package": "@medusajs/types" } @@ -21381,19 +22218,19 @@ { "title": "Properties", "children": [ - 979, - 978, - 977, - 976, - 981, - 980, - 982 + 1019, + 1018, + 1017, + 1016, + 1021, + 1020, + 1022 ] } ] }, { - "id": 1192, + "id": 1235, "name": "PriceListDTO", "variant": "declaration", "kind": 256, @@ -21408,7 +22245,7 @@ }, "children": [ { - "id": 1197, + "id": 1240, "name": "ends_at", "variant": "declaration", "kind": 1024, @@ -21438,7 +22275,7 @@ } }, { - "id": 1193, + "id": 1236, "name": "id", "variant": "declaration", "kind": 1024, @@ -21457,7 +22294,7 @@ } }, { - "id": 1200, + "id": 1243, "name": "money_amounts", "variant": "declaration", "kind": 1024, @@ -21479,35 +22316,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 975, + "target": 1015, "name": "MoneyAmountDTO", "package": "@medusajs/types" } } }, { - "id": 1198, - "name": "number_rules", - "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": 1203, + "id": 1246, "name": "price_list_rules", "variant": "declaration", "kind": 1024, @@ -21529,14 +22345,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 1252, + "target": 1297, "name": "PriceListRuleDTO", "package": "@medusajs/types" } } }, { - "id": 1199, + "id": 1242, "name": "price_set_money_amounts", "variant": "declaration", "kind": 1024, @@ -21558,14 +22374,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 1102, + "target": 1144, "name": "PriceSetMoneyAmountDTO", "package": "@medusajs/types" } } }, { - "id": 1201, + "id": 1244, "name": "rule_types", "variant": "declaration", "kind": 1024, @@ -21587,14 +22403,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 1165, + "target": 1208, "name": "RuleTypeDTO", "package": "@medusajs/types" } } }, { - "id": 1202, + "id": 1245, "name": "rules", "variant": "declaration", "kind": 1024, @@ -21616,14 +22432,35 @@ "type": "array", "elementType": { "type": "reference", - "target": 1252, + "target": 1297, "name": "PriceListRuleDTO", "package": "@medusajs/types" } } }, { - "id": 1195, + "id": 1241, + "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": 1238, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -21653,7 +22490,7 @@ } }, { - "id": 1196, + "id": 1239, "name": "status", "variant": "declaration", "kind": 1024, @@ -21670,13 +22507,13 @@ }, "type": { "type": "reference", - "target": 1186, + "target": 1229, "name": "PriceListStatus", "package": "@medusajs/types" } }, { - "id": 1194, + "id": 1237, "name": "title", "variant": "declaration", "kind": 1024, @@ -21701,23 +22538,23 @@ { "title": "Properties", "children": [ - 1197, - 1193, - 1200, - 1198, - 1203, - 1199, - 1201, - 1202, - 1195, - 1196, - 1194 + 1240, + 1236, + 1243, + 1246, + 1242, + 1244, + 1245, + 1241, + 1238, + 1239, + 1237 ] } ] }, { - "id": 1204, + "id": 1247, "name": "PriceListPriceDTO", "variant": "declaration", "kind": 256, @@ -21732,7 +22569,7 @@ }, "children": [ { - "id": 1209, + "id": 1253, "name": "amount", "variant": "declaration", "kind": 1024, @@ -21751,12 +22588,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 987, + "target": 1027, "name": "CreateMoneyAmountDTO.amount" } }, { - "id": 1208, + "id": 1252, "name": "currency", "variant": "declaration", "kind": 1024, @@ -21773,18 +22610,18 @@ }, "type": { "type": "reference", - "target": 961, + "target": 1001, "name": "CreateCurrencyDTO", "package": "@medusajs/types" }, "inheritedFrom": { "type": "reference", - "target": 986, + "target": 1026, "name": "CreateMoneyAmountDTO.currency" } }, { - "id": 1207, + "id": 1251, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -21803,12 +22640,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 985, + "target": 1025, "name": "CreateMoneyAmountDTO.currency_code" } }, { - "id": 1206, + "id": 1250, "name": "id", "variant": "declaration", "kind": 1024, @@ -21829,12 +22666,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 984, + "target": 1024, "name": "CreateMoneyAmountDTO.id" } }, { - "id": 1211, + "id": 1255, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -21864,12 +22701,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 989, + "target": 1029, "name": "CreateMoneyAmountDTO.max_quantity" } }, { - "id": 1210, + "id": 1254, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -21899,12 +22736,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 988, + "target": 1028, "name": "CreateMoneyAmountDTO.min_quantity" } }, { - "id": 1205, + "id": 1248, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -21921,33 +22758,65 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 1249, + "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": 1256, + "name": "CreatePriceSetPriceRules", + "package": "@medusajs/types" + } } ], "groups": [ { "title": "Properties", "children": [ - 1209, - 1208, - 1207, - 1206, - 1211, - 1210, - 1205 + 1253, + 1252, + 1251, + 1250, + 1255, + 1254, + 1248, + 1249 ] } ], "extendedTypes": [ { "type": "reference", - "target": 983, + "target": 1023, "name": "CreateMoneyAmountDTO", "package": "@medusajs/types" } ] }, { - "id": 1252, + "id": 1297, "name": "PriceListRuleDTO", "variant": "declaration", "kind": 256, @@ -21962,7 +22831,7 @@ }, "children": [ { - "id": 1253, + "id": 1298, "name": "id", "variant": "declaration", "kind": 1024, @@ -21981,7 +22850,7 @@ } }, { - "id": 1256, + "id": 1301, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -21999,13 +22868,13 @@ }, "type": { "type": "reference", - "target": 1192, + "target": 1235, "name": "PriceListDTO", "package": "@medusajs/types" } }, { - "id": 1257, + "id": 1302, "name": "price_list_rule_values", "variant": "declaration", "kind": 1024, @@ -22027,14 +22896,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 1269, + "target": 1314, "name": "PriceListRuleValueDTO", "package": "@medusajs/types" } } }, { - "id": 1255, + "id": 1300, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -22052,13 +22921,13 @@ }, "type": { "type": "reference", - "target": 1165, + "target": 1208, "name": "RuleTypeDTO", "package": "@medusajs/types" } }, { - "id": 1254, + "id": 1299, "name": "value", "variant": "declaration", "kind": 1024, @@ -22081,17 +22950,17 @@ { "title": "Properties", "children": [ - 1253, - 1256, - 1257, - 1255, - 1254 + 1298, + 1301, + 1302, + 1300, + 1299 ] } ] }, { - "id": 1269, + "id": 1314, "name": "PriceListRuleValueDTO", "variant": "declaration", "kind": 256, @@ -22106,7 +22975,7 @@ }, "children": [ { - "id": 1270, + "id": 1315, "name": "id", "variant": "declaration", "kind": 1024, @@ -22125,7 +22994,7 @@ } }, { - "id": 1272, + "id": 1317, "name": "price_list_rule", "variant": "declaration", "kind": 1024, @@ -22143,13 +23012,13 @@ }, "type": { "type": "reference", - "target": 1252, + "target": 1297, "name": "PriceListRuleDTO", "package": "@medusajs/types" } }, { - "id": 1271, + "id": 1316, "name": "value", "variant": "declaration", "kind": 1024, @@ -22172,15 +23041,15 @@ { "title": "Properties", "children": [ - 1270, - 1272, - 1271 + 1315, + 1317, + 1316 ] } ] }, { - "id": 1001, + "id": 1041, "name": "PriceRuleDTO", "variant": "declaration", "kind": 256, @@ -22195,7 +23064,7 @@ }, "children": [ { - "id": 1002, + "id": 1042, "name": "id", "variant": "declaration", "kind": 1024, @@ -22214,7 +23083,7 @@ } }, { - "id": 1010, + "id": 1050, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -22233,7 +23102,7 @@ } }, { - "id": 1004, + "id": 1044, "name": "price_set", "variant": "declaration", "kind": 1024, @@ -22251,13 +23120,13 @@ }, "type": { "type": "reference", - "target": 1037, + "target": 1079, "name": "PriceSetDTO", "package": "@medusajs/types" } }, { - "id": 1003, + "id": 1043, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -22276,7 +23145,7 @@ } }, { - "id": 1009, + "id": 1049, "name": "price_set_money_amount_id", "variant": "declaration", "kind": 1024, @@ -22295,7 +23164,7 @@ } }, { - "id": 1008, + "id": 1048, "name": "priority", "variant": "declaration", "kind": 1024, @@ -22314,7 +23183,7 @@ } }, { - "id": 1006, + "id": 1046, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -22332,13 +23201,13 @@ }, "type": { "type": "reference", - "target": 1165, + "target": 1208, "name": "RuleTypeDTO", "package": "@medusajs/types" } }, { - "id": 1005, + "id": 1045, "name": "rule_type_id", "variant": "declaration", "kind": 1024, @@ -22357,7 +23226,7 @@ } }, { - "id": 1007, + "id": 1047, "name": "value", "variant": "declaration", "kind": 1024, @@ -22380,21 +23249,21 @@ { "title": "Properties", "children": [ - 1002, - 1010, - 1004, - 1003, - 1009, - 1008, - 1006, - 1005, - 1007 + 1042, + 1050, + 1044, + 1043, + 1049, + 1048, + 1046, + 1045, + 1047 ] } ] }, { - "id": 1037, + "id": 1079, "name": "PriceSetDTO", "variant": "declaration", "kind": 256, @@ -22409,7 +23278,7 @@ }, "children": [ { - "id": 1038, + "id": 1080, "name": "id", "variant": "declaration", "kind": 1024, @@ -22428,7 +23297,7 @@ } }, { - "id": 1039, + "id": 1081, "name": "money_amounts", "variant": "declaration", "kind": 1024, @@ -22447,14 +23316,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 975, + "target": 1015, "name": "MoneyAmountDTO", "package": "@medusajs/types" } } }, { - "id": 1040, + "id": 1082, "name": "rule_types", "variant": "declaration", "kind": 1024, @@ -22473,7 +23342,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1165, + "target": 1208, "name": "RuleTypeDTO", "package": "@medusajs/types" } @@ -22484,15 +23353,15 @@ { "title": "Properties", "children": [ - 1038, - 1039, - 1040 + 1080, + 1081, + 1082 ] } ] }, { - "id": 1102, + "id": 1144, "name": "PriceSetMoneyAmountDTO", "variant": "declaration", "kind": 256, @@ -22507,7 +23376,7 @@ }, "children": [ { - "id": 1103, + "id": 1145, "name": "id", "variant": "declaration", "kind": 1024, @@ -22526,7 +23395,7 @@ } }, { - "id": 1109, + "id": 1151, "name": "money_amount", "variant": "declaration", "kind": 1024, @@ -22546,13 +23415,13 @@ }, "type": { "type": "reference", - "target": 975, + "target": 1015, "name": "MoneyAmountDTO", "package": "@medusajs/types" } }, { - "id": 1106, + "id": 1148, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -22572,13 +23441,13 @@ }, "type": { "type": "reference", - "target": 1192, + "target": 1235, "name": "PriceListDTO", "package": "@medusajs/types" } }, { - "id": 1108, + "id": 1150, "name": "price_rules", "variant": "declaration", "kind": 1024, @@ -22600,14 +23469,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 1001, + "target": 1041, "name": "PriceRuleDTO", "package": "@medusajs/types" } } }, { - "id": 1105, + "id": 1147, "name": "price_set", "variant": "declaration", "kind": 1024, @@ -22627,13 +23496,13 @@ }, "type": { "type": "reference", - "target": 1037, + "target": 1079, "name": "PriceSetDTO", "package": "@medusajs/types" } }, { - "id": 1107, + "id": 1149, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -22654,7 +23523,7 @@ } }, { - "id": 1104, + "id": 1146, "name": "title", "variant": "declaration", "kind": 1024, @@ -22679,19 +23548,19 @@ { "title": "Properties", "children": [ - 1103, - 1109, - 1106, - 1108, - 1105, - 1107, - 1104 + 1145, + 1151, + 1148, + 1150, + 1147, + 1149, + 1146 ] } ] }, { - "id": 1126, + "id": 1169, "name": "PriceSetMoneyAmountRulesDTO", "variant": "declaration", "kind": 256, @@ -22706,7 +23575,7 @@ }, "children": [ { - "id": 1127, + "id": 1170, "name": "id", "variant": "declaration", "kind": 1024, @@ -22725,7 +23594,7 @@ } }, { - "id": 1128, + "id": 1171, "name": "price_set_money_amount", "variant": "declaration", "kind": 1024, @@ -22743,13 +23612,13 @@ }, "type": { "type": "reference", - "target": 1102, + "target": 1144, "name": "PriceSetMoneyAmountDTO", "package": "@medusajs/types" } }, { - "id": 1129, + "id": 1172, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -22767,13 +23636,13 @@ }, "type": { "type": "reference", - "target": 1165, + "target": 1208, "name": "RuleTypeDTO", "package": "@medusajs/types" } }, { - "id": 1130, + "id": 1173, "name": "value", "variant": "declaration", "kind": 1024, @@ -22796,23 +23665,23 @@ { "title": "Properties", "children": [ - 1127, - 1128, - 1129, - 1130 + 1170, + 1171, + 1172, + 1173 ] } ] }, { - "id": 1147, + "id": 1190, "name": "PriceSetRuleTypeDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 1148, + "id": 1191, "name": "id", "variant": "declaration", "kind": 1024, @@ -22823,33 +23692,33 @@ } }, { - "id": 1149, + "id": 1192, "name": "price_set", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 1037, + "target": 1079, "name": "PriceSetDTO", "package": "@medusajs/types" } }, { - "id": 1150, + "id": 1193, "name": "rule_type", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 1165, + "target": 1208, "name": "RuleTypeDTO", "package": "@medusajs/types" } }, { - "id": 1151, + "id": 1194, "name": "value", "variant": "declaration", "kind": 1024, @@ -22864,16 +23733,16 @@ { "title": "Properties", "children": [ - 1148, - 1149, - 1150, - 1151 + 1191, + 1192, + 1193, + 1194 ] } ] }, { - "id": 1033, + "id": 1075, "name": "PricingContext", "variant": "declaration", "kind": 256, @@ -22888,7 +23757,7 @@ }, "children": [ { - "id": 1034, + "id": 1076, "name": "context", "variant": "declaration", "kind": 1024, @@ -22969,13 +23838,13 @@ { "title": "Properties", "children": [ - 1034 + 1076 ] } ] }, { - "id": 1035, + "id": 1077, "name": "PricingFilters", "variant": "declaration", "kind": 256, @@ -22990,7 +23859,7 @@ }, "children": [ { - "id": 1036, + "id": 1078, "name": "id", "variant": "declaration", "kind": 1024, @@ -23016,20 +23885,20 @@ { "title": "Properties", "children": [ - 1036 + 1078 ] } ] }, { - "id": 1290, + "id": 1335, "name": "ProductCategoryTransformOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 1291, + "id": 1336, "name": "includeDescendantsTree", "variant": "declaration", "kind": 1024, @@ -23046,7 +23915,7 @@ { "title": "Properties", "children": [ - 1291 + 1336 ] } ], @@ -23060,14 +23929,14 @@ ] }, { - "id": 911, + "id": 951, "name": "RemoteExpandProperty", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 917, + "id": 957, "name": "args", "variant": "declaration", "kind": 1024, @@ -23078,14 +23947,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 880, + "target": 920, "name": "JoinerArgument", "package": "@medusajs/types" } } }, { - "id": 918, + "id": 958, "name": "expands", "variant": "declaration", "kind": 1024, @@ -23094,13 +23963,13 @@ }, "type": { "type": "reference", - "target": 904, + "target": 944, "name": "RemoteNestedExpands", "package": "@medusajs/types" } }, { - "id": 916, + "id": 956, "name": "fields", "variant": "declaration", "kind": 1024, @@ -23114,7 +23983,7 @@ } }, { - "id": 913, + "id": 953, "name": "parent", "variant": "declaration", "kind": 1024, @@ -23125,7 +23994,7 @@ } }, { - "id": 914, + "id": 954, "name": "parentConfig", "variant": "declaration", "kind": 1024, @@ -23134,13 +24003,13 @@ }, "type": { "type": "reference", - "target": 866, + "target": 906, "name": "JoinerServiceConfig", "package": "@medusajs/types" } }, { - "id": 912, + "id": 952, "name": "property", "variant": "declaration", "kind": 1024, @@ -23151,14 +24020,14 @@ } }, { - "id": 915, + "id": 955, "name": "serviceConfig", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 866, + "target": 906, "name": "JoinerServiceConfig", "package": "@medusajs/types" } @@ -23168,26 +24037,26 @@ { "title": "Properties", "children": [ - 917, - 918, - 916, - 913, - 914, - 912, - 915 + 957, + 958, + 956, + 953, + 954, + 952, + 955 ] } ] }, { - "id": 886, + "id": 926, "name": "RemoteJoinerQuery", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 888, + "id": 928, "name": "alias", "variant": "declaration", "kind": 1024, @@ -23200,7 +24069,7 @@ } }, { - "id": 899, + "id": 939, "name": "args", "variant": "declaration", "kind": 1024, @@ -23211,14 +24080,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 880, + "target": 920, "name": "JoinerArgument", "package": "@medusajs/types" } } }, { - "id": 900, + "id": 940, "name": "directives", "variant": "declaration", "kind": 1024, @@ -23228,20 +24097,20 @@ "type": { "type": "reflection", "declaration": { - "id": 901, + "id": 941, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 902, + "id": 942, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 903, + "id": 943, "name": "field", "variant": "param", "kind": 32768, @@ -23256,7 +24125,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 883, + "target": 923, "name": "JoinerDirective", "package": "@medusajs/types" } @@ -23266,7 +24135,7 @@ } }, { - "id": 889, + "id": 929, "name": "expands", "variant": "declaration", "kind": 1024, @@ -23278,14 +24147,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 890, + "id": 930, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 893, + "id": 933, "name": "args", "variant": "declaration", "kind": 1024, @@ -23296,14 +24165,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 880, + "target": 920, "name": "JoinerArgument", "package": "@medusajs/types" } } }, { - "id": 894, + "id": 934, "name": "directives", "variant": "declaration", "kind": 1024, @@ -23313,20 +24182,20 @@ "type": { "type": "reflection", "declaration": { - "id": 895, + "id": 935, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 896, + "id": 936, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 897, + "id": 937, "name": "field", "variant": "param", "kind": 32768, @@ -23341,7 +24210,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 883, + "target": 923, "name": "JoinerDirective", "package": "@medusajs/types" } @@ -23351,7 +24220,7 @@ } }, { - "id": 892, + "id": 932, "name": "fields", "variant": "declaration", "kind": 1024, @@ -23365,7 +24234,7 @@ } }, { - "id": 891, + "id": 931, "name": "property", "variant": "declaration", "kind": 1024, @@ -23380,10 +24249,10 @@ { "title": "Properties", "children": [ - 893, - 894, - 892, - 891 + 933, + 934, + 932, + 931 ] } ] @@ -23392,7 +24261,7 @@ } }, { - "id": 898, + "id": 938, "name": "fields", "variant": "declaration", "kind": 1024, @@ -23406,7 +24275,7 @@ } }, { - "id": 887, + "id": 927, "name": "service", "variant": "declaration", "kind": 1024, @@ -23423,31 +24292,31 @@ { "title": "Properties", "children": [ - 888, - 899, - 900, - 889, - 898, - 887 + 928, + 939, + 940, + 929, + 938, + 927 ] } ] }, { - "id": 904, + "id": 944, "name": "RemoteNestedExpands", "variant": "declaration", "kind": 256, "flags": {}, "indexSignature": { - "id": 905, + "id": 945, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 906, + "id": 946, "name": "key", "variant": "param", "kind": 32768, @@ -23461,14 +24330,14 @@ "type": { "type": "reflection", "declaration": { - "id": 907, + "id": 947, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 909, + "id": 949, "name": "args", "variant": "declaration", "kind": 1024, @@ -23479,14 +24348,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 880, + "target": 920, "name": "JoinerArgument", "package": "@medusajs/types" } } }, { - "id": 910, + "id": 950, "name": "expands", "variant": "declaration", "kind": 1024, @@ -23495,13 +24364,13 @@ }, "type": { "type": "reference", - "target": 904, + "target": 944, "name": "RemoteNestedExpands", "package": "@medusajs/types" } }, { - "id": 908, + "id": 948, "name": "fields", "variant": "declaration", "kind": 1024, @@ -23519,9 +24388,9 @@ { "title": "Properties", "children": [ - 909, - 910, - 908 + 949, + 950, + 948 ] } ] @@ -23530,7 +24399,7 @@ } }, { - "id": 1287, + "id": 1332, "name": "RemovePriceListRulesDTO", "variant": "declaration", "kind": 256, @@ -23545,7 +24414,7 @@ }, "children": [ { - "id": 1288, + "id": 1333, "name": "priceListId", "variant": "declaration", "kind": 1024, @@ -23564,7 +24433,7 @@ } }, { - "id": 1289, + "id": 1334, "name": "rules", "variant": "declaration", "kind": 1024, @@ -23598,14 +24467,14 @@ { "title": "Properties", "children": [ - 1288, - 1289 + 1333, + 1334 ] } ] }, { - "id": 1087, + "id": 1129, "name": "RemovePriceSetRulesDTO", "variant": "declaration", "kind": 256, @@ -23620,7 +24489,7 @@ }, "children": [ { - "id": 1088, + "id": 1130, "name": "id", "variant": "declaration", "kind": 1024, @@ -23639,7 +24508,7 @@ } }, { - "id": 1089, + "id": 1131, "name": "rules", "variant": "declaration", "kind": 1024, @@ -23673,14 +24542,14 @@ { "title": "Properties", "children": [ - 1088, - 1089 + 1130, + 1131 ] } ] }, { - "id": 1165, + "id": 1208, "name": "RuleTypeDTO", "variant": "declaration", "kind": 256, @@ -23695,7 +24564,7 @@ }, "children": [ { - "id": 1169, + "id": 1212, "name": "default_priority", "variant": "declaration", "kind": 1024, @@ -23714,7 +24583,7 @@ } }, { - "id": 1166, + "id": 1209, "name": "id", "variant": "declaration", "kind": 1024, @@ -23733,7 +24602,7 @@ } }, { - "id": 1167, + "id": 1210, "name": "name", "variant": "declaration", "kind": 1024, @@ -23752,7 +24621,7 @@ } }, { - "id": 1168, + "id": 1211, "name": "rule_attribute", "variant": "declaration", "kind": 1024, @@ -23791,16 +24660,16 @@ { "title": "Properties", "children": [ - 1169, - 1166, - 1167, - 1168 + 1212, + 1209, + 1210, + 1211 ] } ] }, { - "id": 1284, + "id": 1329, "name": "SetPriceListRulesDTO", "variant": "declaration", "kind": 256, @@ -23815,7 +24684,7 @@ }, "children": [ { - "id": 1285, + "id": 1330, "name": "priceListId", "variant": "declaration", "kind": 1024, @@ -23834,7 +24703,7 @@ } }, { - "id": 1286, + "id": 1331, "name": "rules", "variant": "declaration", "kind": 1024, @@ -23892,14 +24761,14 @@ { "title": "Properties", "children": [ - 1285, - 1286 + 1330, + 1331 ] } ] }, { - "id": 1292, + "id": 1337, "name": "SharedContext", "variant": "declaration", "kind": 256, @@ -23914,7 +24783,7 @@ }, "children": [ { - "id": 1294, + "id": 1339, "name": "manager", "variant": "declaration", "kind": 1024, @@ -23940,7 +24809,7 @@ } }, { - "id": 1293, + "id": 1338, "name": "transactionManager", "variant": "declaration", "kind": 1024, @@ -23970,14 +24839,14 @@ { "title": "Properties", "children": [ - 1294, - 1293 + 1339, + 1338 ] } ] }, { - "id": 966, + "id": 1006, "name": "UpdateCurrencyDTO", "variant": "declaration", "kind": 256, @@ -24000,7 +24869,7 @@ }, "children": [ { - "id": 967, + "id": 1007, "name": "code", "variant": "declaration", "kind": 1024, @@ -24019,7 +24888,7 @@ } }, { - "id": 970, + "id": 1010, "name": "name", "variant": "declaration", "kind": 1024, @@ -24040,7 +24909,7 @@ } }, { - "id": 968, + "id": 1008, "name": "symbol", "variant": "declaration", "kind": 1024, @@ -24061,7 +24930,7 @@ } }, { - "id": 969, + "id": 1009, "name": "symbol_native", "variant": "declaration", "kind": 1024, @@ -24086,16 +24955,16 @@ { "title": "Properties", "children": [ - 967, - 970, - 968, - 969 + 1007, + 1010, + 1008, + 1009 ] } ] }, { - "id": 990, + "id": 1030, "name": "UpdateMoneyAmountDTO", "variant": "declaration", "kind": 256, @@ -24118,7 +24987,7 @@ }, "children": [ { - "id": 993, + "id": 1033, "name": "amount", "variant": "declaration", "kind": 1024, @@ -24139,7 +25008,7 @@ } }, { - "id": 992, + "id": 1032, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -24160,7 +25029,7 @@ } }, { - "id": 991, + "id": 1031, "name": "id", "variant": "declaration", "kind": 1024, @@ -24179,7 +25048,7 @@ } }, { - "id": 995, + "id": 1035, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -24200,7 +25069,7 @@ } }, { - "id": 994, + "id": 1034, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -24225,17 +25094,17 @@ { "title": "Properties", "children": [ - 993, - 992, - 991, - 995, - 994 + 1033, + 1032, + 1031, + 1035, + 1034 ] } ] }, { - "id": 1223, + "id": 1268, "name": "UpdatePriceListDTO", "variant": "declaration", "kind": 256, @@ -24250,7 +25119,7 @@ }, "children": [ { - "id": 1227, + "id": 1272, "name": "ends_at", "variant": "declaration", "kind": 1024, @@ -24280,7 +25149,7 @@ } }, { - "id": 1224, + "id": 1269, "name": "id", "variant": "declaration", "kind": 1024, @@ -24299,8 +25168,8 @@ } }, { - "id": 1229, - "name": "number_rules", + "id": 1275, + "name": "rules", "variant": "declaration", "kind": 1024, "flags": { @@ -24310,18 +25179,20 @@ "summary": [ { "kind": "text", - "text": "The number of rules associated with the price list." + "text": "The rules to be created and associated with the price list." } ] }, "type": { - "type": "intrinsic", - "name": "number" + "type": "reference", + "target": 1257, + "name": "CreatePriceListRules", + "package": "@medusajs/types" } }, { - "id": 1230, - "name": "rules", + "id": 1274, + "name": "rules_count", "variant": "declaration", "kind": 1024, "flags": { @@ -24331,19 +25202,17 @@ "summary": [ { "kind": "text", - "text": "The rules to be created and associated with the price list." + "text": "The number of rules associated with the price list." } ] }, "type": { - "type": "reference", - "target": 1212, - "name": "CreatePriceListRules", - "package": "@medusajs/types" + "type": "intrinsic", + "name": "number" } }, { - "id": 1226, + "id": 1271, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -24373,7 +25242,7 @@ } }, { - "id": 1228, + "id": 1273, "name": "status", "variant": "declaration", "kind": 1024, @@ -24390,13 +25259,13 @@ }, "type": { "type": "reference", - "target": 1186, + "target": 1229, "name": "PriceListStatus", "package": "@medusajs/types" } }, { - "id": 1225, + "id": 1270, "name": "title", "variant": "declaration", "kind": 1024, @@ -24421,19 +25290,19 @@ { "title": "Properties", "children": [ - 1227, - 1224, - 1229, - 1230, - 1226, - 1228, - 1225 + 1272, + 1269, + 1275, + 1274, + 1271, + 1273, + 1270 ] } ] }, { - "id": 1263, + "id": 1308, "name": "UpdatePriceListRuleDTO", "variant": "declaration", "kind": 256, @@ -24448,7 +25317,7 @@ }, "children": [ { - "id": 1264, + "id": 1309, "name": "id", "variant": "declaration", "kind": 1024, @@ -24467,7 +25336,7 @@ } }, { - "id": 1267, + "id": 1312, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -24488,7 +25357,7 @@ } }, { - "id": 1265, + "id": 1310, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -24509,7 +25378,7 @@ } }, { - "id": 1268, + "id": 1313, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -24530,7 +25399,7 @@ } }, { - "id": 1266, + "id": 1311, "name": "rule_type_id", "variant": "declaration", "kind": 1024, @@ -24555,24 +25424,24 @@ { "title": "Properties", "children": [ - 1264, - 1267, - 1265, - 1268, - 1266 + 1309, + 1312, + 1310, + 1313, + 1311 ] } ] }, { - "id": 1277, + "id": 1322, "name": "UpdatePriceListRuleValueDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 1278, + "id": 1323, "name": "id", "variant": "declaration", "kind": 1024, @@ -24583,7 +25452,7 @@ } }, { - "id": 1280, + "id": 1325, "name": "price_list_rule_id", "variant": "declaration", "kind": 1024, @@ -24594,7 +25463,7 @@ } }, { - "id": 1279, + "id": 1324, "name": "value", "variant": "declaration", "kind": 1024, @@ -24609,15 +25478,15 @@ { "title": "Properties", "children": [ - 1278, - 1280, - 1279 + 1323, + 1325, + 1324 ] } ] }, { - "id": 1018, + "id": 1060, "name": "UpdatePriceRuleDTO", "variant": "declaration", "kind": 256, @@ -24640,7 +25509,7 @@ }, "children": [ { - "id": 1019, + "id": 1061, "name": "id", "variant": "declaration", "kind": 1024, @@ -24651,7 +25520,7 @@ } }, { - "id": 1025, + "id": 1067, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -24672,7 +25541,7 @@ } }, { - "id": 1020, + "id": 1062, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -24685,7 +25554,7 @@ } }, { - "id": 1024, + "id": 1066, "name": "price_set_money_amount_id", "variant": "declaration", "kind": 1024, @@ -24706,7 +25575,7 @@ } }, { - "id": 1023, + "id": 1065, "name": "priority", "variant": "declaration", "kind": 1024, @@ -24727,7 +25596,7 @@ } }, { - "id": 1021, + "id": 1063, "name": "rule_type_id", "variant": "declaration", "kind": 1024, @@ -24740,7 +25609,7 @@ } }, { - "id": 1022, + "id": 1064, "name": "value", "variant": "declaration", "kind": 1024, @@ -24765,19 +25634,19 @@ { "title": "Properties", "children": [ - 1019, - 1025, - 1020, - 1024, - 1023, - 1021, - 1022 + 1061, + 1067, + 1062, + 1066, + 1065, + 1063, + 1064 ] } ] }, { - "id": 1095, + "id": 1137, "name": "UpdatePriceSetDTO", "variant": "declaration", "kind": 256, @@ -24800,7 +25669,7 @@ }, "children": [ { - "id": 1096, + "id": 1138, "name": "id", "variant": "declaration", "kind": 1024, @@ -24823,20 +25692,20 @@ { "title": "Properties", "children": [ - 1096 + 1138 ] } ] }, { - "id": 1110, + "id": 1152, "name": "UpdatePriceSetMoneyAmountDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 1111, + "id": 1153, "name": "id", "variant": "declaration", "kind": 1024, @@ -24847,7 +25716,7 @@ } }, { - "id": 1114, + "id": 1156, "name": "money_amount", "variant": "declaration", "kind": 1024, @@ -24856,13 +25725,13 @@ }, "type": { "type": "reference", - "target": 975, + "target": 1015, "name": "MoneyAmountDTO", "package": "@medusajs/types" } }, { - "id": 1113, + "id": 1155, "name": "price_set", "variant": "declaration", "kind": 1024, @@ -24871,13 +25740,13 @@ }, "type": { "type": "reference", - "target": 1037, + "target": 1079, "name": "PriceSetDTO", "package": "@medusajs/types" } }, { - "id": 1112, + "id": 1154, "name": "title", "variant": "declaration", "kind": 1024, @@ -24894,16 +25763,16 @@ { "title": "Properties", "children": [ - 1111, - 1114, - 1113, - 1112 + 1153, + 1156, + 1155, + 1154 ] } ] }, { - "id": 1135, + "id": 1178, "name": "UpdatePriceSetMoneyAmountRulesDTO", "variant": "declaration", "kind": 256, @@ -24926,7 +25795,7 @@ }, "children": [ { - "id": 1136, + "id": 1179, "name": "id", "variant": "declaration", "kind": 1024, @@ -24945,7 +25814,7 @@ } }, { - "id": 1137, + "id": 1180, "name": "price_set_money_amount", "variant": "declaration", "kind": 1024, @@ -24966,7 +25835,7 @@ } }, { - "id": 1138, + "id": 1181, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -24987,7 +25856,7 @@ } }, { - "id": 1139, + "id": 1182, "name": "value", "variant": "declaration", "kind": 1024, @@ -25012,23 +25881,23 @@ { "title": "Properties", "children": [ - 1136, - 1137, - 1138, - 1139 + 1179, + 1180, + 1181, + 1182 ] } ] }, { - "id": 1155, + "id": 1198, "name": "UpdatePriceSetRuleTypeDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 1156, + "id": 1199, "name": "id", "variant": "declaration", "kind": 1024, @@ -25039,7 +25908,7 @@ } }, { - "id": 1157, + "id": 1200, "name": "price_set", "variant": "declaration", "kind": 1024, @@ -25052,7 +25921,7 @@ } }, { - "id": 1158, + "id": 1201, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -25069,15 +25938,15 @@ { "title": "Properties", "children": [ - 1156, - 1157, - 1158 + 1199, + 1200, + 1201 ] } ] }, { - "id": 1175, + "id": 1218, "name": "UpdateRuleTypeDTO", "variant": "declaration", "kind": 256, @@ -25100,7 +25969,7 @@ }, "children": [ { - "id": 1179, + "id": 1222, "name": "default_priority", "variant": "declaration", "kind": 1024, @@ -25121,7 +25990,7 @@ } }, { - "id": 1176, + "id": 1219, "name": "id", "variant": "declaration", "kind": 1024, @@ -25140,7 +26009,7 @@ } }, { - "id": 1177, + "id": 1220, "name": "name", "variant": "declaration", "kind": 1024, @@ -25161,7 +26030,7 @@ } }, { - "id": 1178, + "id": 1221, "name": "rule_attribute", "variant": "declaration", "kind": 1024, @@ -25202,10 +26071,10 @@ { "title": "Properties", "children": [ - 1179, - 1176, - 1177, - 1178 + 1222, + 1219, + 1220, + 1221 ] } ] @@ -25539,7 +26408,7 @@ } }, { - "id": 796, + "id": 836, "name": "CartDTO", "variant": "declaration", "kind": 2097152, @@ -25547,14 +26416,14 @@ "type": { "type": "reflection", "declaration": { - "id": 797, + "id": 837, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 800, + "id": 840, "name": "billing_address_id", "variant": "declaration", "kind": 1024, @@ -25567,7 +26436,7 @@ } }, { - "id": 805, + "id": 845, "name": "completed_at", "variant": "declaration", "kind": 1024, @@ -25585,7 +26454,7 @@ } }, { - "id": 808, + "id": 848, "name": "context", "variant": "declaration", "kind": 1024, @@ -25613,7 +26482,7 @@ } }, { - "id": 803, + "id": 843, "name": "customer_id", "variant": "declaration", "kind": 1024, @@ -25626,7 +26495,7 @@ } }, { - "id": 812, + "id": 852, "name": "discount_total", "variant": "declaration", "kind": 1024, @@ -25639,7 +26508,7 @@ } }, { - "id": 799, + "id": 839, "name": "email", "variant": "declaration", "kind": 1024, @@ -25652,7 +26521,7 @@ } }, { - "id": 822, + "id": 862, "name": "gift_card_tax_total", "variant": "declaration", "kind": 1024, @@ -25665,7 +26534,7 @@ } }, { - "id": 821, + "id": 861, "name": "gift_card_total", "variant": "declaration", "kind": 1024, @@ -25678,7 +26547,7 @@ } }, { - "id": 798, + "id": 838, "name": "id", "variant": "declaration", "kind": 1024, @@ -25691,7 +26560,7 @@ } }, { - "id": 807, + "id": 847, "name": "idempotency_key", "variant": "declaration", "kind": 1024, @@ -25704,7 +26573,7 @@ } }, { - "id": 814, + "id": 854, "name": "item_tax_total", "variant": "declaration", "kind": 1024, @@ -25726,7 +26595,7 @@ } }, { - "id": 809, + "id": 849, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -25754,7 +26623,7 @@ } }, { - "id": 806, + "id": 846, "name": "payment_authorized_at", "variant": "declaration", "kind": 1024, @@ -25772,7 +26641,7 @@ } }, { - "id": 804, + "id": 844, "name": "payment_id", "variant": "declaration", "kind": 1024, @@ -25785,7 +26654,7 @@ } }, { - "id": 813, + "id": 853, "name": "raw_discount_total", "variant": "declaration", "kind": 1024, @@ -25798,7 +26667,7 @@ } }, { - "id": 820, + "id": 860, "name": "refundable_amount", "variant": "declaration", "kind": 1024, @@ -25811,7 +26680,7 @@ } }, { - "id": 817, + "id": 857, "name": "refunded_total", "variant": "declaration", "kind": 1024, @@ -25824,7 +26693,7 @@ } }, { - "id": 802, + "id": 842, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -25837,7 +26706,7 @@ } }, { - "id": 810, + "id": 850, "name": "sales_channel_id", "variant": "declaration", "kind": 1024, @@ -25859,7 +26728,7 @@ } }, { - "id": 801, + "id": 841, "name": "shipping_address_id", "variant": "declaration", "kind": 1024, @@ -25872,7 +26741,7 @@ } }, { - "id": 815, + "id": 855, "name": "shipping_tax_total", "variant": "declaration", "kind": 1024, @@ -25894,7 +26763,7 @@ } }, { - "id": 811, + "id": 851, "name": "shipping_total", "variant": "declaration", "kind": 1024, @@ -25907,7 +26776,7 @@ } }, { - "id": 819, + "id": 859, "name": "subtotal", "variant": "declaration", "kind": 1024, @@ -25920,7 +26789,7 @@ } }, { - "id": 816, + "id": 856, "name": "tax_total", "variant": "declaration", "kind": 1024, @@ -25942,7 +26811,7 @@ } }, { - "id": 818, + "id": 858, "name": "total", "variant": "declaration", "kind": 1024, @@ -25959,31 +26828,31 @@ { "title": "Properties", "children": [ - 800, - 805, - 808, - 803, - 812, - 799, - 822, - 821, - 798, - 807, - 814, - 809, - 806, - 804, - 813, - 820, - 817, - 802, - 810, - 801, - 815, - 811, - 819, - 816, - 818 + 840, + 845, + 848, + 843, + 852, + 839, + 862, + 861, + 838, + 847, + 854, + 849, + 846, + 844, + 853, + 860, + 857, + 842, + 850, + 841, + 855, + 851, + 859, + 856, + 858 ] } ] @@ -25991,7 +26860,7 @@ } }, { - "id": 841, + "id": 881, "name": "DeleteFileType", "variant": "declaration", "kind": 2097152, @@ -25999,14 +26868,14 @@ "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 882, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 843, + "id": 883, "name": "fileKey", "variant": "declaration", "kind": 1024, @@ -26021,19 +26890,19 @@ { "title": "Properties", "children": [ - 843 + 883 ] } ], "indexSignature": { - "id": 844, + "id": 884, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 845, + "id": 885, "name": "x", "variant": "param", "kind": 32768, @@ -26053,14 +26922,14 @@ } }, { - "id": 1335, + "id": 1380, "name": "Dictionary", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 1339, + "id": 1384, "name": "T", "variant": "typeParam", "kind": 131072, @@ -26074,20 +26943,20 @@ "type": { "type": "reflection", "declaration": { - "id": 1336, + "id": 1381, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 1337, + "id": 1382, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 1338, + "id": 1383, "name": "k", "variant": "param", "kind": 32768, @@ -26109,14 +26978,14 @@ } }, { - "id": 1375, + "id": 1420, "name": "ExpandScalar", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 1376, + "id": 1421, "name": "T", "variant": "typeParam", "kind": 131072, @@ -26207,7 +27076,7 @@ } }, { - "id": 827, + "id": 867, "name": "FileServiceGetUploadStreamResult", "variant": "declaration", "kind": 2097152, @@ -26215,14 +27084,14 @@ "type": { "type": "reflection", "declaration": { - "id": 828, + "id": 868, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 832, + "id": 872, "name": "fileKey", "variant": "declaration", "kind": 1024, @@ -26233,7 +27102,7 @@ } }, { - "id": 830, + "id": 870, "name": "promise", "variant": "declaration", "kind": 1024, @@ -26255,7 +27124,7 @@ } }, { - "id": 831, + "id": 871, "name": "url", "variant": "declaration", "kind": 1024, @@ -26266,7 +27135,7 @@ } }, { - "id": 829, + "id": 869, "name": "writeStream", "variant": "declaration", "kind": 1024, @@ -26287,22 +27156,22 @@ { "title": "Properties", "children": [ - 832, - 830, - 831, - 829 + 872, + 870, + 871, + 869 ] } ], "indexSignature": { - "id": 833, + "id": 873, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 834, + "id": 874, "name": "x", "variant": "param", "kind": 32768, @@ -26322,7 +27191,7 @@ } }, { - "id": 823, + "id": 863, "name": "FileServiceUploadResult", "variant": "declaration", "kind": 2097152, @@ -26330,14 +27199,14 @@ "type": { "type": "reflection", "declaration": { - "id": 824, + "id": 864, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 826, + "id": 866, "name": "key", "variant": "declaration", "kind": 1024, @@ -26348,7 +27217,7 @@ } }, { - "id": 825, + "id": 865, "name": "url", "variant": "declaration", "kind": 1024, @@ -26363,8 +27232,8 @@ { "title": "Properties", "children": [ - 826, - 825 + 866, + 865 ] } ] @@ -26372,14 +27241,14 @@ } }, { - "id": 1381, + "id": 1426, "name": "FilterValue", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 1382, + "id": 1427, "name": "T", "variant": "typeParam", "kind": 131072, @@ -26391,11 +27260,11 @@ "types": [ { "type": "reference", - "target": 1310, + "target": 1355, "typeArguments": [ { "type": "reference", - "target": 1383, + "target": 1428, "typeArguments": [ { "type": "reference", @@ -26413,7 +27282,7 @@ }, { "type": "reference", - "target": 1383, + "target": 1428, "typeArguments": [ { "type": "reference", @@ -26429,7 +27298,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1383, + "target": 1428, "typeArguments": [ { "type": "reference", @@ -26450,14 +27319,14 @@ } }, { - "id": 1383, + "id": 1428, "name": "FilterValue2", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 1384, + "id": 1429, "name": "T", "variant": "typeParam", "kind": 131072, @@ -26475,7 +27344,7 @@ }, { "type": "reference", - "target": 1375, + "target": 1420, "typeArguments": [ { "type": "reference", @@ -26489,7 +27358,7 @@ }, { "type": "reference", - "target": 1385, + "target": 1430, "typeArguments": [ { "type": "reference", @@ -26505,7 +27374,7 @@ } }, { - "id": 835, + "id": 875, "name": "GetUploadedFileType", "variant": "declaration", "kind": 2097152, @@ -26513,14 +27382,14 @@ "type": { "type": "reflection", "declaration": { - "id": 836, + "id": 876, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 837, + "id": 877, "name": "fileKey", "variant": "declaration", "kind": 1024, @@ -26531,7 +27400,7 @@ } }, { - "id": 838, + "id": 878, "name": "isPrivate", "variant": "declaration", "kind": 1024, @@ -26548,20 +27417,20 @@ { "title": "Properties", "children": [ - 837, - 838 + 877, + 878 ] } ], "indexSignature": { - "id": 839, + "id": 879, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 840, + "id": 880, "name": "x", "variant": "param", "kind": 32768, @@ -26581,7 +27450,7 @@ } }, { - "id": 853, + "id": 893, "name": "JoinerRelationship", "variant": "declaration", "kind": 2097152, @@ -26589,14 +27458,14 @@ "type": { "type": "reflection", "declaration": { - "id": 854, + "id": 894, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 855, + "id": 895, "name": "alias", "variant": "declaration", "kind": 1024, @@ -26607,7 +27476,7 @@ } }, { - "id": 862, + "id": 902, "name": "args", "variant": "declaration", "kind": 1024, @@ -26643,7 +27512,7 @@ } }, { - "id": 856, + "id": 896, "name": "foreignKey", "variant": "declaration", "kind": 1024, @@ -26654,7 +27523,7 @@ } }, { - "id": 860, + "id": 900, "name": "inverse", "variant": "declaration", "kind": 1024, @@ -26675,7 +27544,7 @@ } }, { - "id": 859, + "id": 899, "name": "isInternalService", "variant": "declaration", "kind": 1024, @@ -26696,7 +27565,7 @@ } }, { - "id": 861, + "id": 901, "name": "isList", "variant": "declaration", "kind": 1024, @@ -26717,7 +27586,7 @@ } }, { - "id": 857, + "id": 897, "name": "primaryKey", "variant": "declaration", "kind": 1024, @@ -26728,7 +27597,7 @@ } }, { - "id": 858, + "id": 898, "name": "serviceName", "variant": "declaration", "kind": 1024, @@ -26743,14 +27612,14 @@ { "title": "Properties", "children": [ - 855, - 862, - 856, - 860, - 859, - 861, - 857, - 858 + 895, + 902, + 896, + 900, + 899, + 901, + 897, + 898 ] } ] @@ -26758,7 +27627,7 @@ } }, { - "id": 1365, + "id": 1410, "name": "ModuleDeclaration", "variant": "declaration", "kind": 2097152, @@ -26768,13 +27637,13 @@ "types": [ { "type": "reference", - "target": 507, + "target": 535, "name": "ExternalModuleDeclaration", "package": "@medusajs/types" }, { "type": "reference", - "target": 497, + "target": 525, "name": "InternalModuleDeclaration", "package": "@medusajs/types" } @@ -26782,14 +27651,14 @@ } }, { - "id": 1310, + "id": 1355, "name": "OperatorMap", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 1331, + "id": 1376, "name": "T", "variant": "typeParam", "kind": 131072, @@ -26799,14 +27668,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1311, + "id": 1356, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1312, + "id": 1357, "name": "$and", "variant": "declaration", "kind": 1024, @@ -26817,7 +27686,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1373, + "target": 1418, "typeArguments": [ { "type": "reference", @@ -26832,7 +27701,7 @@ } }, { - "id": 1329, + "id": 1374, "name": "$contained", "variant": "declaration", "kind": 1024, @@ -26848,7 +27717,7 @@ } }, { - "id": 1328, + "id": 1373, "name": "$contains", "variant": "declaration", "kind": 1024, @@ -26864,7 +27733,7 @@ } }, { - "id": 1314, + "id": 1359, "name": "$eq", "variant": "declaration", "kind": 1024, @@ -26876,7 +27745,7 @@ "types": [ { "type": "reference", - "target": 1375, + "target": 1420, "typeArguments": [ { "type": "reference", @@ -26892,7 +27761,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1375, + "target": 1420, "typeArguments": [ { "type": "reference", @@ -26909,7 +27778,7 @@ } }, { - "id": 1330, + "id": 1375, "name": "$exists", "variant": "declaration", "kind": 1024, @@ -26922,7 +27791,7 @@ } }, { - "id": 1326, + "id": 1371, "name": "$fulltext", "variant": "declaration", "kind": 1024, @@ -26935,7 +27804,7 @@ } }, { - "id": 1319, + "id": 1364, "name": "$gt", "variant": "declaration", "kind": 1024, @@ -26944,7 +27813,7 @@ }, "type": { "type": "reference", - "target": 1375, + "target": 1420, "typeArguments": [ { "type": "reference", @@ -26958,7 +27827,7 @@ } }, { - "id": 1320, + "id": 1365, "name": "$gte", "variant": "declaration", "kind": 1024, @@ -26967,7 +27836,7 @@ }, "type": { "type": "reference", - "target": 1375, + "target": 1420, "typeArguments": [ { "type": "reference", @@ -26981,7 +27850,7 @@ } }, { - "id": 1325, + "id": 1370, "name": "$ilike", "variant": "declaration", "kind": 1024, @@ -26994,7 +27863,7 @@ } }, { - "id": 1316, + "id": 1361, "name": "$in", "variant": "declaration", "kind": 1024, @@ -27005,7 +27874,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1375, + "target": 1420, "typeArguments": [ { "type": "reference", @@ -27020,7 +27889,7 @@ } }, { - "id": 1323, + "id": 1368, "name": "$like", "variant": "declaration", "kind": 1024, @@ -27033,7 +27902,7 @@ } }, { - "id": 1321, + "id": 1366, "name": "$lt", "variant": "declaration", "kind": 1024, @@ -27042,7 +27911,7 @@ }, "type": { "type": "reference", - "target": 1375, + "target": 1420, "typeArguments": [ { "type": "reference", @@ -27056,7 +27925,7 @@ } }, { - "id": 1322, + "id": 1367, "name": "$lte", "variant": "declaration", "kind": 1024, @@ -27065,7 +27934,7 @@ }, "type": { "type": "reference", - "target": 1375, + "target": 1420, "typeArguments": [ { "type": "reference", @@ -27079,7 +27948,7 @@ } }, { - "id": 1315, + "id": 1360, "name": "$ne", "variant": "declaration", "kind": 1024, @@ -27088,7 +27957,7 @@ }, "type": { "type": "reference", - "target": 1375, + "target": 1420, "typeArguments": [ { "type": "reference", @@ -27102,7 +27971,7 @@ } }, { - "id": 1317, + "id": 1362, "name": "$nin", "variant": "declaration", "kind": 1024, @@ -27113,7 +27982,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1375, + "target": 1420, "typeArguments": [ { "type": "reference", @@ -27128,7 +27997,7 @@ } }, { - "id": 1318, + "id": 1363, "name": "$not", "variant": "declaration", "kind": 1024, @@ -27137,7 +28006,7 @@ }, "type": { "type": "reference", - "target": 1373, + "target": 1418, "typeArguments": [ { "type": "reference", @@ -27151,7 +28020,7 @@ } }, { - "id": 1313, + "id": 1358, "name": "$or", "variant": "declaration", "kind": 1024, @@ -27162,7 +28031,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1373, + "target": 1418, "typeArguments": [ { "type": "reference", @@ -27177,7 +28046,7 @@ } }, { - "id": 1327, + "id": 1372, "name": "$overlap", "variant": "declaration", "kind": 1024, @@ -27193,7 +28062,7 @@ } }, { - "id": 1324, + "id": 1369, "name": "$re", "variant": "declaration", "kind": 1024, @@ -27210,25 +28079,25 @@ { "title": "Properties", "children": [ - 1312, - 1329, - 1328, - 1314, - 1330, - 1326, - 1319, - 1320, - 1325, - 1316, - 1323, - 1321, - 1322, - 1315, - 1317, - 1318, - 1313, - 1327, - 1324 + 1357, + 1374, + 1373, + 1359, + 1375, + 1371, + 1364, + 1365, + 1370, + 1361, + 1368, + 1366, + 1367, + 1360, + 1362, + 1363, + 1358, + 1372, + 1369 ] } ] @@ -27236,14 +28105,14 @@ } }, { - "id": 1333, + "id": 1378, "name": "Order", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 1334, + "id": 1379, "name": "T", "variant": "typeParam", "kind": 131072, @@ -27276,7 +28145,7 @@ }, { "type": "reference", - "target": 1333, + "target": 1378, "typeArguments": [ { "type": "conditional", @@ -27350,7 +28219,7 @@ } }, { - "id": 1332, + "id": 1377, "name": "PrevLimit", "variant": "declaration", "kind": 2097152, @@ -27378,14 +28247,14 @@ } }, { - "id": 1385, + "id": 1430, "name": "Primary", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 1394, + "id": 1439, "name": "T", "variant": "typeParam", "kind": 131072, @@ -27403,14 +28272,14 @@ "extendsType": { "type": "reflection", "declaration": { - "id": 1386, + "id": 1431, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1387, + "id": 1432, "name": "[PrimaryKeyType]", "variant": "declaration", "kind": 1024, @@ -27427,7 +28296,7 @@ { "title": "Properties", "children": [ - 1387 + 1432 ] } ] @@ -27435,7 +28304,7 @@ }, "trueType": { "type": "reference", - "target": 1395, + "target": 1440, "typeArguments": [ { "type": "reference", @@ -27458,14 +28327,14 @@ "extendsType": { "type": "reflection", "declaration": { - "id": 1388, + "id": 1433, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1389, + "id": 1434, "name": "_id", "variant": "declaration", "kind": 1024, @@ -27482,7 +28351,7 @@ { "title": "Properties", "children": [ - 1389 + 1434 ] } ] @@ -27493,7 +28362,7 @@ "types": [ { "type": "reference", - "target": 1395, + "target": 1440, "typeArguments": [ { "type": "reference", @@ -27522,14 +28391,14 @@ "extendsType": { "type": "reflection", "declaration": { - "id": 1390, + "id": 1435, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1391, + "id": 1436, "name": "uuid", "variant": "declaration", "kind": 1024, @@ -27546,7 +28415,7 @@ { "title": "Properties", "children": [ - 1391 + 1436 ] } ] @@ -27554,7 +28423,7 @@ }, "trueType": { "type": "reference", - "target": 1395, + "target": 1440, "typeArguments": [ { "type": "reference", @@ -27577,14 +28446,14 @@ "extendsType": { "type": "reflection", "declaration": { - "id": 1392, + "id": 1437, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1393, + "id": 1438, "name": "id", "variant": "declaration", "kind": 1024, @@ -27601,7 +28470,7 @@ { "title": "Properties", "children": [ - 1393 + 1438 ] } ] @@ -27609,7 +28478,7 @@ }, "trueType": { "type": "reference", - "target": 1395, + "target": 1440, "typeArguments": [ { "type": "reference", @@ -27631,14 +28500,14 @@ } }, { - "id": 1373, + "id": 1418, "name": "Query", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 1374, + "id": 1419, "name": "T", "variant": "typeParam", "kind": 131072, @@ -27667,7 +28536,7 @@ }, "extendsType": { "type": "reference", - "target": 1377, + "target": 1422, "name": "Scalar", "package": "@medusajs/types" }, @@ -27677,7 +28546,7 @@ }, "falseType": { "type": "reference", - "target": 211, + "target": 239, "typeArguments": [ { "type": "reference", @@ -27692,7 +28561,7 @@ }, "falseType": { "type": "reference", - "target": 1381, + "target": 1426, "typeArguments": [ { "type": "reference", @@ -27707,14 +28576,14 @@ } }, { - "id": 1395, + "id": 1440, "name": "ReadonlyPrimary", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 1396, + "id": 1441, "name": "T", "variant": "typeParam", "kind": 131072, @@ -27762,7 +28631,7 @@ } }, { - "id": 1377, + "id": 1422, "name": "Scalar", "variant": "declaration", "kind": 2097152, @@ -27821,21 +28690,21 @@ { "type": "reflection", "declaration": { - "id": 1378, + "id": 1423, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1379, + "id": 1424, "name": "toHexString", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1380, + "id": 1425, "name": "toHexString", "variant": "signature", "kind": 4096, @@ -27852,7 +28721,7 @@ { "title": "Methods", "children": [ - 1379 + 1424 ] } ] @@ -27862,7 +28731,7 @@ } }, { - "id": 1302, + "id": 1347, "name": "SessionOptions", "variant": "declaration", "kind": 2097152, @@ -27870,14 +28739,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1303, + "id": 1348, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1304, + "id": 1349, "name": "name", "variant": "declaration", "kind": 1024, @@ -27890,7 +28759,7 @@ } }, { - "id": 1305, + "id": 1350, "name": "resave", "variant": "declaration", "kind": 1024, @@ -27903,7 +28772,7 @@ } }, { - "id": 1306, + "id": 1351, "name": "rolling", "variant": "declaration", "kind": 1024, @@ -27916,7 +28785,7 @@ } }, { - "id": 1307, + "id": 1352, "name": "saveUninitialized", "variant": "declaration", "kind": 1024, @@ -27929,7 +28798,7 @@ } }, { - "id": 1308, + "id": 1353, "name": "secret", "variant": "declaration", "kind": 1024, @@ -27942,7 +28811,7 @@ } }, { - "id": 1309, + "id": 1354, "name": "ttl", "variant": "declaration", "kind": 1024, @@ -27959,12 +28828,12 @@ { "title": "Properties", "children": [ - 1304, - 1305, - 1306, - 1307, - 1308, - 1309 + 1349, + 1350, + 1351, + 1352, + 1353, + 1354 ] } ] @@ -27972,7 +28841,7 @@ } }, { - "id": 846, + "id": 886, "name": "UploadStreamDescriptorType", "variant": "declaration", "kind": 2097152, @@ -27980,14 +28849,14 @@ "type": { "type": "reflection", "declaration": { - "id": 847, + "id": 887, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 849, + "id": 889, "name": "ext", "variant": "declaration", "kind": 1024, @@ -28000,7 +28869,7 @@ } }, { - "id": 850, + "id": 890, "name": "isPrivate", "variant": "declaration", "kind": 1024, @@ -28013,7 +28882,7 @@ } }, { - "id": 848, + "id": 888, "name": "name", "variant": "declaration", "kind": 1024, @@ -28028,21 +28897,21 @@ { "title": "Properties", "children": [ - 849, - 850, - 848 + 889, + 890, + 888 ] } ], "indexSignature": { - "id": 851, + "id": 891, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 852, + "id": 892, "name": "x", "variant": "param", "kind": 32768, @@ -28068,123 +28937,126 @@ "children": [ 16, 30, - 210, - 340, - 406, - 425, - 483, - 641, - 652, - 696, - 701 + 216, + 238, + 368, + 434, + 453, + 511, + 669, + 681, + 692, + 736, + 741 ] }, { "title": "Enumerations", "children": [ - 1186, - 1189 + 1229, + 1232 ] }, { "title": "Interfaces", "children": [ - 1281, - 1084, - 1071, + 1326, + 1126, + 1113, + 1385, + 1092, + 1083, 1340, - 1050, - 1041, - 1295, - 961, - 983, - 1213, + 1001, + 1023, 1258, - 1273, - 1212, - 1011, - 1090, - 1115, - 1131, - 1152, - 1076, - 1170, - 956, - 971, + 1303, + 1318, + 1257, + 1051, + 1132, + 1157, + 1174, + 1256, + 1195, + 1118, + 1213, 996, - 1231, - 1239, - 1246, - 1026, - 1120, - 1140, - 1097, - 1159, - 1180, - 919, - 1366, - 880, - 883, - 866, - 863, - 975, - 1192, - 1204, - 1252, - 1269, - 1001, - 1037, - 1102, - 1126, - 1147, - 1033, - 1035, - 1290, - 911, - 886, - 904, - 1287, - 1087, - 1165, + 1011, + 1036, + 1276, 1284, - 1292, - 966, - 990, + 1291, + 1068, + 1163, + 1183, + 1139, + 1202, 1223, - 1263, - 1277, - 1018, - 1095, - 1110, - 1135, - 1155, - 1175 + 959, + 1411, + 920, + 923, + 906, + 903, + 1015, + 1235, + 1247, + 1297, + 1314, + 1041, + 1079, + 1144, + 1169, + 1190, + 1075, + 1077, + 1335, + 951, + 926, + 944, + 1332, + 1129, + 1208, + 1329, + 1337, + 1006, + 1030, + 1268, + 1308, + 1322, + 1060, + 1137, + 1152, + 1178, + 1198, + 1218 ] }, { "title": "Type Aliases", "children": [ 1, - 796, - 841, - 1335, - 1375, - 827, - 823, - 1381, - 1383, - 835, - 853, - 1365, - 1310, - 1333, - 1332, - 1385, - 1373, - 1395, + 836, + 881, + 1380, + 1420, + 867, + 863, + 1426, + 1428, + 875, + 893, + 1410, + 1355, + 1378, 1377, - 1302, - 846 + 1430, + 1418, + 1440, + 1422, + 1347, + 886 ] } ], @@ -29027,4710 +29899,4890 @@ "qualifiedName": "__type" }, "210": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "ContainerLike" + }, + "211": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "__type" + }, + "212": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "__type.resolve" + }, + "213": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "__type.resolve" + }, + "214": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "T" + }, + "215": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "key" + }, + "216": { + "sourceFileName": "../../../packages/types/src/customer/index.ts", + "qualifiedName": "" + }, + "217": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO" + }, + "218": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.id" + }, + "219": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.email" + }, + "220": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.billing_address_id" + }, + "221": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.shipping_address_id" + }, + "222": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.first_name" + }, + "223": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.last_name" + }, + "224": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.billing_address" + }, + "225": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.shipping_address" + }, + "226": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.phone" + }, + "227": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.has_account" + }, + "228": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.groups" + }, + "229": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "__type" + }, + "230": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "__type.id" + }, + "231": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.orders" + }, + "232": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "__type" + }, + "233": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "__type.id" + }, + "234": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.metadata" + }, + "235": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.deleted_at" + }, + "236": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.created_at" + }, + "237": { + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.updated_at" + }, + "238": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "" }, - "211": { + "239": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "FilterQuery" }, - "212": { + "240": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type" }, - "213": { + "241": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.__index" }, - "215": { + "243": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "T" }, - "216": { + "244": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "Prev" }, - "217": { + "245": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable" }, - "218": { + "246": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "219": { + "247": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "220": { + "248": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.T" }, - "221": { + "249": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "OptionsQuery" }, - "222": { + "250": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "OptionsQuery.populate" }, - "223": { + "251": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "OptionsQuery.orderBy" }, - "224": { + "252": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "OptionsQuery.limit" }, - "225": { + "253": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "OptionsQuery.offset" }, - "226": { + "254": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "OptionsQuery.fields" }, - "227": { + "255": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "OptionsQuery.groupBy" }, - "228": { + "256": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "OptionsQuery.filters" }, - "229": { + "257": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "OptionsQuery.T" }, - "230": { + "258": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "OptionsQuery.P" }, - "231": { + "259": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "FindOptions" }, - "232": { + "260": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "__type" }, - "233": { + "261": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "__type.where" }, - "234": { + "262": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "__type.options" }, - "235": { + "263": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "T" }, - "236": { + "264": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService" }, - "237": { + "265": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.find" }, - "238": { + "266": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.find" }, - "239": { + "267": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "options" }, - "240": { + "268": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "241": { + "269": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.findAndCount" }, - "242": { + "270": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.findAndCount" }, - "243": { + "271": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "options" }, - "244": { + "272": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "245": { + "273": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.create" }, - "246": { + "274": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.create" }, - "247": { + "275": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "data" }, - "248": { + "276": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "249": { + "277": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.update" }, - "250": { + "278": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.update" }, - "251": { + "279": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "data" }, - "252": { + "280": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "253": { + "281": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.delete" }, - "254": { + "282": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.delete" }, - "255": { + "283": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "ids" }, - "256": { + "284": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "257": { + "285": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.softDelete" }, - "258": { + "286": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.softDelete" }, - "259": { + "287": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "ids" }, - "260": { + "288": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "261": { + "289": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.restore" }, - "262": { + "290": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.restore" }, - "263": { + "291": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "ids" }, - "264": { + "292": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "265": { + "293": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.transaction" }, - "266": { + "294": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.transaction" }, - "267": { + "295": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TManager" }, - "268": { + "296": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "task" }, - "269": { + "297": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type" }, - "270": { + "298": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type" }, - "271": { + "299": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "transactionManager" }, - "272": { + "300": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "273": { + "301": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type" }, - "274": { + "302": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.isolationLevel" }, - "275": { + "303": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.transaction" }, - "276": { + "304": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.enableNestedTransactions" }, - "277": { + "305": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getFreshManager" }, - "278": { + "306": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getFreshManager" }, - "279": { + "307": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TManager" }, - "280": { + "308": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getActiveManager" }, - "281": { + "309": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getActiveManager" }, - "282": { + "310": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TManager" }, - "283": { + "311": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.serialize" }, - "284": { + "312": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.serialize" }, - "285": { + "313": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TOutput" }, - "286": { + "314": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "data" }, - "287": { + "315": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "options" }, - "288": { + "316": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RepositoryService.T" }, - "289": { + "317": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TreeRepositoryService" }, - "290": { + "318": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TreeRepositoryService.find" }, - "291": { + "319": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TreeRepositoryService.find" }, - "292": { + "320": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "options" }, - "293": { + "321": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "transformOptions" }, - "294": { + "322": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "295": { + "323": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TreeRepositoryService.findAndCount" }, - "296": { + "324": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TreeRepositoryService.findAndCount" }, - "297": { + "325": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "options" }, - "298": { + "326": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "transformOptions" }, - "299": { + "327": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "300": { + "328": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TreeRepositoryService.create" }, - "301": { + "329": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TreeRepositoryService.create" }, - "302": { + "330": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "data" }, - "303": { + "331": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "304": { + "332": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TreeRepositoryService.delete" }, - "305": { + "333": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TreeRepositoryService.delete" }, - "306": { + "334": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "id" }, - "307": { + "335": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "308": { + "336": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.transaction" }, - "309": { + "337": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.transaction" }, - "310": { + "338": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TManager" }, - "311": { + "339": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "task" }, - "312": { + "340": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type" }, - "313": { + "341": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type" }, - "314": { + "342": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "transactionManager" }, - "315": { + "343": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "316": { + "344": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type" }, - "317": { + "345": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.isolationLevel" }, - "318": { + "346": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.transaction" }, - "319": { + "347": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.enableNestedTransactions" }, - "320": { + "348": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getFreshManager" }, - "321": { + "349": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getFreshManager" }, - "322": { + "350": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TManager" }, - "323": { + "351": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getActiveManager" }, - "324": { + "352": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getActiveManager" }, - "325": { + "353": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TManager" }, - "326": { + "354": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.serialize" }, - "327": { + "355": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.serialize" }, - "328": { + "356": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TOutput" }, - "329": { + "357": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "data" }, - "330": { + "358": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "options" }, - "331": { + "359": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TreeRepositoryService.T" }, - "332": { + "360": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "SoftDeleteReturn" }, - "333": { + "361": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.returnLinkableKeys" }, - "334": { + "362": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TReturnableLinkableKeys" }, - "335": { + "363": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "RestoreReturn" }, - "336": { + "364": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.returnLinkableKeys" }, - "337": { + "365": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TReturnableLinkableKeys" }, - "338": { + "366": { "sourceFileName": "../../../packages/types/src/dal/entity.ts", "qualifiedName": "EntityDateColumns" }, - "339": { + "367": { "sourceFileName": "../../../packages/types/src/dal/entity.ts", "qualifiedName": "SoftDeletableEntityDateColumns" }, - "340": { + "368": { "sourceFileName": "../../../packages/types/src/event-bus/index.ts", "qualifiedName": "" }, - "341": { + "369": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "Subscriber" }, - "342": { + "370": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type" }, - "343": { + "371": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type" }, - "344": { + "372": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "data" }, - "345": { + "373": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "eventName" }, - "346": { + "374": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "T" }, - "347": { + "375": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "SubscriberContext" }, - "348": { + "376": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type" }, - "349": { + "377": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type.subscriberId" }, - "350": { + "378": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "SubscriberDescriptor" }, - "351": { + "379": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type" }, - "352": { + "380": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type.id" }, - "353": { + "381": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type.subscriber" }, - "354": { + "382": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "EventHandler" }, - "355": { + "383": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type" }, - "356": { + "384": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type" }, - "357": { + "385": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "data" }, - "358": { + "386": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "eventName" }, - "359": { + "387": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "T" }, - "360": { + "388": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "EmitData" }, - "361": { + "389": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type" }, - "362": { + "390": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type.eventName" }, - "363": { + "391": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type.data" }, - "364": { + "392": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "__type.options" }, - "365": { + "393": { "sourceFileName": "../../../packages/types/src/event-bus/common.ts", "qualifiedName": "T" }, - "366": { + "394": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "IEventBusService" }, - "367": { + "395": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "IEventBusService.subscribe" }, - "368": { + "396": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "IEventBusService.subscribe" }, - "369": { + "397": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "eventName" }, - "370": { + "398": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "subscriber" }, - "371": { + "399": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "context" }, - "372": { + "400": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "IEventBusService.unsubscribe" }, - "373": { + "401": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "IEventBusService.unsubscribe" }, - "374": { + "402": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "eventName" }, - "375": { + "403": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "subscriber" }, - "376": { + "404": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "context" }, - "377": { + "405": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "IEventBusService.emit" }, - "378": { + "406": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "IEventBusService.emit" }, - "379": { + "407": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "T" }, - "380": { + "408": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "event" }, - "381": { + "409": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "data" }, - "382": { + "410": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", "qualifiedName": "options" }, - "383": { + "411": { "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", "qualifiedName": "ITransactionBaseService.withTransaction" }, - "384": { + "412": { "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", "qualifiedName": "ITransactionBaseService.withTransaction" }, - "385": { + "413": { "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", "qualifiedName": "transactionManager" }, - "386": { + "414": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "IEventBusModuleService" }, - "387": { + "415": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "IEventBusModuleService.emit" }, - "388": { + "416": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "IEventBusModuleService.emit" }, - "389": { + "417": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "T" }, - "390": { + "418": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "eventName" }, - "391": { + "419": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "data" }, - "392": { + "420": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "options" }, - "393": { + "421": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "IEventBusModuleService.emit" }, - "394": { + "422": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "T" }, - "395": { + "423": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "data" }, - "396": { + "424": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "IEventBusModuleService.subscribe" }, - "397": { + "425": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "IEventBusModuleService.subscribe" }, - "398": { + "426": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "eventName" }, - "399": { + "427": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "subscriber" }, - "400": { + "428": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "context" }, - "401": { + "429": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "IEventBusModuleService.unsubscribe" }, - "402": { + "430": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "IEventBusModuleService.unsubscribe" }, - "403": { + "431": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "eventName" }, - "404": { + "432": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "subscriber" }, - "405": { + "433": { "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", "qualifiedName": "context" }, - "406": { + "434": { "sourceFileName": "../../../packages/types/src/feature-flag/index.ts", "qualifiedName": "" }, - "407": { + "435": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "IFlagRouter" }, - "408": { + "436": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "IFlagRouter.isFeatureEnabled" }, - "409": { + "437": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "__type" }, - "410": { + "438": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "__type" }, - "411": { + "439": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "key" }, - "412": { + "440": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "IFlagRouter.listFlags" }, - "413": { + "441": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "__type" }, - "414": { + "442": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "__type" }, - "415": { + "443": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "FeatureFlagsResponse" }, - "416": { + "444": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "__type" }, - "417": { + "445": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "__type.key" }, - "418": { + "446": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "__type.value" }, - "419": { + "447": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "FlagSettings" }, - "420": { + "448": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "__type" }, - "421": { + "449": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "__type.key" }, - "422": { + "450": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "__type.description" }, - "423": { + "451": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "__type.env_key" }, - "424": { + "452": { "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", "qualifiedName": "__type.default_val" }, - "425": { + "453": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "" }, - "426": { + "454": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger" }, - "427": { + "455": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.panic" }, - "428": { + "456": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "429": { + "457": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "430": { + "458": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "data" }, - "431": { + "459": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.shouldLog" }, - "432": { + "460": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "433": { + "461": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "434": { + "462": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "level" }, - "435": { + "463": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.setLogLevel" }, - "436": { + "464": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "437": { + "465": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "438": { + "466": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "level" }, - "439": { + "467": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.unsetLogLevel" }, - "440": { + "468": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "441": { + "469": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "442": { + "470": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.activity" }, - "443": { + "471": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "444": { + "472": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "445": { + "473": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "message" }, - "446": { + "474": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "config" }, - "447": { + "475": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.progress" }, - "448": { + "476": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "449": { + "477": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "450": { + "478": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "activityId" }, - "451": { + "479": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "message" }, - "452": { + "480": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.error" }, - "453": { + "481": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "454": { + "482": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "455": { + "483": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "messageOrError" }, - "456": { + "484": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "error" }, - "457": { + "485": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.failure" }, - "458": { + "486": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "459": { + "487": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "460": { + "488": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "activityId" }, - "461": { + "489": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "message" }, - "462": { + "490": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.success" }, - "463": { + "491": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "464": { + "492": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "465": { + "493": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "activityId" }, - "466": { + "494": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "message" }, - "467": { + "495": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.debug" }, - "468": { + "496": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "469": { + "497": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "470": { + "498": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "message" }, - "471": { + "499": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.info" }, - "472": { + "500": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "473": { + "501": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "474": { + "502": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "message" }, - "475": { + "503": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.warn" }, - "476": { + "504": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "477": { + "505": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "478": { + "506": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "message" }, - "479": { + "507": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "Logger.log" }, - "480": { + "508": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "481": { + "509": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "__type" }, - "482": { + "510": { "sourceFileName": "../../../packages/types/src/logger/index.ts", "qualifiedName": "args" }, - "483": { + "511": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "" }, - "484": { + "512": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "Constructor" }, - "485": { + "513": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "486": { + "514": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "487": { + "515": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "args" }, - "488": { + "516": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "T" }, - "489": { + "517": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "LogLevel" }, - "490": { + "518": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "LoggerOptions" }, - "491": { + "519": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "MODULE_SCOPE" }, - "492": { + "520": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "MODULE_SCOPE.INTERNAL" }, - "493": { + "521": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "MODULE_SCOPE.EXTERNAL" }, - "494": { + "522": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "MODULE_RESOURCE_TYPE" }, - "495": { + "523": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "MODULE_RESOURCE_TYPE.SHARED" }, - "496": { + "524": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "MODULE_RESOURCE_TYPE.ISOLATED" }, - "497": { + "525": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "InternalModuleDeclaration" }, - "498": { + "526": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "499": { + "527": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.scope" }, - "500": { + "528": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.resources" }, - "501": { + "529": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.dependencies" }, - "502": { + "530": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.definition" }, - "503": { + "531": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.resolve" }, - "504": { + "532": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.options" }, - "505": { + "533": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.alias" }, - "506": { + "534": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.main" }, - "507": { + "535": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ExternalModuleDeclaration" }, - "508": { + "536": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "509": { + "537": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.scope" }, - "510": { + "538": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.definition" }, - "511": { + "539": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.server" }, - "512": { + "540": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "513": { + "541": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.type" }, - "514": { + "542": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.url" }, - "515": { + "543": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.keepAlive" }, - "516": { + "544": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.options" }, - "517": { + "545": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.alias" }, - "518": { + "546": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.main" }, - "519": { + "547": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleResolution" }, - "520": { + "548": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "521": { + "549": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.resolutionPath" }, - "522": { + "550": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.definition" }, - "523": { + "551": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.options" }, - "524": { + "552": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.dependencies" }, - "525": { + "553": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.moduleDeclaration" }, - "526": { + "554": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.moduleExports" }, - "527": { + "555": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleDefinition" }, - "528": { + "556": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "529": { + "557": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.key" }, - "530": { + "558": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.registrationName" }, - "531": { + "559": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.defaultPackage" }, - "532": { + "560": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.label" }, - "533": { + "561": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.canOverride" }, - "534": { + "562": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isRequired" }, - "535": { + "563": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isQueryable" }, - "536": { + "564": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isLegacy" }, - "537": { + "565": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.dependencies" }, - "538": { + "566": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.defaultModuleDeclaration" }, - "539": { + "567": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "LinkModuleDefinition" }, - "540": { + "568": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "541": { + "569": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.key" }, - "542": { + "570": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.registrationName" }, - "543": { + "571": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.label" }, - "544": { + "572": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.dependencies" }, - "545": { + "573": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.defaultModuleDeclaration" }, - "546": { + "574": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleConfig" }, - "547": { + "575": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "548": { + "576": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.module" }, - "549": { + "577": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.path" }, - "550": { + "578": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.definition" }, - "551": { + "579": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "LoadedModule" }, - "552": { + "580": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "553": { + "581": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.__joinerConfig" }, - "554": { + "582": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.__definition" }, - "555": { + "583": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "LoaderOptions" }, - "556": { + "584": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "557": { + "585": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.container" }, - "558": { + "586": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.options" }, - "559": { + "587": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.logger" }, - "560": { + "588": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "TOptions" }, - "561": { + "589": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleLoaderFunction" }, - "562": { + "590": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "563": { + "591": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "564": { + "592": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "options" }, - "565": { + "593": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "moduleDeclaration" }, - "566": { + "594": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModulesResponse" }, - "567": { + "595": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "568": { + "596": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.module" }, - "569": { + "597": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.resolution" }, - "570": { + "598": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleJoinerConfig" }, - "571": { + "599": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "572": { + "600": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.schema" }, - "573": { + "601": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.relationships" }, - "574": { + "602": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.extends" }, - "575": { + "603": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "576": { + "604": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.serviceName" }, - "577": { + "605": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.fieldAlias" }, - "578": { + "606": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "579": { + "607": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.path" }, - "580": { + "608": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.forwardArgumentsOnPath" }, - "581": { + "609": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.relationship" }, - "582": { + "610": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.serviceName" }, - "583": { + "611": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.primaryKeys" }, - "584": { + "612": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isLink" }, - "585": { + "613": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.linkableKeys" }, - "586": { + "614": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isReadOnlyLink" }, - "587": { + "615": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.databaseConfig" }, - "588": { + "616": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "589": { + "617": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.tableName" }, - "590": { + "618": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.idPrefix" }, - "591": { + "619": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.extraFields" }, - "592": { + "620": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "593": { + "621": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.type" }, - "594": { + "622": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.defaultValue" }, - "595": { + "623": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.nullable" }, - "596": { + "624": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.options" }, - "597": { + "625": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleJoinerRelationship" }, - "598": { + "626": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "599": { + "627": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isInternalService" }, - "600": { + "628": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.deleteCascade" }, - "601": { + "629": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleExports" }, - "602": { + "630": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "603": { + "631": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.service" }, - "604": { + "632": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.loaders" }, - "605": { + "633": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.migrations" }, - "606": { + "634": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.models" }, - "607": { + "635": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.runMigrations" }, - "608": { + "636": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.runMigrations" }, - "609": { + "637": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "options" }, - "610": { + "638": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "moduleDeclaration" }, - "611": { + "639": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.revertMigration" }, - "612": { + "640": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.revertMigration" }, - "613": { + "641": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "options" }, - "614": { + "642": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "moduleDeclaration" }, - "615": { + "643": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleServiceInitializeOptions" }, - "616": { + "644": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleServiceInitializeOptions.database" }, - "617": { + "645": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "618": { + "646": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.connection" }, - "619": { + "647": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.clientUrl" }, - "620": { + "648": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.schema" }, - "621": { + "649": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.host" }, - "622": { + "650": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.port" }, - "623": { + "651": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.user" }, - "624": { + "652": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.password" }, - "625": { + "653": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.database" }, - "626": { + "654": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.driverOptions" }, - "627": { + "655": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.debug" }, - "628": { + "656": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.pool" }, - "629": { + "657": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleServiceInitializeCustomDataLayerOptions" }, - "630": { + "658": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "631": { + "659": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.manager" }, - "632": { + "660": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.repositories" }, - "633": { + "661": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "634": { + "662": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.__index" }, - "636": { + "664": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "RemoteQueryFunction" }, - "637": { + "665": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "638": { + "666": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "639": { + "667": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "query" }, - "640": { + "668": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "variables" }, - "641": { + "669": { + "sourceFileName": "../../../packages/types/src/region/index.ts", + "qualifiedName": "" + }, + "670": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "RegionDTO" + }, + "671": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type" + }, + "672": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.name" + }, + "673": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.currency_code" + }, + "674": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.tax_rate" + }, + "675": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.tax_code" + }, + "676": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.gift_cards_taxable" + }, + "677": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.automatic_taxes" + }, + "678": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.tax_provider_id" + }, + "679": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.metadata" + }, + "680": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.includes_tax" + }, + "681": { "sourceFileName": "../../../packages/types/src/sales-channel/index.ts", "qualifiedName": "" }, - "642": { + "682": { "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", "qualifiedName": "SalesChannelLocationDTO" }, - "643": { + "683": { "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", "qualifiedName": "SalesChannelLocationDTO.sales_channel_id" }, - "644": { + "684": { "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", "qualifiedName": "SalesChannelLocationDTO.location_id" }, - "645": { + "685": { "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", "qualifiedName": "SalesChannelLocationDTO.sales_channel" }, - "646": { + "686": { "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", "qualifiedName": "SalesChannelDTO" }, - "647": { + "687": { "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", "qualifiedName": "SalesChannelDTO.id" }, - "648": { + "688": { "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", "qualifiedName": "SalesChannelDTO.description" }, - "649": { + "689": { "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", "qualifiedName": "SalesChannelDTO.is_disabled" }, - "650": { + "690": { "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", "qualifiedName": "SalesChannelDTO.metadata" }, - "651": { + "691": { "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", "qualifiedName": "SalesChannelDTO.locations" }, - "652": { + "692": { "sourceFileName": "../../../packages/types/src/search/index.ts", "qualifiedName": "" }, - "653": { + "693": { "sourceFileName": "../../../packages/types/src/search/index.ts", "qualifiedName": "IndexSettings" }, - "654": { + "694": { "sourceFileName": "../../../packages/types/src/search/index.ts", "qualifiedName": "__type" }, - "655": { + "695": { "sourceFileName": "../../../packages/types/src/search/index.ts", "qualifiedName": "__type.indexSettings" }, - "656": { + "696": { "sourceFileName": "../../../packages/types/src/search/index.ts", "qualifiedName": "__type.primaryKey" }, - "657": { + "697": { "sourceFileName": "../../../packages/types/src/search/index.ts", "qualifiedName": "__type.transformer" }, - "658": { + "698": { "sourceFileName": "../../../packages/types/src/search/index.ts", "qualifiedName": "__type" }, - "659": { + "699": { "sourceFileName": "../../../packages/types/src/search/index.ts", "qualifiedName": "__type" }, - "660": { + "700": { "sourceFileName": "../../../packages/types/src/search/index.ts", "qualifiedName": "document" }, - "661": { + "701": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService" }, - "662": { + "702": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.options" }, - "663": { + "703": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.createIndex" }, - "664": { + "704": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.createIndex" }, - "665": { + "705": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "indexName" }, - "666": { + "706": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "options" }, - "667": { + "707": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.getIndex" }, - "668": { + "708": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.getIndex" }, - "669": { + "709": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "indexName" }, - "670": { + "710": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.addDocuments" }, - "671": { + "711": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.addDocuments" }, - "672": { + "712": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "indexName" }, - "673": { + "713": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "documents" }, - "674": { + "714": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "type" }, - "675": { + "715": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.replaceDocuments" }, - "676": { + "716": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.replaceDocuments" }, - "677": { + "717": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "indexName" }, - "678": { + "718": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "documents" }, - "679": { + "719": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "type" }, - "680": { + "720": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.deleteDocument" }, - "681": { + "721": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.deleteDocument" }, - "682": { + "722": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "indexName" }, - "683": { + "723": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "document_id" }, - "684": { + "724": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.deleteAllDocuments" }, - "685": { + "725": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.deleteAllDocuments" }, - "686": { + "726": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "indexName" }, - "687": { + "727": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.search" }, - "688": { + "728": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.search" }, - "689": { + "729": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "indexName" }, - "690": { + "730": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "query" }, - "691": { + "731": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "options" }, - "692": { + "732": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.updateSettings" }, - "693": { + "733": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "ISearchService.updateSettings" }, - "694": { + "734": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "indexName" }, - "695": { + "735": { "sourceFileName": "../../../packages/types/src/search/interface.ts", "qualifiedName": "settings" }, - "696": { + "736": { "sourceFileName": "../../../packages/types/src/transaction-base/index.ts", "qualifiedName": "" }, - "697": { + "737": { "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", "qualifiedName": "ITransactionBaseService" }, - "698": { + "738": { "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", "qualifiedName": "ITransactionBaseService.withTransaction" }, - "699": { + "739": { "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", "qualifiedName": "ITransactionBaseService.withTransaction" }, - "700": { + "740": { "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", "qualifiedName": "transactionManager" }, - "701": { + "741": { "sourceFileName": "../../../packages/types/src/workflow/index.ts", "qualifiedName": "" }, - "702": { + "742": { "sourceFileName": "../../../packages/types/src/workflow/cart/index.ts", "qualifiedName": "" }, - "703": { + "743": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateLineItemInputDTO" }, - "704": { + "744": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateLineItemInputDTO.variant_id" }, - "705": { + "745": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateLineItemInputDTO.quantity" }, - "706": { + "746": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateCartWorkflowInputDTO" }, - "707": { + "747": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateCartWorkflowInputDTO.region_id" }, - "708": { + "748": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateCartWorkflowInputDTO.country_code" }, - "709": { + "749": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateCartWorkflowInputDTO.items" }, - "710": { + "750": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateCartWorkflowInputDTO.context" }, - "711": { + "751": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateCartWorkflowInputDTO.sales_channel_id" }, - "712": { + "752": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateCartWorkflowInputDTO.shipping_address_id" }, - "713": { + "753": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateCartWorkflowInputDTO.billing_address_id" }, - "714": { + "754": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateCartWorkflowInputDTO.billing_address" }, - "715": { + "755": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateCartWorkflowInputDTO.shipping_address" }, - "716": { + "756": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateCartWorkflowInputDTO.customer_id" }, - "717": { + "757": { "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", "qualifiedName": "CreateCartWorkflowInputDTO.email" }, - "718": { + "758": { "sourceFileName": "../../../packages/types/src/workflow/common.ts", "qualifiedName": "" }, - "719": { + "759": { "sourceFileName": "../../../packages/types/src/workflow/common.ts", "qualifiedName": "WorkflowInputConfig" }, - "720": { + "760": { "sourceFileName": "../../../packages/types/src/workflow/common.ts", "qualifiedName": "WorkflowInputConfig.listConfig" }, - "721": { + "761": { "sourceFileName": "../../../packages/types/src/workflow/common.ts", "qualifiedName": "__type" }, - "722": { + "762": { "sourceFileName": "../../../packages/types/src/workflow/common.ts", "qualifiedName": "__type.select" }, - "723": { + "763": { "sourceFileName": "../../../packages/types/src/workflow/common.ts", "qualifiedName": "__type.relations" }, - "724": { + "764": { "sourceFileName": "../../../packages/types/src/workflow/common.ts", "qualifiedName": "WorkflowInputConfig.retrieveConfig" }, - "725": { + "765": { "sourceFileName": "../../../packages/types/src/workflow/common.ts", "qualifiedName": "__type" }, - "726": { + "766": { "sourceFileName": "../../../packages/types/src/workflow/common.ts", "qualifiedName": "__type.select" }, - "727": { + "767": { "sourceFileName": "../../../packages/types/src/workflow/common.ts", "qualifiedName": "__type.relations" }, - "728": { + "768": { "sourceFileName": "../../../packages/types/src/workflow/price-list/index.ts", "qualifiedName": "" }, - "729": { + "769": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListDTO" }, - "730": { + "770": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListDTO.starts_at" }, - "731": { + "771": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListDTO.ends_at" }, - "732": { + "772": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListDTO.status" }, - "733": { + "773": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListDTO.number_rules" + "qualifiedName": "CreatePriceListDTO.rules_count" }, - "734": { + "774": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListDTO.rules" }, - "735": { + "775": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListDTO.prices" }, - "736": { + "776": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "__type" }, - "737": { + "777": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "__type.amount" }, - "738": { + "778": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "__type.currency_code" }, - "739": { + "779": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "__type.region_id" }, - "740": { + "780": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "__type.max_quantity" }, - "741": { + "781": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "__type.min_quantity" }, - "742": { + "782": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListDTO.customer_groups" }, - "743": { + "783": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "__type" }, - "744": { + "784": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "__type.id" }, - "745": { + "785": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListRuleDTO" }, - "746": { + "786": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListRuleDTO.rule_attribute" }, - "747": { + "787": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListRuleDTO.value" }, - "748": { + "788": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListPriceDTO" }, - "749": { + "789": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListPriceDTO.amount" }, - "750": { + "790": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListPriceDTO.currency_code" }, - "751": { + "791": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListPriceDTO.price_set_id" }, - "752": { + "792": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListPriceDTO.region_id" }, - "753": { + "793": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListPriceDTO.max_quantity" }, - "754": { + "794": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListPriceDTO.min_quantity" }, - "755": { + "795": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListWorkflowInputDTO" }, - "756": { + "796": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListWorkflowInputDTO.price_lists" }, - "757": { + "797": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "RemovePriceListProductsWorkflowInputDTO" }, - "758": { + "798": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "RemovePriceListProductsWorkflowInputDTO.product_ids" }, - "759": { + "799": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "RemovePriceListProductsWorkflowInputDTO.price_list_id" }, - "760": { + "800": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "RemovePriceListVariantsWorkflowInputDTO" }, - "761": { + "801": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "RemovePriceListVariantsWorkflowInputDTO.variant_ids" }, - "762": { + "802": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "RemovePriceListVariantsWorkflowInputDTO.price_list_id" }, - "763": { + "803": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "RemovePriceListPricesWorkflowInputDTO" }, - "764": { + "804": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "RemovePriceListPricesWorkflowInputDTO.money_amount_ids" }, - "765": { + "805": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "RemovePriceListPricesWorkflowInputDTO.price_list_id" }, - "766": { + "806": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListWorkflowDTO" }, - "767": { + "807": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListWorkflowDTO.title" }, - "768": { + "808": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListWorkflowDTO.name" }, - "769": { + "809": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListWorkflowDTO.description" }, - "770": { + "810": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListWorkflowDTO.type" }, - "771": { + "811": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListWorkflowDTO.starts_at" }, - "772": { + "812": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListWorkflowDTO.ends_at" }, - "773": { + "813": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListWorkflowDTO.status" }, - "774": { + "814": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowDTO.number_rules" + "qualifiedName": "CreatePriceListWorkflowDTO.rules_count" }, - "775": { + "815": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListWorkflowDTO.prices" }, - "776": { + "816": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "CreatePriceListWorkflowDTO.rules" }, - "777": { + "817": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "PriceListVariantPriceDTO" }, - "778": { + "818": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "__type" }, - "779": { + "819": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "__type.variant_id" }, - "780": { + "820": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "__type.price_set_id" }, - "781": { + "821": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "UpdatePriceListWorkflowDTO" }, - "782": { + "822": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "UpdatePriceListWorkflowDTO.id" }, - "783": { + "823": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "UpdatePriceListWorkflowDTO.name" }, - "784": { + "824": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "UpdatePriceListWorkflowDTO.starts_at" }, - "785": { + "825": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "UpdatePriceListWorkflowDTO.ends_at" }, - "786": { + "826": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "UpdatePriceListWorkflowDTO.status" }, - "787": { + "827": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "UpdatePriceListWorkflowDTO.rules" }, - "788": { + "828": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "UpdatePriceListWorkflowDTO.prices" }, - "789": { + "829": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "UpdatePriceListWorkflowDTO.customer_groups" }, - "790": { + "830": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "__type" }, - "791": { + "831": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "__type.id" }, - "792": { + "832": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "UpdatePriceListWorkflowInputDTO" }, - "793": { + "833": { "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "UpdatePriceListWorkflowInputDTO.price_lists" }, - "794": { + "834": { "sourceFileName": "../../../packages/types/src/workflow/price-list/remove-price-list.ts", "qualifiedName": "RemovePriceListWorkflowInputDTO" }, - "795": { + "835": { "sourceFileName": "../../../packages/types/src/workflow/price-list/remove-price-list.ts", "qualifiedName": "RemovePriceListWorkflowInputDTO.price_lists" }, - "796": { + "836": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "CartDTO" }, - "797": { + "837": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type" }, - "798": { + "838": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.id" }, - "799": { + "839": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.email" }, - "800": { + "840": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.billing_address_id" }, - "801": { + "841": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.shipping_address_id" }, - "802": { + "842": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.region_id" }, - "803": { + "843": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.customer_id" }, - "804": { + "844": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.payment_id" }, - "805": { + "845": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.completed_at" }, - "806": { + "846": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.payment_authorized_at" }, - "807": { + "847": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.idempotency_key" }, - "808": { + "848": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.context" }, - "809": { + "849": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.metadata" }, - "810": { + "850": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.sales_channel_id" }, - "811": { + "851": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.shipping_total" }, - "812": { + "852": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.discount_total" }, - "813": { + "853": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.raw_discount_total" }, - "814": { + "854": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.item_tax_total" }, - "815": { + "855": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.shipping_tax_total" }, - "816": { + "856": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.tax_total" }, - "817": { + "857": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.refunded_total" }, - "818": { + "858": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.total" }, - "819": { + "859": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.subtotal" }, - "820": { + "860": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.refundable_amount" }, - "821": { + "861": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.gift_card_total" }, - "822": { + "862": { "sourceFileName": "../../../packages/types/src/cart/common.ts", "qualifiedName": "__type.gift_card_tax_total" }, - "823": { + "863": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "FileServiceUploadResult" }, - "824": { + "864": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type" }, - "825": { + "865": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.url" }, - "826": { + "866": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.key" }, - "827": { + "867": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "FileServiceGetUploadStreamResult" }, - "828": { + "868": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type" }, - "829": { + "869": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.writeStream" }, - "830": { + "870": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.promise" }, - "831": { + "871": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.url" }, - "832": { + "872": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.fileKey" }, - "833": { + "873": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.__index" }, - "835": { + "875": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "GetUploadedFileType" }, - "836": { + "876": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type" }, - "837": { + "877": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.fileKey" }, - "838": { + "878": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.isPrivate" }, - "839": { + "879": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.__index" }, - "841": { + "881": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "DeleteFileType" }, - "842": { + "882": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type" }, - "843": { + "883": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.fileKey" }, - "844": { + "884": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.__index" }, - "846": { + "886": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "UploadStreamDescriptorType" }, - "847": { + "887": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type" }, - "848": { + "888": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.name" }, - "849": { + "889": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.ext" }, - "850": { + "890": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.isPrivate" }, - "851": { + "891": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.__index" }, - "853": { + "893": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerRelationship" }, - "854": { + "894": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "855": { + "895": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.alias" }, - "856": { + "896": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.foreignKey" }, - "857": { + "897": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.primaryKey" }, - "858": { + "898": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.serviceName" }, - "859": { + "899": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.isInternalService" }, - "860": { + "900": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.inverse" }, - "861": { + "901": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.isList" }, - "862": { + "902": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.args" }, - "863": { + "903": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfigAlias" }, - "864": { + "904": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfigAlias.name" }, - "865": { + "905": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfigAlias.args" }, - "866": { + "906": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig" }, - "867": { + "907": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.serviceName" }, - "868": { + "908": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.alias" }, - "869": { + "909": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.fieldAlias" }, - "870": { + "910": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "871": { + "911": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.path" }, - "872": { + "912": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.forwardArgumentsOnPath" }, - "873": { + "913": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.primaryKeys" }, - "874": { + "914": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.relationships" }, - "875": { + "915": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.extends" }, - "876": { + "916": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "877": { + "917": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.serviceName" }, - "878": { + "918": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.relationship" }, - "879": { + "919": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.args" }, - "880": { + "920": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerArgument" }, - "881": { + "921": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerArgument.name" }, - "882": { + "922": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerArgument.value" }, - "883": { + "923": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerDirective" }, - "884": { + "924": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerDirective.name" }, - "885": { + "925": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerDirective.value" }, - "886": { + "926": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteJoinerQuery" }, - "887": { + "927": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteJoinerQuery.service" }, - "888": { + "928": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteJoinerQuery.alias" }, - "889": { + "929": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteJoinerQuery.expands" }, - "890": { + "930": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "891": { + "931": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.property" }, - "892": { + "932": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.fields" }, - "893": { + "933": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.args" }, - "894": { + "934": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.directives" }, - "895": { + "935": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "896": { + "936": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.__index" }, - "898": { + "938": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteJoinerQuery.fields" }, - "899": { + "939": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteJoinerQuery.args" }, - "900": { + "940": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteJoinerQuery.directives" }, - "901": { + "941": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "902": { + "942": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.__index" }, - "904": { + "944": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteNestedExpands" }, - "905": { + "945": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteNestedExpands.__index" }, - "907": { + "947": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "908": { + "948": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.fields" }, - "909": { + "949": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.args" }, - "910": { + "950": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.expands" }, - "911": { + "951": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteExpandProperty" }, - "912": { + "952": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteExpandProperty.property" }, - "913": { + "953": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteExpandProperty.parent" }, - "914": { + "954": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteExpandProperty.parentConfig" }, - "915": { + "955": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteExpandProperty.serviceConfig" }, - "916": { + "956": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteExpandProperty.fields" }, - "917": { + "957": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteExpandProperty.args" }, - "918": { + "958": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "RemoteExpandProperty.expands" }, - "919": { + "959": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule" }, - "920": { + "960": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.__joinerConfig" }, - "921": { + "961": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.__joinerConfig" }, - "922": { + "962": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.list" }, - "923": { + "963": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.list" }, - "924": { + "964": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "filters" }, - "925": { + "965": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "config" }, - "926": { + "966": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "sharedContext" }, - "927": { + "967": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.listAndCount" }, - "928": { + "968": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.listAndCount" }, - "929": { + "969": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "filters" }, - "930": { + "970": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "config" }, - "931": { + "971": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "sharedContext" }, - "932": { + "972": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.create" }, - "933": { + "973": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.create" }, - "934": { + "974": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "primaryKeyOrBulkData" }, - "935": { + "975": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "foreignKeyData" }, - "936": { + "976": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "sharedContext" }, - "937": { + "977": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.dismiss" }, - "938": { + "978": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.dismiss" }, - "939": { + "979": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "primaryKeyOrBulkData" }, - "940": { + "980": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "foreignKeyData" }, - "941": { + "981": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "sharedContext" }, - "942": { + "982": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.delete" }, - "943": { + "983": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.delete" }, - "944": { + "984": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "data" }, - "945": { + "985": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "sharedContext" }, - "946": { + "986": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.softDelete" }, - "947": { + "987": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.softDelete" }, - "948": { + "988": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "data" }, - "949": { + "989": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "config" }, - "950": { + "990": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "sharedContext" }, - "951": { + "991": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.restore" }, - "952": { + "992": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "ILinkModule.restore" }, - "953": { + "993": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "data" }, - "954": { + "994": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "config" }, - "955": { + "995": { "sourceFileName": "../../../packages/types/src/link-modules/index.ts", "qualifiedName": "sharedContext" }, - "956": { + "996": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "CurrencyDTO" }, - "957": { + "997": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "CurrencyDTO.code" }, - "958": { + "998": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "CurrencyDTO.symbol" }, - "959": { + "999": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "CurrencyDTO.symbol_native" }, - "960": { + "1000": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "CurrencyDTO.name" }, - "961": { + "1001": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "CreateCurrencyDTO" }, - "962": { + "1002": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "CreateCurrencyDTO.code" }, - "963": { + "1003": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "CreateCurrencyDTO.symbol" }, - "964": { + "1004": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "CreateCurrencyDTO.symbol_native" }, - "965": { + "1005": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "CreateCurrencyDTO.name" }, - "966": { + "1006": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "UpdateCurrencyDTO" }, - "967": { + "1007": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "UpdateCurrencyDTO.code" }, - "968": { + "1008": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "UpdateCurrencyDTO.symbol" }, - "969": { + "1009": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "UpdateCurrencyDTO.symbol_native" }, - "970": { + "1010": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "UpdateCurrencyDTO.name" }, - "971": { + "1011": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "FilterableCurrencyProps" }, - "972": { + "1012": { "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", "qualifiedName": "FilterableCurrencyProps.code" }, - "973": { + "1013": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "974": { + "1014": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "975": { + "1015": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "MoneyAmountDTO" }, - "976": { + "1016": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "MoneyAmountDTO.id" }, - "977": { + "1017": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "MoneyAmountDTO.currency_code" }, - "978": { + "1018": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "MoneyAmountDTO.currency" }, - "979": { + "1019": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "MoneyAmountDTO.amount" }, - "980": { + "1020": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "MoneyAmountDTO.min_quantity" }, - "981": { + "1021": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "MoneyAmountDTO.max_quantity" }, - "982": { + "1022": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "MoneyAmountDTO.price_set_money_amount" }, - "983": { + "1023": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO" }, - "984": { + "1024": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.id" }, - "985": { + "1025": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.currency_code" }, - "986": { + "1026": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.currency" }, - "987": { + "1027": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.amount" }, - "988": { + "1028": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.min_quantity" }, - "989": { + "1029": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.max_quantity" }, - "990": { + "1030": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "UpdateMoneyAmountDTO" }, - "991": { + "1031": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "UpdateMoneyAmountDTO.id" }, - "992": { + "1032": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "UpdateMoneyAmountDTO.currency_code" }, - "993": { + "1033": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "UpdateMoneyAmountDTO.amount" }, - "994": { + "1034": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "UpdateMoneyAmountDTO.min_quantity" }, - "995": { + "1035": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "UpdateMoneyAmountDTO.max_quantity" }, - "996": { + "1036": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "FilterableMoneyAmountProps" }, - "997": { + "1037": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "FilterableMoneyAmountProps.id" }, - "998": { + "1038": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "FilterableMoneyAmountProps.currency_code" }, - "999": { + "1039": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "1000": { + "1040": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "1001": { + "1041": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "PriceRuleDTO" }, - "1002": { + "1042": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "PriceRuleDTO.id" }, - "1003": { + "1043": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "PriceRuleDTO.price_set_id" }, - "1004": { + "1044": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "PriceRuleDTO.price_set" }, - "1005": { + "1045": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "PriceRuleDTO.rule_type_id" }, - "1006": { + "1046": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "PriceRuleDTO.rule_type" }, - "1007": { + "1047": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "PriceRuleDTO.value" }, - "1008": { + "1048": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "PriceRuleDTO.priority" }, - "1009": { + "1049": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "PriceRuleDTO.price_set_money_amount_id" }, - "1010": { + "1050": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "PriceRuleDTO.price_list_id" }, - "1011": { + "1051": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "CreatePriceRuleDTO" }, - "1012": { + "1052": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.id" + "qualifiedName": "CreatePriceRuleDTO.price_set_id" }, - "1013": { + "1053": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.price_set_id" + "qualifiedName": "CreatePriceRuleDTO.price_set" }, - "1014": { + "1054": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "CreatePriceRuleDTO.rule_type_id" }, - "1015": { + "1055": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "CreatePriceRuleDTO.rule_type" + }, + "1056": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "CreatePriceRuleDTO.value" }, - "1016": { + "1057": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "CreatePriceRuleDTO.priority" }, - "1017": { + "1058": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "CreatePriceRuleDTO.price_set_money_amount_id" }, - "1018": { + "1059": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "CreatePriceRuleDTO.price_set_money_amount" + }, + "1060": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "UpdatePriceRuleDTO" }, - "1019": { + "1061": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "UpdatePriceRuleDTO.id" }, - "1020": { + "1062": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "UpdatePriceRuleDTO.price_set_id" }, - "1021": { + "1063": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "UpdatePriceRuleDTO.rule_type_id" }, - "1022": { + "1064": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "UpdatePriceRuleDTO.value" }, - "1023": { + "1065": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "UpdatePriceRuleDTO.priority" }, - "1024": { + "1066": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "UpdatePriceRuleDTO.price_set_money_amount_id" }, - "1025": { + "1067": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "UpdatePriceRuleDTO.price_list_id" }, - "1026": { + "1068": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "FilterablePriceRuleProps" }, - "1027": { + "1069": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "FilterablePriceRuleProps.id" }, - "1028": { + "1070": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "FilterablePriceRuleProps.name" }, - "1029": { + "1071": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "FilterablePriceRuleProps.price_set_id" }, - "1030": { + "1072": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", "qualifiedName": "FilterablePriceRuleProps.rule_type_id" }, - "1031": { + "1073": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "1032": { + "1074": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "1033": { + "1075": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "PricingContext" }, - "1034": { + "1076": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "PricingContext.context" }, - "1035": { + "1077": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "PricingFilters" }, - "1036": { + "1078": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "PricingFilters.id" }, - "1037": { + "1079": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "PriceSetDTO" }, - "1038": { + "1080": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "PriceSetDTO.id" }, - "1039": { + "1081": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "PriceSetDTO.money_amounts" }, - "1040": { + "1082": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "PriceSetDTO.rule_types" }, - "1041": { + "1083": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSetDTO" }, - "1042": { + "1084": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSetDTO.id" }, - "1043": { + "1085": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSetDTO.price_set_id" }, - "1044": { + "1086": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSetDTO.amount" }, - "1045": { + "1087": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSetDTO.currency_code" }, - "1046": { + "1088": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSetDTO.min_quantity" }, - "1047": { + "1089": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSetDTO.max_quantity" }, - "1048": { + "1090": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSetDTO.price_list_type" }, - "1049": { + "1091": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSetDTO.price_list_id" }, - "1050": { + "1092": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSet" }, - "1051": { + "1093": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSet.id" }, - "1052": { + "1094": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSet.is_calculated_price_price_list" }, - "1053": { + "1095": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSet.calculated_amount" }, - "1054": { + "1096": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSet.is_original_price_price_list" }, - "1055": { + "1097": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSet.original_amount" }, - "1056": { + "1098": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSet.currency_code" }, - "1057": { + "1099": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSet.calculated_price" }, - "1058": { + "1100": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type" }, - "1059": { + "1101": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type.money_amount_id" }, - "1060": { + "1102": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type.price_list_id" }, - "1061": { + "1103": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type.price_list_type" }, - "1062": { + "1104": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type.min_quantity" }, - "1063": { + "1105": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type.max_quantity" }, - "1064": { + "1106": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CalculatedPriceSet.original_price" }, - "1065": { + "1107": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type" }, - "1066": { + "1108": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type.money_amount_id" }, - "1067": { + "1109": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type.price_list_id" }, - "1068": { + "1110": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type.price_list_type" }, - "1069": { + "1111": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type.min_quantity" }, - "1070": { + "1112": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type.max_quantity" }, - "1071": { + "1113": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "AddRulesDTO" }, - "1072": { + "1114": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "AddRulesDTO.priceSetId" }, - "1073": { + "1115": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "AddRulesDTO.rules" }, - "1074": { + "1116": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type" }, - "1075": { + "1117": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type.attribute" }, - "1076": { + "1118": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CreatePricesDTO" }, - "1077": { + "1119": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CreatePricesDTO.rules" }, - "1078": { + "1120": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.id" }, - "1079": { + "1121": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.currency_code" }, - "1080": { + "1122": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.currency" }, - "1081": { + "1123": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.amount" }, - "1082": { + "1124": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.min_quantity" }, - "1083": { + "1125": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.max_quantity" }, - "1084": { + "1126": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "AddPricesDTO" }, - "1085": { + "1127": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "AddPricesDTO.priceSetId" }, - "1086": { + "1128": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "AddPricesDTO.prices" }, - "1087": { + "1129": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "RemovePriceSetRulesDTO" }, - "1088": { + "1130": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "RemovePriceSetRulesDTO.id" }, - "1089": { + "1131": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "RemovePriceSetRulesDTO.rules" }, - "1090": { + "1132": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CreatePriceSetDTO" }, - "1091": { + "1133": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CreatePriceSetDTO.rules" }, - "1092": { + "1134": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type" }, - "1093": { + "1135": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "__type.rule_attribute" }, - "1094": { + "1136": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CreatePriceSetDTO.prices" }, - "1095": { + "1137": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "UpdatePriceSetDTO" }, - "1096": { + "1138": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "UpdatePriceSetDTO.id" }, - "1097": { + "1139": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "FilterablePriceSetProps" }, - "1098": { + "1140": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "FilterablePriceSetProps.id" }, - "1099": { + "1141": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "FilterablePriceSetProps.money_amounts" }, - "1100": { + "1142": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "1101": { + "1143": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "1102": { + "1144": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "PriceSetMoneyAmountDTO" }, - "1103": { + "1145": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "PriceSetMoneyAmountDTO.id" }, - "1104": { + "1146": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "PriceSetMoneyAmountDTO.title" }, - "1105": { + "1147": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "PriceSetMoneyAmountDTO.price_set" }, - "1106": { + "1148": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "PriceSetMoneyAmountDTO.price_list" }, - "1107": { + "1149": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "PriceSetMoneyAmountDTO.price_set_id" }, - "1108": { + "1150": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "PriceSetMoneyAmountDTO.price_rules" }, - "1109": { + "1151": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "PriceSetMoneyAmountDTO.money_amount" }, - "1110": { + "1152": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "UpdatePriceSetMoneyAmountDTO" }, - "1111": { + "1153": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "UpdatePriceSetMoneyAmountDTO.id" }, - "1112": { + "1154": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "UpdatePriceSetMoneyAmountDTO.title" }, - "1113": { + "1155": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "UpdatePriceSetMoneyAmountDTO.price_set" }, - "1114": { + "1156": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "UpdatePriceSetMoneyAmountDTO.money_amount" }, - "1115": { + "1157": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "CreatePriceSetMoneyAmountDTO" }, - "1116": { + "1158": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "CreatePriceSetMoneyAmountDTO.title" }, - "1117": { + "1159": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "CreatePriceSetMoneyAmountDTO.price_set" }, - "1118": { + "1160": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "CreatePriceSetMoneyAmountDTO.price_list" }, - "1119": { + "1161": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "CreatePriceSetMoneyAmountDTO.money_amount" + }, + "1162": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "CreatePriceSetMoneyAmountDTO.money_amount" + "qualifiedName": "CreatePriceSetMoneyAmountDTO.rules_count" }, - "1120": { + "1163": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "FilterablePriceSetMoneyAmountProps" }, - "1121": { + "1164": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "FilterablePriceSetMoneyAmountProps.id" }, - "1122": { + "1165": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "FilterablePriceSetMoneyAmountProps.price_set_id" }, - "1123": { + "1166": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", "qualifiedName": "FilterablePriceSetMoneyAmountProps.price_list_id" }, - "1124": { + "1167": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "1125": { + "1168": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "1126": { + "1169": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "PriceSetMoneyAmountRulesDTO" }, - "1127": { + "1170": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "PriceSetMoneyAmountRulesDTO.id" }, - "1128": { + "1171": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "PriceSetMoneyAmountRulesDTO.price_set_money_amount" }, - "1129": { + "1172": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "PriceSetMoneyAmountRulesDTO.rule_type" }, - "1130": { + "1173": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "PriceSetMoneyAmountRulesDTO.value" }, - "1131": { + "1174": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "CreatePriceSetMoneyAmountRulesDTO" }, - "1132": { + "1175": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "CreatePriceSetMoneyAmountRulesDTO.price_set_money_amount" }, - "1133": { + "1176": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "CreatePriceSetMoneyAmountRulesDTO.rule_type" }, - "1134": { + "1177": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "CreatePriceSetMoneyAmountRulesDTO.value" }, - "1135": { + "1178": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO" }, - "1136": { + "1179": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO.id" }, - "1137": { + "1180": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO.price_set_money_amount" }, - "1138": { + "1181": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO.rule_type" }, - "1139": { + "1182": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO.value" }, - "1140": { + "1183": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps" }, - "1141": { + "1184": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps.id" }, - "1142": { + "1185": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps.rule_type_id" }, - "1143": { + "1186": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps.price_set_money_amount_id" }, - "1144": { + "1187": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps.value" }, - "1145": { + "1188": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "1146": { + "1189": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "1147": { + "1190": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "PriceSetRuleTypeDTO" }, - "1148": { + "1191": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "PriceSetRuleTypeDTO.id" }, - "1149": { + "1192": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "PriceSetRuleTypeDTO.price_set" }, - "1150": { + "1193": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "PriceSetRuleTypeDTO.rule_type" }, - "1151": { + "1194": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "PriceSetRuleTypeDTO.value" }, - "1152": { + "1195": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "CreatePriceSetRuleTypeDTO" }, - "1153": { + "1196": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "CreatePriceSetRuleTypeDTO.price_set" }, - "1154": { + "1197": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "CreatePriceSetRuleTypeDTO.rule_type" }, - "1155": { + "1198": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "UpdatePriceSetRuleTypeDTO" }, - "1156": { + "1199": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "UpdatePriceSetRuleTypeDTO.id" }, - "1157": { + "1200": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "UpdatePriceSetRuleTypeDTO.price_set" }, - "1158": { + "1201": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "UpdatePriceSetRuleTypeDTO.rule_type" }, - "1159": { + "1202": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "FilterablePriceSetRuleTypeProps" }, - "1160": { + "1203": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "FilterablePriceSetRuleTypeProps.id" }, - "1161": { + "1204": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "FilterablePriceSetRuleTypeProps.rule_type_id" }, - "1162": { + "1205": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", "qualifiedName": "FilterablePriceSetRuleTypeProps.price_set_id" }, - "1163": { + "1206": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "1164": { + "1207": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "1165": { + "1208": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "RuleTypeDTO" }, - "1166": { + "1209": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "RuleTypeDTO.id" }, - "1167": { + "1210": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "RuleTypeDTO.name" }, - "1168": { + "1211": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "RuleTypeDTO.rule_attribute" }, - "1169": { + "1212": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "RuleTypeDTO.default_priority" }, - "1170": { + "1213": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "CreateRuleTypeDTO" }, - "1171": { + "1214": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "CreateRuleTypeDTO.id" }, - "1172": { + "1215": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "CreateRuleTypeDTO.name" }, - "1173": { + "1216": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "CreateRuleTypeDTO.rule_attribute" }, - "1174": { + "1217": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "CreateRuleTypeDTO.default_priority" }, - "1175": { + "1218": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "UpdateRuleTypeDTO" }, - "1176": { + "1219": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "UpdateRuleTypeDTO.id" }, - "1177": { + "1220": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "UpdateRuleTypeDTO.name" }, - "1178": { + "1221": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "UpdateRuleTypeDTO.rule_attribute" }, - "1179": { + "1222": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "UpdateRuleTypeDTO.default_priority" }, - "1180": { + "1223": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "FilterableRuleTypeProps" }, - "1181": { + "1224": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "FilterableRuleTypeProps.id" }, - "1182": { + "1225": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "FilterableRuleTypeProps.name" }, - "1183": { + "1226": { "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", "qualifiedName": "FilterableRuleTypeProps.rule_attribute" }, - "1184": { + "1227": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "1185": { + "1228": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "1186": { + "1229": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListStatus" }, - "1187": { + "1230": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListStatus.ACTIVE" }, - "1188": { + "1231": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListStatus.DRAFT" }, - "1189": { + "1232": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListType" }, - "1190": { + "1233": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListType.SALE" }, - "1191": { + "1234": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListType.OVERRIDE" }, - "1192": { + "1235": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListDTO" }, - "1193": { + "1236": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListDTO.id" }, - "1194": { + "1237": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListDTO.title" }, - "1195": { + "1238": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListDTO.starts_at" }, - "1196": { + "1239": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListDTO.status" }, - "1197": { + "1240": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListDTO.ends_at" }, - "1198": { + "1241": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.number_rules" + "qualifiedName": "PriceListDTO.rules_count" }, - "1199": { + "1242": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListDTO.price_set_money_amounts" }, - "1200": { + "1243": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListDTO.money_amounts" }, - "1201": { + "1244": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListDTO.rule_types" }, - "1202": { + "1245": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListDTO.rules" }, - "1203": { + "1246": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListDTO.price_list_rules" }, - "1204": { + "1247": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListPriceDTO" }, - "1205": { + "1248": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListPriceDTO.price_set_id" }, - "1206": { + "1249": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListPriceDTO.rules" + }, + "1250": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.id" }, - "1207": { + "1251": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.currency_code" }, - "1208": { + "1252": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.currency" }, - "1209": { + "1253": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.amount" }, - "1210": { + "1254": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.min_quantity" }, - "1211": { + "1255": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.max_quantity" }, - "1212": { + "1256": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceSetPriceRules" + }, + "1257": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRules" }, - "1213": { + "1258": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO" }, - "1214": { + "1259": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.title" }, - "1215": { + "1260": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.description" }, - "1216": { + "1261": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.starts_at" }, - "1217": { + "1262": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.ends_at" }, - "1218": { + "1263": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.status" }, - "1219": { + "1264": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.type" }, - "1220": { + "1265": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListDTO.number_rules" + "qualifiedName": "CreatePriceListDTO.rules_count" }, - "1221": { + "1266": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.rules" }, - "1222": { + "1267": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.prices" }, - "1223": { + "1268": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO" }, - "1224": { + "1269": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO.id" }, - "1225": { + "1270": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO.title" }, - "1226": { + "1271": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO.starts_at" }, - "1227": { + "1272": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO.ends_at" }, - "1228": { + "1273": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO.status" }, - "1229": { + "1274": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListDTO.number_rules" + "qualifiedName": "UpdatePriceListDTO.rules_count" }, - "1230": { + "1275": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO.rules" }, - "1231": { + "1276": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListProps" }, - "1232": { + "1277": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListProps.id" }, - "1233": { + "1278": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListProps.starts_at" }, - "1234": { + "1279": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListProps.ends_at" }, - "1235": { + "1280": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListProps.status" }, - "1236": { + "1281": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps.number_rules" + "qualifiedName": "FilterablePriceListProps.rules_count" }, - "1237": { + "1282": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "1238": { + "1283": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "1239": { + "1284": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleProps" }, - "1240": { + "1285": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleProps.id" }, - "1241": { + "1286": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleProps.value" }, - "1242": { + "1287": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleProps.rule_type" }, - "1243": { + "1288": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleProps.price_list_id" }, - "1244": { + "1289": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "1245": { + "1290": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "1246": { + "1291": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleValueProps" }, - "1247": { + "1292": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleValueProps.id" }, - "1248": { + "1293": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleValueProps.value" }, - "1249": { + "1294": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleValueProps.price_list_rule_id" }, - "1250": { + "1295": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "1251": { + "1296": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "1252": { + "1297": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleDTO" }, - "1253": { + "1298": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleDTO.id" }, - "1254": { + "1299": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleDTO.value" }, - "1255": { + "1300": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleDTO.rule_type" }, - "1256": { + "1301": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleDTO.price_list" }, - "1257": { + "1302": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleDTO.price_list_rule_values" }, - "1258": { + "1303": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleDTO" }, - "1259": { + "1304": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleDTO.rule_type_id" }, - "1260": { + "1305": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleDTO.rule_type" }, - "1261": { + "1306": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleDTO.price_list_id" }, - "1262": { + "1307": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleDTO.price_list" }, - "1263": { + "1308": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleDTO" }, - "1264": { + "1309": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleDTO.id" }, - "1265": { + "1310": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleDTO.price_list_id" }, - "1266": { + "1311": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleDTO.rule_type_id" }, - "1267": { + "1312": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleDTO.price_list" }, - "1268": { + "1313": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleDTO.rule_type" }, - "1269": { + "1314": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleValueDTO" }, - "1270": { + "1315": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleValueDTO.id" }, - "1271": { + "1316": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleValueDTO.value" }, - "1272": { + "1317": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleValueDTO.price_list_rule" }, - "1273": { + "1318": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleValueDTO" }, - "1274": { + "1319": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleValueDTO.value" }, - "1275": { + "1320": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleValueDTO.price_list_rule_id" }, - "1276": { + "1321": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleValueDTO.price_list_rule" }, - "1277": { + "1322": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleValueDTO" }, - "1278": { + "1323": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleValueDTO.id" }, - "1279": { + "1324": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleValueDTO.value" }, - "1280": { + "1325": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleValueDTO.price_list_rule_id" }, - "1281": { + "1326": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "AddPriceListPricesDTO" }, - "1282": { + "1327": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "AddPriceListPricesDTO.priceListId" }, - "1283": { + "1328": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "AddPriceListPricesDTO.prices" }, - "1284": { + "1329": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "SetPriceListRulesDTO" }, - "1285": { + "1330": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "SetPriceListRulesDTO.priceListId" }, - "1286": { + "1331": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "SetPriceListRulesDTO.rules" }, - "1287": { + "1332": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "RemovePriceListRulesDTO" }, - "1288": { + "1333": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "RemovePriceListRulesDTO.priceListId" }, - "1289": { + "1334": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "RemovePriceListRulesDTO.rules" }, - "1290": { + "1335": { "sourceFileName": "../../../packages/types/src/product-category/repository.ts", "qualifiedName": "ProductCategoryTransformOptions" }, - "1291": { + "1336": { "sourceFileName": "../../../packages/types/src/product-category/repository.ts", "qualifiedName": "ProductCategoryTransformOptions.includeDescendantsTree" }, - "1292": { + "1337": { "sourceFileName": "../../../packages/types/src/shared-context.ts", "qualifiedName": "SharedContext" }, - "1293": { + "1338": { "sourceFileName": "../../../packages/types/src/shared-context.ts", "qualifiedName": "__type.transactionManager" }, - "1294": { + "1339": { "sourceFileName": "../../../packages/types/src/shared-context.ts", "qualifiedName": "__type.manager" }, - "1295": { + "1340": { "sourceFileName": "../../../packages/types/src/shared-context.ts", "qualifiedName": "Context" }, - "1296": { + "1341": { "sourceFileName": "../../../packages/types/src/shared-context.ts", "qualifiedName": "__type.transactionManager" }, - "1297": { + "1342": { "sourceFileName": "../../../packages/types/src/shared-context.ts", "qualifiedName": "__type.manager" }, - "1298": { + "1343": { "sourceFileName": "../../../packages/types/src/shared-context.ts", "qualifiedName": "__type.isolationLevel" }, - "1299": { + "1344": { "sourceFileName": "../../../packages/types/src/shared-context.ts", "qualifiedName": "__type.enableNestedTransactions" }, - "1300": { + "1345": { "sourceFileName": "../../../packages/types/src/shared-context.ts", "qualifiedName": "__type.transactionId" }, - "1301": { + "1346": { "sourceFileName": "../../../packages/types/src/shared-context.ts", "qualifiedName": "TManager" }, - "1302": { + "1347": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "SessionOptions" }, - "1303": { + "1348": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type" }, - "1304": { + "1349": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.name" }, - "1305": { + "1350": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.resave" }, - "1306": { + "1351": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.rolling" }, - "1307": { + "1352": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.saveUninitialized" }, - "1308": { + "1353": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.secret" }, - "1309": { + "1354": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.ttl" }, - "1310": { + "1355": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "OperatorMap" }, - "1311": { + "1356": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type" }, - "1312": { + "1357": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$and" }, - "1313": { + "1358": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$or" }, - "1314": { + "1359": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$eq" }, - "1315": { + "1360": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$ne" }, - "1316": { + "1361": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$in" }, - "1317": { + "1362": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$nin" }, - "1318": { + "1363": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$not" }, - "1319": { + "1364": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$gt" }, - "1320": { + "1365": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$gte" }, - "1321": { + "1366": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$lt" }, - "1322": { + "1367": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$lte" }, - "1323": { + "1368": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$like" }, - "1324": { + "1369": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$re" }, - "1325": { + "1370": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$ilike" }, - "1326": { + "1371": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$fulltext" }, - "1327": { + "1372": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$overlap" }, - "1328": { + "1373": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$contains" }, - "1329": { + "1374": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$contained" }, - "1330": { + "1375": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.$exists" }, - "1331": { + "1376": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "T" }, - "1332": { + "1377": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "PrevLimit" }, - "1333": { + "1378": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "Order" }, - "1334": { + "1379": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "T" }, - "1335": { + "1380": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "Dictionary" }, - "1336": { + "1381": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type" }, - "1337": { + "1382": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.__index" }, - "1339": { + "1384": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "T" }, - "1340": { + "1385": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService" }, - "1341": { + "1386": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.transaction" }, - "1342": { + "1387": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.transaction" }, - "1343": { + "1388": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TManager" }, - "1344": { + "1389": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "task" }, - "1345": { + "1390": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type" }, - "1346": { + "1391": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type" }, - "1347": { + "1392": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "transactionManager" }, - "1348": { + "1393": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "1349": { + "1394": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type" }, - "1350": { + "1395": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.isolationLevel" }, - "1351": { + "1396": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.transaction" }, - "1352": { + "1397": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.enableNestedTransactions" }, - "1353": { + "1398": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getFreshManager" }, - "1354": { + "1399": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getFreshManager" }, - "1355": { + "1400": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TManager" }, - "1356": { + "1401": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getActiveManager" }, - "1357": { + "1402": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getActiveManager" }, - "1358": { + "1403": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TManager" }, - "1359": { + "1404": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.serialize" }, - "1360": { + "1405": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.serialize" }, - "1361": { + "1406": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TOutput" }, - "1362": { + "1407": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "data" }, - "1363": { + "1408": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "options" }, - "1364": { + "1409": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.T" }, - "1365": { + "1410": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleDeclaration" }, - "1366": { + "1411": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "InputPrice" }, - "1367": { + "1412": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "InputPrice.region_id" }, - "1368": { + "1413": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "InputPrice.currency_code" }, - "1369": { + "1414": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "InputPrice.amount" }, - "1370": { + "1415": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "InputPrice.variant_id" }, - "1371": { + "1416": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "InputPrice.min_quantity" }, - "1372": { + "1417": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", "qualifiedName": "InputPrice.max_quantity" }, - "1373": { + "1418": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "Query" }, - "1374": { + "1419": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "T" }, - "1375": { + "1420": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "ExpandScalar" }, - "1376": { + "1421": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "T" }, - "1377": { + "1422": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "Scalar" }, - "1378": { + "1423": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type" }, - "1379": { + "1424": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.toHexString" }, - "1380": { + "1425": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.toHexString" }, - "1381": { + "1426": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "FilterValue" }, - "1382": { + "1427": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "T" }, - "1383": { + "1428": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "FilterValue2" }, - "1384": { + "1429": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "T" }, - "1385": { + "1430": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "Primary" }, - "1386": { + "1431": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type" }, - "1387": { + "1432": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.[PrimaryKeyType]" }, - "1388": { + "1433": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type" }, - "1389": { + "1434": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type._id" }, - "1390": { + "1435": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type" }, - "1391": { + "1436": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.uuid" }, - "1392": { + "1437": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type" }, - "1393": { + "1438": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type.id" }, - "1394": { + "1439": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "T" }, - "1395": { + "1440": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "ReadonlyPrimary" }, - "1396": { + "1441": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "T" } diff --git a/docs-util/typedoc-json-output/entities.json b/docs-util/typedoc-json-output/entities.json index 7c06b9ada3923..86dc5dcf7b0f1 100644 --- a/docs-util/typedoc-json-output/entities.json +++ b/docs-util/typedoc-json-output/entities.json @@ -1623,6 +1623,14 @@ "variant": "declaration", "kind": 8, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The status of a payment session." + } + ] + }, "children": [ { "id": 908, @@ -1630,6 +1638,14 @@ "variant": "declaration", "kind": 16, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment is authorized." + } + ] + }, "type": { "type": "literal", "value": "authorized" @@ -1641,6 +1657,14 @@ "variant": "declaration", "kind": 16, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment is canceled." + } + ] + }, "type": { "type": "literal", "value": "canceled" @@ -1652,6 +1676,14 @@ "variant": "declaration", "kind": 16, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An error occurred while processing the payment." + } + ] + }, "type": { "type": "literal", "value": "error" @@ -1663,6 +1695,14 @@ "variant": "declaration", "kind": 16, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment is pending." + } + ] + }, "type": { "type": "literal", "value": "pending" @@ -1674,6 +1714,14 @@ "variant": "declaration", "kind": 16, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment requires an action." + } + ] + }, "type": { "type": "literal", "value": "requires_more" @@ -2086,7 +2134,7 @@ ] }, { - "id": 1376, + "id": 1377, "name": "RequirementType", "variant": "declaration", "kind": 8, @@ -2101,7 +2149,7 @@ }, "children": [ { - "id": 1378, + "id": 1379, "name": "MAX_SUBTOTAL", "variant": "declaration", "kind": 16, @@ -2120,7 +2168,7 @@ } }, { - "id": 1377, + "id": 1378, "name": "MIN_SUBTOTAL", "variant": "declaration", "kind": 16, @@ -2143,8 +2191,8 @@ { "title": "Enumeration Members", "children": [ - 1378, - 1377 + 1379, + 1378 ] } ] @@ -2254,7 +2302,7 @@ ] }, { - "id": 1349, + "id": 1350, "name": "ShippingOptionPriceType", "variant": "declaration", "kind": 8, @@ -2269,7 +2317,7 @@ }, "children": [ { - "id": 1351, + "id": 1352, "name": "CALCULATED", "variant": "declaration", "kind": 16, @@ -2304,7 +2352,7 @@ } }, { - "id": 1350, + "id": 1351, "name": "FLAT_RATE", "variant": "declaration", "kind": 16, @@ -2327,14 +2375,14 @@ { "title": "Enumeration Members", "children": [ - 1351, - 1350 + 1352, + 1351 ] } ] }, { - "id": 1390, + "id": 1391, "name": "ShippingProfileType", "variant": "declaration", "kind": 8, @@ -2349,7 +2397,7 @@ }, "children": [ { - "id": 1393, + "id": 1394, "name": "CUSTOM", "variant": "declaration", "kind": 16, @@ -2368,7 +2416,7 @@ } }, { - "id": 1391, + "id": 1392, "name": "DEFAULT", "variant": "declaration", "kind": 16, @@ -2387,7 +2435,7 @@ } }, { - "id": 1392, + "id": 1393, "name": "GIFT_CARD", "variant": "declaration", "kind": 16, @@ -2410,15 +2458,15 @@ { "title": "Enumeration Members", "children": [ - 1393, - 1391, - 1392 + 1394, + 1392, + 1393 ] } ] }, { - "id": 1446, + "id": 1447, "name": "SwapFulfillmentStatus", "variant": "declaration", "kind": 8, @@ -2433,7 +2481,7 @@ }, "children": [ { - "id": 1451, + "id": 1452, "name": "CANCELED", "variant": "declaration", "kind": 16, @@ -2452,7 +2500,7 @@ } }, { - "id": 1448, + "id": 1449, "name": "FULFILLED", "variant": "declaration", "kind": 16, @@ -2471,7 +2519,7 @@ } }, { - "id": 1447, + "id": 1448, "name": "NOT_FULFILLED", "variant": "declaration", "kind": 16, @@ -2490,7 +2538,7 @@ } }, { - "id": 1450, + "id": 1451, "name": "PARTIALLY_SHIPPED", "variant": "declaration", "kind": 16, @@ -2509,7 +2557,7 @@ } }, { - "id": 1452, + "id": 1453, "name": "REQUIRES_ACTION", "variant": "declaration", "kind": 16, @@ -2528,7 +2576,7 @@ } }, { - "id": 1449, + "id": 1450, "name": "SHIPPED", "variant": "declaration", "kind": 16, @@ -2551,18 +2599,18 @@ { "title": "Enumeration Members", "children": [ - 1451, - 1448, - 1447, - 1450, 1452, - 1449 + 1449, + 1448, + 1451, + 1453, + 1450 ] } ] }, { - "id": 1453, + "id": 1454, "name": "SwapPaymentStatus", "variant": "declaration", "kind": 8, @@ -2577,7 +2625,7 @@ }, "children": [ { - "id": 1455, + "id": 1456, "name": "AWAITING", "variant": "declaration", "kind": 16, @@ -2596,7 +2644,7 @@ } }, { - "id": 1458, + "id": 1459, "name": "CANCELED", "variant": "declaration", "kind": 16, @@ -2615,7 +2663,7 @@ } }, { - "id": 1456, + "id": 1457, "name": "CAPTURED", "variant": "declaration", "kind": 16, @@ -2634,7 +2682,7 @@ } }, { - "id": 1457, + "id": 1458, "name": "CONFIRMED", "variant": "declaration", "kind": 16, @@ -2653,7 +2701,7 @@ } }, { - "id": 1459, + "id": 1460, "name": "DIFFERENCE_REFUNDED", "variant": "declaration", "kind": 16, @@ -2672,7 +2720,7 @@ } }, { - "id": 1454, + "id": 1455, "name": "NOT_PAID", "variant": "declaration", "kind": 16, @@ -2691,7 +2739,7 @@ } }, { - "id": 1460, + "id": 1461, "name": "PARTIALLY_REFUNDED", "variant": "declaration", "kind": 16, @@ -2710,7 +2758,7 @@ } }, { - "id": 1461, + "id": 1462, "name": "REFUNDED", "variant": "declaration", "kind": 16, @@ -2729,7 +2777,7 @@ } }, { - "id": 1462, + "id": 1463, "name": "REQUIRES_ACTION", "variant": "declaration", "kind": 16, @@ -2752,21 +2800,21 @@ { "title": "Enumeration Members", "children": [ - 1455, - 1458, 1456, - 1457, 1459, - 1454, + 1457, + 1458, 1460, + 1455, 1461, - 1462 + 1462, + 1463 ] } ] }, { - "id": 1532, + "id": 1533, "name": "UserRoles", "variant": "declaration", "kind": 8, @@ -2781,7 +2829,7 @@ }, "children": [ { - "id": 1533, + "id": 1534, "name": "ADMIN", "variant": "declaration", "kind": 16, @@ -2800,7 +2848,7 @@ } }, { - "id": 1535, + "id": 1536, "name": "DEVELOPER", "variant": "declaration", "kind": 16, @@ -2819,7 +2867,7 @@ } }, { - "id": 1534, + "id": 1535, "name": "MEMBER", "variant": "declaration", "kind": 16, @@ -2842,9 +2890,9 @@ { "title": "Enumeration Members", "children": [ - 1533, - 1535, - 1534 + 1534, + 1536, + 1535 ] } ] @@ -3965,7 +4013,7 @@ }, "type": { "type": "reference", - "target": 1536, + "target": 1537, "name": "User", "package": "@medusajs/medusa" } @@ -5415,7 +5463,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1310, + "target": 1311, "name": "ShippingMethod", "package": "@medusajs/medusa" } @@ -7076,7 +7124,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1310, + "target": 1311, "name": "ShippingMethod", "package": "@medusajs/medusa" } @@ -8175,7 +8223,7 @@ }, "type": { "type": "reference", - "target": 1352, + "target": 1353, "name": "ShippingOption", "package": "@medusajs/medusa" } @@ -12733,7 +12781,7 @@ }, "type": { "type": "reference", - "target": 1463, + "target": 1464, "name": "Swap", "package": "@medusajs/medusa" } @@ -12778,7 +12826,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1517, + "target": 1518, "name": "TrackingLink", "package": "@medusajs/medusa" } @@ -14823,7 +14871,7 @@ }, "type": { "type": "reference", - "target": 1532, + "target": 1533, "name": "UserRoles", "package": "@medusajs/medusa" }, @@ -15892,7 +15940,7 @@ }, "type": { "type": "reference", - "target": 1463, + "target": 1464, "name": "Swap", "package": "@medusajs/medusa" } @@ -17593,7 +17641,7 @@ }, "type": { "type": "reference", - "target": 1536, + "target": 1537, "name": "User", "package": "@medusajs/medusa" } @@ -19795,7 +19843,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1310, + "target": 1311, "name": "ShippingMethod", "package": "@medusajs/medusa" } @@ -19910,7 +19958,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1463, + "target": 1464, "name": "Swap", "package": "@medusajs/medusa" } @@ -21819,7 +21867,7 @@ }, "type": { "type": "reference", - "target": 1463, + "target": 1464, "name": "Swap", "package": "@medusajs/medusa" } @@ -24197,7 +24245,7 @@ }, "type": { "type": "reference", - "target": 1394, + "target": 1395, "name": "ShippingProfile", "package": "@medusajs/medusa" } @@ -24239,7 +24287,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1394, + "target": 1395, "name": "ShippingProfile", "package": "@medusajs/medusa" } @@ -26762,7 +26810,7 @@ }, "type": { "type": "reference", - "target": 1497, + "target": 1498, "name": "TaxRate", "package": "@medusajs/medusa" } @@ -27289,7 +27337,7 @@ }, "type": { "type": "reference", - "target": 1497, + "target": 1498, "name": "TaxRate", "package": "@medusajs/medusa" } @@ -29997,7 +30045,7 @@ }, "type": { "type": "reference", - "target": 1492, + "target": 1493, "name": "TaxProvider", "package": "@medusajs/medusa" } @@ -30077,7 +30125,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1497, + "target": 1498, "name": "TaxRate", "package": "@medusajs/medusa" } @@ -30649,7 +30697,7 @@ }, "type": { "type": "reference", - "target": 1310, + "target": 1311, "name": "ShippingMethod", "package": "@medusajs/medusa" } @@ -30695,7 +30743,7 @@ }, "type": { "type": "reference", - "target": 1463, + "target": 1464, "name": "Swap", "package": "@medusajs/medusa" } @@ -31636,7 +31684,7 @@ } }, { - "id": 1296, + "id": 1297, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -31665,7 +31713,7 @@ } }, { - "id": 1294, + "id": 1295, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -31731,7 +31779,7 @@ } }, { - "id": 1295, + "id": 1296, "name": "id", "variant": "declaration", "kind": 1024, @@ -31775,7 +31823,7 @@ "defaultValue": false }, { - "id": 1291, + "id": 1292, "name": "locations", "variant": "declaration", "kind": 1024, @@ -31795,7 +31843,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 1298, + "target": 1299, "name": "SalesChannelLocation", "package": "@medusajs/medusa" } @@ -31864,7 +31912,23 @@ } }, { - "id": 1297, + "id": 1291, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 954, + "name": "Product", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1298, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -31893,7 +31957,7 @@ } }, { - "id": 1292, + "id": 1293, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -31902,7 +31966,7 @@ }, "signatures": [ { - "id": 1293, + "id": 1294, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -31925,21 +31989,22 @@ { "title": "Properties", "children": [ - 1296, - 1294, - 1288, + 1297, 1295, + 1288, + 1296, 1289, - 1291, + 1292, 1290, 1287, - 1297 + 1291, + 1298 ] }, { "title": "Methods", "children": [ - 1292 + 1293 ] } ], @@ -31956,7 +32021,7 @@ ] }, { - "id": 1298, + "id": 1299, "name": "SalesChannelLocation", "variant": "declaration", "kind": 128, @@ -31971,14 +32036,14 @@ }, "children": [ { - "id": 1299, + "id": 1300, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1300, + "id": 1301, "name": "new SalesChannelLocation", "variant": "signature", "kind": 16384, @@ -31993,7 +32058,7 @@ }, "type": { "type": "reference", - "target": 1298, + "target": 1299, "name": "SalesChannelLocation", "package": "@medusajs/medusa" }, @@ -32011,7 +32076,7 @@ } }, { - "id": 1308, + "id": 1309, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -32040,7 +32105,7 @@ } }, { - "id": 1306, + "id": 1307, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -32078,7 +32143,7 @@ } }, { - "id": 1307, + "id": 1308, "name": "id", "variant": "declaration", "kind": 1024, @@ -32102,7 +32167,7 @@ } }, { - "id": 1302, + "id": 1303, "name": "location_id", "variant": "declaration", "kind": 1024, @@ -32121,7 +32186,7 @@ } }, { - "id": 1303, + "id": 1304, "name": "sales_channel", "variant": "declaration", "kind": 1024, @@ -32145,7 +32210,7 @@ } }, { - "id": 1301, + "id": 1302, "name": "sales_channel_id", "variant": "declaration", "kind": 1024, @@ -32164,7 +32229,7 @@ } }, { - "id": 1309, + "id": 1310, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -32193,7 +32258,7 @@ } }, { - "id": 1304, + "id": 1305, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -32202,7 +32267,7 @@ }, "signatures": [ { - "id": 1305, + "id": 1306, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -32219,25 +32284,25 @@ { "title": "Constructors", "children": [ - 1299 + 1300 ] }, { "title": "Properties", "children": [ - 1308, - 1306, + 1309, 1307, - 1302, + 1308, 1303, - 1301, - 1309 + 1304, + 1302, + 1310 ] }, { "title": "Methods", "children": [ - 1304 + 1305 ] } ], @@ -32254,7 +32319,7 @@ ] }, { - "id": 1310, + "id": 1311, "name": "ShippingMethod", "variant": "declaration", "kind": 128, @@ -32269,14 +32334,14 @@ }, "children": [ { - "id": 1311, + "id": 1312, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1312, + "id": 1313, "name": "new ShippingMethod", "variant": "signature", "kind": 16384, @@ -32291,7 +32356,7 @@ }, "type": { "type": "reference", - "target": 1310, + "target": 1311, "name": "ShippingMethod", "package": "@medusajs/medusa" } @@ -32299,7 +32364,7 @@ ] }, { - "id": 1320, + "id": 1321, "name": "cart", "variant": "declaration", "kind": 1024, @@ -32323,7 +32388,7 @@ } }, { - "id": 1319, + "id": 1320, "name": "cart_id", "variant": "declaration", "kind": 1024, @@ -32342,7 +32407,7 @@ } }, { - "id": 1318, + "id": 1319, "name": "claim_order", "variant": "declaration", "kind": 1024, @@ -32366,7 +32431,7 @@ } }, { - "id": 1317, + "id": 1318, "name": "claim_order_id", "variant": "declaration", "kind": 1024, @@ -32394,7 +32459,7 @@ } }, { - "id": 1328, + "id": 1329, "name": "data", "variant": "declaration", "kind": 1024, @@ -32428,7 +32493,7 @@ } }, { - "id": 1313, + "id": 1314, "name": "id", "variant": "declaration", "kind": 1024, @@ -32447,7 +32512,7 @@ } }, { - "id": 1329, + "id": 1330, "name": "includes_tax", "variant": "declaration", "kind": 1024, @@ -32489,7 +32554,7 @@ "defaultValue": false }, { - "id": 1316, + "id": 1317, "name": "order", "variant": "declaration", "kind": 1024, @@ -32513,7 +32578,7 @@ } }, { - "id": 1315, + "id": 1316, "name": "order_id", "variant": "declaration", "kind": 1024, @@ -32532,7 +32597,7 @@ } }, { - "id": 1327, + "id": 1328, "name": "price", "variant": "declaration", "kind": 1024, @@ -32551,7 +32616,7 @@ } }, { - "id": 1323, + "id": 1324, "name": "return_id", "variant": "declaration", "kind": 1024, @@ -32570,7 +32635,7 @@ } }, { - "id": 1324, + "id": 1325, "name": "return_order", "variant": "declaration", "kind": 1024, @@ -32594,7 +32659,7 @@ } }, { - "id": 1325, + "id": 1326, "name": "shipping_option", "variant": "declaration", "kind": 1024, @@ -32612,13 +32677,13 @@ }, "type": { "type": "reference", - "target": 1352, + "target": 1353, "name": "ShippingOption", "package": "@medusajs/medusa" } }, { - "id": 1314, + "id": 1315, "name": "shipping_option_id", "variant": "declaration", "kind": 1024, @@ -32637,7 +32702,7 @@ } }, { - "id": 1330, + "id": 1331, "name": "subtotal", "variant": "declaration", "kind": 1024, @@ -32658,7 +32723,7 @@ } }, { - "id": 1322, + "id": 1323, "name": "swap", "variant": "declaration", "kind": 1024, @@ -32676,13 +32741,13 @@ }, "type": { "type": "reference", - "target": 1463, + "target": 1464, "name": "Swap", "package": "@medusajs/medusa" } }, { - "id": 1321, + "id": 1322, "name": "swap_id", "variant": "declaration", "kind": 1024, @@ -32701,7 +32766,7 @@ } }, { - "id": 1326, + "id": 1327, "name": "tax_lines", "variant": "declaration", "kind": 1024, @@ -32721,14 +32786,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 1335, + "target": 1336, "name": "ShippingMethodTaxLine", "package": "@medusajs/medusa" } } }, { - "id": 1332, + "id": 1333, "name": "tax_total", "variant": "declaration", "kind": 1024, @@ -32749,7 +32814,7 @@ } }, { - "id": 1331, + "id": 1332, "name": "total", "variant": "declaration", "kind": 1024, @@ -32770,7 +32835,7 @@ } }, { - "id": 1333, + "id": 1334, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -32779,7 +32844,7 @@ }, "signatures": [ { - "id": 1334, + "id": 1335, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -32796,44 +32861,44 @@ { "title": "Constructors", "children": [ - 1311 + 1312 ] }, { "title": "Properties", "children": [ + 1321, 1320, 1319, 1318, - 1317, - 1328, - 1313, 1329, + 1314, + 1330, + 1317, 1316, - 1315, - 1327, - 1323, + 1328, 1324, 1325, - 1314, - 1330, - 1322, - 1321, 1326, - 1332, - 1331 + 1315, + 1331, + 1323, + 1322, + 1327, + 1333, + 1332 ] }, { "title": "Methods", "children": [ - 1333 + 1334 ] } ] }, { - "id": 1335, + "id": 1336, "name": "ShippingMethodTaxLine", "variant": "declaration", "kind": 128, @@ -32848,14 +32913,14 @@ }, "children": [ { - "id": 1336, + "id": 1337, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1337, + "id": 1338, "name": "new ShippingMethodTaxLine", "variant": "signature", "kind": 16384, @@ -32870,7 +32935,7 @@ }, "type": { "type": "reference", - "target": 1335, + "target": 1336, "name": "ShippingMethodTaxLine", "package": "@medusajs/medusa" }, @@ -32888,7 +32953,7 @@ } }, { - "id": 1344, + "id": 1345, "name": "code", "variant": "declaration", "kind": 1024, @@ -32921,7 +32986,7 @@ } }, { - "id": 1347, + "id": 1348, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -32950,7 +33015,7 @@ } }, { - "id": 1346, + "id": 1347, "name": "id", "variant": "declaration", "kind": 1024, @@ -32974,7 +33039,7 @@ } }, { - "id": 1345, + "id": 1346, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -33013,7 +33078,7 @@ } }, { - "id": 1343, + "id": 1344, "name": "name", "variant": "declaration", "kind": 1024, @@ -33037,7 +33102,7 @@ } }, { - "id": 1342, + "id": 1343, "name": "rate", "variant": "declaration", "kind": 1024, @@ -33061,7 +33126,7 @@ } }, { - "id": 1339, + "id": 1340, "name": "shipping_method", "variant": "declaration", "kind": 1024, @@ -33079,13 +33144,13 @@ }, "type": { "type": "reference", - "target": 1310, + "target": 1311, "name": "ShippingMethod", "package": "@medusajs/medusa" } }, { - "id": 1338, + "id": 1339, "name": "shipping_method_id", "variant": "declaration", "kind": 1024, @@ -33104,7 +33169,7 @@ } }, { - "id": 1348, + "id": 1349, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -33133,7 +33198,7 @@ } }, { - "id": 1340, + "id": 1341, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -33142,7 +33207,7 @@ }, "signatures": [ { - "id": 1341, + "id": 1342, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -33159,27 +33224,27 @@ { "title": "Constructors", "children": [ - 1336 + 1337 ] }, { "title": "Properties", "children": [ - 1344, + 1345, + 1348, 1347, 1346, - 1345, + 1344, 1343, - 1342, + 1340, 1339, - 1338, - 1348 + 1349 ] }, { "title": "Methods", "children": [ - 1340 + 1341 ] } ], @@ -33196,7 +33261,7 @@ ] }, { - "id": 1352, + "id": 1353, "name": "ShippingOption", "variant": "declaration", "kind": 128, @@ -33211,14 +33276,14 @@ }, "children": [ { - "id": 1353, + "id": 1354, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1354, + "id": 1355, "name": "new ShippingOption", "variant": "signature", "kind": 16384, @@ -33233,7 +33298,7 @@ }, "type": { "type": "reference", - "target": 1352, + "target": 1353, "name": "ShippingOption", "package": "@medusajs/medusa" }, @@ -33251,7 +33316,7 @@ } }, { - "id": 1365, + "id": 1366, "name": "admin_only", "variant": "declaration", "kind": 1024, @@ -33271,7 +33336,7 @@ "defaultValue": false }, { - "id": 1363, + "id": 1364, "name": "amount", "variant": "declaration", "kind": 1024, @@ -33299,7 +33364,7 @@ } }, { - "id": 1374, + "id": 1375, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -33328,7 +33393,7 @@ } }, { - "id": 1367, + "id": 1368, "name": "data", "variant": "declaration", "kind": 1024, @@ -33362,7 +33427,7 @@ } }, { - "id": 1372, + "id": 1373, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -33400,7 +33465,7 @@ } }, { - "id": 1373, + "id": 1374, "name": "id", "variant": "declaration", "kind": 1024, @@ -33424,7 +33489,7 @@ } }, { - "id": 1369, + "id": 1370, "name": "includes_tax", "variant": "declaration", "kind": 1024, @@ -33466,7 +33531,7 @@ "defaultValue": false }, { - "id": 1364, + "id": 1365, "name": "is_return", "variant": "declaration", "kind": 1024, @@ -33486,7 +33551,7 @@ "defaultValue": false }, { - "id": 1368, + "id": 1369, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -33520,7 +33585,7 @@ } }, { - "id": 1355, + "id": 1356, "name": "name", "variant": "declaration", "kind": 1024, @@ -33539,7 +33604,7 @@ } }, { - "id": 1362, + "id": 1363, "name": "price_type", "variant": "declaration", "kind": 1024, @@ -33554,13 +33619,13 @@ }, "type": { "type": "reference", - "target": 1349, + "target": 1350, "name": "ShippingOptionPriceType", "package": "@medusajs/medusa" } }, { - "id": 1359, + "id": 1360, "name": "profile", "variant": "declaration", "kind": 1024, @@ -33578,13 +33643,13 @@ }, "type": { "type": "reference", - "target": 1394, + "target": 1395, "name": "ShippingProfile", "package": "@medusajs/medusa" } }, { - "id": 1358, + "id": 1359, "name": "profile_id", "variant": "declaration", "kind": 1024, @@ -33603,7 +33668,7 @@ } }, { - "id": 1361, + "id": 1362, "name": "provider", "variant": "declaration", "kind": 1024, @@ -33627,7 +33692,7 @@ } }, { - "id": 1360, + "id": 1361, "name": "provider_id", "variant": "declaration", "kind": 1024, @@ -33646,7 +33711,7 @@ } }, { - "id": 1357, + "id": 1358, "name": "region", "variant": "declaration", "kind": 1024, @@ -33670,7 +33735,7 @@ } }, { - "id": 1356, + "id": 1357, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -33689,7 +33754,7 @@ } }, { - "id": 1366, + "id": 1367, "name": "requirements", "variant": "declaration", "kind": 1024, @@ -33709,14 +33774,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 1379, + "target": 1380, "name": "ShippingOptionRequirement", "package": "@medusajs/medusa" } } }, { - "id": 1375, + "id": 1376, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -33745,7 +33810,7 @@ } }, { - "id": 1370, + "id": 1371, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -33754,7 +33819,7 @@ }, "signatures": [ { - "id": 1371, + "id": 1372, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -33771,37 +33836,37 @@ { "title": "Constructors", "children": [ - 1353 + 1354 ] }, { "title": "Properties", "children": [ - 1365, - 1363, - 1374, - 1367, - 1372, - 1373, - 1369, + 1366, 1364, + 1375, 1368, - 1355, - 1362, + 1373, + 1374, + 1370, + 1365, + 1369, + 1356, + 1363, + 1360, 1359, - 1358, + 1362, 1361, - 1360, + 1358, 1357, - 1356, - 1366, - 1375 + 1367, + 1376 ] }, { "title": "Methods", "children": [ - 1370 + 1371 ] } ], @@ -33818,7 +33883,7 @@ ] }, { - "id": 1379, + "id": 1380, "name": "ShippingOptionRequirement", "variant": "declaration", "kind": 128, @@ -33833,14 +33898,14 @@ }, "children": [ { - "id": 1380, + "id": 1381, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1381, + "id": 1382, "name": "new ShippingOptionRequirement", "variant": "signature", "kind": 16384, @@ -33855,7 +33920,7 @@ }, "type": { "type": "reference", - "target": 1379, + "target": 1380, "name": "ShippingOptionRequirement", "package": "@medusajs/medusa" } @@ -33863,7 +33928,7 @@ ] }, { - "id": 1386, + "id": 1387, "name": "amount", "variant": "declaration", "kind": 1024, @@ -33882,7 +33947,7 @@ } }, { - "id": 1387, + "id": 1388, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -33906,7 +33971,7 @@ } }, { - "id": 1382, + "id": 1383, "name": "id", "variant": "declaration", "kind": 1024, @@ -33925,7 +33990,7 @@ } }, { - "id": 1384, + "id": 1385, "name": "shipping_option", "variant": "declaration", "kind": 1024, @@ -33943,13 +34008,13 @@ }, "type": { "type": "reference", - "target": 1352, + "target": 1353, "name": "ShippingOption", "package": "@medusajs/medusa" } }, { - "id": 1383, + "id": 1384, "name": "shipping_option_id", "variant": "declaration", "kind": 1024, @@ -33968,7 +34033,7 @@ } }, { - "id": 1385, + "id": 1386, "name": "type", "variant": "declaration", "kind": 1024, @@ -33983,13 +34048,13 @@ }, "type": { "type": "reference", - "target": 1376, + "target": 1377, "name": "RequirementType", "package": "@medusajs/medusa" } }, { - "id": 1388, + "id": 1389, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -33998,7 +34063,7 @@ }, "signatures": [ { - "id": 1389, + "id": 1390, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -34015,30 +34080,30 @@ { "title": "Constructors", "children": [ - 1380 + 1381 ] }, { "title": "Properties", "children": [ - 1386, 1387, - 1382, - 1384, + 1388, 1383, - 1385 + 1385, + 1384, + 1386 ] }, { "title": "Methods", "children": [ - 1388 + 1389 ] } ] }, { - "id": 1394, + "id": 1395, "name": "ShippingProfile", "variant": "declaration", "kind": 128, @@ -34053,14 +34118,14 @@ }, "children": [ { - "id": 1395, + "id": 1396, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1396, + "id": 1397, "name": "new ShippingProfile", "variant": "signature", "kind": 16384, @@ -34075,7 +34140,7 @@ }, "type": { "type": "reference", - "target": 1394, + "target": 1395, "name": "ShippingProfile", "package": "@medusajs/medusa" }, @@ -34093,7 +34158,7 @@ } }, { - "id": 1406, + "id": 1407, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -34122,7 +34187,7 @@ } }, { - "id": 1404, + "id": 1405, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -34160,7 +34225,7 @@ } }, { - "id": 1405, + "id": 1406, "name": "id", "variant": "declaration", "kind": 1024, @@ -34184,7 +34249,7 @@ } }, { - "id": 1401, + "id": 1402, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -34218,7 +34283,7 @@ } }, { - "id": 1397, + "id": 1398, "name": "name", "variant": "declaration", "kind": 1024, @@ -34237,7 +34302,7 @@ } }, { - "id": 1399, + "id": 1400, "name": "products", "variant": "declaration", "kind": 1024, @@ -34264,7 +34329,7 @@ } }, { - "id": 1400, + "id": 1401, "name": "shipping_options", "variant": "declaration", "kind": 1024, @@ -34284,14 +34349,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 1352, + "target": 1353, "name": "ShippingOption", "package": "@medusajs/medusa" } } }, { - "id": 1398, + "id": 1399, "name": "type", "variant": "declaration", "kind": 1024, @@ -34306,13 +34371,13 @@ }, "type": { "type": "reference", - "target": 1390, + "target": 1391, "name": "ShippingProfileType", "package": "@medusajs/medusa" } }, { - "id": 1407, + "id": 1408, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -34341,7 +34406,7 @@ } }, { - "id": 1402, + "id": 1403, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -34350,7 +34415,7 @@ }, "signatures": [ { - "id": 1403, + "id": 1404, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -34367,27 +34432,27 @@ { "title": "Constructors", "children": [ - 1395 + 1396 ] }, { "title": "Properties", "children": [ - 1406, - 1404, + 1407, 1405, + 1406, + 1402, + 1398, + 1400, 1401, - 1397, 1399, - 1400, - 1398, - 1407 + 1408 ] }, { "title": "Methods", "children": [ - 1402 + 1403 ] } ], @@ -34404,7 +34469,7 @@ ] }, { - "id": 1408, + "id": 1409, "name": "ShippingTaxRate", "variant": "declaration", "kind": 128, @@ -34419,14 +34484,14 @@ }, "children": [ { - "id": 1409, + "id": 1410, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1410, + "id": 1411, "name": "new ShippingTaxRate", "variant": "signature", "kind": 16384, @@ -34441,7 +34506,7 @@ }, "type": { "type": "reference", - "target": 1408, + "target": 1409, "name": "ShippingTaxRate", "package": "@medusajs/medusa" } @@ -34449,7 +34514,7 @@ ] }, { - "id": 1415, + "id": 1416, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -34473,7 +34538,7 @@ } }, { - "id": 1417, + "id": 1418, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -34507,7 +34572,7 @@ } }, { - "id": 1412, + "id": 1413, "name": "rate_id", "variant": "declaration", "kind": 1024, @@ -34526,7 +34591,7 @@ } }, { - "id": 1413, + "id": 1414, "name": "shipping_option", "variant": "declaration", "kind": 1024, @@ -34546,13 +34611,13 @@ }, "type": { "type": "reference", - "target": 1352, + "target": 1353, "name": "ShippingOption", "package": "@medusajs/medusa" } }, { - "id": 1411, + "id": 1412, "name": "shipping_option_id", "variant": "declaration", "kind": 1024, @@ -34571,7 +34636,7 @@ } }, { - "id": 1414, + "id": 1415, "name": "tax_rate", "variant": "declaration", "kind": 1024, @@ -34591,13 +34656,13 @@ }, "type": { "type": "reference", - "target": 1497, + "target": 1498, "name": "TaxRate", "package": "@medusajs/medusa" } }, { - "id": 1416, + "id": 1417, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -34625,25 +34690,25 @@ { "title": "Constructors", "children": [ - 1409 + 1410 ] }, { "title": "Properties", "children": [ - 1415, - 1417, - 1412, + 1416, + 1418, 1413, - 1411, 1414, - 1416 + 1412, + 1415, + 1417 ] } ] }, { - "id": 1418, + "id": 1419, "name": "StagedJob", "variant": "declaration", "kind": 128, @@ -34658,14 +34723,14 @@ }, "children": [ { - "id": 1419, + "id": 1420, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1420, + "id": 1421, "name": "new StagedJob", "variant": "signature", "kind": 16384, @@ -34680,7 +34745,7 @@ }, "type": { "type": "reference", - "target": 1418, + "target": 1419, "name": "StagedJob", "package": "@medusajs/medusa" } @@ -34688,7 +34753,7 @@ ] }, { - "id": 1423, + "id": 1424, "name": "data", "variant": "declaration", "kind": 1024, @@ -34722,7 +34787,7 @@ } }, { - "id": 1422, + "id": 1423, "name": "event_name", "variant": "declaration", "kind": 1024, @@ -34741,7 +34806,7 @@ } }, { - "id": 1421, + "id": 1422, "name": "id", "variant": "declaration", "kind": 1024, @@ -34760,7 +34825,7 @@ } }, { - "id": 1424, + "id": 1425, "name": "options", "variant": "declaration", "kind": 1024, @@ -34786,7 +34851,7 @@ } }, { - "id": 1425, + "id": 1426, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -34795,7 +34860,7 @@ }, "signatures": [ { - "id": 1426, + "id": 1427, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -34812,28 +34877,28 @@ { "title": "Constructors", "children": [ - 1419 + 1420 ] }, { "title": "Properties", "children": [ + 1424, 1423, 1422, - 1421, - 1424 + 1425 ] }, { "title": "Methods", "children": [ - 1425 + 1426 ] } ] }, { - "id": 1427, + "id": 1428, "name": "Store", "variant": "declaration", "kind": 128, @@ -34848,14 +34913,14 @@ }, "children": [ { - "id": 1428, + "id": 1429, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1429, + "id": 1430, "name": "new Store", "variant": "signature", "kind": 16384, @@ -34870,7 +34935,7 @@ }, "type": { "type": "reference", - "target": 1427, + "target": 1428, "name": "Store", "package": "@medusajs/medusa" }, @@ -34888,7 +34953,7 @@ } }, { - "id": 1444, + "id": 1445, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -34917,7 +34982,7 @@ } }, { - "id": 1433, + "id": 1434, "name": "currencies", "variant": "declaration", "kind": 1024, @@ -34944,7 +35009,7 @@ } }, { - "id": 1432, + "id": 1433, "name": "default_currency", "variant": "declaration", "kind": 1024, @@ -34969,7 +35034,7 @@ "defaultValue": "usd" }, { - "id": 1431, + "id": 1432, "name": "default_currency_code", "variant": "declaration", "kind": 1024, @@ -34988,7 +35053,7 @@ } }, { - "id": 1437, + "id": 1438, "name": "default_location_id", "variant": "declaration", "kind": 1024, @@ -35007,7 +35072,7 @@ } }, { - "id": 1440, + "id": 1441, "name": "default_sales_channel", "variant": "declaration", "kind": 1024, @@ -35031,7 +35096,7 @@ } }, { - "id": 1439, + "id": 1440, "name": "default_sales_channel_id", "variant": "declaration", "kind": 1024, @@ -35059,7 +35124,7 @@ } }, { - "id": 1443, + "id": 1444, "name": "id", "variant": "declaration", "kind": 1024, @@ -35083,7 +35148,7 @@ } }, { - "id": 1436, + "id": 1437, "name": "invite_link_template", "variant": "declaration", "kind": 1024, @@ -35111,7 +35176,7 @@ } }, { - "id": 1438, + "id": 1439, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -35154,7 +35219,7 @@ } }, { - "id": 1430, + "id": 1431, "name": "name", "variant": "declaration", "kind": 1024, @@ -35174,7 +35239,7 @@ "defaultValue": "Medusa Store" }, { - "id": 1435, + "id": 1436, "name": "payment_link_template", "variant": "declaration", "kind": 1024, @@ -35202,7 +35267,7 @@ } }, { - "id": 1434, + "id": 1435, "name": "swap_link_template", "variant": "declaration", "kind": 1024, @@ -35230,7 +35295,7 @@ } }, { - "id": 1445, + "id": 1446, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -35259,7 +35324,7 @@ } }, { - "id": 1441, + "id": 1442, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -35268,7 +35333,7 @@ }, "signatures": [ { - "id": 1442, + "id": 1443, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -35285,32 +35350,32 @@ { "title": "Constructors", "children": [ - 1428 + 1429 ] }, { "title": "Properties", "children": [ - 1444, + 1445, + 1434, 1433, 1432, - 1431, - 1437, + 1438, + 1441, 1440, + 1444, + 1437, 1439, - 1443, + 1431, 1436, - 1438, - 1430, 1435, - 1434, - 1445 + 1446 ] }, { "title": "Methods", "children": [ - 1441 + 1442 ] } ], @@ -35327,7 +35392,7 @@ ] }, { - "id": 1463, + "id": 1464, "name": "Swap", "variant": "declaration", "kind": 128, @@ -35342,14 +35407,14 @@ }, "children": [ { - "id": 1464, + "id": 1465, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1465, + "id": 1466, "name": "new Swap", "variant": "signature", "kind": 16384, @@ -35364,7 +35429,7 @@ }, "type": { "type": "reference", - "target": 1463, + "target": 1464, "name": "Swap", "package": "@medusajs/medusa" }, @@ -35382,7 +35447,7 @@ } }, { - "id": 1470, + "id": 1471, "name": "additional_items", "variant": "declaration", "kind": 1024, @@ -35409,7 +35474,7 @@ } }, { - "id": 1483, + "id": 1484, "name": "allow_backorder", "variant": "declaration", "kind": 1024, @@ -35429,7 +35494,7 @@ "defaultValue": false }, { - "id": 1481, + "id": 1482, "name": "canceled_at", "variant": "declaration", "kind": 1024, @@ -35453,7 +35518,7 @@ } }, { - "id": 1479, + "id": 1480, "name": "cart", "variant": "declaration", "kind": 1024, @@ -35477,7 +35542,7 @@ } }, { - "id": 1478, + "id": 1479, "name": "cart_id", "variant": "declaration", "kind": 1024, @@ -35496,7 +35561,7 @@ } }, { - "id": 1480, + "id": 1481, "name": "confirmed_at", "variant": "declaration", "kind": 1024, @@ -35520,7 +35585,7 @@ } }, { - "id": 1490, + "id": 1491, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -35549,7 +35614,7 @@ } }, { - "id": 1488, + "id": 1489, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -35587,7 +35652,7 @@ } }, { - "id": 1474, + "id": 1475, "name": "difference_due", "variant": "declaration", "kind": 1024, @@ -35606,7 +35671,7 @@ } }, { - "id": 1466, + "id": 1467, "name": "fulfillment_status", "variant": "declaration", "kind": 1024, @@ -35621,13 +35686,13 @@ }, "type": { "type": "reference", - "target": 1446, + "target": 1447, "name": "SwapFulfillmentStatus", "package": "@medusajs/medusa" } }, { - "id": 1472, + "id": 1473, "name": "fulfillments", "variant": "declaration", "kind": 1024, @@ -35654,7 +35719,7 @@ } }, { - "id": 1489, + "id": 1490, "name": "id", "variant": "declaration", "kind": 1024, @@ -35678,7 +35743,7 @@ } }, { - "id": 1484, + "id": 1485, "name": "idempotency_key", "variant": "declaration", "kind": 1024, @@ -35697,7 +35762,7 @@ } }, { - "id": 1485, + "id": 1486, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -35731,7 +35796,7 @@ } }, { - "id": 1482, + "id": 1483, "name": "no_notification", "variant": "declaration", "kind": 1024, @@ -35750,7 +35815,7 @@ } }, { - "id": 1469, + "id": 1470, "name": "order", "variant": "declaration", "kind": 1024, @@ -35774,7 +35839,7 @@ } }, { - "id": 1468, + "id": 1469, "name": "order_id", "variant": "declaration", "kind": 1024, @@ -35793,7 +35858,7 @@ } }, { - "id": 1473, + "id": 1474, "name": "payment", "variant": "declaration", "kind": 1024, @@ -35817,7 +35882,7 @@ } }, { - "id": 1467, + "id": 1468, "name": "payment_status", "variant": "declaration", "kind": 1024, @@ -35832,13 +35897,13 @@ }, "type": { "type": "reference", - "target": 1453, + "target": 1454, "name": "SwapPaymentStatus", "package": "@medusajs/medusa" } }, { - "id": 1471, + "id": 1472, "name": "return_order", "variant": "declaration", "kind": 1024, @@ -35862,7 +35927,7 @@ } }, { - "id": 1476, + "id": 1477, "name": "shipping_address", "variant": "declaration", "kind": 1024, @@ -35886,7 +35951,7 @@ } }, { - "id": 1475, + "id": 1476, "name": "shipping_address_id", "variant": "declaration", "kind": 1024, @@ -35905,7 +35970,7 @@ } }, { - "id": 1477, + "id": 1478, "name": "shipping_methods", "variant": "declaration", "kind": 1024, @@ -35925,14 +35990,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 1310, + "target": 1311, "name": "ShippingMethod", "package": "@medusajs/medusa" } } }, { - "id": 1491, + "id": 1492, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -35961,7 +36026,7 @@ } }, { - "id": 1486, + "id": 1487, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -35970,7 +36035,7 @@ }, "signatures": [ { - "id": 1487, + "id": 1488, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -35987,42 +36052,42 @@ { "title": "Constructors", "children": [ - 1464 + 1465 ] }, { "title": "Properties", "children": [ - 1470, - 1483, - 1481, - 1479, - 1478, + 1471, + 1484, + 1482, 1480, - 1490, - 1488, - 1474, - 1466, - 1472, + 1479, + 1481, + 1491, 1489, - 1484, + 1475, + 1467, + 1473, + 1490, 1485, - 1482, + 1486, + 1483, + 1470, 1469, + 1474, 1468, - 1473, - 1467, - 1471, - 1476, - 1475, + 1472, 1477, - 1491 + 1476, + 1478, + 1492 ] }, { "title": "Methods", "children": [ - 1486 + 1487 ] } ], @@ -36039,7 +36104,7 @@ ] }, { - "id": 1492, + "id": 1493, "name": "TaxProvider", "variant": "declaration", "kind": 128, @@ -36054,14 +36119,14 @@ }, "children": [ { - "id": 1493, + "id": 1494, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1494, + "id": 1495, "name": "new TaxProvider", "variant": "signature", "kind": 16384, @@ -36076,7 +36141,7 @@ }, "type": { "type": "reference", - "target": 1492, + "target": 1493, "name": "TaxProvider", "package": "@medusajs/medusa" } @@ -36084,7 +36149,7 @@ ] }, { - "id": 1495, + "id": 1496, "name": "id", "variant": "declaration", "kind": 1024, @@ -36103,7 +36168,7 @@ } }, { - "id": 1496, + "id": 1497, "name": "is_installed", "variant": "declaration", "kind": 1024, @@ -36127,20 +36192,20 @@ { "title": "Constructors", "children": [ - 1493 + 1494 ] }, { "title": "Properties", "children": [ - 1495, - 1496 + 1496, + 1497 ] } ] }, { - "id": 1497, + "id": 1498, "name": "TaxRate", "variant": "declaration", "kind": 128, @@ -36155,14 +36220,14 @@ }, "children": [ { - "id": 1498, + "id": 1499, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1499, + "id": 1500, "name": "new TaxRate", "variant": "signature", "kind": 16384, @@ -36177,7 +36242,7 @@ }, "type": { "type": "reference", - "target": 1497, + "target": 1498, "name": "TaxRate", "package": "@medusajs/medusa" }, @@ -36195,7 +36260,7 @@ } }, { - "id": 1501, + "id": 1502, "name": "code", "variant": "declaration", "kind": 1024, @@ -36223,7 +36288,7 @@ } }, { - "id": 1515, + "id": 1516, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -36252,7 +36317,7 @@ } }, { - "id": 1514, + "id": 1515, "name": "id", "variant": "declaration", "kind": 1024, @@ -36276,7 +36341,7 @@ } }, { - "id": 1505, + "id": 1506, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -36310,7 +36375,7 @@ } }, { - "id": 1502, + "id": 1503, "name": "name", "variant": "declaration", "kind": 1024, @@ -36329,7 +36394,7 @@ } }, { - "id": 1509, + "id": 1510, "name": "product_count", "variant": "declaration", "kind": 1024, @@ -36350,7 +36415,7 @@ } }, { - "id": 1510, + "id": 1511, "name": "product_type_count", "variant": "declaration", "kind": 1024, @@ -36371,7 +36436,7 @@ } }, { - "id": 1507, + "id": 1508, "name": "product_types", "variant": "declaration", "kind": 1024, @@ -36398,7 +36463,7 @@ } }, { - "id": 1506, + "id": 1507, "name": "products", "variant": "declaration", "kind": 1024, @@ -36425,7 +36490,7 @@ } }, { - "id": 1500, + "id": 1501, "name": "rate", "variant": "declaration", "kind": 1024, @@ -36453,7 +36518,7 @@ } }, { - "id": 1504, + "id": 1505, "name": "region", "variant": "declaration", "kind": 1024, @@ -36477,7 +36542,7 @@ } }, { - "id": 1503, + "id": 1504, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -36496,7 +36561,7 @@ } }, { - "id": 1511, + "id": 1512, "name": "shipping_option_count", "variant": "declaration", "kind": 1024, @@ -36517,7 +36582,7 @@ } }, { - "id": 1508, + "id": 1509, "name": "shipping_options", "variant": "declaration", "kind": 1024, @@ -36537,14 +36602,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 1352, + "target": 1353, "name": "ShippingOption", "package": "@medusajs/medusa" } } }, { - "id": 1516, + "id": 1517, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -36573,7 +36638,7 @@ } }, { - "id": 1512, + "id": 1513, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -36582,7 +36647,7 @@ }, "signatures": [ { - "id": 1513, + "id": 1514, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -36599,33 +36664,33 @@ { "title": "Constructors", "children": [ - 1498 + 1499 ] }, { "title": "Properties", "children": [ - 1501, - 1515, - 1514, - 1505, 1502, - 1509, - 1510, - 1507, + 1516, + 1515, 1506, - 1500, - 1504, 1503, + 1510, 1511, 1508, - 1516 + 1507, + 1501, + 1505, + 1504, + 1512, + 1509, + 1517 ] }, { "title": "Methods", "children": [ - 1512 + 1513 ] } ], @@ -36642,7 +36707,7 @@ ] }, { - "id": 1517, + "id": 1518, "name": "TrackingLink", "variant": "declaration", "kind": 128, @@ -36657,14 +36722,14 @@ }, "children": [ { - "id": 1518, + "id": 1519, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1519, + "id": 1520, "name": "new TrackingLink", "variant": "signature", "kind": 16384, @@ -36679,7 +36744,7 @@ }, "type": { "type": "reference", - "target": 1517, + "target": 1518, "name": "TrackingLink", "package": "@medusajs/medusa" }, @@ -36697,7 +36762,7 @@ } }, { - "id": 1530, + "id": 1531, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -36726,7 +36791,7 @@ } }, { - "id": 1528, + "id": 1529, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -36764,7 +36829,7 @@ } }, { - "id": 1523, + "id": 1524, "name": "fulfillment", "variant": "declaration", "kind": 1024, @@ -36788,7 +36853,7 @@ } }, { - "id": 1522, + "id": 1523, "name": "fulfillment_id", "variant": "declaration", "kind": 1024, @@ -36807,7 +36872,7 @@ } }, { - "id": 1529, + "id": 1530, "name": "id", "variant": "declaration", "kind": 1024, @@ -36831,7 +36896,7 @@ } }, { - "id": 1524, + "id": 1525, "name": "idempotency_key", "variant": "declaration", "kind": 1024, @@ -36850,7 +36915,7 @@ } }, { - "id": 1525, + "id": 1526, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -36884,7 +36949,7 @@ } }, { - "id": 1521, + "id": 1522, "name": "tracking_number", "variant": "declaration", "kind": 1024, @@ -36903,7 +36968,7 @@ } }, { - "id": 1531, + "id": 1532, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -36932,7 +36997,7 @@ } }, { - "id": 1520, + "id": 1521, "name": "url", "variant": "declaration", "kind": 1024, @@ -36951,7 +37016,7 @@ } }, { - "id": 1526, + "id": 1527, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -36960,7 +37025,7 @@ }, "signatures": [ { - "id": 1527, + "id": 1528, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -36977,28 +37042,28 @@ { "title": "Constructors", "children": [ - 1518 + 1519 ] }, { "title": "Properties", "children": [ - 1530, - 1528, - 1523, - 1522, + 1531, 1529, 1524, + 1523, + 1530, 1525, - 1521, - 1531, - 1520 + 1526, + 1522, + 1532, + 1521 ] }, { "title": "Methods", "children": [ - 1526 + 1527 ] } ], @@ -37015,7 +37080,7 @@ ] }, { - "id": 1536, + "id": 1537, "name": "User", "variant": "declaration", "kind": 128, @@ -37030,14 +37095,14 @@ }, "children": [ { - "id": 1537, + "id": 1538, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1538, + "id": 1539, "name": "new User", "variant": "signature", "kind": 16384, @@ -37052,7 +37117,7 @@ }, "type": { "type": "reference", - "target": 1536, + "target": 1537, "name": "User", "package": "@medusajs/medusa" }, @@ -37070,7 +37135,7 @@ } }, { - "id": 1544, + "id": 1545, "name": "api_token", "variant": "declaration", "kind": 1024, @@ -37089,7 +37154,7 @@ } }, { - "id": 1550, + "id": 1551, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -37118,7 +37183,7 @@ } }, { - "id": 1548, + "id": 1549, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -37156,7 +37221,7 @@ } }, { - "id": 1540, + "id": 1541, "name": "email", "variant": "declaration", "kind": 1024, @@ -37175,7 +37240,7 @@ } }, { - "id": 1541, + "id": 1542, "name": "first_name", "variant": "declaration", "kind": 1024, @@ -37194,7 +37259,7 @@ } }, { - "id": 1549, + "id": 1550, "name": "id", "variant": "declaration", "kind": 1024, @@ -37218,7 +37283,7 @@ } }, { - "id": 1542, + "id": 1543, "name": "last_name", "variant": "declaration", "kind": 1024, @@ -37237,7 +37302,7 @@ } }, { - "id": 1545, + "id": 1546, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -37271,7 +37336,7 @@ } }, { - "id": 1543, + "id": 1544, "name": "password_hash", "variant": "declaration", "kind": 1024, @@ -37282,7 +37347,7 @@ } }, { - "id": 1539, + "id": 1540, "name": "role", "variant": "declaration", "kind": 1024, @@ -37297,14 +37362,14 @@ }, "type": { "type": "reference", - "target": 1532, + "target": 1533, "name": "UserRoles", "package": "@medusajs/medusa" }, "defaultValue": "member" }, { - "id": 1551, + "id": 1552, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -37333,7 +37398,7 @@ } }, { - "id": 1546, + "id": 1547, "name": "beforeInsert", "variant": "declaration", "kind": 2048, @@ -37342,7 +37407,7 @@ }, "signatures": [ { - "id": 1547, + "id": 1548, "name": "beforeInsert", "variant": "signature", "kind": 4096, @@ -37359,29 +37424,29 @@ { "title": "Constructors", "children": [ - 1537 + 1538 ] }, { "title": "Properties", "children": [ - 1544, - 1550, - 1548, - 1540, - 1541, + 1545, + 1551, 1549, + 1541, 1542, - 1545, + 1550, 1543, - 1539, - 1551 + 1546, + 1544, + 1540, + 1552 ] }, { "title": "Methods", "children": [ - 1546 + 1547 ] } ], @@ -37422,13 +37487,13 @@ 716, 949, 1177, - 1376, + 1377, 1224, - 1349, - 1390, - 1446, - 1453, - 1532 + 1350, + 1391, + 1447, + 1454, + 1533 ] }, { @@ -37500,20 +37565,20 @@ 1253, 1268, 1284, - 1298, - 1310, - 1335, - 1352, - 1379, - 1394, - 1408, - 1418, - 1427, - 1463, - 1492, - 1497, - 1517, - 1536 + 1299, + 1311, + 1336, + 1353, + 1380, + 1395, + 1409, + 1419, + 1428, + 1464, + 1493, + 1498, + 1518, + 1537 ] } ], @@ -42157,933 +42222,937 @@ }, "1291": { "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", - "qualifiedName": "SalesChannel.locations" + "qualifiedName": "SalesChannel.products" }, "1292": { "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", - "qualifiedName": "SalesChannel.beforeInsert" + "qualifiedName": "SalesChannel.locations" }, "1293": { "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", "qualifiedName": "SalesChannel.beforeInsert" }, "1294": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel.beforeInsert" + }, + "1295": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/soft-deletable-entity.ts", "qualifiedName": "SoftDeletableEntity.deleted_at" }, - "1295": { + "1296": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "1296": { + "1297": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "1297": { + "1298": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "1298": { + "1299": { "sourceFileName": "../../../packages/medusa/src/models/sales-channel-location.ts", "qualifiedName": "SalesChannelLocation" }, - "1301": { + "1302": { "sourceFileName": "../../../packages/medusa/src/models/sales-channel-location.ts", "qualifiedName": "SalesChannelLocation.sales_channel_id" }, - "1302": { + "1303": { "sourceFileName": "../../../packages/medusa/src/models/sales-channel-location.ts", "qualifiedName": "SalesChannelLocation.location_id" }, - "1303": { + "1304": { "sourceFileName": "../../../packages/medusa/src/models/sales-channel-location.ts", "qualifiedName": "SalesChannelLocation.sales_channel" }, - "1304": { + "1305": { "sourceFileName": "../../../packages/medusa/src/models/sales-channel-location.ts", "qualifiedName": "SalesChannelLocation.beforeInsert" }, - "1305": { + "1306": { "sourceFileName": "../../../packages/medusa/src/models/sales-channel-location.ts", "qualifiedName": "SalesChannelLocation.beforeInsert" }, - "1306": { + "1307": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/soft-deletable-entity.ts", "qualifiedName": "SoftDeletableEntity.deleted_at" }, - "1307": { + "1308": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "1308": { + "1309": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "1309": { + "1310": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "1310": { + "1311": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod" }, - "1313": { + "1314": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.id" }, - "1314": { + "1315": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.shipping_option_id" }, - "1315": { + "1316": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.order_id" }, - "1316": { + "1317": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.order" }, - "1317": { + "1318": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.claim_order_id" }, - "1318": { + "1319": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.claim_order" }, - "1319": { + "1320": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.cart_id" }, - "1320": { + "1321": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.cart" }, - "1321": { + "1322": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.swap_id" }, - "1322": { + "1323": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.swap" }, - "1323": { + "1324": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.return_id" }, - "1324": { + "1325": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.return_order" }, - "1325": { + "1326": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.shipping_option" }, - "1326": { + "1327": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.tax_lines" }, - "1327": { + "1328": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.price" }, - "1328": { + "1329": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.data" }, - "1329": { + "1330": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.includes_tax" }, - "1330": { + "1331": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.subtotal" }, - "1331": { + "1332": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.total" }, - "1332": { + "1333": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.tax_total" }, - "1333": { + "1334": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.beforeInsert" }, - "1334": { + "1335": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", "qualifiedName": "ShippingMethod.beforeInsert" }, - "1335": { + "1336": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method-tax-line.ts", "qualifiedName": "ShippingMethodTaxLine" }, - "1338": { + "1339": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method-tax-line.ts", "qualifiedName": "ShippingMethodTaxLine.shipping_method_id" }, - "1339": { + "1340": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method-tax-line.ts", "qualifiedName": "ShippingMethodTaxLine.shipping_method" }, - "1340": { + "1341": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method-tax-line.ts", "qualifiedName": "ShippingMethodTaxLine.beforeInsert" }, - "1341": { + "1342": { "sourceFileName": "../../../packages/medusa/src/models/shipping-method-tax-line.ts", "qualifiedName": "ShippingMethodTaxLine.beforeInsert" }, - "1342": { + "1343": { "sourceFileName": "../../../packages/medusa/src/models/tax-line.ts", "qualifiedName": "TaxLine.rate" }, - "1343": { + "1344": { "sourceFileName": "../../../packages/medusa/src/models/tax-line.ts", "qualifiedName": "TaxLine.name" }, - "1344": { + "1345": { "sourceFileName": "../../../packages/medusa/src/models/tax-line.ts", "qualifiedName": "TaxLine.code" }, - "1345": { + "1346": { "sourceFileName": "../../../packages/medusa/src/models/tax-line.ts", "qualifiedName": "TaxLine.metadata" }, - "1346": { + "1347": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "1347": { + "1348": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "1348": { + "1349": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "1349": { + "1350": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOptionPriceType" }, - "1350": { + "1351": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOptionPriceType.FLAT_RATE" }, - "1351": { + "1352": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOptionPriceType.CALCULATED" }, - "1352": { + "1353": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption" }, - "1355": { + "1356": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.name" }, - "1356": { + "1357": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.region_id" }, - "1357": { + "1358": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.region" }, - "1358": { + "1359": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.profile_id" }, - "1359": { + "1360": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.profile" }, - "1360": { + "1361": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.provider_id" }, - "1361": { + "1362": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.provider" }, - "1362": { + "1363": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.price_type" }, - "1363": { + "1364": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.amount" }, - "1364": { + "1365": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.is_return" }, - "1365": { + "1366": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.admin_only" }, - "1366": { + "1367": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.requirements" }, - "1367": { + "1368": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.data" }, - "1368": { + "1369": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.metadata" }, - "1369": { + "1370": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.includes_tax" }, - "1370": { + "1371": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.beforeInsert" }, - "1371": { + "1372": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", "qualifiedName": "ShippingOption.beforeInsert" }, - "1372": { + "1373": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/soft-deletable-entity.ts", "qualifiedName": "SoftDeletableEntity.deleted_at" }, - "1373": { + "1374": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "1374": { + "1375": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "1375": { + "1376": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "1376": { + "1377": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", "qualifiedName": "RequirementType" }, - "1377": { + "1378": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", "qualifiedName": "RequirementType.MIN_SUBTOTAL" }, - "1378": { + "1379": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", "qualifiedName": "RequirementType.MAX_SUBTOTAL" }, - "1379": { + "1380": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", "qualifiedName": "ShippingOptionRequirement" }, - "1382": { + "1383": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", "qualifiedName": "ShippingOptionRequirement.id" }, - "1383": { + "1384": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", "qualifiedName": "ShippingOptionRequirement.shipping_option_id" }, - "1384": { + "1385": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", "qualifiedName": "ShippingOptionRequirement.shipping_option" }, - "1385": { + "1386": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", "qualifiedName": "ShippingOptionRequirement.type" }, - "1386": { + "1387": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", "qualifiedName": "ShippingOptionRequirement.amount" }, - "1387": { + "1388": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", "qualifiedName": "ShippingOptionRequirement.deleted_at" }, - "1388": { + "1389": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", "qualifiedName": "ShippingOptionRequirement.beforeInsert" }, - "1389": { + "1390": { "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", "qualifiedName": "ShippingOptionRequirement.beforeInsert" }, - "1390": { + "1391": { "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", "qualifiedName": "ShippingProfileType" }, - "1391": { + "1392": { "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", "qualifiedName": "ShippingProfileType.DEFAULT" }, - "1392": { + "1393": { "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", "qualifiedName": "ShippingProfileType.GIFT_CARD" }, - "1393": { + "1394": { "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", "qualifiedName": "ShippingProfileType.CUSTOM" }, - "1394": { + "1395": { "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", "qualifiedName": "ShippingProfile" }, - "1397": { + "1398": { "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", "qualifiedName": "ShippingProfile.name" }, - "1398": { + "1399": { "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", "qualifiedName": "ShippingProfile.type" }, - "1399": { + "1400": { "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", "qualifiedName": "ShippingProfile.products" }, - "1400": { + "1401": { "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", "qualifiedName": "ShippingProfile.shipping_options" }, - "1401": { + "1402": { "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", "qualifiedName": "ShippingProfile.metadata" }, - "1402": { + "1403": { "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", "qualifiedName": "ShippingProfile.beforeInsert" }, - "1403": { + "1404": { "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", "qualifiedName": "ShippingProfile.beforeInsert" }, - "1404": { + "1405": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/soft-deletable-entity.ts", "qualifiedName": "SoftDeletableEntity.deleted_at" }, - "1405": { + "1406": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "1406": { + "1407": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "1407": { + "1408": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "1408": { + "1409": { "sourceFileName": "../../../packages/medusa/src/models/shipping-tax-rate.ts", "qualifiedName": "ShippingTaxRate" }, - "1411": { + "1412": { "sourceFileName": "../../../packages/medusa/src/models/shipping-tax-rate.ts", "qualifiedName": "ShippingTaxRate.shipping_option_id" }, - "1412": { + "1413": { "sourceFileName": "../../../packages/medusa/src/models/shipping-tax-rate.ts", "qualifiedName": "ShippingTaxRate.rate_id" }, - "1413": { + "1414": { "sourceFileName": "../../../packages/medusa/src/models/shipping-tax-rate.ts", "qualifiedName": "ShippingTaxRate.shipping_option" }, - "1414": { + "1415": { "sourceFileName": "../../../packages/medusa/src/models/shipping-tax-rate.ts", "qualifiedName": "ShippingTaxRate.tax_rate" }, - "1415": { + "1416": { "sourceFileName": "../../../packages/medusa/src/models/shipping-tax-rate.ts", "qualifiedName": "ShippingTaxRate.created_at" }, - "1416": { + "1417": { "sourceFileName": "../../../packages/medusa/src/models/shipping-tax-rate.ts", "qualifiedName": "ShippingTaxRate.updated_at" }, - "1417": { + "1418": { "sourceFileName": "../../../packages/medusa/src/models/shipping-tax-rate.ts", "qualifiedName": "ShippingTaxRate.metadata" }, - "1418": { + "1419": { "sourceFileName": "../../../packages/medusa/src/models/staged-job.ts", "qualifiedName": "StagedJob" }, - "1421": { + "1422": { "sourceFileName": "../../../packages/medusa/src/models/staged-job.ts", "qualifiedName": "StagedJob.id" }, - "1422": { + "1423": { "sourceFileName": "../../../packages/medusa/src/models/staged-job.ts", "qualifiedName": "StagedJob.event_name" }, - "1423": { + "1424": { "sourceFileName": "../../../packages/medusa/src/models/staged-job.ts", "qualifiedName": "StagedJob.data" }, - "1424": { + "1425": { "sourceFileName": "../../../packages/medusa/src/models/staged-job.ts", "qualifiedName": "StagedJob.options" }, - "1425": { + "1426": { "sourceFileName": "../../../packages/medusa/src/models/staged-job.ts", "qualifiedName": "StagedJob.beforeInsert" }, - "1426": { + "1427": { "sourceFileName": "../../../packages/medusa/src/models/staged-job.ts", "qualifiedName": "StagedJob.beforeInsert" }, - "1427": { + "1428": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store" }, - "1430": { + "1431": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.name" }, - "1431": { + "1432": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.default_currency_code" }, - "1432": { + "1433": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.default_currency" }, - "1433": { + "1434": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.currencies" }, - "1434": { + "1435": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.swap_link_template" }, - "1435": { + "1436": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.payment_link_template" }, - "1436": { + "1437": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.invite_link_template" }, - "1437": { + "1438": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.default_location_id" }, - "1438": { + "1439": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.metadata" }, - "1439": { + "1440": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.default_sales_channel_id" }, - "1440": { + "1441": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.default_sales_channel" }, - "1441": { + "1442": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.beforeInsert" }, - "1442": { + "1443": { "sourceFileName": "../../../packages/medusa/src/models/store.ts", "qualifiedName": "Store.beforeInsert" }, - "1443": { + "1444": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "1444": { + "1445": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "1445": { + "1446": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "1446": { + "1447": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapFulfillmentStatus" }, - "1447": { + "1448": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapFulfillmentStatus.NOT_FULFILLED" }, - "1448": { + "1449": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapFulfillmentStatus.FULFILLED" }, - "1449": { + "1450": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapFulfillmentStatus.SHIPPED" }, - "1450": { + "1451": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapFulfillmentStatus.PARTIALLY_SHIPPED" }, - "1451": { + "1452": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapFulfillmentStatus.CANCELED" }, - "1452": { + "1453": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapFulfillmentStatus.REQUIRES_ACTION" }, - "1453": { + "1454": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapPaymentStatus" }, - "1454": { + "1455": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapPaymentStatus.NOT_PAID" }, - "1455": { + "1456": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapPaymentStatus.AWAITING" }, - "1456": { + "1457": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapPaymentStatus.CAPTURED" }, - "1457": { + "1458": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapPaymentStatus.CONFIRMED" }, - "1458": { + "1459": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapPaymentStatus.CANCELED" }, - "1459": { + "1460": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapPaymentStatus.DIFFERENCE_REFUNDED" }, - "1460": { + "1461": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapPaymentStatus.PARTIALLY_REFUNDED" }, - "1461": { + "1462": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapPaymentStatus.REFUNDED" }, - "1462": { + "1463": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "SwapPaymentStatus.REQUIRES_ACTION" }, - "1463": { + "1464": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap" }, - "1466": { + "1467": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.fulfillment_status" }, - "1467": { + "1468": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.payment_status" }, - "1468": { + "1469": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.order_id" }, - "1469": { + "1470": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.order" }, - "1470": { + "1471": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.additional_items" }, - "1471": { + "1472": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.return_order" }, - "1472": { + "1473": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.fulfillments" }, - "1473": { + "1474": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.payment" }, - "1474": { + "1475": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.difference_due" }, - "1475": { + "1476": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.shipping_address_id" }, - "1476": { + "1477": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.shipping_address" }, - "1477": { + "1478": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.shipping_methods" }, - "1478": { + "1479": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.cart_id" }, - "1479": { + "1480": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.cart" }, - "1480": { + "1481": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.confirmed_at" }, - "1481": { + "1482": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.canceled_at" }, - "1482": { + "1483": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.no_notification" }, - "1483": { + "1484": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.allow_backorder" }, - "1484": { + "1485": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.idempotency_key" }, - "1485": { + "1486": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.metadata" }, - "1486": { + "1487": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.beforeInsert" }, - "1487": { + "1488": { "sourceFileName": "../../../packages/medusa/src/models/swap.ts", "qualifiedName": "Swap.beforeInsert" }, - "1488": { + "1489": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/soft-deletable-entity.ts", "qualifiedName": "SoftDeletableEntity.deleted_at" }, - "1489": { + "1490": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "1490": { + "1491": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "1491": { + "1492": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "1492": { + "1493": { "sourceFileName": "../../../packages/medusa/src/models/tax-provider.ts", "qualifiedName": "TaxProvider" }, - "1495": { + "1496": { "sourceFileName": "../../../packages/medusa/src/models/tax-provider.ts", "qualifiedName": "TaxProvider.id" }, - "1496": { + "1497": { "sourceFileName": "../../../packages/medusa/src/models/tax-provider.ts", "qualifiedName": "TaxProvider.is_installed" }, - "1497": { + "1498": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate" }, - "1500": { + "1501": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.rate" }, - "1501": { + "1502": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.code" }, - "1502": { + "1503": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.name" }, - "1503": { + "1504": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.region_id" }, - "1504": { + "1505": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.region" }, - "1505": { + "1506": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.metadata" }, - "1506": { + "1507": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.products" }, - "1507": { + "1508": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.product_types" }, - "1508": { + "1509": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.shipping_options" }, - "1509": { + "1510": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.product_count" }, - "1510": { + "1511": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.product_type_count" }, - "1511": { + "1512": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.shipping_option_count" }, - "1512": { + "1513": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.beforeInsert" }, - "1513": { + "1514": { "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", "qualifiedName": "TaxRate.beforeInsert" }, - "1514": { + "1515": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "1515": { + "1516": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "1516": { + "1517": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "1517": { + "1518": { "sourceFileName": "../../../packages/medusa/src/models/tracking-link.ts", "qualifiedName": "TrackingLink" }, - "1520": { + "1521": { "sourceFileName": "../../../packages/medusa/src/models/tracking-link.ts", "qualifiedName": "TrackingLink.url" }, - "1521": { + "1522": { "sourceFileName": "../../../packages/medusa/src/models/tracking-link.ts", "qualifiedName": "TrackingLink.tracking_number" }, - "1522": { + "1523": { "sourceFileName": "../../../packages/medusa/src/models/tracking-link.ts", "qualifiedName": "TrackingLink.fulfillment_id" }, - "1523": { + "1524": { "sourceFileName": "../../../packages/medusa/src/models/tracking-link.ts", "qualifiedName": "TrackingLink.fulfillment" }, - "1524": { + "1525": { "sourceFileName": "../../../packages/medusa/src/models/tracking-link.ts", "qualifiedName": "TrackingLink.idempotency_key" }, - "1525": { + "1526": { "sourceFileName": "../../../packages/medusa/src/models/tracking-link.ts", "qualifiedName": "TrackingLink.metadata" }, - "1526": { + "1527": { "sourceFileName": "../../../packages/medusa/src/models/tracking-link.ts", "qualifiedName": "TrackingLink.beforeInsert" }, - "1527": { + "1528": { "sourceFileName": "../../../packages/medusa/src/models/tracking-link.ts", "qualifiedName": "TrackingLink.beforeInsert" }, - "1528": { + "1529": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/soft-deletable-entity.ts", "qualifiedName": "SoftDeletableEntity.deleted_at" }, - "1529": { + "1530": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "1530": { + "1531": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "1531": { + "1532": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "1532": { + "1533": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "UserRoles" }, - "1533": { + "1534": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "UserRoles.ADMIN" }, - "1534": { + "1535": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "UserRoles.MEMBER" }, - "1535": { + "1536": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "UserRoles.DEVELOPER" }, - "1536": { + "1537": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "User" }, - "1539": { + "1540": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "User.role" }, - "1540": { + "1541": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "User.email" }, - "1541": { + "1542": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "User.first_name" }, - "1542": { + "1543": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "User.last_name" }, - "1543": { + "1544": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "User.password_hash" }, - "1544": { + "1545": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "User.api_token" }, - "1545": { + "1546": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "User.metadata" }, - "1546": { + "1547": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "User.beforeInsert" }, - "1547": { + "1548": { "sourceFileName": "../../../packages/medusa/src/models/user.ts", "qualifiedName": "User.beforeInsert" }, - "1548": { + "1549": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/soft-deletable-entity.ts", "qualifiedName": "SoftDeletableEntity.deleted_at" }, - "1549": { + "1550": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "1550": { + "1551": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "1551": { + "1552": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" } diff --git a/docs-util/typedoc-json-output/js-client.json b/docs-util/typedoc-json-output/js-client.json index 476ad95366f5f..7e2b215593571 100644 --- a/docs-util/typedoc-json-output/js-client.json +++ b/docs-util/typedoc-json-output/js-client.json @@ -1006,7 +1006,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminInvitesResource", - "target": 788, + "target": 787, "tsLinkText": "" }, { @@ -1017,7 +1017,7 @@ }, "type": { "type": "reference", - "target": 788, + "target": 787, "name": "AdminInvitesResource", "package": "@medusajs/medusa-js" }, @@ -1041,7 +1041,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminNotesResource", - "target": 811, + "target": 810, "tsLinkText": "" }, { @@ -1052,7 +1052,7 @@ }, "type": { "type": "reference", - "target": 811, + "target": 810, "name": "AdminNotesResource", "package": "@medusajs/medusa-js" }, @@ -1076,7 +1076,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminNotificationsResource", - "target": 836, + "target": 835, "tsLinkText": "" }, { @@ -1087,7 +1087,7 @@ }, "type": { "type": "reference", - "target": 836, + "target": 835, "name": "AdminNotificationsResource", "package": "@medusajs/medusa-js" }, @@ -1111,7 +1111,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminOrderEditsResource", - "target": 980, + "target": 979, "tsLinkText": "" }, { @@ -1122,7 +1122,7 @@ }, "type": { "type": "reference", - "target": 980, + "target": 979, "name": "AdminOrderEditsResource", "package": "@medusajs/medusa-js" }, @@ -1146,7 +1146,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminOrdersResource", - "target": 849, + "target": 848, "tsLinkText": "" }, { @@ -1157,7 +1157,7 @@ }, "type": { "type": "reference", - "target": 849, + "target": 848, "name": "AdminOrdersResource", "package": "@medusajs/medusa-js" }, @@ -1181,7 +1181,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminPaymentCollectionsResource", - "target": 1640, + "target": 1638, "tsLinkText": "" }, { @@ -1192,7 +1192,7 @@ }, "type": { "type": "reference", - "target": 1640, + "target": 1638, "name": "AdminPaymentCollectionsResource", "package": "@medusajs/medusa-js" }, @@ -1216,7 +1216,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminPaymentsResource", - "target": 1662, + "target": 1660, "tsLinkText": "" }, { @@ -1227,7 +1227,7 @@ }, "type": { "type": "reference", - "target": 1662, + "target": 1660, "name": "AdminPaymentsResource", "package": "@medusajs/medusa-js" }, @@ -1251,7 +1251,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminPriceListResource", - "target": 1039, + "target": 1038, "tsLinkText": "" }, { @@ -1262,7 +1262,7 @@ }, "type": { "type": "reference", - "target": 1039, + "target": 1038, "name": "AdminPriceListResource", "package": "@medusajs/medusa-js" }, @@ -1286,7 +1286,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminProductCategoriesResource", - "target": 1680, + "target": 1678, "tsLinkText": "" }, { @@ -1297,7 +1297,7 @@ }, "type": { "type": "reference", - "target": 1680, + "target": 1678, "name": "AdminProductCategoriesResource", "package": "@medusajs/medusa-js" }, @@ -1321,7 +1321,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminProductTagsResource", - "target": 1094, + "target": 1093, "tsLinkText": "" }, { @@ -1332,7 +1332,7 @@ }, "type": { "type": "reference", - "target": 1094, + "target": 1093, "name": "AdminProductTagsResource", "package": "@medusajs/medusa-js" }, @@ -1356,7 +1356,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminProductTypesResource", - "target": 1101, + "target": 1100, "tsLinkText": "" }, { @@ -1367,7 +1367,7 @@ }, "type": { "type": "reference", - "target": 1101, + "target": 1100, "name": "AdminProductTypesResource", "package": "@medusajs/medusa-js" }, @@ -1391,7 +1391,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminProductsResource", - "target": 1109, + "target": 1108, "tsLinkText": "" }, { @@ -1402,7 +1402,7 @@ }, "type": { "type": "reference", - "target": 1109, + "target": 1108, "name": "AdminProductsResource", "package": "@medusajs/medusa-js" }, @@ -1426,7 +1426,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminPublishableApiKeyResource", - "target": 1177, + "target": 1176, "tsLinkText": "" }, { @@ -1437,7 +1437,7 @@ }, "type": { "type": "reference", - "target": 1177, + "target": 1176, "name": "AdminPublishableApiKeyResource", "package": "@medusajs/medusa-js" }, @@ -1461,7 +1461,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminRegionsResource", - "target": 1222, + "target": 1220, "tsLinkText": "" }, { @@ -1472,7 +1472,7 @@ }, "type": { "type": "reference", - "target": 1222, + "target": 1220, "name": "AdminRegionsResource", "package": "@medusajs/medusa-js" }, @@ -1496,7 +1496,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminReservationsResource", - "target": 1281, + "target": 1279, "tsLinkText": "" }, { @@ -1507,7 +1507,7 @@ }, "type": { "type": "reference", - "target": 1281, + "target": 1279, "name": "AdminReservationsResource", "package": "@medusajs/medusa-js" }, @@ -1531,7 +1531,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminReturnReasonsResource", - "target": 1306, + "target": 1304, "tsLinkText": "" }, { @@ -1542,7 +1542,7 @@ }, "type": { "type": "reference", - "target": 1306, + "target": 1304, "name": "AdminReturnReasonsResource", "package": "@medusajs/medusa-js" }, @@ -1566,7 +1566,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminReturnsResource", - "target": 1330, + "target": 1328, "tsLinkText": "" }, { @@ -1577,7 +1577,7 @@ }, "type": { "type": "reference", - "target": 1330, + "target": 1328, "name": "AdminReturnsResource", "package": "@medusajs/medusa-js" }, @@ -1601,7 +1601,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminSalesChannelsResource", - "target": 1347, + "target": 1345, "tsLinkText": "" }, { @@ -1612,7 +1612,7 @@ }, "type": { "type": "reference", - "target": 1347, + "target": 1345, "name": "AdminSalesChannelsResource", "package": "@medusajs/medusa-js" }, @@ -1636,7 +1636,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminShippingOptionsResource", - "target": 1392, + "target": 1390, "tsLinkText": "" }, { @@ -1647,7 +1647,7 @@ }, "type": { "type": "reference", - "target": 1392, + "target": 1390, "name": "AdminShippingOptionsResource", "package": "@medusajs/medusa-js" }, @@ -1671,7 +1671,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminShippingProfilesResource", - "target": 1417, + "target": 1415, "tsLinkText": "" }, { @@ -1682,7 +1682,7 @@ }, "type": { "type": "reference", - "target": 1417, + "target": 1415, "name": "AdminShippingProfilesResource", "package": "@medusajs/medusa-js" }, @@ -1706,7 +1706,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminStockLocationsResource", - "target": 1441, + "target": 1439, "tsLinkText": "" }, { @@ -1717,7 +1717,7 @@ }, "type": { "type": "reference", - "target": 1441, + "target": 1439, "name": "AdminStockLocationsResource", "package": "@medusajs/medusa-js" }, @@ -1741,7 +1741,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminStoresResource", - "target": 1466, + "target": 1464, "tsLinkText": "" }, { @@ -1752,7 +1752,7 @@ }, "type": { "type": "reference", - "target": 1466, + "target": 1464, "name": "AdminStoresResource", "package": "@medusajs/medusa-js" }, @@ -1776,7 +1776,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminSwapsResource", - "target": 1491, + "target": 1489, "tsLinkText": "" }, { @@ -1787,7 +1787,7 @@ }, "type": { "type": "reference", - "target": 1491, + "target": 1489, "name": "AdminSwapsResource", "package": "@medusajs/medusa-js" }, @@ -1811,7 +1811,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminTaxRatesResource", - "target": 1503, + "target": 1501, "tsLinkText": "" }, { @@ -1822,7 +1822,7 @@ }, "type": { "type": "reference", - "target": 1503, + "target": 1501, "name": "AdminTaxRatesResource", "package": "@medusajs/medusa-js" }, @@ -1846,7 +1846,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminUploadsResource", - "target": 1567, + "target": 1565, "tsLinkText": "" }, { @@ -1857,7 +1857,7 @@ }, "type": { "type": "reference", - "target": 1567, + "target": 1565, "name": "AdminUploadsResource", "package": "@medusajs/medusa-js" }, @@ -1881,7 +1881,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminUsersResource", - "target": 1591, + "target": 1589, "tsLinkText": "" }, { @@ -1892,7 +1892,7 @@ }, "type": { "type": "reference", - "target": 1591, + "target": 1589, "name": "AdminUsersResource", "package": "@medusajs/medusa-js" }, @@ -1920,7 +1920,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminVariantsResource", - "target": 1623, + "target": 1621, "tsLinkText": "" }, { @@ -1933,7 +1933,7 @@ }, "type": { "type": "reference", - "target": 1623, + "target": 1621, "name": "AdminVariantsResource", "package": "@medusajs/medusa-js" }, @@ -10743,7 +10743,7 @@ "summary": [ { "kind": "text", - "text": "Delete a Draft Order" + "text": "Delete a Draft Order." } ], "blockTags": [ @@ -11780,7 +11780,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminProductsResource", - "target": 1109 + "target": 1108 }, { "kind": "text", @@ -11856,15 +11856,7 @@ "summary": [ { "kind": "text", - "text": "Create a gift card that can redeemed by its unique code. The Gift Card is only valid within " - }, - { - "kind": "code", - "text": "`1`" - }, - { - "kind": "text", - "text": " region." + "text": "Create a gift card that can redeemed by its unique code. The Gift Card is only valid within one region." } ], "blockTags": [ @@ -13172,32 +13164,6 @@ }, { "id": 781, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configurations to apply on the returned inventory item." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts", - "qualifiedName": "AdminGetInventoryItemsParams" - }, - "name": "AdminGetInventoryItemsParams", - "package": "@medusajs/medusa" - } - }, - { - "id": 782, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -13309,15 +13275,6 @@ } ] }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.inventoryItems.list()\n.then(({ inventory_items, count, offset, limit }) => {\n console.log(inventory_items.length);\n})\n```" - } - ] - }, { "tag": "@example", "content": [ @@ -13452,14 +13409,14 @@ ] }, { - "id": 783, + "id": 782, "name": "listLocationLevels", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 784, + "id": 783, "name": "listLocationLevels", "variant": "signature", "kind": 4096, @@ -13510,7 +13467,7 @@ }, "parameters": [ { - "id": 785, + "id": 784, "name": "inventoryItemId", "variant": "param", "kind": 32768, @@ -13529,7 +13486,7 @@ } }, { - "id": 786, + "id": 785, "name": "query", "variant": "param", "kind": 32768, @@ -13555,7 +13512,7 @@ } }, { - "id": 787, + "id": 786, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -14134,7 +14091,7 @@ 751, 777, 760, - 783, + 782, 740, 745, 764 @@ -14154,7 +14111,7 @@ ] }, { - "id": 788, + "id": 787, "name": "AdminInvitesResource", "variant": "declaration", "kind": 128, @@ -14187,21 +14144,21 @@ }, "children": [ { - "id": 789, + "id": 788, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 790, + "id": 789, "name": "new AdminInvitesResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 791, + "id": 790, "name": "client", "variant": "param", "kind": 32768, @@ -14219,7 +14176,7 @@ ], "type": { "type": "reference", - "target": 788, + "target": 787, "name": "AdminInvitesResource", "package": "@medusajs/medusa-js" }, @@ -14237,14 +14194,14 @@ } }, { - "id": 792, + "id": 791, "name": "accept", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 793, + "id": 792, "name": "accept", "variant": "signature", "kind": 4096, @@ -14287,7 +14244,7 @@ }, "parameters": [ { - "id": 794, + "id": 793, "name": "payload", "variant": "param", "kind": 32768, @@ -14311,7 +14268,7 @@ } }, { - "id": 795, + "id": 794, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -14359,14 +14316,14 @@ ] }, { - "id": 796, + "id": 795, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 797, + "id": 796, "name": "create", "variant": "signature", "kind": 4096, @@ -14409,7 +14366,7 @@ }, "parameters": [ { - "id": 798, + "id": 797, "name": "payload", "variant": "param", "kind": 32768, @@ -14433,7 +14390,7 @@ } }, { - "id": 799, + "id": 798, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -14481,14 +14438,14 @@ ] }, { - "id": 800, + "id": 799, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 801, + "id": 800, "name": "delete", "variant": "signature", "kind": 4096, @@ -14523,7 +14480,7 @@ }, "parameters": [ { - "id": 802, + "id": 801, "name": "id", "variant": "param", "kind": 32768, @@ -14542,7 +14499,7 @@ } }, { - "id": 803, + "id": 802, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -14601,14 +14558,14 @@ ] }, { - "id": 804, + "id": 803, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 805, + "id": 804, "name": "list", "variant": "signature", "kind": 4096, @@ -14643,7 +14600,7 @@ }, "parameters": [ { - "id": 806, + "id": 805, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -14702,14 +14659,14 @@ ] }, { - "id": 807, + "id": 806, "name": "resend", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 808, + "id": 807, "name": "resend", "variant": "signature", "kind": 4096, @@ -14752,7 +14709,7 @@ }, "parameters": [ { - "id": 809, + "id": 808, "name": "id", "variant": "param", "kind": 32768, @@ -14771,7 +14728,7 @@ } }, { - "id": 810, + "id": 809, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -14823,17 +14780,17 @@ { "title": "Constructors", "children": [ - 789 + 788 ] }, { "title": "Methods", "children": [ - 792, - 796, - 800, - 804, - 807 + 791, + 795, + 799, + 803, + 806 ] } ], @@ -14850,7 +14807,7 @@ ] }, { - "id": 811, + "id": 810, "name": "AdminNotesResource", "variant": "declaration", "kind": 128, @@ -14883,21 +14840,21 @@ }, "children": [ { - "id": 812, + "id": 811, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 813, + "id": 812, "name": "new AdminNotesResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 814, + "id": 813, "name": "client", "variant": "param", "kind": 32768, @@ -14915,7 +14872,7 @@ ], "type": { "type": "reference", - "target": 811, + "target": 810, "name": "AdminNotesResource", "package": "@medusajs/medusa-js" }, @@ -14933,14 +14890,14 @@ } }, { - "id": 815, + "id": 814, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 816, + "id": 815, "name": "create", "variant": "signature", "kind": 4096, @@ -14975,7 +14932,7 @@ }, "parameters": [ { - "id": 817, + "id": 816, "name": "payload", "variant": "param", "kind": 32768, @@ -14999,7 +14956,7 @@ } }, { - "id": 818, + "id": 817, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -15058,14 +15015,14 @@ ] }, { - "id": 824, + "id": 823, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 825, + "id": 824, "name": "delete", "variant": "signature", "kind": 4096, @@ -15100,7 +15057,7 @@ }, "parameters": [ { - "id": 826, + "id": 825, "name": "id", "variant": "param", "kind": 32768, @@ -15119,7 +15076,7 @@ } }, { - "id": 827, + "id": 826, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -15178,14 +15135,14 @@ ] }, { - "id": 832, + "id": 831, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 833, + "id": 832, "name": "list", "variant": "signature", "kind": 4096, @@ -15272,7 +15229,7 @@ }, "parameters": [ { - "id": 834, + "id": 833, "name": "query", "variant": "param", "kind": 32768, @@ -15298,7 +15255,7 @@ } }, { - "id": 835, + "id": 834, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -15357,14 +15314,14 @@ ] }, { - "id": 828, + "id": 827, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 829, + "id": 828, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -15399,7 +15356,7 @@ }, "parameters": [ { - "id": 830, + "id": 829, "name": "id", "variant": "param", "kind": 32768, @@ -15418,7 +15375,7 @@ } }, { - "id": 831, + "id": 830, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -15477,14 +15434,14 @@ ] }, { - "id": 819, + "id": 818, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 820, + "id": 819, "name": "update", "variant": "signature", "kind": 4096, @@ -15519,7 +15476,7 @@ }, "parameters": [ { - "id": 821, + "id": 820, "name": "id", "variant": "param", "kind": 32768, @@ -15538,7 +15495,7 @@ } }, { - "id": 822, + "id": 821, "name": "payload", "variant": "param", "kind": 32768, @@ -15562,7 +15519,7 @@ } }, { - "id": 823, + "id": 822, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -15625,17 +15582,17 @@ { "title": "Constructors", "children": [ - 812 + 811 ] }, { "title": "Methods", "children": [ - 815, - 824, - 832, - 828, - 819 + 814, + 823, + 831, + 827, + 818 ] } ], @@ -15652,7 +15609,7 @@ ] }, { - "id": 836, + "id": 835, "name": "AdminNotificationsResource", "variant": "declaration", "kind": 128, @@ -15685,21 +15642,21 @@ }, "children": [ { - "id": 837, + "id": 836, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 838, + "id": 837, "name": "new AdminNotificationsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 839, + "id": 838, "name": "client", "variant": "param", "kind": 32768, @@ -15717,7 +15674,7 @@ ], "type": { "type": "reference", - "target": 836, + "target": 835, "name": "AdminNotificationsResource", "package": "@medusajs/medusa-js" }, @@ -15735,14 +15692,14 @@ } }, { - "id": 840, + "id": 839, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 841, + "id": 840, "name": "list", "variant": "signature", "kind": 4096, @@ -15845,7 +15802,7 @@ }, "parameters": [ { - "id": 842, + "id": 841, "name": "query", "variant": "param", "kind": 32768, @@ -15871,7 +15828,7 @@ } }, { - "id": 843, + "id": 842, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -15930,14 +15887,14 @@ ] }, { - "id": 844, + "id": 843, "name": "resend", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 845, + "id": 844, "name": "resend", "variant": "signature", "kind": 4096, @@ -15972,7 +15929,7 @@ }, "parameters": [ { - "id": 846, + "id": 845, "name": "id", "variant": "param", "kind": 32768, @@ -15991,7 +15948,7 @@ } }, { - "id": 847, + "id": 846, "name": "payload", "variant": "param", "kind": 32768, @@ -16015,7 +15972,7 @@ } }, { - "id": 848, + "id": 847, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -16078,14 +16035,14 @@ { "title": "Constructors", "children": [ - 837 + 836 ] }, { "title": "Methods", "children": [ - 840, - 844 + 839, + 843 ] } ], @@ -16102,7 +16059,7 @@ ] }, { - "id": 980, + "id": 979, "name": "AdminOrderEditsResource", "variant": "declaration", "kind": 128, @@ -16143,21 +16100,21 @@ }, "children": [ { - "id": 981, + "id": 980, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 982, + "id": 981, "name": "new AdminOrderEditsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 983, + "id": 982, "name": "client", "variant": "param", "kind": 32768, @@ -16175,7 +16132,7 @@ ], "type": { "type": "reference", - "target": 980, + "target": 979, "name": "AdminOrderEditsResource", "package": "@medusajs/medusa-js" }, @@ -16193,14 +16150,14 @@ } }, { - "id": 1006, + "id": 1005, "name": "addLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1007, + "id": 1006, "name": "addLineItem", "variant": "signature", "kind": 4096, @@ -16235,7 +16192,7 @@ }, "parameters": [ { - "id": 1008, + "id": 1007, "name": "id", "variant": "param", "kind": 32768, @@ -16254,7 +16211,7 @@ } }, { - "id": 1009, + "id": 1008, "name": "payload", "variant": "param", "kind": 32768, @@ -16278,7 +16235,7 @@ } }, { - "id": 1010, + "id": 1009, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -16337,14 +16294,14 @@ ] }, { - "id": 1020, + "id": 1019, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1021, + "id": 1020, "name": "cancel", "variant": "signature", "kind": 4096, @@ -16379,7 +16336,7 @@ }, "parameters": [ { - "id": 1022, + "id": 1021, "name": "id", "variant": "param", "kind": 32768, @@ -16398,7 +16355,7 @@ } }, { - "id": 1023, + "id": 1022, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -16457,14 +16414,14 @@ ] }, { - "id": 1024, + "id": 1023, "name": "confirm", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1025, + "id": 1024, "name": "confirm", "variant": "signature", "kind": 4096, @@ -16499,7 +16456,7 @@ }, "parameters": [ { - "id": 1026, + "id": 1025, "name": "id", "variant": "param", "kind": 32768, @@ -16518,7 +16475,7 @@ } }, { - "id": 1027, + "id": 1026, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -16577,14 +16534,14 @@ ] }, { - "id": 993, + "id": 992, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 994, + "id": 993, "name": "create", "variant": "signature", "kind": 4096, @@ -16619,7 +16576,7 @@ }, "parameters": [ { - "id": 995, + "id": 994, "name": "payload", "variant": "param", "kind": 32768, @@ -16643,7 +16600,7 @@ } }, { - "id": 996, + "id": 995, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -16702,14 +16659,14 @@ ] }, { - "id": 1002, + "id": 1001, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1003, + "id": 1002, "name": "delete", "variant": "signature", "kind": 4096, @@ -16752,7 +16709,7 @@ }, "parameters": [ { - "id": 1004, + "id": 1003, "name": "id", "variant": "param", "kind": 32768, @@ -16771,7 +16728,7 @@ } }, { - "id": 1005, + "id": 1004, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -16830,14 +16787,14 @@ ] }, { - "id": 1011, + "id": 1010, "name": "deleteItemChange", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1012, + "id": 1011, "name": "deleteItemChange", "variant": "signature", "kind": 4096, @@ -16872,7 +16829,7 @@ }, "parameters": [ { - "id": 1013, + "id": 1012, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -16891,7 +16848,7 @@ } }, { - "id": 1014, + "id": 1013, "name": "itemChangeId", "variant": "param", "kind": 32768, @@ -16910,7 +16867,7 @@ } }, { - "id": 1015, + "id": 1014, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -16969,14 +16926,14 @@ ] }, { - "id": 989, + "id": 988, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 990, + "id": 989, "name": "list", "variant": "signature", "kind": 4096, @@ -17079,7 +17036,7 @@ }, "parameters": [ { - "id": 991, + "id": 990, "name": "query", "variant": "param", "kind": 32768, @@ -17105,7 +17062,7 @@ } }, { - "id": 992, + "id": 991, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -17164,14 +17121,14 @@ ] }, { - "id": 1034, + "id": 1033, "name": "removeLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1035, + "id": 1034, "name": "removeLineItem", "variant": "signature", "kind": 4096, @@ -17206,7 +17163,7 @@ }, "parameters": [ { - "id": 1036, + "id": 1035, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -17225,7 +17182,7 @@ } }, { - "id": 1037, + "id": 1036, "name": "itemId", "variant": "param", "kind": 32768, @@ -17244,7 +17201,7 @@ } }, { - "id": 1038, + "id": 1037, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -17303,14 +17260,14 @@ ] }, { - "id": 1016, + "id": 1015, "name": "requestConfirmation", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1017, + "id": 1016, "name": "requestConfirmation", "variant": "signature", "kind": 4096, @@ -17353,7 +17310,7 @@ }, "parameters": [ { - "id": 1018, + "id": 1017, "name": "id", "variant": "param", "kind": 32768, @@ -17372,7 +17329,7 @@ } }, { - "id": 1019, + "id": 1018, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -17431,14 +17388,14 @@ ] }, { - "id": 984, + "id": 983, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 985, + "id": 984, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -17485,7 +17442,7 @@ }, "parameters": [ { - "id": 986, + "id": 985, "name": "id", "variant": "param", "kind": 32768, @@ -17504,7 +17461,7 @@ } }, { - "id": 987, + "id": 986, "name": "query", "variant": "param", "kind": 32768, @@ -17530,7 +17487,7 @@ } }, { - "id": 988, + "id": 987, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -17589,14 +17546,14 @@ ] }, { - "id": 997, + "id": 996, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 998, + "id": 997, "name": "update", "variant": "signature", "kind": 4096, @@ -17631,7 +17588,7 @@ }, "parameters": [ { - "id": 999, + "id": 998, "name": "id", "variant": "param", "kind": 32768, @@ -17650,7 +17607,7 @@ } }, { - "id": 1000, + "id": 999, "name": "payload", "variant": "param", "kind": 32768, @@ -17674,7 +17631,7 @@ } }, { - "id": 1001, + "id": 1000, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -17733,14 +17690,14 @@ ] }, { - "id": 1028, + "id": 1027, "name": "updateLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1029, + "id": 1028, "name": "updateLineItem", "variant": "signature", "kind": 4096, @@ -17775,7 +17732,7 @@ }, "parameters": [ { - "id": 1030, + "id": 1029, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -17794,7 +17751,7 @@ } }, { - "id": 1031, + "id": 1030, "name": "itemId", "variant": "param", "kind": 32768, @@ -17813,7 +17770,7 @@ } }, { - "id": 1032, + "id": 1031, "name": "payload", "variant": "param", "kind": 32768, @@ -17837,7 +17794,7 @@ } }, { - "id": 1033, + "id": 1032, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -17900,24 +17857,24 @@ { "title": "Constructors", "children": [ - 981 + 980 ] }, { "title": "Methods", "children": [ - 1006, - 1020, - 1024, - 993, - 1002, - 1011, - 989, - 1034, - 1016, - 984, - 997, - 1028 + 1005, + 1019, + 1023, + 992, + 1001, + 1010, + 988, + 1033, + 1015, + 983, + 996, + 1027 ] } ], @@ -17934,7 +17891,7 @@ ] }, { - "id": 849, + "id": 848, "name": "AdminOrdersResource", "variant": "declaration", "kind": 128, @@ -17977,21 +17934,21 @@ }, "children": [ { - "id": 850, + "id": 849, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 851, + "id": 850, "name": "new AdminOrdersResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 852, + "id": 851, "name": "client", "variant": "param", "kind": 32768, @@ -18009,7 +17966,7 @@ ], "type": { "type": "reference", - "target": 849, + "target": 848, "name": "AdminOrdersResource", "package": "@medusajs/medusa-js" }, @@ -18027,14 +17984,14 @@ } }, { - "id": 916, + "id": 915, "name": "addShippingMethod", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 917, + "id": 916, "name": "addShippingMethod", "variant": "signature", "kind": 4096, @@ -18069,7 +18026,7 @@ }, "parameters": [ { - "id": 918, + "id": 917, "name": "id", "variant": "param", "kind": 32768, @@ -18088,7 +18045,7 @@ } }, { - "id": 919, + "id": 918, "name": "payload", "variant": "param", "kind": 32768, @@ -18112,7 +18069,7 @@ } }, { - "id": 920, + "id": 919, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -18171,14 +18128,14 @@ ] }, { - "id": 921, + "id": 920, "name": "archive", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 922, + "id": 921, "name": "archive", "variant": "signature", "kind": 4096, @@ -18213,7 +18170,7 @@ }, "parameters": [ { - "id": 923, + "id": 922, "name": "id", "variant": "param", "kind": 32768, @@ -18232,7 +18189,7 @@ } }, { - "id": 924, + "id": 923, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -18291,14 +18248,14 @@ ] }, { - "id": 912, + "id": 911, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 913, + "id": 912, "name": "cancel", "variant": "signature", "kind": 4096, @@ -18333,7 +18290,7 @@ }, "parameters": [ { - "id": 914, + "id": 913, "name": "id", "variant": "param", "kind": 32768, @@ -18352,7 +18309,7 @@ } }, { - "id": 915, + "id": 914, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -18411,14 +18368,14 @@ ] }, { - "id": 957, + "id": 956, "name": "cancelClaim", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 958, + "id": 957, "name": "cancelClaim", "variant": "signature", "kind": 4096, @@ -18461,7 +18418,7 @@ }, "parameters": [ { - "id": 959, + "id": 958, "name": "id", "variant": "param", "kind": 32768, @@ -18480,7 +18437,7 @@ } }, { - "id": 960, + "id": 959, "name": "claimId", "variant": "param", "kind": 32768, @@ -18499,7 +18456,7 @@ } }, { - "id": 961, + "id": 960, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -18558,14 +18515,14 @@ ] }, { - "id": 896, + "id": 895, "name": "cancelClaimFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 897, + "id": 896, "name": "cancelClaimFulfillment", "variant": "signature", "kind": 4096, @@ -18608,7 +18565,7 @@ }, "parameters": [ { - "id": 898, + "id": 897, "name": "id", "variant": "param", "kind": 32768, @@ -18627,7 +18584,7 @@ } }, { - "id": 899, + "id": 898, "name": "claimId", "variant": "param", "kind": 32768, @@ -18646,7 +18603,7 @@ } }, { - "id": 900, + "id": 899, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -18665,7 +18622,7 @@ } }, { - "id": 901, + "id": 900, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -18724,14 +18681,14 @@ ] }, { - "id": 885, + "id": 884, "name": "cancelFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 886, + "id": 885, "name": "cancelFulfillment", "variant": "signature", "kind": 4096, @@ -18774,7 +18731,7 @@ }, "parameters": [ { - "id": 887, + "id": 886, "name": "id", "variant": "param", "kind": 32768, @@ -18793,7 +18750,7 @@ } }, { - "id": 888, + "id": 887, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -18812,7 +18769,7 @@ } }, { - "id": 889, + "id": 888, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -18871,14 +18828,14 @@ ] }, { - "id": 930, + "id": 929, "name": "cancelSwap", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 931, + "id": 930, "name": "cancelSwap", "variant": "signature", "kind": 4096, @@ -18921,7 +18878,7 @@ }, "parameters": [ { - "id": 932, + "id": 931, "name": "id", "variant": "param", "kind": 32768, @@ -18940,7 +18897,7 @@ } }, { - "id": 933, + "id": 932, "name": "swapId", "variant": "param", "kind": 32768, @@ -18959,7 +18916,7 @@ } }, { - "id": 934, + "id": 933, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -19018,14 +18975,14 @@ ] }, { - "id": 890, + "id": 889, "name": "cancelSwapFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 891, + "id": 890, "name": "cancelSwapFulfillment", "variant": "signature", "kind": 4096, @@ -19068,7 +19025,7 @@ }, "parameters": [ { - "id": 892, + "id": 891, "name": "id", "variant": "param", "kind": 32768, @@ -19087,7 +19044,7 @@ } }, { - "id": 893, + "id": 892, "name": "swapId", "variant": "param", "kind": 32768, @@ -19106,7 +19063,7 @@ } }, { - "id": 894, + "id": 893, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -19125,7 +19082,7 @@ } }, { - "id": 895, + "id": 894, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -19184,14 +19141,14 @@ ] }, { - "id": 871, + "id": 870, "name": "capturePayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 872, + "id": 871, "name": "capturePayment", "variant": "signature", "kind": 4096, @@ -19226,7 +19183,7 @@ }, "parameters": [ { - "id": 873, + "id": 872, "name": "id", "variant": "param", "kind": 32768, @@ -19245,7 +19202,7 @@ } }, { - "id": 874, + "id": 873, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -19304,14 +19261,14 @@ ] }, { - "id": 867, + "id": 866, "name": "complete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 868, + "id": 867, "name": "complete", "variant": "signature", "kind": 4096, @@ -19346,7 +19303,7 @@ }, "parameters": [ { - "id": 869, + "id": 868, "name": "id", "variant": "param", "kind": 32768, @@ -19365,7 +19322,7 @@ } }, { - "id": 870, + "id": 869, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -19424,14 +19381,14 @@ ] }, { - "id": 952, + "id": 951, "name": "createClaim", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 953, + "id": 952, "name": "createClaim", "variant": "signature", "kind": 4096, @@ -19457,7 +19414,7 @@ "content": [ { "kind": "text", - "text": "Resolves to the order's details. You can access the swap under the " + "text": "Resolves to the order's details. You can access the claim under the " }, { "kind": "code", @@ -19482,7 +19439,7 @@ }, "parameters": [ { - "id": 954, + "id": 953, "name": "id", "variant": "param", "kind": 32768, @@ -19501,7 +19458,7 @@ } }, { - "id": 955, + "id": 954, "name": "payload", "variant": "param", "kind": 32768, @@ -19525,7 +19482,7 @@ } }, { - "id": 956, + "id": 955, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -19584,14 +19541,14 @@ ] }, { - "id": 974, + "id": 973, "name": "createClaimShipment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 975, + "id": 974, "name": "createClaimShipment", "variant": "signature", "kind": 4096, @@ -19650,7 +19607,7 @@ }, "parameters": [ { - "id": 976, + "id": 975, "name": "id", "variant": "param", "kind": 32768, @@ -19669,7 +19626,7 @@ } }, { - "id": 977, + "id": 976, "name": "claimId", "variant": "param", "kind": 32768, @@ -19688,7 +19645,7 @@ } }, { - "id": 978, + "id": 977, "name": "payload", "variant": "param", "kind": 32768, @@ -19712,7 +19669,7 @@ } }, { - "id": 979, + "id": 978, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -19771,14 +19728,14 @@ ] }, { - "id": 880, + "id": 879, "name": "createFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 881, + "id": 880, "name": "createFulfillment", "variant": "signature", "kind": 4096, @@ -19803,7 +19760,7 @@ }, { "kind": "text", - "text": ", depending on\n whether all the items were fulfilled." + "text": ", depending on\nwhether all the items were fulfilled." } ], "blockTags": [ @@ -19829,7 +19786,7 @@ }, "parameters": [ { - "id": 882, + "id": 881, "name": "id", "variant": "param", "kind": 32768, @@ -19848,7 +19805,7 @@ } }, { - "id": 883, + "id": 882, "name": "payload", "variant": "param", "kind": 32768, @@ -19872,7 +19829,7 @@ } }, { - "id": 884, + "id": 883, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -19931,14 +19888,14 @@ ] }, { - "id": 902, + "id": 901, "name": "createShipment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 903, + "id": 902, "name": "createShipment", "variant": "signature", "kind": 4096, @@ -19989,7 +19946,7 @@ }, "parameters": [ { - "id": 904, + "id": 903, "name": "id", "variant": "param", "kind": 32768, @@ -20008,7 +19965,7 @@ } }, { - "id": 905, + "id": 904, "name": "payload", "variant": "param", "kind": 32768, @@ -20032,7 +19989,7 @@ } }, { - "id": 906, + "id": 905, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -20091,14 +20048,14 @@ ] }, { - "id": 925, + "id": 924, "name": "createSwap", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 926, + "id": 925, "name": "createSwap", "variant": "signature", "kind": 4096, @@ -20133,7 +20090,7 @@ "content": [ { "kind": "code", - "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.orders.createSwap(orderId, {\n return_items: [\n {\n item_id,\n quantity: 1\n }\n ]\n})\n.then(({ order }) => {\n console.log(order.id);\n})\n```" + "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.orders.createSwap(orderId, {\n return_items: [\n {\n item_id,\n quantity: 1\n }\n ]\n})\n.then(({ order }) => {\n console.log(order.swaps);\n})\n```" } ] } @@ -20141,7 +20098,7 @@ }, "parameters": [ { - "id": 927, + "id": 926, "name": "id", "variant": "param", "kind": 32768, @@ -20160,7 +20117,7 @@ } }, { - "id": 928, + "id": 927, "name": "payload", "variant": "param", "kind": 32768, @@ -20184,7 +20141,7 @@ } }, { - "id": 929, + "id": 928, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -20243,14 +20200,14 @@ ] }, { - "id": 941, + "id": 940, "name": "createSwapShipment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 942, + "id": 941, "name": "createSwapShipment", "variant": "signature", "kind": 4096, @@ -20309,7 +20266,7 @@ }, "parameters": [ { - "id": 943, + "id": 942, "name": "id", "variant": "param", "kind": 32768, @@ -20328,7 +20285,7 @@ } }, { - "id": 944, + "id": 943, "name": "swapId", "variant": "param", "kind": 32768, @@ -20347,7 +20304,7 @@ } }, { - "id": 945, + "id": 944, "name": "payload", "variant": "param", "kind": 32768, @@ -20371,7 +20328,7 @@ } }, { - "id": 946, + "id": 945, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -20430,14 +20387,14 @@ ] }, { - "id": 968, + "id": 967, "name": "fulfillClaim", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 969, + "id": 968, "name": "fulfillClaim", "variant": "signature", "kind": 4096, @@ -20504,7 +20461,7 @@ }, "parameters": [ { - "id": 970, + "id": 969, "name": "id", "variant": "param", "kind": 32768, @@ -20523,7 +20480,7 @@ } }, { - "id": 971, + "id": 970, "name": "claimId", "variant": "param", "kind": 32768, @@ -20542,7 +20499,7 @@ } }, { - "id": 972, + "id": 971, "name": "payload", "variant": "param", "kind": 32768, @@ -20566,7 +20523,7 @@ } }, { - "id": 973, + "id": 972, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -20625,14 +20582,14 @@ ] }, { - "id": 935, + "id": 934, "name": "fulfillSwap", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 936, + "id": 935, "name": "fulfillSwap", "variant": "signature", "kind": 4096, @@ -20691,7 +20648,7 @@ }, "parameters": [ { - "id": 937, + "id": 936, "name": "id", "variant": "param", "kind": 32768, @@ -20710,7 +20667,7 @@ } }, { - "id": 938, + "id": 937, "name": "swapId", "variant": "param", "kind": 32768, @@ -20729,7 +20686,7 @@ } }, { - "id": 939, + "id": 938, "name": "payload", "variant": "param", "kind": 32768, @@ -20753,7 +20710,7 @@ } }, { - "id": 940, + "id": 939, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -20812,14 +20769,14 @@ ] }, { - "id": 863, + "id": 862, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 864, + "id": 863, "name": "list", "variant": "signature", "kind": 4096, @@ -20922,7 +20879,7 @@ }, "parameters": [ { - "id": 865, + "id": 864, "name": "query", "variant": "param", "kind": 32768, @@ -20948,7 +20905,7 @@ } }, { - "id": 866, + "id": 865, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -21007,14 +20964,14 @@ ] }, { - "id": 947, + "id": 946, "name": "processSwapPayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 948, + "id": 947, "name": "processSwapPayment", "variant": "signature", "kind": 4096, @@ -21081,7 +21038,7 @@ }, "parameters": [ { - "id": 949, + "id": 948, "name": "id", "variant": "param", "kind": 32768, @@ -21100,7 +21057,7 @@ } }, { - "id": 950, + "id": 949, "name": "swapId", "variant": "param", "kind": 32768, @@ -21119,7 +21076,7 @@ } }, { - "id": 951, + "id": 950, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -21178,14 +21135,14 @@ ] }, { - "id": 875, + "id": 874, "name": "refundPayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 876, + "id": 875, "name": "refundPayment", "variant": "signature", "kind": 4096, @@ -21228,7 +21185,7 @@ }, "parameters": [ { - "id": 877, + "id": 876, "name": "id", "variant": "param", "kind": 32768, @@ -21247,7 +21204,7 @@ } }, { - "id": 878, + "id": 877, "name": "payload", "variant": "param", "kind": 32768, @@ -21271,7 +21228,7 @@ } }, { - "id": 879, + "id": 878, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -21330,14 +21287,14 @@ ] }, { - "id": 907, + "id": 906, "name": "requestReturn", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 908, + "id": 907, "name": "requestReturn", "variant": "signature", "kind": 4096, @@ -21380,7 +21337,7 @@ }, "parameters": [ { - "id": 909, + "id": 908, "name": "id", "variant": "param", "kind": 32768, @@ -21399,7 +21356,7 @@ } }, { - "id": 910, + "id": 909, "name": "payload", "variant": "param", "kind": 32768, @@ -21423,7 +21380,7 @@ } }, { - "id": 911, + "id": 910, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -21482,14 +21439,14 @@ ] }, { - "id": 858, + "id": 857, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 859, + "id": 858, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -21536,7 +21493,7 @@ }, "parameters": [ { - "id": 860, + "id": 859, "name": "id", "variant": "param", "kind": 32768, @@ -21555,7 +21512,7 @@ } }, { - "id": 861, + "id": 860, "name": "query", "variant": "param", "kind": 32768, @@ -21581,7 +21538,7 @@ } }, { - "id": 862, + "id": 861, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -21640,14 +21597,14 @@ ] }, { - "id": 853, + "id": 852, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 854, + "id": 853, "name": "update", "variant": "signature", "kind": 4096, @@ -21656,7 +21613,7 @@ "summary": [ { "kind": "text", - "text": "Update and order's details." + "text": "Update an order's details." } ], "blockTags": [ @@ -21682,7 +21639,7 @@ }, "parameters": [ { - "id": 855, + "id": 854, "name": "id", "variant": "param", "kind": 32768, @@ -21701,7 +21658,7 @@ } }, { - "id": 856, + "id": 855, "name": "payload", "variant": "param", "kind": 32768, @@ -21725,7 +21682,7 @@ } }, { - "id": 857, + "id": 856, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -21784,14 +21741,14 @@ ] }, { - "id": 962, + "id": 961, "name": "updateClaim", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 963, + "id": 962, "name": "updateClaim", "variant": "signature", "kind": 4096, @@ -21809,7 +21766,7 @@ "content": [ { "kind": "text", - "text": "Resolves to the order's details. You can access the swap under the " + "text": "Resolves to the order's details. You can access the claims under the " }, { "kind": "code", @@ -21834,7 +21791,7 @@ }, "parameters": [ { - "id": 964, + "id": 963, "name": "id", "variant": "param", "kind": 32768, @@ -21853,7 +21810,7 @@ } }, { - "id": 965, + "id": 964, "name": "claimId", "variant": "param", "kind": 32768, @@ -21872,7 +21829,7 @@ } }, { - "id": 966, + "id": 965, "name": "payload", "variant": "param", "kind": 32768, @@ -21896,7 +21853,7 @@ } }, { - "id": 967, + "id": 966, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -21959,37 +21916,37 @@ { "title": "Constructors", "children": [ - 850 + 849 ] }, { "title": "Methods", "children": [ - 916, - 921, - 912, - 957, - 896, - 885, - 930, - 890, - 871, - 867, - 952, - 974, - 880, - 902, - 925, - 941, - 968, - 935, - 863, - 947, - 875, - 907, - 858, - 853, - 962 + 915, + 920, + 911, + 956, + 895, + 884, + 929, + 889, + 870, + 866, + 951, + 973, + 879, + 901, + 924, + 940, + 967, + 934, + 862, + 946, + 874, + 906, + 857, + 852, + 961 ] } ], @@ -22006,7 +21963,7 @@ ] }, { - "id": 1640, + "id": 1638, "name": "AdminPaymentCollectionsResource", "variant": "declaration", "kind": 128, @@ -22039,21 +21996,21 @@ }, "children": [ { - "id": 1641, + "id": 1639, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1642, + "id": 1640, "name": "new AdminPaymentCollectionsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1643, + "id": 1641, "name": "client", "variant": "param", "kind": 32768, @@ -22071,7 +22028,7 @@ ], "type": { "type": "reference", - "target": 1640, + "target": 1638, "name": "AdminPaymentCollectionsResource", "package": "@medusajs/medusa-js" }, @@ -22089,14 +22046,14 @@ } }, { - "id": 1654, + "id": 1652, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1655, + "id": 1653, "name": "delete", "variant": "signature", "kind": 4096, @@ -22147,7 +22104,7 @@ }, "parameters": [ { - "id": 1656, + "id": 1654, "name": "id", "variant": "param", "kind": 32768, @@ -22166,7 +22123,7 @@ } }, { - "id": 1657, + "id": 1655, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -22225,14 +22182,14 @@ ] }, { - "id": 1658, + "id": 1656, "name": "markAsAuthorized", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1659, + "id": 1657, "name": "markAsAuthorized", "variant": "signature", "kind": 4096, @@ -22283,7 +22240,7 @@ }, "parameters": [ { - "id": 1660, + "id": 1658, "name": "id", "variant": "param", "kind": 32768, @@ -22302,7 +22259,7 @@ } }, { - "id": 1661, + "id": 1659, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -22361,14 +22318,14 @@ ] }, { - "id": 1644, + "id": 1642, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1645, + "id": 1643, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -22415,7 +22372,7 @@ }, "parameters": [ { - "id": 1646, + "id": 1644, "name": "id", "variant": "param", "kind": 32768, @@ -22434,7 +22391,7 @@ } }, { - "id": 1647, + "id": 1645, "name": "query", "variant": "param", "kind": 32768, @@ -22460,7 +22417,7 @@ } }, { - "id": 1648, + "id": 1646, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -22519,14 +22476,14 @@ ] }, { - "id": 1649, + "id": 1647, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1650, + "id": 1648, "name": "update", "variant": "signature", "kind": 4096, @@ -22561,7 +22518,7 @@ }, "parameters": [ { - "id": 1651, + "id": 1649, "name": "id", "variant": "param", "kind": 32768, @@ -22580,7 +22537,7 @@ } }, { - "id": 1652, + "id": 1650, "name": "payload", "variant": "param", "kind": 32768, @@ -22604,7 +22561,7 @@ } }, { - "id": 1653, + "id": 1651, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -22667,16 +22624,16 @@ { "title": "Constructors", "children": [ - 1641 + 1639 ] }, { "title": "Methods", "children": [ - 1654, - 1658, - 1644, - 1649 + 1652, + 1656, + 1642, + 1647 ] } ], @@ -22693,7 +22650,7 @@ ] }, { - "id": 1662, + "id": 1660, "name": "AdminPaymentsResource", "variant": "declaration", "kind": 128, @@ -22726,21 +22683,21 @@ }, "children": [ { - "id": 1663, + "id": 1661, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1664, + "id": 1662, "name": "new AdminPaymentsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1665, + "id": 1663, "name": "client", "variant": "param", "kind": 32768, @@ -22758,7 +22715,7 @@ ], "type": { "type": "reference", - "target": 1662, + "target": 1660, "name": "AdminPaymentsResource", "package": "@medusajs/medusa-js" }, @@ -22776,14 +22733,14 @@ } }, { - "id": 1671, + "id": 1669, "name": "capturePayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1672, + "id": 1670, "name": "capturePayment", "variant": "signature", "kind": 4096, @@ -22818,7 +22775,7 @@ }, "parameters": [ { - "id": 1673, + "id": 1671, "name": "id", "variant": "param", "kind": 32768, @@ -22837,7 +22794,7 @@ } }, { - "id": 1674, + "id": 1672, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -22896,14 +22853,14 @@ ] }, { - "id": 1675, + "id": 1673, "name": "refundPayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1676, + "id": 1674, "name": "refundPayment", "variant": "signature", "kind": 4096, @@ -22930,7 +22887,7 @@ "content": [ { "kind": "code", - "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.payments.refundPayment(paymentId, {\n amount: 1000,\n reason: \"return\",\n note: \"Do not like it\",\n})\n.then(({ payment }) => {\n console.log(payment.id);\n})\n```" + "text": "```ts\nimport { RefundReason } from \"@medusajs/medusa\";\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.payments.refundPayment(paymentId, {\n amount: 1000,\n reason: RefundReason.RETURN,\n note: \"Do not like it\",\n})\n.then(({ refund }) => {\n console.log(refund.amount);\n})\n```" } ] } @@ -22938,7 +22895,7 @@ }, "parameters": [ { - "id": 1677, + "id": 1675, "name": "id", "variant": "param", "kind": 32768, @@ -22957,7 +22914,7 @@ } }, { - "id": 1678, + "id": 1676, "name": "payload", "variant": "param", "kind": 32768, @@ -22981,7 +22938,7 @@ } }, { - "id": 1679, + "id": 1677, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -23040,14 +22997,14 @@ ] }, { - "id": 1666, + "id": 1664, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1667, + "id": 1665, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -23082,7 +23039,7 @@ }, "parameters": [ { - "id": 1668, + "id": 1666, "name": "id", "variant": "param", "kind": 32768, @@ -23101,7 +23058,7 @@ } }, { - "id": 1669, + "id": 1667, "name": "query", "variant": "param", "kind": 32768, @@ -23127,7 +23084,7 @@ } }, { - "id": 1670, + "id": 1668, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -23190,15 +23147,15 @@ { "title": "Constructors", "children": [ - 1663 + 1661 ] }, { "title": "Methods", "children": [ - 1671, - 1675, - 1666 + 1669, + 1673, + 1664 ] } ], @@ -23215,7 +23172,7 @@ ] }, { - "id": 1039, + "id": 1038, "name": "AdminPriceListResource", "variant": "declaration", "kind": 128, @@ -23248,21 +23205,21 @@ }, "children": [ { - "id": 1040, + "id": 1039, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1041, + "id": 1040, "name": "new AdminPriceListResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1042, + "id": 1041, "name": "client", "variant": "param", "kind": 32768, @@ -23280,7 +23237,7 @@ ], "type": { "type": "reference", - "target": 1039, + "target": 1038, "name": "AdminPriceListResource", "package": "@medusajs/medusa-js" }, @@ -23298,14 +23255,14 @@ } }, { - "id": 1069, + "id": 1068, "name": "addPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1070, + "id": 1069, "name": "addPrices", "variant": "signature", "kind": 4096, @@ -23340,7 +23297,7 @@ }, "parameters": [ { - "id": 1071, + "id": 1070, "name": "id", "variant": "param", "kind": 32768, @@ -23359,7 +23316,7 @@ } }, { - "id": 1072, + "id": 1071, "name": "payload", "variant": "param", "kind": 32768, @@ -23383,7 +23340,7 @@ } }, { - "id": 1073, + "id": 1072, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -23442,14 +23399,14 @@ ] }, { - "id": 1043, + "id": 1042, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1044, + "id": 1043, "name": "create", "variant": "signature", "kind": 4096, @@ -23484,7 +23441,7 @@ }, "parameters": [ { - "id": 1045, + "id": 1044, "name": "payload", "variant": "param", "kind": 32768, @@ -23508,7 +23465,7 @@ } }, { - "id": 1046, + "id": 1045, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -23567,14 +23524,14 @@ ] }, { - "id": 1052, + "id": 1051, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1053, + "id": 1052, "name": "delete", "variant": "signature", "kind": 4096, @@ -23609,7 +23566,7 @@ }, "parameters": [ { - "id": 1054, + "id": 1053, "name": "id", "variant": "param", "kind": 32768, @@ -23628,7 +23585,7 @@ } }, { - "id": 1055, + "id": 1054, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -23687,14 +23644,14 @@ ] }, { - "id": 1074, + "id": 1073, "name": "deletePrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1075, + "id": 1074, "name": "deletePrices", "variant": "signature", "kind": 4096, @@ -23729,7 +23686,7 @@ }, "parameters": [ { - "id": 1076, + "id": 1075, "name": "id", "variant": "param", "kind": 32768, @@ -23748,7 +23705,7 @@ } }, { - "id": 1077, + "id": 1076, "name": "payload", "variant": "param", "kind": 32768, @@ -23772,7 +23729,7 @@ } }, { - "id": 1078, + "id": 1077, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -23831,14 +23788,14 @@ ] }, { - "id": 1079, + "id": 1078, "name": "deleteProductPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1080, + "id": 1079, "name": "deleteProductPrices", "variant": "signature", "kind": 4096, @@ -23873,7 +23830,7 @@ }, "parameters": [ { - "id": 1081, + "id": 1080, "name": "priceListId", "variant": "param", "kind": 32768, @@ -23892,7 +23849,7 @@ } }, { - "id": 1082, + "id": 1081, "name": "productId", "variant": "param", "kind": 32768, @@ -23911,7 +23868,7 @@ } }, { - "id": 1083, + "id": 1082, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -23970,14 +23927,14 @@ ] }, { - "id": 1089, + "id": 1088, "name": "deleteProductsPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1090, + "id": 1089, "name": "deleteProductsPrices", "variant": "signature", "kind": 4096, @@ -24012,7 +23969,7 @@ }, "parameters": [ { - "id": 1091, + "id": 1090, "name": "priceListId", "variant": "param", "kind": 32768, @@ -24031,7 +23988,7 @@ } }, { - "id": 1092, + "id": 1091, "name": "payload", "variant": "param", "kind": 32768, @@ -24055,7 +24012,7 @@ } }, { - "id": 1093, + "id": 1092, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -24114,14 +24071,14 @@ ] }, { - "id": 1084, + "id": 1083, "name": "deleteVariantPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1085, + "id": 1084, "name": "deleteVariantPrices", "variant": "signature", "kind": 4096, @@ -24156,7 +24113,7 @@ }, "parameters": [ { - "id": 1086, + "id": 1085, "name": "priceListId", "variant": "param", "kind": 32768, @@ -24175,7 +24132,7 @@ } }, { - "id": 1087, + "id": 1086, "name": "variantId", "variant": "param", "kind": 32768, @@ -24194,7 +24151,7 @@ } }, { - "id": 1088, + "id": 1087, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -24253,14 +24210,14 @@ ] }, { - "id": 1060, + "id": 1059, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1061, + "id": 1060, "name": "list", "variant": "signature", "kind": 4096, @@ -24363,7 +24320,7 @@ }, "parameters": [ { - "id": 1062, + "id": 1061, "name": "query", "variant": "param", "kind": 32768, @@ -24389,7 +24346,7 @@ } }, { - "id": 1063, + "id": 1062, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -24448,14 +24405,14 @@ ] }, { - "id": 1064, + "id": 1063, "name": "listProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1065, + "id": 1064, "name": "listProducts", "variant": "signature", "kind": 4096, @@ -24558,7 +24515,7 @@ }, "parameters": [ { - "id": 1066, + "id": 1065, "name": "id", "variant": "param", "kind": 32768, @@ -24577,7 +24534,7 @@ } }, { - "id": 1067, + "id": 1066, "name": "query", "variant": "param", "kind": 32768, @@ -24603,7 +24560,7 @@ } }, { - "id": 1068, + "id": 1067, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -24662,14 +24619,14 @@ ] }, { - "id": 1056, + "id": 1055, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1057, + "id": 1056, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -24704,7 +24661,7 @@ }, "parameters": [ { - "id": 1058, + "id": 1057, "name": "id", "variant": "param", "kind": 32768, @@ -24723,7 +24680,7 @@ } }, { - "id": 1059, + "id": 1058, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -24782,14 +24739,14 @@ ] }, { - "id": 1047, + "id": 1046, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1048, + "id": 1047, "name": "update", "variant": "signature", "kind": 4096, @@ -24824,7 +24781,7 @@ }, "parameters": [ { - "id": 1049, + "id": 1048, "name": "id", "variant": "param", "kind": 32768, @@ -24843,7 +24800,7 @@ } }, { - "id": 1050, + "id": 1049, "name": "payload", "variant": "param", "kind": 32768, @@ -24867,7 +24824,7 @@ } }, { - "id": 1051, + "id": 1050, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -24930,23 +24887,23 @@ { "title": "Constructors", "children": [ - 1040 + 1039 ] }, { "title": "Methods", "children": [ - 1069, - 1043, - 1052, - 1074, - 1079, - 1089, - 1084, - 1060, - 1064, - 1056, - 1047 + 1068, + 1042, + 1051, + 1073, + 1078, + 1088, + 1083, + 1059, + 1063, + 1055, + 1046 ] } ], @@ -24963,7 +24920,7 @@ ] }, { - "id": 1680, + "id": 1678, "name": "AdminProductCategoriesResource", "variant": "declaration", "kind": 128, @@ -25007,21 +24964,21 @@ }, "children": [ { - "id": 1681, + "id": 1679, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1682, + "id": 1680, "name": "new AdminProductCategoriesResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1683, + "id": 1681, "name": "client", "variant": "param", "kind": 32768, @@ -25039,7 +24996,7 @@ ], "type": { "type": "reference", - "target": 1680, + "target": 1678, "name": "AdminProductCategoriesResource", "package": "@medusajs/medusa-js" }, @@ -25057,14 +25014,14 @@ } }, { - "id": 1711, + "id": 1709, "name": "addProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1712, + "id": 1710, "name": "addProducts", "variant": "signature", "kind": 4096, @@ -25099,7 +25056,7 @@ }, "parameters": [ { - "id": 1713, + "id": 1711, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -25118,7 +25075,7 @@ } }, { - "id": 1714, + "id": 1712, "name": "payload", "variant": "param", "kind": 32768, @@ -25142,7 +25099,7 @@ } }, { - "id": 1715, + "id": 1713, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -25201,14 +25158,14 @@ ] }, { - "id": 1689, + "id": 1687, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1690, + "id": 1688, "name": "create", "variant": "signature", "kind": 4096, @@ -25243,7 +25200,7 @@ }, "parameters": [ { - "id": 1691, + "id": 1689, "name": "payload", "variant": "param", "kind": 32768, @@ -25267,7 +25224,7 @@ } }, { - "id": 1692, + "id": 1690, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -25326,14 +25283,14 @@ ] }, { - "id": 1702, + "id": 1700, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1703, + "id": 1701, "name": "delete", "variant": "signature", "kind": 4096, @@ -25368,7 +25325,7 @@ }, "parameters": [ { - "id": 1704, + "id": 1702, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -25387,7 +25344,7 @@ } }, { - "id": 1705, + "id": 1703, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -25446,14 +25403,14 @@ ] }, { - "id": 1698, + "id": 1696, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1699, + "id": 1697, "name": "list", "variant": "signature", "kind": 4096, @@ -25556,7 +25513,7 @@ }, "parameters": [ { - "id": 1700, + "id": 1698, "name": "query", "variant": "param", "kind": 32768, @@ -25582,7 +25539,7 @@ } }, { - "id": 1701, + "id": 1699, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -25641,14 +25598,14 @@ ] }, { - "id": 1706, + "id": 1704, "name": "removeProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1707, + "id": 1705, "name": "removeProducts", "variant": "signature", "kind": 4096, @@ -25683,7 +25640,7 @@ }, "parameters": [ { - "id": 1708, + "id": 1706, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -25702,7 +25659,7 @@ } }, { - "id": 1709, + "id": 1707, "name": "payload", "variant": "param", "kind": 32768, @@ -25726,7 +25683,7 @@ } }, { - "id": 1710, + "id": 1708, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -25785,14 +25742,14 @@ ] }, { - "id": 1684, + "id": 1682, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1685, + "id": 1683, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -25839,7 +25796,7 @@ }, "parameters": [ { - "id": 1686, + "id": 1684, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -25858,7 +25815,7 @@ } }, { - "id": 1687, + "id": 1685, "name": "query", "variant": "param", "kind": 32768, @@ -25884,7 +25841,7 @@ } }, { - "id": 1688, + "id": 1686, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -25943,14 +25900,14 @@ ] }, { - "id": 1693, + "id": 1691, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1694, + "id": 1692, "name": "update", "variant": "signature", "kind": 4096, @@ -25985,7 +25942,7 @@ }, "parameters": [ { - "id": 1695, + "id": 1693, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -26004,7 +25961,7 @@ } }, { - "id": 1696, + "id": 1694, "name": "payload", "variant": "param", "kind": 32768, @@ -26028,7 +25985,7 @@ } }, { - "id": 1697, + "id": 1695, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -26091,19 +26048,19 @@ { "title": "Constructors", "children": [ - 1681 + 1679 ] }, { "title": "Methods", "children": [ - 1711, - 1689, - 1702, - 1698, - 1706, - 1684, - 1693 + 1709, + 1687, + 1700, + 1696, + 1704, + 1682, + 1691 ] } ], @@ -26120,7 +26077,7 @@ ] }, { - "id": 1094, + "id": 1093, "name": "AdminProductTagsResource", "variant": "declaration", "kind": 128, @@ -26153,21 +26110,21 @@ }, "children": [ { - "id": 1095, + "id": 1094, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1096, + "id": 1095, "name": "new AdminProductTagsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1097, + "id": 1096, "name": "client", "variant": "param", "kind": 32768, @@ -26185,7 +26142,7 @@ ], "type": { "type": "reference", - "target": 1094, + "target": 1093, "name": "AdminProductTagsResource", "package": "@medusajs/medusa-js" }, @@ -26203,14 +26160,14 @@ } }, { - "id": 1098, + "id": 1097, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1099, + "id": 1098, "name": "list", "variant": "signature", "kind": 4096, @@ -26305,7 +26262,7 @@ }, "parameters": [ { - "id": 1100, + "id": 1099, "name": "query", "variant": "param", "kind": 32768, @@ -26359,13 +26316,13 @@ { "title": "Constructors", "children": [ - 1095 + 1094 ] }, { "title": "Methods", "children": [ - 1098 + 1097 ] } ], @@ -26382,7 +26339,7 @@ ] }, { - "id": 1101, + "id": 1100, "name": "AdminProductTypesResource", "variant": "declaration", "kind": 128, @@ -26415,21 +26372,21 @@ }, "children": [ { - "id": 1102, + "id": 1101, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1103, + "id": 1102, "name": "new AdminProductTypesResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1104, + "id": 1103, "name": "client", "variant": "param", "kind": 32768, @@ -26447,7 +26404,7 @@ ], "type": { "type": "reference", - "target": 1101, + "target": 1100, "name": "AdminProductTypesResource", "package": "@medusajs/medusa-js" }, @@ -26465,14 +26422,14 @@ } }, { - "id": 1105, + "id": 1104, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1106, + "id": 1105, "name": "list", "variant": "signature", "kind": 4096, @@ -26567,7 +26524,7 @@ }, "parameters": [ { - "id": 1107, + "id": 1106, "name": "query", "variant": "param", "kind": 32768, @@ -26593,7 +26550,7 @@ } }, { - "id": 1108, + "id": 1107, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -26656,13 +26613,13 @@ { "title": "Constructors", "children": [ - 1102 + 1101 ] }, { "title": "Methods", "children": [ - 1105 + 1104 ] } ], @@ -26679,7 +26636,7 @@ ] }, { - "id": 1109, + "id": 1108, "name": "AdminProductsResource", "variant": "declaration", "kind": 128, @@ -26712,21 +26669,21 @@ }, "children": [ { - "id": 1110, + "id": 1109, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1111, + "id": 1110, "name": "new AdminProductsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1112, + "id": 1111, "name": "client", "variant": "param", "kind": 32768, @@ -26744,7 +26701,7 @@ ], "type": { "type": "reference", - "target": 1109, + "target": 1108, "name": "AdminProductsResource", "package": "@medusajs/medusa-js" }, @@ -26762,14 +26719,14 @@ } }, { - "id": 1161, + "id": 1160, "name": "addOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1162, + "id": 1161, "name": "addOption", "variant": "signature", "kind": 4096, @@ -26812,7 +26769,7 @@ }, "parameters": [ { - "id": 1163, + "id": 1162, "name": "id", "variant": "param", "kind": 32768, @@ -26831,7 +26788,7 @@ } }, { - "id": 1164, + "id": 1163, "name": "payload", "variant": "param", "kind": 32768, @@ -26855,7 +26812,7 @@ } }, { - "id": 1165, + "id": 1164, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -26914,14 +26871,14 @@ ] }, { - "id": 1113, + "id": 1112, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1114, + "id": 1113, "name": "create", "variant": "signature", "kind": 4096, @@ -26972,7 +26929,7 @@ }, "parameters": [ { - "id": 1115, + "id": 1114, "name": "payload", "variant": "param", "kind": 32768, @@ -26996,7 +26953,7 @@ } }, { - "id": 1116, + "id": 1115, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -27055,14 +27012,14 @@ ] }, { - "id": 1145, + "id": 1144, "name": "createVariant", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1146, + "id": 1145, "name": "createVariant", "variant": "signature", "kind": 4096, @@ -27105,7 +27062,7 @@ }, "parameters": [ { - "id": 1147, + "id": 1146, "name": "id", "variant": "param", "kind": 32768, @@ -27124,7 +27081,7 @@ } }, { - "id": 1148, + "id": 1147, "name": "payload", "variant": "param", "kind": 32768, @@ -27148,7 +27105,7 @@ } }, { - "id": 1149, + "id": 1148, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -27207,14 +27164,14 @@ ] }, { - "id": 1126, + "id": 1125, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1127, + "id": 1126, "name": "delete", "variant": "signature", "kind": 4096, @@ -27249,7 +27206,7 @@ }, "parameters": [ { - "id": 1128, + "id": 1127, "name": "id", "variant": "param", "kind": 32768, @@ -27268,7 +27225,7 @@ } }, { - "id": 1129, + "id": 1128, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -27327,14 +27284,14 @@ ] }, { - "id": 1172, + "id": 1171, "name": "deleteOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1173, + "id": 1172, "name": "deleteOption", "variant": "signature", "kind": 4096, @@ -27360,7 +27317,7 @@ }, "parameters": [ { - "id": 1174, + "id": 1173, "name": "id", "variant": "param", "kind": 32768, @@ -27379,7 +27336,7 @@ } }, { - "id": 1175, + "id": 1174, "name": "optionId", "variant": "param", "kind": 32768, @@ -27398,7 +27355,7 @@ } }, { - "id": 1176, + "id": 1175, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -27457,14 +27414,14 @@ ] }, { - "id": 1156, + "id": 1155, "name": "deleteVariant", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1157, + "id": 1156, "name": "deleteVariant", "variant": "signature", "kind": 4096, @@ -27499,7 +27456,7 @@ }, "parameters": [ { - "id": 1158, + "id": 1157, "name": "id", "variant": "param", "kind": 32768, @@ -27518,7 +27475,7 @@ } }, { - "id": 1159, + "id": 1158, "name": "variantId", "variant": "param", "kind": 32768, @@ -27537,7 +27494,7 @@ } }, { - "id": 1160, + "id": 1159, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -27596,14 +27553,14 @@ ] }, { - "id": 1130, + "id": 1129, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1131, + "id": 1130, "name": "list", "variant": "signature", "kind": 4096, @@ -27706,7 +27663,7 @@ }, "parameters": [ { - "id": 1132, + "id": 1131, "name": "query", "variant": "param", "kind": 32768, @@ -27732,7 +27689,7 @@ } }, { - "id": 1133, + "id": 1132, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -27791,14 +27748,14 @@ ] }, { - "id": 1137, + "id": 1136, "name": "listTags", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1138, + "id": 1137, "name": "listTags", "variant": "signature", "kind": 4096, @@ -27833,7 +27790,7 @@ }, "parameters": [ { - "id": 1139, + "id": 1138, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -27892,14 +27849,14 @@ ] }, { - "id": 1117, + "id": 1116, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1118, + "id": 1117, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -27934,7 +27891,7 @@ }, "parameters": [ { - "id": 1119, + "id": 1118, "name": "id", "variant": "param", "kind": 32768, @@ -27953,7 +27910,7 @@ } }, { - "id": 1120, + "id": 1119, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -28012,14 +27969,14 @@ ] }, { - "id": 1140, + "id": 1139, "name": "setMetadata", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1141, + "id": 1140, "name": "setMetadata", "variant": "signature", "kind": 4096, @@ -28054,7 +28011,7 @@ }, "parameters": [ { - "id": 1142, + "id": 1141, "name": "id", "variant": "param", "kind": 32768, @@ -28073,7 +28030,7 @@ } }, { - "id": 1143, + "id": 1142, "name": "payload", "variant": "param", "kind": 32768, @@ -28097,7 +28054,7 @@ } }, { - "id": 1144, + "id": 1143, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -28156,14 +28113,14 @@ ] }, { - "id": 1121, + "id": 1120, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1122, + "id": 1121, "name": "update", "variant": "signature", "kind": 4096, @@ -28198,7 +28155,7 @@ }, "parameters": [ { - "id": 1123, + "id": 1122, "name": "id", "variant": "param", "kind": 32768, @@ -28217,7 +28174,7 @@ } }, { - "id": 1124, + "id": 1123, "name": "payload", "variant": "param", "kind": 32768, @@ -28241,7 +28198,7 @@ } }, { - "id": 1125, + "id": 1124, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -28300,14 +28257,14 @@ ] }, { - "id": 1166, + "id": 1165, "name": "updateOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1167, + "id": 1166, "name": "updateOption", "variant": "signature", "kind": 4096, @@ -28350,7 +28307,7 @@ }, "parameters": [ { - "id": 1168, + "id": 1167, "name": "id", "variant": "param", "kind": 32768, @@ -28369,7 +28326,7 @@ } }, { - "id": 1169, + "id": 1168, "name": "optionId", "variant": "param", "kind": 32768, @@ -28388,7 +28345,7 @@ } }, { - "id": 1170, + "id": 1169, "name": "payload", "variant": "param", "kind": 32768, @@ -28412,7 +28369,7 @@ } }, { - "id": 1171, + "id": 1170, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -28471,14 +28428,14 @@ ] }, { - "id": 1150, + "id": 1149, "name": "updateVariant", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1151, + "id": 1150, "name": "updateVariant", "variant": "signature", "kind": 4096, @@ -28521,7 +28478,7 @@ }, "parameters": [ { - "id": 1152, + "id": 1151, "name": "id", "variant": "param", "kind": 32768, @@ -28540,7 +28497,7 @@ } }, { - "id": 1153, + "id": 1152, "name": "variantId", "variant": "param", "kind": 32768, @@ -28559,7 +28516,7 @@ } }, { - "id": 1154, + "id": 1153, "name": "payload", "variant": "param", "kind": 32768, @@ -28583,7 +28540,7 @@ } }, { - "id": 1155, + "id": 1154, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -28646,25 +28603,25 @@ { "title": "Constructors", "children": [ - 1110 + 1109 ] }, { "title": "Methods", "children": [ - 1161, - 1113, - 1145, - 1126, - 1172, - 1156, - 1130, - 1137, - 1117, - 1140, - 1121, - 1166, - 1150 + 1160, + 1112, + 1144, + 1125, + 1171, + 1155, + 1129, + 1136, + 1116, + 1139, + 1120, + 1165, + 1149 ] } ], @@ -28681,7 +28638,7 @@ ] }, { - "id": 1177, + "id": 1176, "name": "AdminPublishableApiKeyResource", "variant": "declaration", "kind": 128, @@ -28714,21 +28671,21 @@ }, "children": [ { - "id": 1178, + "id": 1177, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1179, + "id": 1178, "name": "new AdminPublishableApiKeyResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1180, + "id": 1179, "name": "client", "variant": "param", "kind": 32768, @@ -28746,7 +28703,7 @@ ], "type": { "type": "reference", - "target": 1177, + "target": 1176, "name": "AdminPublishableApiKeyResource", "package": "@medusajs/medusa-js" }, @@ -28764,14 +28721,14 @@ } }, { - "id": 1207, + "id": 1205, "name": "addSalesChannelsBatch", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1208, + "id": 1206, "name": "addSalesChannelsBatch", "variant": "signature", "kind": 4096, @@ -28806,7 +28763,7 @@ }, "parameters": [ { - "id": 1209, + "id": 1207, "name": "id", "variant": "param", "kind": 32768, @@ -28825,7 +28782,7 @@ } }, { - "id": 1210, + "id": 1208, "name": "payload", "variant": "param", "kind": 32768, @@ -28849,7 +28806,7 @@ } }, { - "id": 1211, + "id": 1209, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -28908,14 +28865,14 @@ ] }, { - "id": 1190, + "id": 1188, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1191, + "id": 1189, "name": "create", "variant": "signature", "kind": 4096, @@ -28950,7 +28907,7 @@ }, "parameters": [ { - "id": 1192, + "id": 1190, "name": "payload", "variant": "param", "kind": 32768, @@ -28974,7 +28931,7 @@ } }, { - "id": 1193, + "id": 1191, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -29033,14 +28990,14 @@ ] }, { - "id": 1199, + "id": 1197, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1200, + "id": 1198, "name": "delete", "variant": "signature", "kind": 4096, @@ -29075,7 +29032,7 @@ }, "parameters": [ { - "id": 1201, + "id": 1199, "name": "id", "variant": "param", "kind": 32768, @@ -29094,7 +29051,7 @@ } }, { - "id": 1202, + "id": 1200, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -29153,14 +29110,14 @@ ] }, { - "id": 1212, + "id": 1210, "name": "deleteSalesChannelsBatch", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1213, + "id": 1211, "name": "deleteSalesChannelsBatch", "variant": "signature", "kind": 4096, @@ -29195,7 +29152,7 @@ }, "parameters": [ { - "id": 1214, + "id": 1212, "name": "id", "variant": "param", "kind": 32768, @@ -29214,7 +29171,7 @@ } }, { - "id": 1215, + "id": 1213, "name": "payload", "variant": "param", "kind": 32768, @@ -29238,7 +29195,7 @@ } }, { - "id": 1216, + "id": 1214, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -29297,14 +29254,14 @@ ] }, { - "id": 1186, + "id": 1184, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1187, + "id": 1185, "name": "list", "variant": "signature", "kind": 4096, @@ -29391,7 +29348,7 @@ }, "parameters": [ { - "id": 1188, + "id": 1186, "name": "query", "variant": "param", "kind": 32768, @@ -29417,7 +29374,7 @@ } }, { - "id": 1189, + "id": 1187, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -29476,14 +29433,14 @@ ] }, { - "id": 1217, + "id": 1215, "name": "listSalesChannels", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1218, + "id": 1216, "name": "listSalesChannels", "variant": "signature", "kind": 4096, @@ -29534,7 +29491,7 @@ }, "parameters": [ { - "id": 1219, + "id": 1217, "name": "id", "variant": "param", "kind": 32768, @@ -29553,7 +29510,7 @@ } }, { - "id": 1220, + "id": 1218, "name": "query", "variant": "param", "kind": 32768, @@ -29579,7 +29536,7 @@ } }, { - "id": 1221, + "id": 1219, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -29638,14 +29595,14 @@ ] }, { - "id": 1181, + "id": 1180, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1182, + "id": 1181, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -29679,8 +29636,128 @@ ] }, "parameters": [ + { + "id": 1182, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the publishable API key." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, { "id": 1183, + "name": "customHeaders", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Custom headers to attach to the request." + } + ] + }, + "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": "{}" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/src/typings.ts", + "qualifiedName": "ResponsePromise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "ResponsePromise", + "package": "@medusajs/medusa-js" + } + } + ] + }, + { + "id": 1201, + "name": "revoke", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1202, + "name": "revoke", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Revoke a publishable API key. Revoking the publishable API Key can't be undone, and the key can't be used in future requests." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Resolves to the publishbale API key's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.publishableApiKeys.revoke(publishableApiKeyId)\n.then(({ publishable_api_key }) => {\n console.log(publishable_api_key.id)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1203, "name": "id", "variant": "param", "kind": 32768, @@ -29699,11 +29776,19 @@ } }, { - "id": 1184, - "name": "query", + "id": 1204, + "name": "customHeaders", "variant": "param", "kind": 32768, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Custom headers to attach to the request." + } + ] + }, "type": { "type": "reference", "target": { @@ -29724,273 +29809,118 @@ "package": "typescript" }, "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/src/typings.ts", + "qualifiedName": "ResponsePromise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "ResponsePromise", + "package": "@medusajs/medusa-js" + } + } + ] + }, + { + "id": 1192, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1193, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update a publishable API key's details." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Resolves to the publishbale API key's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.publishableApiKeys.update(publishableApiKeyId, {\n title: \"new title\"\n})\n.then(({ publishable_api_key }) => {\n console.log(publishable_api_key.id)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1194, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the publishable API key." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1195, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attributes to update in the publishable API key." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/update-publishable-api-key.d.ts", + "qualifiedName": "AdminPostPublishableApiKeysPublishableApiKeyReq" + }, + "name": "AdminPostPublishableApiKeysPublishableApiKeyReq", + "package": "@medusajs/medusa" + } }, { - "id": 1185, - "name": "customHeaders", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers to attach to the request." - } - ] - }, - "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": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa-js/src/typings.ts", - "qualifiedName": "ResponsePromise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", - "qualifiedName": "AdminPublishableApiKeysRes" - }, - "name": "AdminPublishableApiKeysRes", - "package": "@medusajs/medusa" - } - ], - "name": "ResponsePromise", - "package": "@medusajs/medusa-js" - } - } - ] - }, - { - "id": 1203, - "name": "revoke", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1204, - "name": "revoke", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revoke a publishable API key. Revoking the publishable API Key can't be undone, and the key can't be used in future requests." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Resolves to the publishbale API key's details." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.publishableApiKeys.revoke(publishableApiKeyId)\n.then(({ publishable_api_key }) => {\n console.log(publishable_api_key.id)\n})\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 1205, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the publishable API key." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1206, - "name": "customHeaders", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers to attach to the request." - } - ] - }, - "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": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa-js/src/typings.ts", - "qualifiedName": "ResponsePromise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", - "qualifiedName": "AdminPublishableApiKeysRes" - }, - "name": "AdminPublishableApiKeysRes", - "package": "@medusajs/medusa" - } - ], - "name": "ResponsePromise", - "package": "@medusajs/medusa-js" - } - } - ] - }, - { - "id": 1194, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1195, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update a publishable API key's details." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Resolves to the publishbale API key's details." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.publishableApiKeys.update(publishableApiKeyId, {\n title: \"new title\"\n})\n.then(({ publishable_api_key }) => {\n console.log(publishable_api_key.id)\n})\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 1196, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the publishable API key." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1197, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attributes to update in the publishable API key." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/update-publishable-api-key.d.ts", - "qualifiedName": "AdminPostPublishableApiKeysPublishableApiKeyReq" - }, - "name": "AdminPostPublishableApiKeysPublishableApiKeyReq", - "package": "@medusajs/medusa" - } - }, - { - "id": 1198, + "id": 1196, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -30053,21 +29983,21 @@ { "title": "Constructors", "children": [ - 1178 + 1177 ] }, { "title": "Methods", "children": [ - 1207, - 1190, - 1199, - 1212, - 1186, - 1217, - 1181, - 1203, - 1194 + 1205, + 1188, + 1197, + 1210, + 1184, + 1215, + 1180, + 1201, + 1192 ] } ], @@ -30084,7 +30014,7 @@ ] }, { - "id": 1222, + "id": 1220, "name": "AdminRegionsResource", "variant": "declaration", "kind": 128, @@ -30117,21 +30047,21 @@ }, "children": [ { - "id": 1223, + "id": 1221, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1224, + "id": 1222, "name": "new AdminRegionsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1225, + "id": 1223, "name": "client", "variant": "param", "kind": 32768, @@ -30149,7 +30079,7 @@ ], "type": { "type": "reference", - "target": 1222, + "target": 1220, "name": "AdminRegionsResource", "package": "@medusajs/medusa-js" }, @@ -30167,14 +30097,14 @@ } }, { - "id": 1247, + "id": 1245, "name": "addCountry", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1248, + "id": 1246, "name": "addCountry", "variant": "signature", "kind": 4096, @@ -30209,7 +30139,7 @@ }, "parameters": [ { - "id": 1249, + "id": 1247, "name": "id", "variant": "param", "kind": 32768, @@ -30228,7 +30158,7 @@ } }, { - "id": 1250, + "id": 1248, "name": "payload", "variant": "param", "kind": 32768, @@ -30252,7 +30182,7 @@ } }, { - "id": 1251, + "id": 1249, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -30311,14 +30241,14 @@ ] }, { - "id": 1257, + "id": 1255, "name": "addFulfillmentProvider", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1258, + "id": 1256, "name": "addFulfillmentProvider", "variant": "signature", "kind": 4096, @@ -30353,7 +30283,7 @@ }, "parameters": [ { - "id": 1259, + "id": 1257, "name": "id", "variant": "param", "kind": 32768, @@ -30372,7 +30302,7 @@ } }, { - "id": 1260, + "id": 1258, "name": "payload", "variant": "param", "kind": 32768, @@ -30396,7 +30326,7 @@ } }, { - "id": 1261, + "id": 1259, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -30455,14 +30385,14 @@ ] }, { - "id": 1271, + "id": 1269, "name": "addPaymentProvider", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1272, + "id": 1270, "name": "addPaymentProvider", "variant": "signature", "kind": 4096, @@ -30497,7 +30427,7 @@ }, "parameters": [ { - "id": 1273, + "id": 1271, "name": "id", "variant": "param", "kind": 32768, @@ -30516,7 +30446,7 @@ } }, { - "id": 1274, + "id": 1272, "name": "payload", "variant": "param", "kind": 32768, @@ -30540,7 +30470,7 @@ } }, { - "id": 1275, + "id": 1273, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -30599,14 +30529,14 @@ ] }, { - "id": 1226, + "id": 1224, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1227, + "id": 1225, "name": "create", "variant": "signature", "kind": 4096, @@ -30641,7 +30571,7 @@ }, "parameters": [ { - "id": 1228, + "id": 1226, "name": "payload", "variant": "param", "kind": 32768, @@ -30665,7 +30595,7 @@ } }, { - "id": 1229, + "id": 1227, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -30724,14 +30654,14 @@ ] }, { - "id": 1235, + "id": 1233, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1236, + "id": 1234, "name": "delete", "variant": "signature", "kind": 4096, @@ -30766,7 +30696,7 @@ }, "parameters": [ { - "id": 1237, + "id": 1235, "name": "id", "variant": "param", "kind": 32768, @@ -30785,7 +30715,7 @@ } }, { - "id": 1238, + "id": 1236, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -30844,14 +30774,14 @@ ] }, { - "id": 1252, + "id": 1250, "name": "deleteCountry", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1253, + "id": 1251, "name": "deleteCountry", "variant": "signature", "kind": 4096, @@ -30886,7 +30816,7 @@ }, "parameters": [ { - "id": 1254, + "id": 1252, "name": "id", "variant": "param", "kind": 32768, @@ -30905,7 +30835,7 @@ } }, { - "id": 1255, + "id": 1253, "name": "country_code", "variant": "param", "kind": 32768, @@ -30924,7 +30854,7 @@ } }, { - "id": 1256, + "id": 1254, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -30983,14 +30913,14 @@ ] }, { - "id": 1262, + "id": 1260, "name": "deleteFulfillmentProvider", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1263, + "id": 1261, "name": "deleteFulfillmentProvider", "variant": "signature", "kind": 4096, @@ -31025,7 +30955,7 @@ }, "parameters": [ { - "id": 1264, + "id": 1262, "name": "id", "variant": "param", "kind": 32768, @@ -31044,7 +30974,7 @@ } }, { - "id": 1265, + "id": 1263, "name": "provider_id", "variant": "param", "kind": 32768, @@ -31063,7 +30993,7 @@ } }, { - "id": 1266, + "id": 1264, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -31122,14 +31052,14 @@ ] }, { - "id": 1276, + "id": 1274, "name": "deletePaymentProvider", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1277, + "id": 1275, "name": "deletePaymentProvider", "variant": "signature", "kind": 4096, @@ -31164,7 +31094,7 @@ }, "parameters": [ { - "id": 1278, + "id": 1276, "name": "id", "variant": "param", "kind": 32768, @@ -31183,7 +31113,7 @@ } }, { - "id": 1279, + "id": 1277, "name": "provider_id", "variant": "param", "kind": 32768, @@ -31202,7 +31132,7 @@ } }, { - "id": 1280, + "id": 1278, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -31261,14 +31191,14 @@ ] }, { - "id": 1243, + "id": 1241, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1244, + "id": 1242, "name": "list", "variant": "signature", "kind": 4096, @@ -31355,7 +31285,7 @@ }, "parameters": [ { - "id": 1245, + "id": 1243, "name": "query", "variant": "param", "kind": 32768, @@ -31381,7 +31311,7 @@ } }, { - "id": 1246, + "id": 1244, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -31440,14 +31370,14 @@ ] }, { - "id": 1239, + "id": 1237, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1240, + "id": 1238, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -31482,7 +31412,7 @@ }, "parameters": [ { - "id": 1241, + "id": 1239, "name": "id", "variant": "param", "kind": 32768, @@ -31501,7 +31431,7 @@ } }, { - "id": 1242, + "id": 1240, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -31560,14 +31490,14 @@ ] }, { - "id": 1267, + "id": 1265, "name": "retrieveFulfillmentOptions", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1268, + "id": 1266, "name": "retrieveFulfillmentOptions", "variant": "signature", "kind": 4096, @@ -31602,7 +31532,7 @@ }, "parameters": [ { - "id": 1269, + "id": 1267, "name": "id", "variant": "param", "kind": 32768, @@ -31621,7 +31551,7 @@ } }, { - "id": 1270, + "id": 1268, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -31680,14 +31610,14 @@ ] }, { - "id": 1230, + "id": 1228, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1231, + "id": 1229, "name": "update", "variant": "signature", "kind": 4096, @@ -31722,7 +31652,7 @@ }, "parameters": [ { - "id": 1232, + "id": 1230, "name": "id", "variant": "param", "kind": 32768, @@ -31741,7 +31671,7 @@ } }, { - "id": 1233, + "id": 1231, "name": "payload", "variant": "param", "kind": 32768, @@ -31765,7 +31695,7 @@ } }, { - "id": 1234, + "id": 1232, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -31828,24 +31758,24 @@ { "title": "Constructors", "children": [ - 1223 + 1221 ] }, { "title": "Methods", "children": [ - 1247, - 1257, - 1271, - 1226, - 1235, - 1252, - 1262, - 1276, - 1243, - 1239, - 1267, - 1230 + 1245, + 1255, + 1269, + 1224, + 1233, + 1250, + 1260, + 1274, + 1241, + 1237, + 1265, + 1228 ] } ], @@ -31862,7 +31792,7 @@ ] }, { - "id": 1281, + "id": 1279, "name": "AdminReservationsResource", "variant": "declaration", "kind": 128, @@ -31895,21 +31825,21 @@ }, "children": [ { - "id": 1282, + "id": 1280, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1283, + "id": 1281, "name": "new AdminReservationsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1284, + "id": 1282, "name": "client", "variant": "param", "kind": 32768, @@ -31927,7 +31857,7 @@ ], "type": { "type": "reference", - "target": 1281, + "target": 1279, "name": "AdminReservationsResource", "package": "@medusajs/medusa-js" }, @@ -31945,14 +31875,14 @@ } }, { - "id": 1293, + "id": 1291, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1294, + "id": 1292, "name": "create", "variant": "signature", "kind": 4096, @@ -31987,7 +31917,7 @@ }, "parameters": [ { - "id": 1295, + "id": 1293, "name": "payload", "variant": "param", "kind": 32768, @@ -32011,7 +31941,7 @@ } }, { - "id": 1296, + "id": 1294, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -32070,14 +32000,14 @@ ] }, { - "id": 1302, + "id": 1300, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1303, + "id": 1301, "name": "delete", "variant": "signature", "kind": 4096, @@ -32112,7 +32042,7 @@ }, "parameters": [ { - "id": 1304, + "id": 1302, "name": "id", "variant": "param", "kind": 32768, @@ -32131,7 +32061,7 @@ } }, { - "id": 1305, + "id": 1303, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -32190,14 +32120,14 @@ ] }, { - "id": 1289, + "id": 1287, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1290, + "id": 1288, "name": "list", "variant": "signature", "kind": 4096, @@ -32300,7 +32230,7 @@ }, "parameters": [ { - "id": 1291, + "id": 1289, "name": "query", "variant": "param", "kind": 32768, @@ -32326,7 +32256,7 @@ } }, { - "id": 1292, + "id": 1290, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -32385,14 +32315,14 @@ ] }, { - "id": 1285, + "id": 1283, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1286, + "id": 1284, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -32427,7 +32357,7 @@ }, "parameters": [ { - "id": 1287, + "id": 1285, "name": "id", "variant": "param", "kind": 32768, @@ -32446,7 +32376,7 @@ } }, { - "id": 1288, + "id": 1286, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -32505,14 +32435,14 @@ ] }, { - "id": 1297, + "id": 1295, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1298, + "id": 1296, "name": "update", "variant": "signature", "kind": 4096, @@ -32547,7 +32477,7 @@ }, "parameters": [ { - "id": 1299, + "id": 1297, "name": "id", "variant": "param", "kind": 32768, @@ -32566,7 +32496,7 @@ } }, { - "id": 1300, + "id": 1298, "name": "payload", "variant": "param", "kind": 32768, @@ -32590,7 +32520,7 @@ } }, { - "id": 1301, + "id": 1299, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -32653,17 +32583,17 @@ { "title": "Constructors", "children": [ - 1282 + 1280 ] }, { "title": "Methods", "children": [ - 1293, - 1302, - 1289, - 1285, - 1297 + 1291, + 1300, + 1287, + 1283, + 1295 ] } ], @@ -32680,7 +32610,7 @@ ] }, { - "id": 1306, + "id": 1304, "name": "AdminReturnReasonsResource", "variant": "declaration", "kind": 128, @@ -32713,21 +32643,21 @@ }, "children": [ { - "id": 1307, + "id": 1305, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1308, + "id": 1306, "name": "new AdminReturnReasonsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1309, + "id": 1307, "name": "client", "variant": "param", "kind": 32768, @@ -32745,7 +32675,7 @@ ], "type": { "type": "reference", - "target": 1306, + "target": 1304, "name": "AdminReturnReasonsResource", "package": "@medusajs/medusa-js" }, @@ -32763,14 +32693,14 @@ } }, { - "id": 1310, + "id": 1308, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1311, + "id": 1309, "name": "create", "variant": "signature", "kind": 4096, @@ -32805,7 +32735,7 @@ }, "parameters": [ { - "id": 1312, + "id": 1310, "name": "payload", "variant": "param", "kind": 32768, @@ -32829,7 +32759,7 @@ } }, { - "id": 1313, + "id": 1311, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -32888,14 +32818,14 @@ ] }, { - "id": 1319, + "id": 1317, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1320, + "id": 1318, "name": "delete", "variant": "signature", "kind": 4096, @@ -32930,7 +32860,7 @@ }, "parameters": [ { - "id": 1321, + "id": 1319, "name": "id", "variant": "param", "kind": 32768, @@ -32949,7 +32879,7 @@ } }, { - "id": 1322, + "id": 1320, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -33008,14 +32938,14 @@ ] }, { - "id": 1327, + "id": 1325, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1328, + "id": 1326, "name": "list", "variant": "signature", "kind": 4096, @@ -33050,7 +32980,7 @@ }, "parameters": [ { - "id": 1329, + "id": 1327, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -33109,14 +33039,14 @@ ] }, { - "id": 1323, + "id": 1321, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1324, + "id": 1322, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -33151,7 +33081,7 @@ }, "parameters": [ { - "id": 1325, + "id": 1323, "name": "id", "variant": "param", "kind": 32768, @@ -33170,7 +33100,7 @@ } }, { - "id": 1326, + "id": 1324, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -33229,14 +33159,14 @@ ] }, { - "id": 1314, + "id": 1312, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1315, + "id": 1313, "name": "update", "variant": "signature", "kind": 4096, @@ -33271,7 +33201,7 @@ }, "parameters": [ { - "id": 1316, + "id": 1314, "name": "id", "variant": "param", "kind": 32768, @@ -33290,7 +33220,7 @@ } }, { - "id": 1317, + "id": 1315, "name": "payload", "variant": "param", "kind": 32768, @@ -33314,7 +33244,7 @@ } }, { - "id": 1318, + "id": 1316, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -33377,17 +33307,17 @@ { "title": "Constructors", "children": [ - 1307 + 1305 ] }, { "title": "Methods", "children": [ - 1310, - 1319, - 1327, - 1323, - 1314 + 1308, + 1317, + 1325, + 1321, + 1312 ] } ], @@ -33404,7 +33334,7 @@ ] }, { - "id": 1330, + "id": 1328, "name": "AdminReturnsResource", "variant": "declaration", "kind": 128, @@ -33437,21 +33367,21 @@ }, "children": [ { - "id": 1331, + "id": 1329, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1332, + "id": 1330, "name": "new AdminReturnsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1333, + "id": 1331, "name": "client", "variant": "param", "kind": 32768, @@ -33469,7 +33399,7 @@ ], "type": { "type": "reference", - "target": 1330, + "target": 1328, "name": "AdminReturnsResource", "package": "@medusajs/medusa-js" }, @@ -33487,14 +33417,14 @@ } }, { - "id": 1334, + "id": 1332, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1335, + "id": 1333, "name": "cancel", "variant": "signature", "kind": 4096, @@ -33503,7 +33433,7 @@ "summary": [ { "kind": "text", - "text": "Registers a return as canceled. The return can be associated with an order, claim, or swap." + "text": "Register a return as canceled. The return can be associated with an order, claim, or swap." } ], "blockTags": [ @@ -33529,7 +33459,7 @@ }, "parameters": [ { - "id": 1336, + "id": 1334, "name": "id", "variant": "param", "kind": 32768, @@ -33548,7 +33478,7 @@ } }, { - "id": 1337, + "id": 1335, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -33607,14 +33537,14 @@ ] }, { - "id": 1343, + "id": 1341, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1344, + "id": 1342, "name": "list", "variant": "signature", "kind": 4096, @@ -33685,7 +33615,7 @@ }, "parameters": [ { - "id": 1345, + "id": 1343, "name": "query", "variant": "param", "kind": 32768, @@ -33711,7 +33641,7 @@ } }, { - "id": 1346, + "id": 1344, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -33770,14 +33700,14 @@ ] }, { - "id": 1338, + "id": 1336, "name": "receive", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1339, + "id": 1337, "name": "receive", "variant": "signature", "kind": 4096, @@ -33812,7 +33742,7 @@ }, "parameters": [ { - "id": 1340, + "id": 1338, "name": "id", "variant": "param", "kind": 32768, @@ -33831,7 +33761,7 @@ } }, { - "id": 1341, + "id": 1339, "name": "payload", "variant": "param", "kind": 32768, @@ -33855,7 +33785,7 @@ } }, { - "id": 1342, + "id": 1340, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -33918,15 +33848,15 @@ { "title": "Constructors", "children": [ - 1331 + 1329 ] }, { "title": "Methods", "children": [ - 1334, - 1343, - 1338 + 1332, + 1341, + 1336 ] } ], @@ -33943,7 +33873,7 @@ ] }, { - "id": 1347, + "id": 1345, "name": "AdminSalesChannelsResource", "variant": "declaration", "kind": 128, @@ -33976,21 +33906,21 @@ }, "children": [ { - "id": 1348, + "id": 1346, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1349, + "id": 1347, "name": "new AdminSalesChannelsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1350, + "id": 1348, "name": "client", "variant": "param", "kind": 32768, @@ -34008,7 +33938,7 @@ ], "type": { "type": "reference", - "target": 1347, + "target": 1345, "name": "AdminSalesChannelsResource", "package": "@medusajs/medusa-js" }, @@ -34026,14 +33956,14 @@ } }, { - "id": 1382, + "id": 1380, "name": "addLocation", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1383, + "id": 1381, "name": "addLocation", "variant": "signature", "kind": 4096, @@ -34042,7 +33972,7 @@ "summary": [ { "kind": "text", - "text": "Associate a stock location with a sales channel." + "text": "Associate a stock location with a sales channel. It requires the \n[@medusajs/stock-location](https://docs.medusajs.com/modules/multiwarehouse/install-modules#stock-location-module) module to be installed in\nyour Medusa backend." } ], "blockTags": [ @@ -34068,7 +33998,7 @@ }, "parameters": [ { - "id": 1384, + "id": 1382, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -34087,7 +34017,7 @@ } }, { - "id": 1385, + "id": 1383, "name": "payload", "variant": "param", "kind": 32768, @@ -34111,7 +34041,7 @@ } }, { - "id": 1386, + "id": 1384, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -34170,14 +34100,14 @@ ] }, { - "id": 1377, + "id": 1375, "name": "addProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1378, + "id": 1376, "name": "addProducts", "variant": "signature", "kind": 4096, @@ -34212,7 +34142,7 @@ }, "parameters": [ { - "id": 1379, + "id": 1377, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -34231,7 +34161,7 @@ } }, { - "id": 1380, + "id": 1378, "name": "payload", "variant": "param", "kind": 32768, @@ -34255,7 +34185,7 @@ } }, { - "id": 1381, + "id": 1379, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -34314,14 +34244,14 @@ ] }, { - "id": 1355, + "id": 1353, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1356, + "id": 1354, "name": "create", "variant": "signature", "kind": 4096, @@ -34356,7 +34286,7 @@ }, "parameters": [ { - "id": 1357, + "id": 1355, "name": "payload", "variant": "param", "kind": 32768, @@ -34380,7 +34310,7 @@ } }, { - "id": 1358, + "id": 1356, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -34439,14 +34369,14 @@ ] }, { - "id": 1368, + "id": 1366, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1369, + "id": 1367, "name": "delete", "variant": "signature", "kind": 4096, @@ -34481,7 +34411,7 @@ }, "parameters": [ { - "id": 1370, + "id": 1368, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -34500,7 +34430,7 @@ } }, { - "id": 1371, + "id": 1369, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -34559,14 +34489,14 @@ ] }, { - "id": 1364, + "id": 1362, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1365, + "id": 1363, "name": "list", "variant": "signature", "kind": 4096, @@ -34669,7 +34599,7 @@ }, "parameters": [ { - "id": 1366, + "id": 1364, "name": "query", "variant": "param", "kind": 32768, @@ -34695,7 +34625,7 @@ } }, { - "id": 1367, + "id": 1365, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -34754,14 +34684,14 @@ ] }, { - "id": 1387, + "id": 1385, "name": "removeLocation", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1388, + "id": 1386, "name": "removeLocation", "variant": "signature", "kind": 4096, @@ -34796,7 +34726,7 @@ }, "parameters": [ { - "id": 1389, + "id": 1387, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -34815,7 +34745,7 @@ } }, { - "id": 1390, + "id": 1388, "name": "payload", "variant": "param", "kind": 32768, @@ -34839,7 +34769,7 @@ } }, { - "id": 1391, + "id": 1389, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -34898,14 +34828,14 @@ ] }, { - "id": 1372, + "id": 1370, "name": "removeProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1373, + "id": 1371, "name": "removeProducts", "variant": "signature", "kind": 4096, @@ -34940,7 +34870,7 @@ }, "parameters": [ { - "id": 1374, + "id": 1372, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -34959,7 +34889,7 @@ } }, { - "id": 1375, + "id": 1373, "name": "payload", "variant": "param", "kind": 32768, @@ -34983,7 +34913,7 @@ } }, { - "id": 1376, + "id": 1374, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -35042,14 +34972,14 @@ ] }, { - "id": 1351, + "id": 1349, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1352, + "id": 1350, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -35084,7 +35014,7 @@ }, "parameters": [ { - "id": 1353, + "id": 1351, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -35103,7 +35033,7 @@ } }, { - "id": 1354, + "id": 1352, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -35162,14 +35092,14 @@ ] }, { - "id": 1359, + "id": 1357, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1360, + "id": 1358, "name": "update", "variant": "signature", "kind": 4096, @@ -35204,7 +35134,7 @@ }, "parameters": [ { - "id": 1361, + "id": 1359, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -35223,7 +35153,7 @@ } }, { - "id": 1362, + "id": 1360, "name": "payload", "variant": "param", "kind": 32768, @@ -35247,7 +35177,7 @@ } }, { - "id": 1363, + "id": 1361, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -35310,21 +35240,21 @@ { "title": "Constructors", "children": [ - 1348 + 1346 ] }, { "title": "Methods", "children": [ - 1382, - 1377, - 1355, - 1368, - 1364, - 1387, - 1372, - 1351, - 1359 + 1380, + 1375, + 1353, + 1366, + 1362, + 1385, + 1370, + 1349, + 1357 ] } ], @@ -35341,7 +35271,7 @@ ] }, { - "id": 1392, + "id": 1390, "name": "AdminShippingOptionsResource", "variant": "declaration", "kind": 128, @@ -35374,21 +35304,21 @@ }, "children": [ { - "id": 1393, + "id": 1391, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1394, + "id": 1392, "name": "new AdminShippingOptionsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1395, + "id": 1393, "name": "client", "variant": "param", "kind": 32768, @@ -35406,7 +35336,7 @@ ], "type": { "type": "reference", - "target": 1392, + "target": 1390, "name": "AdminShippingOptionsResource", "package": "@medusajs/medusa-js" }, @@ -35424,14 +35354,14 @@ } }, { - "id": 1396, + "id": 1394, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1397, + "id": 1395, "name": "create", "variant": "signature", "kind": 4096, @@ -35466,7 +35396,7 @@ }, "parameters": [ { - "id": 1398, + "id": 1396, "name": "payload", "variant": "param", "kind": 32768, @@ -35490,7 +35420,7 @@ } }, { - "id": 1399, + "id": 1397, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -35549,14 +35479,14 @@ ] }, { - "id": 1405, + "id": 1403, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1406, + "id": 1404, "name": "delete", "variant": "signature", "kind": 4096, @@ -35591,7 +35521,7 @@ }, "parameters": [ { - "id": 1407, + "id": 1405, "name": "id", "variant": "param", "kind": 32768, @@ -35610,7 +35540,7 @@ } }, { - "id": 1408, + "id": 1406, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -35669,14 +35599,14 @@ ] }, { - "id": 1413, + "id": 1411, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1414, + "id": 1412, "name": "list", "variant": "signature", "kind": 4096, @@ -35735,7 +35665,7 @@ }, "parameters": [ { - "id": 1415, + "id": 1413, "name": "query", "variant": "param", "kind": 32768, @@ -35761,7 +35691,7 @@ } }, { - "id": 1416, + "id": 1414, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -35820,14 +35750,14 @@ ] }, { - "id": 1409, + "id": 1407, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1410, + "id": 1408, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -35862,7 +35792,7 @@ }, "parameters": [ { - "id": 1411, + "id": 1409, "name": "id", "variant": "param", "kind": 32768, @@ -35881,7 +35811,7 @@ } }, { - "id": 1412, + "id": 1410, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -35940,14 +35870,14 @@ ] }, { - "id": 1400, + "id": 1398, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1401, + "id": 1399, "name": "update", "variant": "signature", "kind": 4096, @@ -35982,7 +35912,7 @@ }, "parameters": [ { - "id": 1402, + "id": 1400, "name": "id", "variant": "param", "kind": 32768, @@ -36001,7 +35931,7 @@ } }, { - "id": 1403, + "id": 1401, "name": "payload", "variant": "param", "kind": 32768, @@ -36025,7 +35955,7 @@ } }, { - "id": 1404, + "id": 1402, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -36088,17 +36018,17 @@ { "title": "Constructors", "children": [ - 1393 + 1391 ] }, { "title": "Methods", "children": [ - 1396, - 1405, - 1413, - 1409, - 1400 + 1394, + 1403, + 1411, + 1407, + 1398 ] } ], @@ -36115,7 +36045,7 @@ ] }, { - "id": 1417, + "id": 1415, "name": "AdminShippingProfilesResource", "variant": "declaration", "kind": 128, @@ -36148,21 +36078,21 @@ }, "children": [ { - "id": 1418, + "id": 1416, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1419, + "id": 1417, "name": "new AdminShippingProfilesResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1420, + "id": 1418, "name": "client", "variant": "param", "kind": 32768, @@ -36180,7 +36110,7 @@ ], "type": { "type": "reference", - "target": 1417, + "target": 1415, "name": "AdminShippingProfilesResource", "package": "@medusajs/medusa-js" }, @@ -36198,14 +36128,14 @@ } }, { - "id": 1421, + "id": 1419, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1422, + "id": 1420, "name": "create", "variant": "signature", "kind": 4096, @@ -36232,7 +36162,7 @@ "content": [ { "kind": "code", - "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.shippingProfiles.create({\n name: \"Large Products\"\n})\n.then(({ shipping_profile }) => {\n console.log(shipping_profile.id);\n})\n```" + "text": "```ts\nimport { ShippingProfileType } from \"@medusajs/medusa\"\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.shippingProfiles.create({\n name: \"Large Products\",\n type: ShippingProfileType.DEFAULT\n})\n.then(({ shipping_profile }) => {\n console.log(shipping_profile.id);\n})\n```" } ] } @@ -36240,7 +36170,7 @@ }, "parameters": [ { - "id": 1423, + "id": 1421, "name": "payload", "variant": "param", "kind": 32768, @@ -36264,7 +36194,7 @@ } }, { - "id": 1424, + "id": 1422, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -36323,14 +36253,14 @@ ] }, { - "id": 1430, + "id": 1428, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1431, + "id": 1429, "name": "delete", "variant": "signature", "kind": 4096, @@ -36365,7 +36295,7 @@ }, "parameters": [ { - "id": 1432, + "id": 1430, "name": "id", "variant": "param", "kind": 32768, @@ -36384,7 +36314,7 @@ } }, { - "id": 1433, + "id": 1431, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -36443,14 +36373,14 @@ ] }, { - "id": 1438, + "id": 1436, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1439, + "id": 1437, "name": "list", "variant": "signature", "kind": 4096, @@ -36485,7 +36415,7 @@ }, "parameters": [ { - "id": 1440, + "id": 1438, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -36544,14 +36474,14 @@ ] }, { - "id": 1434, + "id": 1432, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1435, + "id": 1433, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -36586,7 +36516,7 @@ }, "parameters": [ { - "id": 1436, + "id": 1434, "name": "id", "variant": "param", "kind": 32768, @@ -36605,7 +36535,7 @@ } }, { - "id": 1437, + "id": 1435, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -36664,14 +36594,14 @@ ] }, { - "id": 1425, + "id": 1423, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1426, + "id": 1424, "name": "update", "variant": "signature", "kind": 4096, @@ -36706,7 +36636,7 @@ }, "parameters": [ { - "id": 1427, + "id": 1425, "name": "id", "variant": "param", "kind": 32768, @@ -36725,7 +36655,7 @@ } }, { - "id": 1428, + "id": 1426, "name": "payload", "variant": "param", "kind": 32768, @@ -36749,7 +36679,7 @@ } }, { - "id": 1429, + "id": 1427, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -36812,17 +36742,17 @@ { "title": "Constructors", "children": [ - 1418 + 1416 ] }, { "title": "Methods", "children": [ - 1421, - 1430, - 1438, - 1434, - 1425 + 1419, + 1428, + 1436, + 1432, + 1423 ] } ], @@ -36839,7 +36769,7 @@ ] }, { - "id": 1441, + "id": 1439, "name": "AdminStockLocationsResource", "variant": "declaration", "kind": 128, @@ -36872,21 +36802,21 @@ }, "children": [ { - "id": 1442, + "id": 1440, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1443, + "id": 1441, "name": "new AdminStockLocationsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1444, + "id": 1442, "name": "client", "variant": "param", "kind": 32768, @@ -36904,7 +36834,7 @@ ], "type": { "type": "reference", - "target": 1441, + "target": 1439, "name": "AdminStockLocationsResource", "package": "@medusajs/medusa-js" }, @@ -36922,14 +36852,14 @@ } }, { - "id": 1445, + "id": 1443, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1446, + "id": 1444, "name": "create", "variant": "signature", "kind": 4096, @@ -36964,7 +36894,7 @@ }, "parameters": [ { - "id": 1447, + "id": 1445, "name": "payload", "variant": "param", "kind": 32768, @@ -36988,7 +36918,7 @@ } }, { - "id": 1448, + "id": 1446, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -37047,14 +36977,14 @@ ] }, { - "id": 1458, + "id": 1456, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1459, + "id": 1457, "name": "delete", "variant": "signature", "kind": 4096, @@ -37089,7 +37019,7 @@ }, "parameters": [ { - "id": 1460, + "id": 1458, "name": "id", "variant": "param", "kind": 32768, @@ -37108,7 +37038,7 @@ } }, { - "id": 1461, + "id": 1459, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -37167,14 +37097,14 @@ ] }, { - "id": 1462, + "id": 1460, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1463, + "id": 1461, "name": "list", "variant": "signature", "kind": 4096, @@ -37277,7 +37207,7 @@ }, "parameters": [ { - "id": 1464, + "id": 1462, "name": "query", "variant": "param", "kind": 32768, @@ -37303,7 +37233,7 @@ } }, { - "id": 1465, + "id": 1463, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -37362,14 +37292,14 @@ ] }, { - "id": 1449, + "id": 1447, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1450, + "id": 1448, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -37404,7 +37334,7 @@ }, "parameters": [ { - "id": 1451, + "id": 1449, "name": "itemId", "variant": "param", "kind": 32768, @@ -37423,7 +37353,7 @@ } }, { - "id": 1452, + "id": 1450, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -37482,14 +37412,14 @@ ] }, { - "id": 1453, + "id": 1451, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1454, + "id": 1452, "name": "update", "variant": "signature", "kind": 4096, @@ -37524,7 +37454,7 @@ }, "parameters": [ { - "id": 1455, + "id": 1453, "name": "stockLocationId", "variant": "param", "kind": 32768, @@ -37543,7 +37473,7 @@ } }, { - "id": 1456, + "id": 1454, "name": "payload", "variant": "param", "kind": 32768, @@ -37567,7 +37497,7 @@ } }, { - "id": 1457, + "id": 1455, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -37630,17 +37560,17 @@ { "title": "Constructors", "children": [ - 1442 + 1440 ] }, { "title": "Methods", "children": [ - 1445, - 1458, - 1462, - 1449, - 1453 + 1443, + 1456, + 1460, + 1447, + 1451 ] } ], @@ -37657,7 +37587,7 @@ ] }, { - "id": 1466, + "id": 1464, "name": "AdminStoresResource", "variant": "declaration", "kind": 128, @@ -37690,21 +37620,21 @@ }, "children": [ { - "id": 1467, + "id": 1465, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1468, + "id": 1466, "name": "new AdminStoresResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1469, + "id": 1467, "name": "client", "variant": "param", "kind": 32768, @@ -37722,7 +37652,7 @@ ], "type": { "type": "reference", - "target": 1466, + "target": 1464, "name": "AdminStoresResource", "package": "@medusajs/medusa-js" }, @@ -37740,14 +37670,14 @@ } }, { - "id": 1474, + "id": 1472, "name": "addCurrency", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1475, + "id": 1473, "name": "addCurrency", "variant": "signature", "kind": 4096, @@ -37782,7 +37712,7 @@ }, "parameters": [ { - "id": 1476, + "id": 1474, "name": "currency_code", "variant": "param", "kind": 32768, @@ -37801,7 +37731,7 @@ } }, { - "id": 1477, + "id": 1475, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -37860,14 +37790,14 @@ ] }, { - "id": 1478, + "id": 1476, "name": "deleteCurrency", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1479, + "id": 1477, "name": "deleteCurrency", "variant": "signature", "kind": 4096, @@ -37902,7 +37832,7 @@ }, "parameters": [ { - "id": 1480, + "id": 1478, "name": "currency_code", "variant": "param", "kind": 32768, @@ -37921,7 +37851,7 @@ } }, { - "id": 1481, + "id": 1479, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -37980,14 +37910,14 @@ ] }, { - "id": 1485, + "id": 1483, "name": "listPaymentProviders", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1486, + "id": 1484, "name": "listPaymentProviders", "variant": "signature", "kind": 4096, @@ -38022,7 +37952,7 @@ }, "parameters": [ { - "id": 1487, + "id": 1485, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -38081,14 +38011,14 @@ ] }, { - "id": 1488, + "id": 1486, "name": "listTaxProviders", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1489, + "id": 1487, "name": "listTaxProviders", "variant": "signature", "kind": 4096, @@ -38123,7 +38053,7 @@ }, "parameters": [ { - "id": 1490, + "id": 1488, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -38182,14 +38112,14 @@ ] }, { - "id": 1482, + "id": 1480, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1483, + "id": 1481, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -38224,7 +38154,7 @@ }, "parameters": [ { - "id": 1484, + "id": 1482, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -38283,14 +38213,14 @@ ] }, { - "id": 1470, + "id": 1468, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1471, + "id": 1469, "name": "update", "variant": "signature", "kind": 4096, @@ -38325,7 +38255,7 @@ }, "parameters": [ { - "id": 1472, + "id": 1470, "name": "payload", "variant": "param", "kind": 32768, @@ -38349,7 +38279,7 @@ } }, { - "id": 1473, + "id": 1471, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -38412,18 +38342,18 @@ { "title": "Constructors", "children": [ - 1467 + 1465 ] }, { "title": "Methods", "children": [ - 1474, - 1478, - 1485, - 1488, - 1482, - 1470 + 1472, + 1476, + 1483, + 1486, + 1480, + 1468 ] } ], @@ -38440,7 +38370,7 @@ ] }, { - "id": 1491, + "id": 1489, "name": "AdminSwapsResource", "variant": "declaration", "kind": 128, @@ -38473,21 +38403,21 @@ }, "children": [ { - "id": 1492, + "id": 1490, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1493, + "id": 1491, "name": "new AdminSwapsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1494, + "id": 1492, "name": "client", "variant": "param", "kind": 32768, @@ -38505,7 +38435,7 @@ ], "type": { "type": "reference", - "target": 1491, + "target": 1489, "name": "AdminSwapsResource", "package": "@medusajs/medusa-js" }, @@ -38523,14 +38453,14 @@ } }, { - "id": 1499, + "id": 1497, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1500, + "id": 1498, "name": "list", "variant": "signature", "kind": 4096, @@ -38601,7 +38531,7 @@ }, "parameters": [ { - "id": 1501, + "id": 1499, "name": "query", "variant": "param", "kind": 32768, @@ -38627,7 +38557,7 @@ } }, { - "id": 1502, + "id": 1500, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -38686,14 +38616,14 @@ ] }, { - "id": 1495, + "id": 1493, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1496, + "id": 1494, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -38728,7 +38658,7 @@ }, "parameters": [ { - "id": 1497, + "id": 1495, "name": "id", "variant": "param", "kind": 32768, @@ -38747,7 +38677,7 @@ } }, { - "id": 1498, + "id": 1496, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -38810,14 +38740,14 @@ { "title": "Constructors", "children": [ - 1492 + 1490 ] }, { "title": "Methods", "children": [ - 1499, - 1495 + 1497, + 1493 ] } ], @@ -38834,7 +38764,7 @@ ] }, { - "id": 1503, + "id": 1501, "name": "AdminTaxRatesResource", "variant": "declaration", "kind": 128, @@ -38867,21 +38797,21 @@ }, "children": [ { - "id": 1504, + "id": 1502, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1505, + "id": 1503, "name": "new AdminTaxRatesResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1506, + "id": 1504, "name": "client", "variant": "param", "kind": 32768, @@ -38899,7 +38829,7 @@ ], "type": { "type": "reference", - "target": 1503, + "target": 1501, "name": "AdminTaxRatesResource", "package": "@medusajs/medusa-js" }, @@ -38917,14 +38847,14 @@ } }, { - "id": 1533, + "id": 1531, "name": "addProductTypes", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1534, + "id": 1532, "name": "addProductTypes", "variant": "signature", "kind": 4096, @@ -38959,7 +38889,7 @@ }, "parameters": [ { - "id": 1535, + "id": 1533, "name": "id", "variant": "param", "kind": 32768, @@ -38978,7 +38908,7 @@ } }, { - "id": 1536, + "id": 1534, "name": "payload", "variant": "param", "kind": 32768, @@ -39002,7 +38932,7 @@ } }, { - "id": 1537, + "id": 1535, "name": "query", "variant": "param", "kind": 32768, @@ -39028,7 +38958,7 @@ } }, { - "id": 1538, + "id": 1536, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -39087,14 +39017,14 @@ ] }, { - "id": 1527, + "id": 1525, "name": "addProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1528, + "id": 1526, "name": "addProducts", "variant": "signature", "kind": 4096, @@ -39129,7 +39059,7 @@ }, "parameters": [ { - "id": 1529, + "id": 1527, "name": "id", "variant": "param", "kind": 32768, @@ -39148,7 +39078,7 @@ } }, { - "id": 1530, + "id": 1528, "name": "payload", "variant": "param", "kind": 32768, @@ -39172,7 +39102,7 @@ } }, { - "id": 1531, + "id": 1529, "name": "query", "variant": "param", "kind": 32768, @@ -39198,7 +39128,7 @@ } }, { - "id": 1532, + "id": 1530, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -39257,14 +39187,14 @@ ] }, { - "id": 1539, + "id": 1537, "name": "addShippingOptions", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1540, + "id": 1538, "name": "addShippingOptions", "variant": "signature", "kind": 4096, @@ -39299,7 +39229,7 @@ }, "parameters": [ { - "id": 1541, + "id": 1539, "name": "id", "variant": "param", "kind": 32768, @@ -39318,7 +39248,7 @@ } }, { - "id": 1542, + "id": 1540, "name": "payload", "variant": "param", "kind": 32768, @@ -39342,7 +39272,7 @@ } }, { - "id": 1543, + "id": 1541, "name": "query", "variant": "param", "kind": 32768, @@ -39368,7 +39298,7 @@ } }, { - "id": 1544, + "id": 1542, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -39427,14 +39357,14 @@ ] }, { - "id": 1516, + "id": 1514, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1517, + "id": 1515, "name": "create", "variant": "signature", "kind": 4096, @@ -39469,7 +39399,7 @@ }, "parameters": [ { - "id": 1518, + "id": 1516, "name": "payload", "variant": "param", "kind": 32768, @@ -39493,7 +39423,7 @@ } }, { - "id": 1519, + "id": 1517, "name": "query", "variant": "param", "kind": 32768, @@ -39519,7 +39449,7 @@ } }, { - "id": 1520, + "id": 1518, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -39578,14 +39508,14 @@ ] }, { - "id": 1563, + "id": 1561, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1564, + "id": 1562, "name": "delete", "variant": "signature", "kind": 4096, @@ -39620,7 +39550,7 @@ }, "parameters": [ { - "id": 1565, + "id": 1563, "name": "id", "variant": "param", "kind": 32768, @@ -39639,7 +39569,7 @@ } }, { - "id": 1566, + "id": 1564, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -39698,14 +39628,14 @@ ] }, { - "id": 1512, + "id": 1510, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1513, + "id": 1511, "name": "list", "variant": "signature", "kind": 4096, @@ -39768,7 +39698,7 @@ }, { "kind": "code", - "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.taxRates.list({\n expand: \"shipping_options\"\n})\n.then(({ tax_rates, limit, offset, count }) => {\n console.log(tax_rates.length);\n})\n```" + "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.taxRates.list({\n expand: [\"shipping_options\"]\n})\n.then(({ tax_rates, limit, offset, count }) => {\n console.log(tax_rates.length);\n})\n```" }, { "kind": "text", @@ -39800,7 +39730,7 @@ }, { "kind": "code", - "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.taxRates.list({\n expand: \"shipping_options\",\n limit,\n offset\n})\n.then(({ tax_rates, limit, offset, count }) => {\n console.log(tax_rates.length);\n})\n```" + "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.taxRates.list({\n expand: [\"shipping_options\"],\n limit,\n offset\n})\n.then(({ tax_rates, limit, offset, count }) => {\n console.log(tax_rates.length);\n})\n```" } ] } @@ -39808,7 +39738,7 @@ }, "parameters": [ { - "id": 1514, + "id": 1512, "name": "query", "variant": "param", "kind": 32768, @@ -39834,7 +39764,7 @@ } }, { - "id": 1515, + "id": 1513, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -39893,14 +39823,14 @@ ] }, { - "id": 1551, + "id": 1549, "name": "removeProductTypes", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1552, + "id": 1550, "name": "removeProductTypes", "variant": "signature", "kind": 4096, @@ -39935,7 +39865,7 @@ }, "parameters": [ { - "id": 1553, + "id": 1551, "name": "id", "variant": "param", "kind": 32768, @@ -39954,7 +39884,7 @@ } }, { - "id": 1554, + "id": 1552, "name": "payload", "variant": "param", "kind": 32768, @@ -39978,7 +39908,7 @@ } }, { - "id": 1555, + "id": 1553, "name": "query", "variant": "param", "kind": 32768, @@ -40004,7 +39934,7 @@ } }, { - "id": 1556, + "id": 1554, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -40063,14 +39993,14 @@ ] }, { - "id": 1545, + "id": 1543, "name": "removeProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1546, + "id": 1544, "name": "removeProducts", "variant": "signature", "kind": 4096, @@ -40105,7 +40035,7 @@ }, "parameters": [ { - "id": 1547, + "id": 1545, "name": "id", "variant": "param", "kind": 32768, @@ -40124,7 +40054,7 @@ } }, { - "id": 1548, + "id": 1546, "name": "payload", "variant": "param", "kind": 32768, @@ -40148,7 +40078,7 @@ } }, { - "id": 1549, + "id": 1547, "name": "query", "variant": "param", "kind": 32768, @@ -40174,7 +40104,7 @@ } }, { - "id": 1550, + "id": 1548, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -40233,14 +40163,14 @@ ] }, { - "id": 1557, + "id": 1555, "name": "removeShippingOptions", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1558, + "id": 1556, "name": "removeShippingOptions", "variant": "signature", "kind": 4096, @@ -40275,7 +40205,7 @@ }, "parameters": [ { - "id": 1559, + "id": 1557, "name": "id", "variant": "param", "kind": 32768, @@ -40294,7 +40224,7 @@ } }, { - "id": 1560, + "id": 1558, "name": "payload", "variant": "param", "kind": 32768, @@ -40318,7 +40248,7 @@ } }, { - "id": 1561, + "id": 1559, "name": "query", "variant": "param", "kind": 32768, @@ -40344,7 +40274,7 @@ } }, { - "id": 1562, + "id": 1560, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -40403,14 +40333,14 @@ ] }, { - "id": 1507, + "id": 1505, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1508, + "id": 1506, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -40457,7 +40387,7 @@ }, "parameters": [ { - "id": 1509, + "id": 1507, "name": "id", "variant": "param", "kind": 32768, @@ -40476,7 +40406,7 @@ } }, { - "id": 1510, + "id": 1508, "name": "query", "variant": "param", "kind": 32768, @@ -40502,7 +40432,7 @@ } }, { - "id": 1511, + "id": 1509, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -40561,14 +40491,14 @@ ] }, { - "id": 1521, + "id": 1519, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1522, + "id": 1520, "name": "update", "variant": "signature", "kind": 4096, @@ -40603,7 +40533,7 @@ }, "parameters": [ { - "id": 1523, + "id": 1521, "name": "id", "variant": "param", "kind": 32768, @@ -40622,7 +40552,7 @@ } }, { - "id": 1524, + "id": 1522, "name": "payload", "variant": "param", "kind": 32768, @@ -40646,7 +40576,7 @@ } }, { - "id": 1525, + "id": 1523, "name": "query", "variant": "param", "kind": 32768, @@ -40672,7 +40602,7 @@ } }, { - "id": 1526, + "id": 1524, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -40735,23 +40665,23 @@ { "title": "Constructors", "children": [ - 1504 + 1502 ] }, { "title": "Methods", "children": [ - 1533, - 1527, - 1539, - 1516, - 1563, - 1512, - 1551, - 1545, - 1557, - 1507, - 1521 + 1531, + 1525, + 1537, + 1514, + 1561, + 1510, + 1549, + 1543, + 1555, + 1505, + 1519 ] } ], @@ -40768,7 +40698,7 @@ ] }, { - "id": 1567, + "id": 1565, "name": "AdminUploadsResource", "variant": "declaration", "kind": 128, @@ -40801,21 +40731,21 @@ }, "children": [ { - "id": 1568, + "id": 1566, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1569, + "id": 1567, "name": "new AdminUploadsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1570, + "id": 1568, "name": "client", "variant": "param", "kind": 32768, @@ -40833,7 +40763,7 @@ ], "type": { "type": "reference", - "target": 1567, + "target": 1565, "name": "AdminUploadsResource", "package": "@medusajs/medusa-js" }, @@ -40851,7 +40781,7 @@ } }, { - "id": 1588, + "id": 1586, "name": "_createPayload", "variant": "declaration", "kind": 2048, @@ -40860,14 +40790,14 @@ }, "signatures": [ { - "id": 1589, + "id": 1587, "name": "_createPayload", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1590, + "id": 1588, "name": "file", "variant": "param", "kind": 32768, @@ -40896,14 +40826,14 @@ ] }, { - "id": 1574, + "id": 1572, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1575, + "id": 1573, "name": "create", "variant": "signature", "kind": 4096, @@ -40912,7 +40842,7 @@ "summary": [ { "kind": "text", - "text": "Upload a file to a public bucket or storage. The file upload is handled by the file service installed on the Medusa backend." + "text": "Upload a file or multiple files to a public bucket or storage. The file upload is handled by the file service installed on the Medusa backend." } ], "blockTags": [ @@ -40938,7 +40868,7 @@ }, "parameters": [ { - "id": 1576, + "id": 1574, "name": "file", "variant": "param", "kind": 32768, @@ -40947,7 +40877,7 @@ "summary": [ { "kind": "text", - "text": "The file to upload." + "text": "The file(s) to upload." } ] }, @@ -40986,14 +40916,14 @@ ] }, { - "id": 1577, + "id": 1575, "name": "createProtected", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1578, + "id": 1576, "name": "createProtected", "variant": "signature", "kind": 4096, @@ -41028,7 +40958,7 @@ }, "parameters": [ { - "id": 1579, + "id": 1577, "name": "file", "variant": "param", "kind": 32768, @@ -41076,14 +41006,14 @@ ] }, { - "id": 1580, + "id": 1578, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1581, + "id": 1579, "name": "delete", "variant": "signature", "kind": 4096, @@ -41118,7 +41048,7 @@ }, "parameters": [ { - "id": 1582, + "id": 1580, "name": "payload", "variant": "param", "kind": 32768, @@ -41142,7 +41072,7 @@ } }, { - "id": 1583, + "id": 1581, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -41201,14 +41131,14 @@ ] }, { - "id": 1584, + "id": 1582, "name": "getPresignedDownloadUrl", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1585, + "id": 1583, "name": "getPresignedDownloadUrl", "variant": "signature", "kind": 4096, @@ -41243,7 +41173,7 @@ }, "parameters": [ { - "id": 1586, + "id": 1584, "name": "payload", "variant": "param", "kind": 32768, @@ -41267,7 +41197,7 @@ } }, { - "id": 1587, + "id": 1585, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -41330,17 +41260,17 @@ { "title": "Constructors", "children": [ - 1568 + 1566 ] }, { "title": "Methods", "children": [ - 1588, - 1574, - 1577, - 1580, - 1584 + 1586, + 1572, + 1575, + 1578, + 1582 ] } ], @@ -41357,7 +41287,7 @@ ] }, { - "id": 1591, + "id": 1589, "name": "AdminUsersResource", "variant": "declaration", "kind": 128, @@ -41390,21 +41320,21 @@ }, "children": [ { - "id": 1592, + "id": 1590, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1593, + "id": 1591, "name": "new AdminUsersResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1594, + "id": 1592, "name": "client", "variant": "param", "kind": 32768, @@ -41422,7 +41352,7 @@ ], "type": { "type": "reference", - "target": 1591, + "target": 1589, "name": "AdminUsersResource", "package": "@medusajs/medusa-js" }, @@ -41440,14 +41370,14 @@ } }, { - "id": 1607, + "id": 1605, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1608, + "id": 1606, "name": "create", "variant": "signature", "kind": 4096, @@ -41482,7 +41412,7 @@ }, "parameters": [ { - "id": 1609, + "id": 1607, "name": "payload", "variant": "param", "kind": 32768, @@ -41506,7 +41436,7 @@ } }, { - "id": 1610, + "id": 1608, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -41565,14 +41495,14 @@ ] }, { - "id": 1616, + "id": 1614, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1617, + "id": 1615, "name": "delete", "variant": "signature", "kind": 4096, @@ -41607,7 +41537,7 @@ }, "parameters": [ { - "id": 1618, + "id": 1616, "name": "id", "variant": "param", "kind": 32768, @@ -41626,7 +41556,7 @@ } }, { - "id": 1619, + "id": 1617, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -41685,14 +41615,14 @@ ] }, { - "id": 1620, + "id": 1618, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1621, + "id": 1619, "name": "list", "variant": "signature", "kind": 4096, @@ -41727,7 +41657,7 @@ }, "parameters": [ { - "id": 1622, + "id": 1620, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -41786,14 +41716,14 @@ ] }, { - "id": 1599, + "id": 1597, "name": "resetPassword", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1600, + "id": 1598, "name": "resetPassword", "variant": "signature", "kind": 4096, @@ -41808,7 +41738,7 @@ "kind": "inline-tag", "tag": "@link", "text": "sendResetPasswordToken", - "target": 1595, + "target": 1593, "tsLinkText": "" }, { @@ -41839,7 +41769,7 @@ }, "parameters": [ { - "id": 1601, + "id": 1599, "name": "payload", "variant": "param", "kind": 32768, @@ -41863,7 +41793,7 @@ } }, { - "id": 1602, + "id": 1600, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -41922,14 +41852,14 @@ ] }, { - "id": 1603, + "id": 1601, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1604, + "id": 1602, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -41964,7 +41894,7 @@ }, "parameters": [ { - "id": 1605, + "id": 1603, "name": "id", "variant": "param", "kind": 32768, @@ -41983,7 +41913,7 @@ } }, { - "id": 1606, + "id": 1604, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -42042,14 +41972,14 @@ ] }, { - "id": 1595, + "id": 1593, "name": "sendResetPasswordToken", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1596, + "id": 1594, "name": "sendResetPasswordToken", "variant": "signature", "kind": 4096, @@ -42080,7 +42010,7 @@ "kind": "inline-tag", "tag": "@link", "text": "resetPassword", - "target": 1599, + "target": 1597, "tsLinkText": "" }, { @@ -42111,7 +42041,7 @@ }, "parameters": [ { - "id": 1597, + "id": 1595, "name": "payload", "variant": "param", "kind": 32768, @@ -42135,7 +42065,7 @@ } }, { - "id": 1598, + "id": 1596, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -42189,14 +42119,14 @@ ] }, { - "id": 1611, + "id": 1609, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1612, + "id": 1610, "name": "update", "variant": "signature", "kind": 4096, @@ -42231,7 +42161,7 @@ }, "parameters": [ { - "id": 1613, + "id": 1611, "name": "id", "variant": "param", "kind": 32768, @@ -42250,7 +42180,7 @@ } }, { - "id": 1614, + "id": 1612, "name": "payload", "variant": "param", "kind": 32768, @@ -42274,7 +42204,7 @@ } }, { - "id": 1615, + "id": 1613, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -42337,19 +42267,19 @@ { "title": "Constructors", "children": [ - 1592 + 1590 ] }, { "title": "Methods", "children": [ - 1607, - 1616, - 1620, - 1599, - 1603, - 1595, - 1611 + 1605, + 1614, + 1618, + 1597, + 1601, + 1593, + 1609 ] } ], @@ -42366,7 +42296,7 @@ ] }, { - "id": 1623, + "id": 1621, "name": "AdminVariantsResource", "variant": "declaration", "kind": 128, @@ -42399,7 +42329,7 @@ "kind": "inline-tag", "tag": "@link", "text": "AdminProductsResource", - "target": 1109 + "target": 1108 }, { "kind": "text", @@ -42409,21 +42339,21 @@ }, "children": [ { - "id": 1624, + "id": 1622, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1625, + "id": 1623, "name": "new AdminVariantsResource", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1626, + "id": 1624, "name": "client", "variant": "param", "kind": 32768, @@ -42441,7 +42371,7 @@ ], "type": { "type": "reference", - "target": 1623, + "target": 1621, "name": "AdminVariantsResource", "package": "@medusajs/medusa-js" }, @@ -42459,14 +42389,14 @@ } }, { - "id": 1636, + "id": 1634, "name": "getInventory", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1637, + "id": 1635, "name": "getInventory", "variant": "signature", "kind": 4096, @@ -42501,7 +42431,7 @@ }, "parameters": [ { - "id": 1638, + "id": 1636, "name": "variantId", "variant": "param", "kind": 32768, @@ -42520,7 +42450,7 @@ } }, { - "id": 1639, + "id": 1637, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -42579,14 +42509,14 @@ ] }, { - "id": 1627, + "id": 1625, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1628, + "id": 1626, "name": "list", "variant": "signature", "kind": 4096, @@ -42689,7 +42619,7 @@ }, "parameters": [ { - "id": 1629, + "id": 1627, "name": "query", "variant": "param", "kind": 32768, @@ -42715,7 +42645,7 @@ } }, { - "id": 1630, + "id": 1628, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -42774,14 +42704,14 @@ ] }, { - "id": 1631, + "id": 1629, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1632, + "id": 1630, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -42828,7 +42758,7 @@ }, "parameters": [ { - "id": 1633, + "id": 1631, "name": "id", "variant": "param", "kind": 32768, @@ -42847,7 +42777,7 @@ } }, { - "id": 1634, + "id": 1632, "name": "query", "variant": "param", "kind": 32768, @@ -42873,7 +42803,7 @@ } }, { - "id": 1635, + "id": 1633, "name": "customHeaders", "variant": "param", "kind": 32768, @@ -42936,15 +42866,15 @@ { "title": "Constructors", "children": [ - 1624 + 1622 ] }, { "title": "Methods", "children": [ - 1636, - 1627, - 1631 + 1634, + 1625, + 1629 ] } ], @@ -43975,7 +43905,7 @@ "content": [ { "kind": "code", - "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.complete(cartId)\n.then(({ cart }) => {\n console.log(cart.id);\n})\n```" + "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.complete(cartId)\n.then(({ data, type }) => {\n console.log(data.id, type);\n})\n```" } ] } @@ -47041,7 +46971,7 @@ "summary": [ { "kind": "text", - "text": "Generates a Line Item with a given Product Variant and adds it to the Cart" + "text": "Generate a Line Item with a given Product Variant and adds it to the Cart" } ], "blockTags": [ @@ -47589,7 +47519,7 @@ "summary": [ { "kind": "text", - "text": "Complete an Order Edit and reflect its changes on the original order. Any additional payment required must be authorized first using the " + "text": "Complete and confirm an Order Edit and reflect its changes on the original order. Any additional payment required must be authorized first using the " }, { "kind": "inline-tag", @@ -48976,7 +48906,7 @@ "content": [ { "kind": "code", - "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.paymentCollections.authorize(paymentId)\n.then(({ payment_collection }) => {\n console.log(payment_collection.id);\n})\n```" + "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.paymentCollections.authorizePaymentSessionsBatch(paymentCollectionId, {\n session_ids: [\"ps_123456\"]\n})\n.then(({ payment_collection }) => {\n console.log(payment_collection.id);\n})\n```" } ] } @@ -49428,7 +49358,7 @@ "content": [ { "kind": "code", - "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.paymentCollections.refreshPaymentSession(paymentCollectionId, sessionId)\n.then(({ payment_session }) => {\n console.log(payment_session.id);\n})\n```" + "text": "```ts\nimport Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.paymentCollections.refreshPaymentSession(paymentCollectionId, sessionId)\n.then(({ payment_session }) => {\n console.log(payment_session.status);\n})\n```" } ] } @@ -51593,7 +51523,7 @@ "summary": [ { "kind": "text", - "text": "Retrieves a list of products. The products can be filtered by fields such as " + "text": "Retrieve a list of products. The products can be filtered by fields such as " }, { "kind": "code", @@ -52149,7 +52079,7 @@ }, { "kind": "text", - "text": " property.\n\nRegions are different countries or geographical regions that the commerce store serves customers in.\nCustomers can choose what region they're in, which can be used to change the prices shown based on the region and its currency.\n\nRelated Guide: [How to use regions in a storefront](https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions)" + "text": " property.\n\nRegions are different countries or geographical regions that the commerce store serves customers in.\nCustomers can choose what region they're in, which can be used to change the prices shown based on the region and its currency.\n\nRelated Guide: [How to use regions in a storefront](https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions)." } ] }, @@ -53746,33 +53676,33 @@ 666, 711, 736, - 788, - 811, - 836, - 980, - 849, - 1640, - 1662, - 1039, - 1680, - 1094, - 1101, - 1109, - 1177, - 1222, - 1281, - 1306, - 1330, - 1347, - 1392, - 1417, - 1441, - 1466, - 1491, - 1503, - 1567, - 1591, - 1623, + 787, + 810, + 835, + 979, + 848, + 1638, + 1660, + 1038, + 1678, + 1093, + 1100, + 1108, + 1176, + 1220, + 1279, + 1304, + 1328, + 1345, + 1390, + 1415, + 1439, + 1464, + 1489, + 1501, + 1565, + 1589, + 1621, 18, 40, 97, @@ -56924,63 +56854,63 @@ }, "781": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/inventory-item.ts", - "qualifiedName": "query" + "qualifiedName": "customHeaders" }, "782": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/inventory-item.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminInventoryItemsResource.listLocationLevels" }, "783": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/inventory-item.ts", "qualifiedName": "AdminInventoryItemsResource.listLocationLevels" }, "784": { - "sourceFileName": "../../../packages/medusa-js/src/resources/admin/inventory-item.ts", - "qualifiedName": "AdminInventoryItemsResource.listLocationLevels" - }, - "785": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/inventory-item.ts", "qualifiedName": "inventoryItemId" }, - "786": { + "785": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/inventory-item.ts", "qualifiedName": "query" }, - "787": { + "786": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/inventory-item.ts", "qualifiedName": "customHeaders" }, - "788": { + "787": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", "qualifiedName": "AdminInvitesResource" }, - "789": { + "788": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "790": { + "789": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminInvitesResource" }, - "791": { + "790": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, + "791": { + "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", + "qualifiedName": "AdminInvitesResource.accept" + }, "792": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", "qualifiedName": "AdminInvitesResource.accept" }, "793": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", - "qualifiedName": "AdminInvitesResource.accept" + "qualifiedName": "payload" }, "794": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "795": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminInvitesResource.create" }, "796": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", @@ -56988,15 +56918,15 @@ }, "797": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", - "qualifiedName": "AdminInvitesResource.create" + "qualifiedName": "payload" }, "798": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "799": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminInvitesResource.delete" }, "800": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", @@ -57004,15 +56934,15 @@ }, "801": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", - "qualifiedName": "AdminInvitesResource.delete" + "qualifiedName": "id" }, "802": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "803": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminInvitesResource.list" }, "804": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", @@ -57020,59 +56950,59 @@ }, "805": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", - "qualifiedName": "AdminInvitesResource.list" + "qualifiedName": "customHeaders" }, "806": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminInvitesResource.resend" }, "807": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", "qualifiedName": "AdminInvitesResource.resend" }, "808": { - "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", - "qualifiedName": "AdminInvitesResource.resend" - }, - "809": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", "qualifiedName": "id" }, - "810": { + "809": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/invites.ts", "qualifiedName": "customHeaders" }, - "811": { + "810": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", "qualifiedName": "AdminNotesResource" }, - "812": { + "811": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "813": { + "812": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminNotesResource" }, - "814": { + "813": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, + "814": { + "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", + "qualifiedName": "AdminNotesResource.create" + }, "815": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", "qualifiedName": "AdminNotesResource.create" }, "816": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "AdminNotesResource.create" + "qualifiedName": "payload" }, "817": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "818": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminNotesResource.update" }, "819": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", @@ -57080,19 +57010,19 @@ }, "820": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "AdminNotesResource.update" + "qualifiedName": "id" }, "821": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "822": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "823": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminNotesResource.delete" }, "824": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", @@ -57100,15 +57030,15 @@ }, "825": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "AdminNotesResource.delete" + "qualifiedName": "id" }, "826": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "827": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminNotesResource.retrieve" }, "828": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", @@ -57116,119 +57046,119 @@ }, "829": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "AdminNotesResource.retrieve" + "qualifiedName": "id" }, "830": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "831": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminNotesResource.list" }, "832": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", "qualifiedName": "AdminNotesResource.list" }, "833": { - "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", - "qualifiedName": "AdminNotesResource.list" - }, - "834": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", "qualifiedName": "query" }, - "835": { + "834": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notes.ts", "qualifiedName": "customHeaders" }, - "836": { + "835": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notifications.ts", "qualifiedName": "AdminNotificationsResource" }, - "837": { + "836": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "838": { + "837": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminNotificationsResource" }, - "839": { + "838": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "840": { + "839": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notifications.ts", "qualifiedName": "AdminNotificationsResource.list" }, - "841": { + "840": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notifications.ts", "qualifiedName": "AdminNotificationsResource.list" }, - "842": { + "841": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notifications.ts", "qualifiedName": "query" }, - "843": { + "842": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notifications.ts", "qualifiedName": "customHeaders" }, - "844": { + "843": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notifications.ts", "qualifiedName": "AdminNotificationsResource.resend" }, - "845": { + "844": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notifications.ts", "qualifiedName": "AdminNotificationsResource.resend" }, - "846": { + "845": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notifications.ts", "qualifiedName": "id" }, - "847": { + "846": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notifications.ts", "qualifiedName": "payload" }, - "848": { + "847": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/notifications.ts", "qualifiedName": "customHeaders" }, - "849": { + "848": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", "qualifiedName": "AdminOrdersResource" }, - "850": { + "849": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "851": { + "850": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminOrdersResource" }, - "852": { + "851": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, + "852": { + "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", + "qualifiedName": "AdminOrdersResource.update" + }, "853": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", "qualifiedName": "AdminOrdersResource.update" }, "854": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.update" + "qualifiedName": "id" }, "855": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "856": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "857": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.retrieve" }, "858": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57236,19 +57166,19 @@ }, "859": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.retrieve" + "qualifiedName": "id" }, "860": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "query" }, "861": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "query" + "qualifiedName": "customHeaders" }, "862": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.list" }, "863": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57256,15 +57186,15 @@ }, "864": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.list" + "qualifiedName": "query" }, "865": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "query" + "qualifiedName": "customHeaders" }, "866": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.complete" }, "867": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57272,15 +57202,15 @@ }, "868": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.complete" + "qualifiedName": "id" }, "869": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "870": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.capturePayment" }, "871": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57288,15 +57218,15 @@ }, "872": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.capturePayment" + "qualifiedName": "id" }, "873": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "874": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.refundPayment" }, "875": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57304,19 +57234,19 @@ }, "876": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.refundPayment" + "qualifiedName": "id" }, "877": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "878": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "879": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.createFulfillment" }, "880": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57324,19 +57254,19 @@ }, "881": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.createFulfillment" + "qualifiedName": "id" }, "882": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "883": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "884": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.cancelFulfillment" }, "885": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57344,19 +57274,19 @@ }, "886": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.cancelFulfillment" + "qualifiedName": "id" }, "887": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "fulfillmentId" }, "888": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "fulfillmentId" + "qualifiedName": "customHeaders" }, "889": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.cancelSwapFulfillment" }, "890": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57364,23 +57294,23 @@ }, "891": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.cancelSwapFulfillment" + "qualifiedName": "id" }, "892": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "swapId" }, "893": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "swapId" + "qualifiedName": "fulfillmentId" }, "894": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "fulfillmentId" + "qualifiedName": "customHeaders" }, "895": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.cancelClaimFulfillment" }, "896": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57388,23 +57318,23 @@ }, "897": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.cancelClaimFulfillment" + "qualifiedName": "id" }, "898": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "claimId" }, "899": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "claimId" + "qualifiedName": "fulfillmentId" }, "900": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "fulfillmentId" + "qualifiedName": "customHeaders" }, "901": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.createShipment" }, "902": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57412,19 +57342,19 @@ }, "903": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.createShipment" + "qualifiedName": "id" }, "904": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "905": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "906": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.requestReturn" }, "907": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57432,19 +57362,19 @@ }, "908": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.requestReturn" + "qualifiedName": "id" }, "909": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "910": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "911": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.cancel" }, "912": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57452,15 +57382,15 @@ }, "913": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.cancel" + "qualifiedName": "id" }, "914": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "915": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.addShippingMethod" }, "916": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57468,19 +57398,19 @@ }, "917": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.addShippingMethod" + "qualifiedName": "id" }, "918": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "919": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "920": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.archive" }, "921": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57488,15 +57418,15 @@ }, "922": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.archive" + "qualifiedName": "id" }, "923": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "924": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.createSwap" }, "925": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57504,19 +57434,19 @@ }, "926": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.createSwap" + "qualifiedName": "id" }, "927": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "928": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "929": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.cancelSwap" }, "930": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57524,19 +57454,19 @@ }, "931": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.cancelSwap" + "qualifiedName": "id" }, "932": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "swapId" }, "933": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "swapId" + "qualifiedName": "customHeaders" }, "934": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.fulfillSwap" }, "935": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57544,23 +57474,23 @@ }, "936": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.fulfillSwap" + "qualifiedName": "id" }, "937": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "swapId" }, "938": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "swapId" + "qualifiedName": "payload" }, "939": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "940": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.createSwapShipment" }, "941": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57568,23 +57498,23 @@ }, "942": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.createSwapShipment" + "qualifiedName": "id" }, "943": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "swapId" }, "944": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "swapId" + "qualifiedName": "payload" }, "945": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "946": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.processSwapPayment" }, "947": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57592,19 +57522,19 @@ }, "948": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.processSwapPayment" + "qualifiedName": "id" }, "949": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "swapId" }, "950": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "swapId" + "qualifiedName": "customHeaders" }, "951": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.createClaim" }, "952": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57612,19 +57542,19 @@ }, "953": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.createClaim" + "qualifiedName": "id" }, "954": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "955": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "956": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.cancelClaim" }, "957": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57632,19 +57562,19 @@ }, "958": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.cancelClaim" + "qualifiedName": "id" }, "959": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "claimId" }, "960": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "claimId" + "qualifiedName": "customHeaders" }, "961": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.updateClaim" }, "962": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57652,23 +57582,23 @@ }, "963": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.updateClaim" + "qualifiedName": "id" }, "964": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "claimId" }, "965": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "claimId" + "qualifiedName": "payload" }, "966": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "967": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.fulfillClaim" }, "968": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", @@ -57676,83 +57606,83 @@ }, "969": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.fulfillClaim" + "qualifiedName": "id" }, "970": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "id" + "qualifiedName": "claimId" }, "971": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "claimId" + "qualifiedName": "payload" }, "972": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "973": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrdersResource.createClaimShipment" }, "974": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", "qualifiedName": "AdminOrdersResource.createClaimShipment" }, "975": { - "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", - "qualifiedName": "AdminOrdersResource.createClaimShipment" - }, - "976": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", "qualifiedName": "id" }, - "977": { + "976": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", "qualifiedName": "claimId" }, - "978": { + "977": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", "qualifiedName": "payload" }, - "979": { + "978": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/orders.ts", "qualifiedName": "customHeaders" }, - "980": { + "979": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", "qualifiedName": "AdminOrderEditsResource" }, - "981": { + "980": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "982": { + "981": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminOrderEditsResource" }, - "983": { + "982": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, + "983": { + "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", + "qualifiedName": "AdminOrderEditsResource.retrieve" + }, "984": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", "qualifiedName": "AdminOrderEditsResource.retrieve" }, "985": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "AdminOrderEditsResource.retrieve" + "qualifiedName": "id" }, "986": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "id" + "qualifiedName": "query" }, "987": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "query" + "qualifiedName": "customHeaders" }, "988": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrderEditsResource.list" }, "989": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", @@ -57760,15 +57690,15 @@ }, "990": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "AdminOrderEditsResource.list" + "qualifiedName": "query" }, "991": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "query" + "qualifiedName": "customHeaders" }, "992": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrderEditsResource.create" }, "993": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", @@ -57776,15 +57706,15 @@ }, "994": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "AdminOrderEditsResource.create" + "qualifiedName": "payload" }, "995": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "996": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrderEditsResource.update" }, "997": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", @@ -57792,19 +57722,19 @@ }, "998": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "AdminOrderEditsResource.update" + "qualifiedName": "id" }, "999": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "1000": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1001": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrderEditsResource.delete" }, "1002": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", @@ -57812,15 +57742,15 @@ }, "1003": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "AdminOrderEditsResource.delete" + "qualifiedName": "id" }, "1004": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "1005": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrderEditsResource.addLineItem" }, "1006": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", @@ -57828,19 +57758,19 @@ }, "1007": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "AdminOrderEditsResource.addLineItem" + "qualifiedName": "id" }, "1008": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "1009": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1010": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrderEditsResource.deleteItemChange" }, "1011": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", @@ -57848,19 +57778,19 @@ }, "1012": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "AdminOrderEditsResource.deleteItemChange" + "qualifiedName": "orderEditId" }, "1013": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "orderEditId" + "qualifiedName": "itemChangeId" }, "1014": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "itemChangeId" + "qualifiedName": "customHeaders" }, "1015": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrderEditsResource.requestConfirmation" }, "1016": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", @@ -57868,15 +57798,15 @@ }, "1017": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "AdminOrderEditsResource.requestConfirmation" + "qualifiedName": "id" }, "1018": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "1019": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrderEditsResource.cancel" }, "1020": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", @@ -57884,15 +57814,15 @@ }, "1021": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "AdminOrderEditsResource.cancel" + "qualifiedName": "id" }, "1022": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "1023": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrderEditsResource.confirm" }, "1024": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", @@ -57900,15 +57830,15 @@ }, "1025": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "AdminOrderEditsResource.confirm" + "qualifiedName": "id" }, "1026": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "1027": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrderEditsResource.updateLineItem" }, "1028": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", @@ -57916,75 +57846,75 @@ }, "1029": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "AdminOrderEditsResource.updateLineItem" + "qualifiedName": "orderEditId" }, "1030": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "orderEditId" + "qualifiedName": "itemId" }, "1031": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "itemId" + "qualifiedName": "payload" }, "1032": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1033": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminOrderEditsResource.removeLineItem" }, "1034": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", "qualifiedName": "AdminOrderEditsResource.removeLineItem" }, "1035": { - "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", - "qualifiedName": "AdminOrderEditsResource.removeLineItem" - }, - "1036": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", "qualifiedName": "orderEditId" }, - "1037": { + "1036": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", "qualifiedName": "itemId" }, - "1038": { + "1037": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/order-edits.ts", "qualifiedName": "customHeaders" }, - "1039": { + "1038": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", "qualifiedName": "AdminPriceListResource" }, - "1040": { + "1039": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1041": { + "1040": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminPriceListResource" }, - "1042": { + "1041": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, + "1042": { + "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", + "qualifiedName": "AdminPriceListResource.create" + }, "1043": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", "qualifiedName": "AdminPriceListResource.create" }, "1044": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "AdminPriceListResource.create" + "qualifiedName": "payload" }, "1045": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1046": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminPriceListResource.update" }, "1047": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", @@ -57992,19 +57922,19 @@ }, "1048": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "AdminPriceListResource.update" + "qualifiedName": "id" }, "1049": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "1050": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1051": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminPriceListResource.delete" }, "1052": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", @@ -58012,15 +57942,15 @@ }, "1053": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "AdminPriceListResource.delete" + "qualifiedName": "id" }, "1054": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "1055": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminPriceListResource.retrieve" }, "1056": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", @@ -58028,15 +57958,15 @@ }, "1057": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "AdminPriceListResource.retrieve" + "qualifiedName": "id" }, "1058": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "1059": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminPriceListResource.list" }, "1060": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", @@ -58044,15 +57974,15 @@ }, "1061": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "AdminPriceListResource.list" + "qualifiedName": "query" }, "1062": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "query" + "qualifiedName": "customHeaders" }, "1063": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminPriceListResource.listProducts" }, "1064": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", @@ -58060,19 +57990,19 @@ }, "1065": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "AdminPriceListResource.listProducts" + "qualifiedName": "id" }, "1066": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "id" + "qualifiedName": "query" }, "1067": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "query" + "qualifiedName": "customHeaders" }, "1068": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminPriceListResource.addPrices" }, "1069": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", @@ -58080,19 +58010,19 @@ }, "1070": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "AdminPriceListResource.addPrices" + "qualifiedName": "id" }, "1071": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "1072": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1073": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminPriceListResource.deletePrices" }, "1074": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", @@ -58100,19 +58030,19 @@ }, "1075": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "AdminPriceListResource.deletePrices" + "qualifiedName": "id" }, "1076": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "1077": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1078": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminPriceListResource.deleteProductPrices" }, "1079": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", @@ -58120,19 +58050,19 @@ }, "1080": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "AdminPriceListResource.deleteProductPrices" + "qualifiedName": "priceListId" }, "1081": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "priceListId" + "qualifiedName": "productId" }, "1082": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "productId" + "qualifiedName": "customHeaders" }, "1083": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminPriceListResource.deleteVariantPrices" }, "1084": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", @@ -58140,131 +58070,131 @@ }, "1085": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "AdminPriceListResource.deleteVariantPrices" + "qualifiedName": "priceListId" }, "1086": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "priceListId" + "qualifiedName": "variantId" }, "1087": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "variantId" + "qualifiedName": "customHeaders" }, "1088": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminPriceListResource.deleteProductsPrices" }, "1089": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", "qualifiedName": "AdminPriceListResource.deleteProductsPrices" }, "1090": { - "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", - "qualifiedName": "AdminPriceListResource.deleteProductsPrices" - }, - "1091": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", "qualifiedName": "priceListId" }, - "1092": { + "1091": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", "qualifiedName": "payload" }, - "1093": { + "1092": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/price-lists.ts", "qualifiedName": "customHeaders" }, - "1094": { + "1093": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-tags.ts", "qualifiedName": "AdminProductTagsResource" }, - "1095": { + "1094": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1096": { + "1095": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminProductTagsResource" }, - "1097": { + "1096": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1098": { + "1097": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-tags.ts", "qualifiedName": "AdminProductTagsResource.list" }, - "1099": { + "1098": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-tags.ts", "qualifiedName": "AdminProductTagsResource.list" }, - "1100": { + "1099": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-tags.ts", "qualifiedName": "query" }, - "1101": { + "1100": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-types.ts", "qualifiedName": "AdminProductTypesResource" }, - "1102": { + "1101": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1103": { + "1102": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminProductTypesResource" }, - "1104": { + "1103": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1105": { + "1104": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-types.ts", "qualifiedName": "AdminProductTypesResource.list" }, - "1106": { + "1105": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-types.ts", "qualifiedName": "AdminProductTypesResource.list" }, - "1107": { + "1106": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-types.ts", "qualifiedName": "query" }, - "1108": { + "1107": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-types.ts", "qualifiedName": "customHeaders" }, - "1109": { + "1108": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", "qualifiedName": "AdminProductsResource" }, - "1110": { + "1109": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1111": { + "1110": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminProductsResource" }, - "1112": { + "1111": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, + "1112": { + "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", + "qualifiedName": "AdminProductsResource.create" + }, "1113": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", "qualifiedName": "AdminProductsResource.create" }, "1114": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.create" + "qualifiedName": "payload" }, "1115": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1116": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminProductsResource.retrieve" }, "1117": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", @@ -58272,15 +58202,15 @@ }, "1118": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.retrieve" + "qualifiedName": "id" }, "1119": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "1120": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminProductsResource.update" }, "1121": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", @@ -58288,19 +58218,19 @@ }, "1122": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.update" + "qualifiedName": "id" }, "1123": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "1124": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1125": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminProductsResource.delete" }, "1126": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", @@ -58308,15 +58238,15 @@ }, "1127": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.delete" + "qualifiedName": "id" }, "1128": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "id" + "qualifiedName": "customHeaders" }, "1129": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminProductsResource.list" }, "1130": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", @@ -58324,15 +58254,15 @@ }, "1131": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.list" + "qualifiedName": "query" }, "1132": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "query" + "qualifiedName": "customHeaders" }, - "1133": { + "1136": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminProductsResource.listTags" }, "1137": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", @@ -58340,11 +58270,11 @@ }, "1138": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.listTags" + "qualifiedName": "customHeaders" }, "1139": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminProductsResource.setMetadata" }, "1140": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", @@ -58352,19 +58282,19 @@ }, "1141": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.setMetadata" + "qualifiedName": "id" }, "1142": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "1143": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1144": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminProductsResource.createVariant" }, "1145": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", @@ -58372,19 +58302,19 @@ }, "1146": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.createVariant" + "qualifiedName": "id" }, "1147": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "1148": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1149": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminProductsResource.updateVariant" }, "1150": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", @@ -58392,23 +58322,23 @@ }, "1151": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.updateVariant" + "qualifiedName": "id" }, "1152": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "id" + "qualifiedName": "variantId" }, "1153": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "variantId" + "qualifiedName": "payload" }, "1154": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1155": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminProductsResource.deleteVariant" }, "1156": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", @@ -58416,19 +58346,19 @@ }, "1157": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.deleteVariant" + "qualifiedName": "id" }, "1158": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "id" + "qualifiedName": "variantId" }, "1159": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "variantId" + "qualifiedName": "customHeaders" }, "1160": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminProductsResource.addOption" }, "1161": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", @@ -58436,19 +58366,19 @@ }, "1162": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.addOption" + "qualifiedName": "id" }, "1163": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "id" + "qualifiedName": "payload" }, "1164": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1165": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminProductsResource.updateOption" }, "1166": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", @@ -58456,2185 +58386,2177 @@ }, "1167": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.updateOption" + "qualifiedName": "id" }, "1168": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "id" + "qualifiedName": "optionId" }, "1169": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "optionId" + "qualifiedName": "payload" }, "1170": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "payload" + "qualifiedName": "customHeaders" }, "1171": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "customHeaders" + "qualifiedName": "AdminProductsResource.deleteOption" }, "1172": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", "qualifiedName": "AdminProductsResource.deleteOption" }, "1173": { - "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", - "qualifiedName": "AdminProductsResource.deleteOption" - }, - "1174": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", "qualifiedName": "id" }, - "1175": { + "1174": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", "qualifiedName": "optionId" }, - "1176": { + "1175": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/products.ts", "qualifiedName": "customHeaders" }, - "1177": { + "1176": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource" }, - "1178": { + "1177": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1179": { + "1178": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminPublishableApiKeyResource" }, - "1180": { + "1179": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1181": { + "1180": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.retrieve" }, - "1182": { + "1181": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.retrieve" }, - "1183": { + "1182": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "id" }, - "1184": { - "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", - "qualifiedName": "query" - }, - "1185": { + "1183": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "customHeaders" }, - "1186": { + "1184": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.list" }, - "1187": { + "1185": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.list" }, - "1188": { + "1186": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "query" }, - "1189": { + "1187": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "customHeaders" }, - "1190": { + "1188": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.create" }, - "1191": { + "1189": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.create" }, - "1192": { + "1190": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "payload" }, - "1193": { + "1191": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "customHeaders" }, - "1194": { + "1192": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.update" }, - "1195": { + "1193": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.update" }, - "1196": { + "1194": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "id" }, - "1197": { + "1195": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "payload" }, - "1198": { + "1196": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "customHeaders" }, - "1199": { + "1197": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.delete" }, - "1200": { + "1198": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.delete" }, - "1201": { + "1199": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "id" }, - "1202": { + "1200": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "customHeaders" }, - "1203": { + "1201": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.revoke" }, - "1204": { + "1202": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.revoke" }, - "1205": { + "1203": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "id" }, - "1206": { + "1204": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "customHeaders" }, - "1207": { + "1205": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.addSalesChannelsBatch" }, - "1208": { + "1206": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.addSalesChannelsBatch" }, - "1209": { + "1207": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "id" }, - "1210": { + "1208": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "payload" }, - "1211": { + "1209": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "customHeaders" }, - "1212": { + "1210": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.deleteSalesChannelsBatch" }, - "1213": { + "1211": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.deleteSalesChannelsBatch" }, - "1214": { + "1212": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "id" }, - "1215": { + "1213": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "payload" }, - "1216": { + "1214": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "customHeaders" }, - "1217": { + "1215": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.listSalesChannels" }, - "1218": { + "1216": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "AdminPublishableApiKeyResource.listSalesChannels" }, - "1219": { + "1217": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "id" }, - "1220": { + "1218": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "query" }, - "1221": { + "1219": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/publishable-api-keys.ts", "qualifiedName": "customHeaders" }, - "1222": { + "1220": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource" }, - "1223": { + "1221": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1224": { + "1222": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminRegionsResource" }, - "1225": { + "1223": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1226": { + "1224": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.create" }, - "1227": { + "1225": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.create" }, - "1228": { + "1226": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "payload" }, - "1229": { + "1227": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "customHeaders" }, - "1230": { + "1228": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.update" }, - "1231": { + "1229": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.update" }, - "1232": { + "1230": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "id" }, - "1233": { + "1231": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "payload" }, - "1234": { + "1232": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "customHeaders" }, - "1235": { + "1233": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.delete" }, - "1236": { + "1234": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.delete" }, - "1237": { + "1235": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "id" }, - "1238": { + "1236": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "customHeaders" }, - "1239": { + "1237": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.retrieve" }, - "1240": { + "1238": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.retrieve" }, - "1241": { + "1239": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "id" }, - "1242": { + "1240": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "customHeaders" }, - "1243": { + "1241": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.list" }, - "1244": { + "1242": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.list" }, - "1245": { + "1243": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "query" }, - "1246": { + "1244": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "customHeaders" }, - "1247": { + "1245": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.addCountry" }, - "1248": { + "1246": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.addCountry" }, - "1249": { + "1247": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "id" }, - "1250": { + "1248": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "payload" }, - "1251": { + "1249": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "customHeaders" }, - "1252": { + "1250": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.deleteCountry" }, - "1253": { + "1251": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.deleteCountry" }, - "1254": { + "1252": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "id" }, - "1255": { + "1253": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "country_code" }, - "1256": { + "1254": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "customHeaders" }, - "1257": { + "1255": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.addFulfillmentProvider" }, - "1258": { + "1256": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.addFulfillmentProvider" }, - "1259": { + "1257": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "id" }, - "1260": { + "1258": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "payload" }, - "1261": { + "1259": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "customHeaders" }, - "1262": { + "1260": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.deleteFulfillmentProvider" }, - "1263": { + "1261": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.deleteFulfillmentProvider" }, - "1264": { + "1262": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "id" }, - "1265": { + "1263": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "provider_id" }, - "1266": { + "1264": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "customHeaders" }, - "1267": { + "1265": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.retrieveFulfillmentOptions" }, - "1268": { + "1266": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.retrieveFulfillmentOptions" }, - "1269": { + "1267": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "id" }, - "1270": { + "1268": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "customHeaders" }, - "1271": { + "1269": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.addPaymentProvider" }, - "1272": { + "1270": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.addPaymentProvider" }, - "1273": { + "1271": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "id" }, - "1274": { + "1272": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "payload" }, - "1275": { + "1273": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "customHeaders" }, - "1276": { + "1274": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.deletePaymentProvider" }, - "1277": { + "1275": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "AdminRegionsResource.deletePaymentProvider" }, - "1278": { + "1276": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "id" }, - "1279": { + "1277": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "provider_id" }, - "1280": { + "1278": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/regions.ts", "qualifiedName": "customHeaders" }, - "1281": { + "1279": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "AdminReservationsResource" }, - "1282": { + "1280": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1283": { + "1281": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminReservationsResource" }, - "1284": { + "1282": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1285": { + "1283": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "AdminReservationsResource.retrieve" }, - "1286": { + "1284": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "AdminReservationsResource.retrieve" }, - "1287": { + "1285": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "id" }, - "1288": { + "1286": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "customHeaders" }, - "1289": { + "1287": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "AdminReservationsResource.list" }, - "1290": { + "1288": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "AdminReservationsResource.list" }, - "1291": { + "1289": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "query" }, - "1292": { + "1290": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "customHeaders" }, - "1293": { + "1291": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "AdminReservationsResource.create" }, - "1294": { + "1292": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "AdminReservationsResource.create" }, - "1295": { + "1293": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "payload" }, - "1296": { + "1294": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "customHeaders" }, - "1297": { + "1295": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "AdminReservationsResource.update" }, - "1298": { + "1296": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "AdminReservationsResource.update" }, - "1299": { + "1297": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "id" }, - "1300": { + "1298": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "payload" }, - "1301": { + "1299": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "customHeaders" }, - "1302": { + "1300": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "AdminReservationsResource.delete" }, - "1303": { + "1301": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "AdminReservationsResource.delete" }, - "1304": { + "1302": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "id" }, - "1305": { + "1303": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/reservations.ts", "qualifiedName": "customHeaders" }, - "1306": { + "1304": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "AdminReturnReasonsResource" }, - "1307": { + "1305": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1308": { + "1306": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminReturnReasonsResource" }, - "1309": { + "1307": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1310": { + "1308": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "AdminReturnReasonsResource.create" }, - "1311": { + "1309": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "AdminReturnReasonsResource.create" }, - "1312": { + "1310": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "payload" }, - "1313": { + "1311": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "customHeaders" }, - "1314": { + "1312": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "AdminReturnReasonsResource.update" }, - "1315": { + "1313": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "AdminReturnReasonsResource.update" }, - "1316": { + "1314": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "id" }, - "1317": { + "1315": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "payload" }, - "1318": { + "1316": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "customHeaders" }, - "1319": { + "1317": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "AdminReturnReasonsResource.delete" }, - "1320": { + "1318": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "AdminReturnReasonsResource.delete" }, - "1321": { + "1319": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "id" }, - "1322": { + "1320": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "customHeaders" }, - "1323": { + "1321": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "AdminReturnReasonsResource.retrieve" }, - "1324": { + "1322": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "AdminReturnReasonsResource.retrieve" }, - "1325": { + "1323": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "id" }, - "1326": { + "1324": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "customHeaders" }, - "1327": { + "1325": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "AdminReturnReasonsResource.list" }, - "1328": { + "1326": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "AdminReturnReasonsResource.list" }, - "1329": { + "1327": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/return-reasons.ts", "qualifiedName": "customHeaders" }, - "1330": { + "1328": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "AdminReturnsResource" }, - "1331": { + "1329": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1332": { + "1330": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminReturnsResource" }, - "1333": { + "1331": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1334": { + "1332": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "AdminReturnsResource.cancel" }, - "1335": { + "1333": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "AdminReturnsResource.cancel" }, - "1336": { + "1334": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "id" }, - "1337": { + "1335": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "customHeaders" }, - "1338": { + "1336": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "AdminReturnsResource.receive" }, - "1339": { + "1337": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "AdminReturnsResource.receive" }, - "1340": { + "1338": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "id" }, - "1341": { + "1339": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "payload" }, - "1342": { + "1340": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "customHeaders" }, - "1343": { + "1341": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "AdminReturnsResource.list" }, - "1344": { + "1342": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "AdminReturnsResource.list" }, - "1345": { + "1343": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "query" }, - "1346": { + "1344": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/returns.ts", "qualifiedName": "customHeaders" }, - "1347": { + "1345": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource" }, - "1348": { + "1346": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1349": { + "1347": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminSalesChannelsResource" }, - "1350": { + "1348": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1351": { + "1349": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.retrieve" }, - "1352": { + "1350": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.retrieve" }, - "1353": { + "1351": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "salesChannelId" }, - "1354": { + "1352": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "customHeaders" }, - "1355": { + "1353": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.create" }, - "1356": { + "1354": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.create" }, - "1357": { + "1355": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "payload" }, - "1358": { + "1356": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "customHeaders" }, - "1359": { + "1357": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.update" }, - "1360": { + "1358": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.update" }, - "1361": { + "1359": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "salesChannelId" }, - "1362": { + "1360": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "payload" }, - "1363": { + "1361": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "customHeaders" }, - "1364": { + "1362": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.list" }, - "1365": { + "1363": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.list" }, - "1366": { + "1364": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "query" }, - "1367": { + "1365": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "customHeaders" }, - "1368": { + "1366": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.delete" }, - "1369": { + "1367": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.delete" }, - "1370": { + "1368": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "salesChannelId" }, - "1371": { + "1369": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "customHeaders" }, - "1372": { + "1370": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.removeProducts" }, - "1373": { + "1371": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.removeProducts" }, - "1374": { + "1372": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "salesChannelId" }, - "1375": { + "1373": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "payload" }, - "1376": { + "1374": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "customHeaders" }, - "1377": { + "1375": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.addProducts" }, - "1378": { + "1376": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.addProducts" }, - "1379": { + "1377": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "salesChannelId" }, - "1380": { + "1378": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "payload" }, - "1381": { + "1379": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "customHeaders" }, - "1382": { + "1380": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.addLocation" }, - "1383": { + "1381": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.addLocation" }, - "1384": { + "1382": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "salesChannelId" }, - "1385": { + "1383": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "payload" }, - "1386": { + "1384": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "customHeaders" }, - "1387": { + "1385": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.removeLocation" }, - "1388": { + "1386": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "AdminSalesChannelsResource.removeLocation" }, - "1389": { + "1387": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "salesChannelId" }, - "1390": { + "1388": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "payload" }, - "1391": { + "1389": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/sales-channels.ts", "qualifiedName": "customHeaders" }, - "1392": { + "1390": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "AdminShippingOptionsResource" }, - "1393": { + "1391": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1394": { + "1392": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminShippingOptionsResource" }, - "1395": { + "1393": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1396": { + "1394": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "AdminShippingOptionsResource.create" }, - "1397": { + "1395": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "AdminShippingOptionsResource.create" }, - "1398": { + "1396": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "payload" }, - "1399": { + "1397": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "customHeaders" }, - "1400": { + "1398": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "AdminShippingOptionsResource.update" }, - "1401": { + "1399": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "AdminShippingOptionsResource.update" }, - "1402": { + "1400": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "id" }, - "1403": { + "1401": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "payload" }, - "1404": { + "1402": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "customHeaders" }, - "1405": { + "1403": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "AdminShippingOptionsResource.delete" }, - "1406": { + "1404": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "AdminShippingOptionsResource.delete" }, - "1407": { + "1405": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "id" }, - "1408": { + "1406": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "customHeaders" }, - "1409": { + "1407": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "AdminShippingOptionsResource.retrieve" }, - "1410": { + "1408": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "AdminShippingOptionsResource.retrieve" }, - "1411": { + "1409": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "id" }, - "1412": { + "1410": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "customHeaders" }, - "1413": { + "1411": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "AdminShippingOptionsResource.list" }, - "1414": { + "1412": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "AdminShippingOptionsResource.list" }, - "1415": { + "1413": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "query" }, - "1416": { + "1414": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-options.ts", "qualifiedName": "customHeaders" }, - "1417": { + "1415": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "AdminShippingProfilesResource" }, - "1418": { + "1416": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1419": { + "1417": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminShippingProfilesResource" }, - "1420": { + "1418": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1421": { + "1419": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "AdminShippingProfilesResource.create" }, - "1422": { + "1420": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "AdminShippingProfilesResource.create" }, - "1423": { + "1421": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "payload" }, - "1424": { + "1422": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "customHeaders" }, - "1425": { + "1423": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "AdminShippingProfilesResource.update" }, - "1426": { + "1424": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "AdminShippingProfilesResource.update" }, - "1427": { + "1425": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "id" }, - "1428": { + "1426": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "payload" }, - "1429": { + "1427": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "customHeaders" }, - "1430": { + "1428": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "AdminShippingProfilesResource.delete" }, - "1431": { + "1429": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "AdminShippingProfilesResource.delete" }, - "1432": { + "1430": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "id" }, - "1433": { + "1431": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "customHeaders" }, - "1434": { + "1432": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "AdminShippingProfilesResource.retrieve" }, - "1435": { + "1433": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "AdminShippingProfilesResource.retrieve" }, - "1436": { + "1434": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "id" }, - "1437": { + "1435": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "customHeaders" }, - "1438": { + "1436": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "AdminShippingProfilesResource.list" }, - "1439": { + "1437": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "AdminShippingProfilesResource.list" }, - "1440": { + "1438": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/shipping-profiles.ts", "qualifiedName": "customHeaders" }, - "1441": { + "1439": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "AdminStockLocationsResource" }, - "1442": { + "1440": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1443": { + "1441": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminStockLocationsResource" }, - "1444": { + "1442": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1445": { + "1443": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "AdminStockLocationsResource.create" }, - "1446": { + "1444": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "AdminStockLocationsResource.create" }, - "1447": { + "1445": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "payload" }, - "1448": { + "1446": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "customHeaders" }, - "1449": { + "1447": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "AdminStockLocationsResource.retrieve" }, - "1450": { + "1448": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "AdminStockLocationsResource.retrieve" }, - "1451": { + "1449": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "itemId" }, - "1452": { + "1450": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "customHeaders" }, - "1453": { + "1451": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "AdminStockLocationsResource.update" }, - "1454": { + "1452": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "AdminStockLocationsResource.update" }, - "1455": { + "1453": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "stockLocationId" }, - "1456": { + "1454": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "payload" }, - "1457": { + "1455": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "customHeaders" }, - "1458": { + "1456": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "AdminStockLocationsResource.delete" }, - "1459": { + "1457": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "AdminStockLocationsResource.delete" }, - "1460": { + "1458": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "id" }, - "1461": { + "1459": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "customHeaders" }, - "1462": { + "1460": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "AdminStockLocationsResource.list" }, - "1463": { + "1461": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "AdminStockLocationsResource.list" }, - "1464": { + "1462": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "query" }, - "1465": { + "1463": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/stock-locations.ts", "qualifiedName": "customHeaders" }, - "1466": { + "1464": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource" }, - "1467": { + "1465": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1468": { + "1466": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminStoresResource" }, - "1469": { + "1467": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1470": { + "1468": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource.update" }, - "1471": { + "1469": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource.update" }, - "1472": { + "1470": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "payload" }, - "1473": { + "1471": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "customHeaders" }, - "1474": { + "1472": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource.addCurrency" }, - "1475": { + "1473": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource.addCurrency" }, - "1476": { + "1474": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "currency_code" }, - "1477": { + "1475": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "customHeaders" }, - "1478": { + "1476": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource.deleteCurrency" }, - "1479": { + "1477": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource.deleteCurrency" }, - "1480": { + "1478": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "currency_code" }, - "1481": { + "1479": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "customHeaders" }, - "1482": { + "1480": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource.retrieve" }, - "1483": { + "1481": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource.retrieve" }, - "1484": { + "1482": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "customHeaders" }, - "1485": { + "1483": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource.listPaymentProviders" }, - "1486": { + "1484": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource.listPaymentProviders" }, - "1487": { + "1485": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "customHeaders" }, - "1488": { + "1486": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource.listTaxProviders" }, - "1489": { + "1487": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "AdminStoresResource.listTaxProviders" }, - "1490": { + "1488": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/store.ts", "qualifiedName": "customHeaders" }, - "1491": { + "1489": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/swaps.ts", "qualifiedName": "AdminSwapsResource" }, - "1492": { + "1490": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1493": { + "1491": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminSwapsResource" }, - "1494": { + "1492": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1495": { + "1493": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/swaps.ts", "qualifiedName": "AdminSwapsResource.retrieve" }, - "1496": { + "1494": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/swaps.ts", "qualifiedName": "AdminSwapsResource.retrieve" }, - "1497": { + "1495": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/swaps.ts", "qualifiedName": "id" }, - "1498": { + "1496": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/swaps.ts", "qualifiedName": "customHeaders" }, - "1499": { + "1497": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/swaps.ts", "qualifiedName": "AdminSwapsResource.list" }, - "1500": { + "1498": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/swaps.ts", "qualifiedName": "AdminSwapsResource.list" }, - "1501": { + "1499": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/swaps.ts", "qualifiedName": "query" }, - "1502": { + "1500": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/swaps.ts", "qualifiedName": "customHeaders" }, - "1503": { + "1501": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource" }, - "1504": { + "1502": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1505": { + "1503": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminTaxRatesResource" }, - "1506": { + "1504": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1507": { + "1505": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.retrieve" }, - "1508": { + "1506": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.retrieve" }, - "1509": { + "1507": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "id" }, - "1510": { + "1508": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "query" }, - "1511": { + "1509": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "customHeaders" }, - "1512": { + "1510": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.list" }, - "1513": { + "1511": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.list" }, - "1514": { + "1512": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "query" }, - "1515": { + "1513": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "customHeaders" }, - "1516": { + "1514": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.create" }, - "1517": { + "1515": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.create" }, - "1518": { + "1516": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "payload" }, - "1519": { + "1517": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "query" }, - "1520": { + "1518": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "customHeaders" }, - "1521": { + "1519": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.update" }, - "1522": { + "1520": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.update" }, - "1523": { + "1521": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "id" }, - "1524": { + "1522": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "payload" }, - "1525": { + "1523": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "query" }, - "1526": { + "1524": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "customHeaders" }, - "1527": { + "1525": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.addProducts" }, - "1528": { + "1526": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.addProducts" }, - "1529": { + "1527": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "id" }, - "1530": { + "1528": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "payload" }, - "1531": { + "1529": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "query" }, - "1532": { + "1530": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "customHeaders" }, - "1533": { + "1531": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.addProductTypes" }, - "1534": { + "1532": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.addProductTypes" }, - "1535": { + "1533": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "id" }, - "1536": { + "1534": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "payload" }, - "1537": { + "1535": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "query" }, - "1538": { + "1536": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "customHeaders" }, - "1539": { + "1537": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.addShippingOptions" }, - "1540": { + "1538": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.addShippingOptions" }, - "1541": { + "1539": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "id" }, - "1542": { + "1540": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "payload" }, - "1543": { + "1541": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "query" }, - "1544": { + "1542": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "customHeaders" }, - "1545": { + "1543": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.removeProducts" }, - "1546": { + "1544": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.removeProducts" }, - "1547": { + "1545": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "id" }, - "1548": { + "1546": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "payload" }, - "1549": { + "1547": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "query" }, - "1550": { + "1548": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "customHeaders" }, - "1551": { + "1549": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.removeProductTypes" }, - "1552": { + "1550": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.removeProductTypes" }, - "1553": { + "1551": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "id" }, - "1554": { + "1552": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "payload" }, - "1555": { + "1553": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "query" }, - "1556": { + "1554": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "customHeaders" }, - "1557": { + "1555": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.removeShippingOptions" }, - "1558": { + "1556": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.removeShippingOptions" }, - "1559": { + "1557": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "id" }, - "1560": { + "1558": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "payload" }, - "1561": { + "1559": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "query" }, - "1562": { + "1560": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "customHeaders" }, - "1563": { + "1561": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.delete" }, - "1564": { + "1562": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "AdminTaxRatesResource.delete" }, - "1565": { + "1563": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "id" }, - "1566": { + "1564": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/tax-rates.ts", "qualifiedName": "customHeaders" }, - "1567": { + "1565": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "AdminUploadsResource" }, - "1568": { + "1566": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1569": { + "1567": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminUploadsResource" }, - "1570": { + "1568": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1574": { + "1572": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "AdminUploadsResource.create" }, - "1575": { + "1573": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "AdminUploadsResource.create" }, - "1576": { + "1574": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "file" }, - "1577": { + "1575": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "AdminUploadsResource.createProtected" }, - "1578": { + "1576": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "AdminUploadsResource.createProtected" }, - "1579": { + "1577": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "file" }, - "1580": { + "1578": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "AdminUploadsResource.delete" }, - "1581": { + "1579": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "AdminUploadsResource.delete" }, - "1582": { + "1580": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "payload" }, - "1583": { + "1581": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "customHeaders" }, - "1584": { + "1582": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "AdminUploadsResource.getPresignedDownloadUrl" }, - "1585": { + "1583": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "AdminUploadsResource.getPresignedDownloadUrl" }, - "1586": { + "1584": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "payload" }, - "1587": { + "1585": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "customHeaders" }, - "1588": { + "1586": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "AdminUploadsResource._createPayload" }, - "1589": { + "1587": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "AdminUploadsResource._createPayload" }, - "1590": { + "1588": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/uploads.ts", "qualifiedName": "file" }, - "1591": { + "1589": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource" }, - "1592": { + "1590": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1593": { + "1591": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminUsersResource" }, - "1594": { + "1592": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1595": { + "1593": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.sendResetPasswordToken" }, - "1596": { + "1594": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.sendResetPasswordToken" }, - "1597": { + "1595": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "payload" }, - "1598": { + "1596": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "customHeaders" }, - "1599": { + "1597": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.resetPassword" }, - "1600": { + "1598": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.resetPassword" }, - "1601": { + "1599": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "payload" }, - "1602": { + "1600": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "customHeaders" }, - "1603": { + "1601": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.retrieve" }, - "1604": { + "1602": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.retrieve" }, - "1605": { + "1603": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "id" }, - "1606": { + "1604": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "customHeaders" }, - "1607": { + "1605": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.create" }, - "1608": { + "1606": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.create" }, - "1609": { + "1607": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "payload" }, - "1610": { + "1608": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "customHeaders" }, - "1611": { + "1609": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.update" }, - "1612": { + "1610": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.update" }, - "1613": { + "1611": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "id" }, - "1614": { + "1612": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "payload" }, - "1615": { + "1613": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "customHeaders" }, - "1616": { + "1614": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.delete" }, - "1617": { + "1615": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.delete" }, - "1618": { + "1616": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "id" }, - "1619": { + "1617": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "customHeaders" }, - "1620": { + "1618": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.list" }, - "1621": { + "1619": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "AdminUsersResource.list" }, - "1622": { + "1620": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/users.ts", "qualifiedName": "customHeaders" }, - "1623": { + "1621": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "AdminVariantsResource" }, - "1624": { + "1622": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1625": { + "1623": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminVariantsResource" }, - "1626": { + "1624": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1627": { + "1625": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "AdminVariantsResource.list" }, - "1628": { + "1626": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "AdminVariantsResource.list" }, - "1629": { + "1627": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "query" }, - "1630": { + "1628": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "customHeaders" }, - "1631": { + "1629": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "AdminVariantsResource.retrieve" }, - "1632": { + "1630": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "AdminVariantsResource.retrieve" }, - "1633": { + "1631": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "id" }, - "1634": { + "1632": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "query" }, - "1635": { + "1633": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "customHeaders" }, - "1636": { + "1634": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "AdminVariantsResource.getInventory" }, - "1637": { + "1635": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "AdminVariantsResource.getInventory" }, - "1638": { + "1636": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "variantId" }, - "1639": { + "1637": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/variants.ts", "qualifiedName": "customHeaders" }, - "1640": { + "1638": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "AdminPaymentCollectionsResource" }, - "1641": { + "1639": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1642": { + "1640": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminPaymentCollectionsResource" }, - "1643": { + "1641": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1644": { + "1642": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "AdminPaymentCollectionsResource.retrieve" }, - "1645": { + "1643": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "AdminPaymentCollectionsResource.retrieve" }, - "1646": { + "1644": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "id" }, - "1647": { + "1645": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "query" }, - "1648": { + "1646": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "customHeaders" }, - "1649": { + "1647": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "AdminPaymentCollectionsResource.update" }, - "1650": { + "1648": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "AdminPaymentCollectionsResource.update" }, - "1651": { + "1649": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "id" }, - "1652": { + "1650": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "payload" }, - "1653": { + "1651": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "customHeaders" }, - "1654": { + "1652": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "AdminPaymentCollectionsResource.delete" }, - "1655": { + "1653": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "AdminPaymentCollectionsResource.delete" }, - "1656": { + "1654": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "id" }, - "1657": { + "1655": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "customHeaders" }, - "1658": { + "1656": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "AdminPaymentCollectionsResource.markAsAuthorized" }, - "1659": { + "1657": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "AdminPaymentCollectionsResource.markAsAuthorized" }, - "1660": { + "1658": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "id" }, - "1661": { + "1659": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payment-collections.ts", "qualifiedName": "customHeaders" }, - "1662": { + "1660": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "AdminPaymentsResource" }, - "1663": { + "1661": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1664": { + "1662": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminPaymentsResource" }, - "1665": { + "1663": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1666": { + "1664": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "AdminPaymentsResource.retrieve" }, - "1667": { + "1665": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "AdminPaymentsResource.retrieve" }, - "1668": { + "1666": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "id" }, - "1669": { + "1667": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "query" }, - "1670": { + "1668": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "customHeaders" }, - "1671": { + "1669": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "AdminPaymentsResource.capturePayment" }, - "1672": { + "1670": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "AdminPaymentsResource.capturePayment" }, - "1673": { + "1671": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "id" }, - "1674": { + "1672": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "customHeaders" }, - "1675": { + "1673": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "AdminPaymentsResource.refundPayment" }, - "1676": { + "1674": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "AdminPaymentsResource.refundPayment" }, - "1677": { + "1675": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "id" }, - "1678": { + "1676": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "payload" }, - "1679": { + "1677": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/payments.ts", "qualifiedName": "customHeaders" }, - "1680": { + "1678": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource" }, - "1681": { + "1679": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "default.__constructor" }, - "1682": { + "1680": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "AdminProductCategoriesResource" }, - "1683": { + "1681": { "sourceFileName": "../../../packages/medusa-js/src/resources/base.ts", "qualifiedName": "client" }, - "1684": { + "1682": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.retrieve" }, - "1685": { + "1683": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.retrieve" }, - "1686": { + "1684": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "productCategoryId" }, - "1687": { + "1685": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "query" }, - "1688": { + "1686": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "customHeaders" }, - "1689": { + "1687": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.create" }, - "1690": { + "1688": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.create" }, - "1691": { + "1689": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "payload" }, - "1692": { + "1690": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "customHeaders" }, - "1693": { + "1691": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.update" }, - "1694": { + "1692": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.update" }, - "1695": { + "1693": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "productCategoryId" }, - "1696": { + "1694": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "payload" }, - "1697": { + "1695": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "customHeaders" }, - "1698": { + "1696": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.list" }, - "1699": { + "1697": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.list" }, - "1700": { + "1698": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "query" }, - "1701": { + "1699": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "customHeaders" }, - "1702": { + "1700": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.delete" }, - "1703": { + "1701": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.delete" }, - "1704": { + "1702": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "productCategoryId" }, - "1705": { + "1703": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "customHeaders" }, - "1706": { + "1704": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.removeProducts" }, - "1707": { + "1705": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.removeProducts" }, - "1708": { + "1706": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "productCategoryId" }, - "1709": { + "1707": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "payload" }, - "1710": { + "1708": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "customHeaders" }, - "1711": { + "1709": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.addProducts" }, - "1712": { + "1710": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "AdminProductCategoriesResource.addProducts" }, - "1713": { + "1711": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "productCategoryId" }, - "1714": { + "1712": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "payload" }, - "1715": { + "1713": { "sourceFileName": "../../../packages/medusa-js/src/resources/admin/product-categories.ts", "qualifiedName": "customHeaders" } diff --git a/docs-util/typedoc-json-output/medusa-react.json b/docs-util/typedoc-json-output/medusa-react.json new file mode 100644 index 0000000000000..bd67effdb2eea --- /dev/null +++ b/docs-util/typedoc-json-output/medusa-react.json @@ -0,0 +1,113047 @@ +{ + "id": 0, + "name": "medusa-react", + "variant": "project", + "kind": 1, + "flags": {}, + "children": [ + { + "id": 6, + "name": "Hooks", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 7, + "name": "Admin", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@namespaceMember" + ] + }, + "children": [ + { + "id": 8, + "name": "Auth", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and mutations listed here are used to send requests to the [Admin Auth API Routes](https://docs.medusajs.com/api/admin#auth_getauth).\n\nThey allow admin users to manage their session, such as login or log out.\nYou can send authenticated requests for an admin user either using the Cookie header, their API token, or the JWT Token.\nWhen you log the admin user in using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": " hook, Medusa React will automatically attach the\ncookie header in all subsequent requests.\n\nRelated Guide: [How to implement user profiles](https://docs.medusajs.com/modules/users/admin/manage-profile)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 856, + "name": "useAdminDeleteSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 857, + "name": "useAdminDeleteSession", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook is used to Log out the user and remove their authentication session. This will only work if you're using Cookie session for authentication. If the API token is still passed in the header,\nthe user is still authorized to perform admin functionalities in other API Routes.\n\nThis hook requires " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteSession } from \"medusa-react\"\n\nconst Logout = () => {\n const adminLogout = useAdminDeleteSession()\n // ...\n\n const handleLogout = () => {\n adminLogout.mutate(undefined, {\n onSuccess: () => {\n // user logged out.\n }\n })\n }\n\n // ...\n}\n\nexport default Logout\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 858, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 838, + "name": "useAdminGetSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 839, + "name": "useAdminGetSession", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook is used to get the currently logged in user's details. Can also be used to check if there is an authenticated user.\n\nThis hook requires " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminGetSession } from \"medusa-react\"\n\nconst Profile = () => {\n const { user, isLoading } = useAdminGetSession()\n\n return (\n
\n {isLoading && Loading...}\n {user && {user.email}}\n
\n )\n}\n\nexport default Profile\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 840, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/auth/index.d.ts", + "qualifiedName": "AdminAuthRes" + }, + "name": "AdminAuthRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_auth" + }, + { + "type": "literal", + "value": "detail" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 841, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 843, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 842, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/user.d.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 843, + 842 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 844, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 846, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 845, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/user.d.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 846, + 845 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 847, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 849, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 848, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/user.d.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 849, + 848 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 850, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 852, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 851, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/user.d.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 852, + 851 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 853, + "name": "useAdminLogin", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 854, + "name": "useAdminLogin", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook is used to log a User in using their credentials. If the user is authenticated successfully, \nthe cookie is automatically attached to subsequent requests sent with other hooks." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminLogin } from \"medusa-react\"\n\nconst Login = () => {\n const adminLogin = useAdminLogin()\n // ...\n\n const handleLogin = () => {\n adminLogin.mutate({\n email: \"user@example.com\",\n password: \"supersecret\",\n }, {\n onSuccess: ({ user }) => {\n console.log(user)\n }\n })\n }\n\n // ...\n}\n\nexport default Login\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 855, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "stuff again" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/auth/index.d.ts", + "qualifiedName": "AdminAuthRes" + }, + "name": "AdminAuthRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/auth/create-session.d.ts", + "qualifiedName": "AdminPostAuthReq" + }, + "name": "AdminPostAuthReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/auth/index.d.ts", + "qualifiedName": "AdminAuthRes" + }, + "name": "AdminAuthRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/auth/create-session.d.ts", + "qualifiedName": "AdminPostAuthReq" + }, + "name": "AdminPostAuthReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 856, + 838, + 853 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 838 + ] + }, + { + "title": "Mutations", + "children": [ + 853, + 856 + ] + } + ] + }, + { + "id": 9, + "name": "Batch Jobs", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and mutations listed here are used to send requests to the [Admin Batch Job API Routes](https://docs.medusajs.com/api/admin#batch-jobs).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA batch job is a task that is performed by the Medusa backend asynchronusly. For example, the Import Product feature is implemented using batch jobs.\nThe methods in this class allow admins to manage the batch jobs and their state.\n\nRelated Guide: [How to import products](https://docs.medusajs.com/modules/products/admin/import-products)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 890, + "name": "useAdminBatchJob", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 891, + "name": "useAdminBatchJob", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves the details of a batch job." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminBatchJob } from \"medusa-react\"\n\ntype Props = {\n batchJobId: string\n}\n\nconst BatchJob = ({ batchJobId }: Props) => {\n const { batch_job, isLoading } = useAdminBatchJob(batchJobId)\n\n return (\n
\n {isLoading && Loading...}\n {batch_job && {batch_job.created_by}}\n
\n )\n}\n\nexport default BatchJob\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 892, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the batch job." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 893, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "AdminBatchJobRes" + }, + "name": "AdminBatchJobRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_batches" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 894, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 895, + "name": "batch_job", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/batch-job.d.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" + } + }, + { + "id": 896, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 895, + 896 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 897, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 898, + "name": "batch_job", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/batch-job.d.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" + } + }, + { + "id": 899, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 898, + 899 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 900, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 901, + "name": "batch_job", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/batch-job.d.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" + } + }, + { + "id": 902, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 901, + 902 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 903, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 904, + "name": "batch_job", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/batch-job.d.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" + } + }, + { + "id": 905, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 904, + 905 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 860, + "name": "useAdminBatchJobs", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 861, + "name": "useAdminBatchJobs", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of Batch Jobs. The batch jobs can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`type`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`confirmed_at`" + }, + { + "kind": "text", + "text": ". The batch jobs can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list batch jobs:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminBatchJobs } from \"medusa-react\"\n\nconst BatchJobs = () => {\n const { \n batch_jobs, \n limit,\n offset,\n count,\n isLoading\n } = useAdminBatchJobs()\n\n return (\n
\n {isLoading && Loading...}\n {batch_jobs?.length && (\n
    \n {batch_jobs.map((batchJob) => (\n
  • \n {batchJob.id}\n
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default BatchJobs\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the batch jobs:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminBatchJobs } from \"medusa-react\"\n\nconst BatchJobs = () => {\n const { \n batch_jobs, \n limit,\n offset,\n count,\n isLoading\n } = useAdminBatchJobs({\n expand: \"created_by_user\",\n limit: 10,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {batch_jobs?.length && (\n
    \n {batch_jobs.map((batchJob) => (\n
  • \n {batchJob.id}\n
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default BatchJobs\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`10`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminBatchJobs } from \"medusa-react\"\n\nconst BatchJobs = () => {\n const { \n batch_jobs, \n limit,\n offset,\n count,\n isLoading\n } = useAdminBatchJobs({\n expand: \"created_by_user\",\n limit: 20,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {batch_jobs?.length && (\n
    \n {batch_jobs.map((batchJob) => (\n
  • \n {batchJob.id}\n
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default BatchJobs\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 862, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved batch jobs." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts", + "qualifiedName": "AdminGetBatchParams" + }, + "name": "AdminGetBatchParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 863, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "AdminBatchJobListRes" + }, + "name": "AdminBatchJobListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_batches" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 864, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 865, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 865 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 866, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 870, + "name": "batch_jobs", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/batch-job.d.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 869, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 867, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 868, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 871, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 870, + 869, + 867, + 868, + 871 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 872, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 876, + "name": "batch_jobs", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/batch-job.d.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 875, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 873, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 874, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 877, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 876, + 875, + 873, + 874, + 877 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 878, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 882, + "name": "batch_jobs", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/batch-job.d.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 881, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 879, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 880, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 883, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 882, + 881, + 879, + 880, + 883 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 884, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 888, + "name": "batch_jobs", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/batch-job.d.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 887, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 885, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 886, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 889, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 888, + 887, + 885, + 886, + 889 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 909, + "name": "useAdminCancelBatchJob", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 910, + "name": "useAdminCancelBatchJob", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook marks a batch job as canceled. When a batch job is canceled, the processing of the batch job doesn’t automatically stop." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCancelBatchJob } from \"medusa-react\"\n\ntype Props = {\n batchJobId: string\n}\n\nconst BatchJob = ({ batchJobId }: Props) => {\n const cancelBatchJob = useAdminCancelBatchJob(batchJobId)\n // ...\n\n const handleCancel = () => {\n cancelBatchJob.mutate(undefined, {\n onSuccess: ({ batch_job }) => {\n console.log(batch_job)\n }\n })\n }\n\n // ...\n}\n\nexport default BatchJob\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 911, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the batch job." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 912, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "AdminBatchJobRes" + }, + "name": "AdminBatchJobRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "AdminBatchJobRes" + }, + "name": "AdminBatchJobRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 906, + "name": "useAdminCreateBatchJob", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 907, + "name": "useAdminCreateBatchJob", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a Batch Job to be executed asynchronously in the Medusa backend. If " + }, + { + "kind": "code", + "text": "`dry_run`" + }, + { + "kind": "text", + "text": " is set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the batch job will not be executed until the it is confirmed,\nwhich can be done using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useAdminConfirmBatchJob", + "target": 913, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " hook." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateBatchJob } from \"medusa-react\"\n\nconst CreateBatchJob = () => {\n const createBatchJob = useAdminCreateBatchJob()\n // ...\n\n const handleCreateBatchJob = () => {\n createBatchJob.mutate({\n type: \"publish-products\",\n context: {},\n dry_run: true\n }, {\n onSuccess: ({ batch_job }) => {\n console.log(batch_job)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateBatchJob\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 908, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "AdminBatchJobRes" + }, + "name": "AdminBatchJobRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts", + "qualifiedName": "AdminPostBatchesReq" + }, + "name": "AdminPostBatchesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "AdminBatchJobRes" + }, + "name": "AdminBatchJobRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts", + "qualifiedName": "AdminPostBatchesReq" + }, + "name": "AdminPostBatchesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 890, + 860, + 909, + 906 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 860, + 890 + ] + }, + { + "title": "Mutations", + "children": [ + 906, + 909 + ] + } + ] + }, + { + "id": 10, + "name": "Claims", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Mutations listed here are used to send requests to the [Admin Order API Routes related to claims](https://docs.medusajs.com/api/admin#orders).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA claim represents a return or replacement request of order items. It allows refunding the customer or replacing some or all of its\norder items with new items.\n\nRelated Guide: [How to manage claims](https://docs.medusajs.com/modules/orders/admin/manage-claims)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 928, + "name": "useAdminCancelClaim", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 929, + "name": "useAdminCancelClaim", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook cancels a claim and change its status. A claim can't be canceled if it has a refund, if its fulfillments haven't been canceled, \nof if its associated return hasn't been canceled." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The claim's ID." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCancelClaim } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n claimId: string\n}\n\nconst Claim = ({ orderId, claimId }: Props) => {\n const cancelClaim = useAdminCancelClaim(orderId)\n // ...\n\n const handleCancel = () => {\n cancelClaim.mutate(claimId)\n }\n\n // ...\n}\n\nexport default Claim\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 930, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the order the claim is associated with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 931, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 944, + "name": "useAdminCancelClaimFulfillment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 945, + "name": "useAdminCancelClaimFulfillment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook cancels a claim's fulfillment and change its fulfillment status to " + }, + { + "kind": "code", + "text": "`canceled`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCancelClaimFulfillment } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n claimId: string\n}\n\nconst Claim = ({ orderId, claimId }: Props) => {\n const cancelFulfillment = useAdminCancelClaimFulfillment(\n orderId\n )\n // ...\n\n const handleCancel = (fulfillmentId: string) => {\n cancelFulfillment.mutate({\n claim_id: claimId,\n fulfillment_id: fulfillmentId,\n }, {\n onSuccess: ({ order }) => {\n console.log(order.claims)\n }\n })\n }\n\n // ...\n}\n\nexport default Claim\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 946, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the order the claim is associated with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 947, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 940, + "name": "AdminCancelClaimFulfillmentReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 940, + "name": "AdminCancelClaimFulfillmentReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 917, + "name": "useAdminCreateClaim", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 918, + "name": "useAdminCreateClaim", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates 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 " + }, + { + "kind": "code", + "text": "`refund`" + }, + { + "kind": "text", + "text": ",\nthe refund is processed as well." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateClaim } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst CreateClaim = ({ orderId }: Props) => {\n const createClaim = useAdminCreateClaim(orderId)\n // ...\n\n const handleCreate = (itemId: string) => {\n createClaim.mutate({\n type: \"refund\",\n claim_items: [\n {\n item_id: itemId,\n quantity: 1,\n },\n ],\n }, {\n onSuccess: ({ order }) => {\n console.log(order.claims)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateClaim\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 919, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the order the claim is associated with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 920, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts", + "qualifiedName": "AdminPostOrdersOrderClaimsReq" + }, + "name": "AdminPostOrdersOrderClaimsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts", + "qualifiedName": "AdminPostOrdersOrderClaimsReq" + }, + "name": "AdminPostOrdersOrderClaimsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 948, + "name": "useAdminCreateClaimShipment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 949, + "name": "useAdminCreateClaimShipment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a shipment for the claim and mark its fulfillment as shipped. If the shipment is created successfully, this changes the claim's fulfillment status\nto either " + }, + { + "kind": "code", + "text": "`partially_shipped`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`shipped`" + }, + { + "kind": "text", + "text": ", depending on whether all the items were shipped." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateClaimShipment } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n claimId: string\n}\n\nconst Claim = ({ orderId, claimId }: Props) => {\n const createShipment = useAdminCreateClaimShipment(orderId)\n // ...\n\n const handleCreateShipment = (fulfillmentId: string) => {\n createShipment.mutate({\n claim_id: claimId,\n fulfillment_id: fulfillmentId,\n }, {\n onSuccess: ({ order }) => {\n console.log(order.claims)\n }\n })\n }\n\n // ...\n}\n\nexport default Claim\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 950, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the order the claim is associated with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 951, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts", + "qualifiedName": "AdminPostOrdersOrderClaimsClaimShipmentsReq" + }, + "name": "AdminPostOrdersOrderClaimsClaimShipmentsReq", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 952, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 953, + "name": "claim_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 953 + ] + } + ] + } + } + ] + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts", + "qualifiedName": "AdminPostOrdersOrderClaimsClaimShipmentsReq" + }, + "name": "AdminPostOrdersOrderClaimsClaimShipmentsReq", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 954, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 955, + "name": "claim_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 955 + ] + } + ] + } + } + ] + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 932, + "name": "useAdminFulfillClaim", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 933, + "name": "useAdminFulfillClaim", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a Fulfillment for a Claim, and change its fulfillment status to " + }, + { + "kind": "code", + "text": "`partially_fulfilled`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`fulfilled`" + }, + { + "kind": "text", + "text": " depending on whether all the items were fulfilled.\nIt may also change the status to " + }, + { + "kind": "code", + "text": "`requires_action`" + }, + { + "kind": "text", + "text": " if any actions are required." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminFulfillClaim } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n claimId: string\n}\n\nconst Claim = ({ orderId, claimId }: Props) => {\n const fulfillClaim = useAdminFulfillClaim(orderId)\n // ...\n\n const handleFulfill = () => {\n fulfillClaim.mutate({\n claim_id: claimId,\n }, {\n onSuccess: ({ order }) => {\n console.log(order.claims)\n }\n })\n }\n\n // ...\n}\n\nexport default Claim\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 934, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the order the claim is associated with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 935, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts", + "qualifiedName": "AdminPostOrdersOrderClaimsClaimFulfillmentsReq" + }, + "name": "AdminPostOrdersOrderClaimsClaimFulfillmentsReq", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 936, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 937, + "name": "claim_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 937 + ] + } + ] + } + } + ] + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts", + "qualifiedName": "AdminPostOrdersOrderClaimsClaimFulfillmentsReq" + }, + "name": "AdminPostOrdersOrderClaimsClaimFulfillmentsReq", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 938, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 939, + "name": "claim_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 939 + ] + } + ] + } + } + ] + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 924, + "name": "useAdminUpdateClaim", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 925, + "name": "useAdminUpdateClaim", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a claim's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateClaim } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n claimId: string\n}\n\nconst Claim = ({ orderId, claimId }: Props) => {\n const updateClaim = useAdminUpdateClaim(orderId)\n // ...\n\n const handleUpdate = () => {\n updateClaim.mutate({\n claim_id: claimId,\n no_notification: false\n }, {\n onSuccess: ({ order }) => {\n console.log(order.claims)\n }\n })\n }\n\n // ...\n}\n\nexport default Claim\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 926, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the order the claim is associated with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 927, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 921, + "name": "AdminUpdateClaimReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 921, + "name": "AdminUpdateClaimReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 928, + 944, + 917, + 948, + 932, + 924 + ] + } + ], + "categories": [ + { + "title": "Mutations", + "children": [ + 917, + 924, + 928, + 932, + 944, + 948 + ] + } + ] + }, + { + "id": 12, + "name": "Currencies", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Currency API Routes](https://docs.medusajs.com/api/admin#currencies).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA store can use unlimited currencies, and each region must be associated with at least one currency.\nCurrencies are defined within the Medusa backend. The methods in this class allow admins to list and update currencies.\n\nRelated Guide: [How to manage currencies](https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-currencies)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1027, + "name": "useAdminCurrencies", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1028, + "name": "useAdminCurrencies", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of currencies. The currencies can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`code`" + }, + { + "kind": "text", + "text": ". \nThe currencies can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list currencies:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCurrencies } from \"medusa-react\"\n\nconst Currencies = () => {\n const { currencies, isLoading } = useAdminCurrencies()\n\n return (\n
\n {isLoading && Loading...}\n {currencies && !currencies.length && (\n No Currencies\n )}\n {currencies && currencies.length > 0 && (\n
    \n {currencies.map((currency) => (\n
  • {currency.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Currencies\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`20`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCurrencies } from \"medusa-react\"\n\nconst Currencies = () => {\n const { currencies, limit, offset, isLoading } = useAdminCurrencies({\n limit: 10,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {currencies && !currencies.length && (\n No Currencies\n )}\n {currencies && currencies.length > 0 && (\n
    \n {currencies.map((currency) => (\n
  • {currency.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Currencies\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1029, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on retrieved currencies." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/currencies/list-currencies.d.ts", + "qualifiedName": "AdminGetCurrenciesParams" + }, + "name": "AdminGetCurrenciesParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1030, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/currencies/index.d.ts", + "qualifiedName": "AdminCurrenciesListRes" + }, + "name": "AdminCurrenciesListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_currencies" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1031, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1032, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1032 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1033, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1036, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1037, + "name": "currencies", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/currency.d.ts", + "qualifiedName": "Currency" + }, + "name": "Currency", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1034, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1035, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1038, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1036, + 1037, + 1034, + 1035, + 1038 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1039, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1042, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1043, + "name": "currencies", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/currency.d.ts", + "qualifiedName": "Currency" + }, + "name": "Currency", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1040, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1041, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1044, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1042, + 1043, + 1040, + 1041, + 1044 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1045, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1048, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1049, + "name": "currencies", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/currency.d.ts", + "qualifiedName": "Currency" + }, + "name": "Currency", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1046, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1047, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1050, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1048, + 1049, + 1046, + 1047, + 1050 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1051, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1054, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1055, + "name": "currencies", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/currency.d.ts", + "qualifiedName": "Currency" + }, + "name": "Currency", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1052, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1053, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1056, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1054, + 1055, + 1052, + 1053, + 1056 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1022, + "name": "useAdminUpdateCurrency", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1023, + "name": "useAdminUpdateCurrency", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a currency's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateCurrency } from \"medusa-react\"\n\ntype Props = {\n currencyCode: string\n}\n\nconst Currency = ({ currencyCode }: Props) => {\n const updateCurrency = useAdminUpdateCurrency(currencyCode)\n // ...\n\n const handleUpdate = (includes_tax: boolean) => {\n updateCurrency.mutate({\n includes_tax,\n }, {\n onSuccess: ({ currency }) => {\n console.log(currency)\n }\n })\n }\n\n // ...\n}\n\nexport default Currency\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1024, + "name": "code", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currency's code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1025, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/currencies/index.d.ts", + "qualifiedName": "AdminCurrenciesRes" + }, + "name": "AdminCurrenciesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/currencies/update-currency.d.ts", + "qualifiedName": "AdminPostCurrenciesCurrencyReq" + }, + "name": "AdminPostCurrenciesCurrencyReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/currencies/index.d.ts", + "qualifiedName": "AdminCurrenciesRes" + }, + "name": "AdminCurrenciesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/currencies/update-currency.d.ts", + "qualifiedName": "AdminPostCurrenciesCurrencyReq" + }, + "name": "AdminPostCurrenciesCurrencyReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1027, + 1022 + ] + } + ], + "categories": [ + { + "title": "Mutations", + "children": [ + 1022 + ] + }, + { + "title": "Queries", + "children": [ + 1027 + ] + } + ] + }, + { + "id": 13, + "name": "Custom", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This class is used to send requests custom API Routes. All its method\nare available in the JS Client under the " + }, + { + "kind": "code", + "text": "`medusa.admin.custom`" + }, + { + "kind": "text", + "text": " property." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1057, + "name": "useAdminCustomDelete", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1058, + "name": "useAdminCustomDelete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook sends a " + }, + { + "kind": "code", + "text": "`DELETE`" + }, + { + "kind": "text", + "text": " request to a custom API Route." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "TResponse - The response based on the type provided for " + }, + { + "kind": "code", + "text": "`TResponse`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCustomDelete } from \"medusa-react\"\n\ntype Props = {\n customId: string\n}\n\nconst Custom = ({ customId }: Props) => {\n const customDelete = useAdminCustomDelete(\n `/blog/posts/${customId}`,\n [\"posts\"]\n )\n\n // ...\n\n const handleAction = (title: string) => {\n customDelete.mutate(void 0, {\n onSuccess: () => {\n // Delete action successful\n }\n })\n }\n\n // ...\n}\n\nexport default Custom\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 1059, + "name": "TResponse", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The response's type which defaults to " + }, + { + "kind": "code", + "text": "`any`" + }, + { + "kind": "text", + "text": "." + } + ] + } + } + ], + "parameters": [ + { + "id": 1060, + "name": "path", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The path to the custom endpoint." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1061, + "name": "queryKey", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of query keys, used to invalidate data." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@tanstack/query-core/build/lib/types.d.ts", + "qualifiedName": "QueryKey" + }, + "name": "QueryKey", + "package": "@tanstack/query-core" + } + }, + { + "id": 1062, + "name": "relatedDomains", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of related domains that should be invalidated and refetch when the mutation\nfunction is invoked." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "RelatedDomains" + }, + "name": "RelatedDomains", + "package": "medusa-react" + } + }, + { + "id": 1063, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "TResponse", + "refersToTypeParameter": true + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "TResponse", + "refersToTypeParameter": true + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1064, + "name": "useAdminCustomPost", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1065, + "name": "useAdminCustomPost", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook sends a " + }, + { + "kind": "code", + "text": "`POST`" + }, + { + "kind": "text", + "text": " request to a custom API Route." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "TResponse - The response based on the specified type for " + }, + { + "kind": "code", + "text": "`TResponse`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "TPayload - The payload based on the specified type for " + }, + { + "kind": "code", + "text": "`TPayload`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCustomPost } from \"medusa-react\"\nimport Post from \"./models/Post\"\n\ntype PostRequest = {\n title: string\n}\ntype PostResponse = {\n post: Post\n}\n\nconst Custom = () => {\n const customPost = useAdminCustomPost\n (\n \"/blog/posts\",\n [\"posts\"]\n )\n\n // ...\n\n const handleAction = (title: string) => {\n customPost.mutate({\n title\n }, {\n onSuccess: ({ post }) => {\n console.log(post)\n }\n })\n }\n\n // ...\n}\n\nexport default Custom\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 1066, + "name": "TPayload", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of accepted body parameters which defaults to " + }, + { + "kind": "code", + "text": "`Record`" + }, + { + "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": "any" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1067, + "name": "TResponse", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of response, which defaults to " + }, + { + "kind": "code", + "text": "`any`" + }, + { + "kind": "text", + "text": "." + } + ] + } + } + ], + "parameters": [ + { + "id": 1068, + "name": "path", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The path to the custom endpoint." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1069, + "name": "queryKey", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of query keys, used to invalidate data." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@tanstack/query-core/build/lib/types.d.ts", + "qualifiedName": "QueryKey" + }, + "name": "QueryKey", + "package": "@tanstack/query-core" + } + }, + { + "id": 1070, + "name": "relatedDomains", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of related domains that should be invalidated and refetch when the mutation\nfunction is invoked." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "RelatedDomains" + }, + "name": "RelatedDomains", + "package": "medusa-react" + } + }, + { + "id": 1071, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "TResponse", + "refersToTypeParameter": true + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": -1, + "name": "TPayload", + "refersToTypeParameter": true + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "TResponse", + "refersToTypeParameter": true + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": -1, + "name": "TPayload", + "refersToTypeParameter": true + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1072, + "name": "useAdminCustomQuery", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1073, + "name": "useAdminCustomQuery", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook sends a " + }, + { + "kind": "code", + "text": "`GET`" + }, + { + "kind": "text", + "text": " request to a custom API Route." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "TQuery - The query parameters based on the type specified for " + }, + { + "kind": "code", + "text": "`TQuery`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "TResponse - The response based on the type specified for " + }, + { + "kind": "code", + "text": "`TResponse`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCustomQuery } from \"medusa-react\"\nimport Post from \"./models/Post\"\n\ntype RequestQuery = {\n title: string\n}\n\ntype ResponseData = {\n posts: Post\n}\n\nconst Custom = () => {\n const { data, isLoading } = useAdminCustomQuery\n (\n \"/blog/posts\",\n [\"posts\"],\n {\n title: \"My post\"\n }\n )\n\n return (\n
\n {isLoading && Loading...}\n {data?.posts && !data.posts.length && (\n No Post\n )}\n {data?.posts && data.posts?.length > 0 && (\n
    \n {data.posts.map((post) => (\n
  • {post.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Custom\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 1074, + "name": "TQuery", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of accepted query parameters which defaults to " + }, + { + "kind": "code", + "text": "`Record`" + }, + { + "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": "any" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1075, + "name": "TResponse", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of response which defaults to " + }, + { + "kind": "code", + "text": "`any`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "default": { + "type": "intrinsic", + "name": "any" + } + } + ], + "parameters": [ + { + "id": 1076, + "name": "path", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The path to the custom endpoint." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1077, + "name": "queryKey", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of query keys, used to invalidate data." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@tanstack/query-core/build/lib/types.d.ts", + "qualifiedName": "QueryKey" + }, + "name": "QueryKey", + "package": "@tanstack/query-core" + } + }, + { + "id": 1078, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Query parameters to pass to the request." + } + ] + }, + "type": { + "type": "reference", + "target": -1, + "name": "TQuery", + "refersToTypeParameter": true + } + }, + { + "id": 1079, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "TResponse", + "refersToTypeParameter": true + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@tanstack/query-core/build/lib/types.d.ts", + "qualifiedName": "QueryKey" + }, + "name": "QueryKey", + "package": "@tanstack/query-core" + }, + { + "type": "reference", + "target": -1, + "name": "TQuery", + "refersToTypeParameter": true + } + ] + } + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1080, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1081, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "TResponse", + "refersToTypeParameter": true + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1081 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1082, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1083, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "TResponse", + "refersToTypeParameter": true + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1083 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1084, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1085, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "TResponse", + "refersToTypeParameter": true + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1085 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1086, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1087, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "TResponse", + "refersToTypeParameter": true + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1087 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1057, + 1064, + 1072 + ] + } + ], + "categories": [ + { + "title": "Mutations", + "children": [ + 1057, + 1064, + 1072 + ] + } + ] + }, + { + "id": 14, + "name": "Customer Groups", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Customer Group API Routes](https://docs.medusajs.com/api/admin#customer-groups).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nCustomer Groups can be used to organize customers that share similar data or attributes into dedicated groups.\nThis can be useful for different purposes such as setting a different price for a specific customer group.\n\nRelated Guide: [How to manage customer groups](https://docs.medusajs.com/modules/customers/admin/manage-customer-groups)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1212, + "name": "useAdminAddCustomersToCustomerGroup", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1213, + "name": "useAdminAddCustomersToCustomerGroup", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The hook adds a list of customers to a customer group." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminAddCustomersToCustomerGroup,\n} from \"medusa-react\"\n\ntype Props = {\n customerGroupId: string\n}\n\nconst CustomerGroup = ({ customerGroupId }: Props) => {\n const addCustomers = useAdminAddCustomersToCustomerGroup(\n customerGroupId\n )\n // ...\n\n const handleAddCustomers= (customerId: string) => {\n addCustomers.mutate({\n customer_ids: [\n {\n id: customerId,\n },\n ],\n })\n }\n\n // ...\n}\n\nexport default CustomerGroup\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1214, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer group's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1215, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "AdminCustomerGroupsRes" + }, + "name": "AdminCustomerGroupsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/add-customers-batch.d.ts", + "qualifiedName": "AdminPostCustomerGroupsGroupCustomersBatchReq" + }, + "name": "AdminPostCustomerGroupsGroupCustomersBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "AdminCustomerGroupsRes" + }, + "name": "AdminCustomerGroupsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/add-customers-batch.d.ts", + "qualifiedName": "AdminPostCustomerGroupsGroupCustomersBatchReq" + }, + "name": "AdminPostCustomerGroupsGroupCustomersBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1201, + "name": "useAdminCreateCustomerGroup", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1202, + "name": "useAdminCreateCustomerGroup", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a customer group." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateCustomerGroup } from \"medusa-react\"\n\nconst CreateCustomerGroup = () => {\n const createCustomerGroup = useAdminCreateCustomerGroup()\n // ...\n\n const handleCreate = (name: string) => {\n createCustomerGroup.mutate({\n name,\n })\n }\n\n // ...\n}\n\nexport default CreateCustomerGroup\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1203, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "AdminCustomerGroupsRes" + }, + "name": "AdminCustomerGroupsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts", + "qualifiedName": "AdminPostCustomerGroupsReq" + }, + "name": "AdminPostCustomerGroupsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "AdminCustomerGroupsRes" + }, + "name": "AdminCustomerGroupsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts", + "qualifiedName": "AdminPostCustomerGroupsReq" + }, + "name": "AdminPostCustomerGroupsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1118, + "name": "useAdminCustomerGroup", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1119, + "name": "useAdminCustomerGroup", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a customer group by its ID. You can expand the customer group's relations or \nselect the fields that should be returned." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCustomerGroup } from \"medusa-react\"\n\ntype Props = {\n customerGroupId: string\n}\n\nconst CustomerGroup = ({ customerGroupId }: Props) => {\n const { customer_group, isLoading } = useAdminCustomerGroup(\n customerGroupId\n )\n\n return (\n
\n {isLoading && Loading...}\n {customer_group && {customer_group.name}}\n
\n )\n}\n\nexport default CustomerGroup\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1120, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer group's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1121, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configurations to apply on the retrieved customer group." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/get-customer-group.d.ts", + "qualifiedName": "AdminGetCustomerGroupsGroupParams" + }, + "name": "AdminGetCustomerGroupsGroupParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1122, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "AdminCustomerGroupsRes" + }, + "name": "AdminCustomerGroupsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_customer_groups" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1123, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1124, + "name": "customer_group", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer-group.d.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + }, + { + "id": 1125, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1124, + 1125 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1126, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1127, + "name": "customer_group", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer-group.d.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + }, + { + "id": 1128, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1127, + 1128 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1129, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1130, + "name": "customer_group", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer-group.d.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + }, + { + "id": 1131, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1130, + 1131 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1132, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1133, + "name": "customer_group", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer-group.d.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + }, + { + "id": 1134, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1133, + 1134 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1165, + "name": "useAdminCustomerGroupCustomers", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1166, + "name": "useAdminCustomerGroupCustomers", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of customers in a customer group. The customers can be filtered \nby the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " field. The customers can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCustomerGroupCustomers } from \"medusa-react\"\n\ntype Props = {\n customerGroupId: string\n}\n\nconst CustomerGroup = ({ customerGroupId }: Props) => {\n const { \n customers, \n isLoading,\n } = useAdminCustomerGroupCustomers(\n customerGroupId\n )\n\n return (\n
\n {isLoading && Loading...}\n {customers && !customers.length && (\n No customers\n )}\n {customers && customers.length > 0 && (\n
    \n {customers.map((customer) => (\n
  • {customer.first_name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default CustomerGroup\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1167, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer group's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1168, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved customers." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts", + "qualifiedName": "AdminGetCustomersParams" + }, + "name": "AdminGetCustomersParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1169, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "AdminCustomersListRes" + }, + "name": "AdminCustomersListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1170, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1173, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "inline-tag", + "tag": "@inheritDoc", + "text": "FindParams.expand" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1176, + "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": 1175, + "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": 1171, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "inline-tag", + "tag": "@inheritDoc", + "text": "FindPaginationParams.limit" + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n50\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1172, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "inline-tag", + "tag": "@inheritDoc", + "text": "FindPaginationParams.offset" + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1174, + "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": "Properties", + "children": [ + 1173, + 1176, + 1175, + 1171, + 1172, + 1174 + ] + } + ] + } + } + ] + } + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1177, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1180, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1181, + "name": "customers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1178, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1179, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1182, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1180, + 1181, + 1178, + 1179, + 1182 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1183, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1186, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1187, + "name": "customers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1184, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1185, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1188, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1186, + 1187, + 1184, + 1185, + 1188 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1189, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1192, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1193, + "name": "customers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1190, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1191, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1194, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1192, + 1193, + 1190, + 1191, + 1194 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1195, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1198, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1199, + "name": "customers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1196, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1197, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1200, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1198, + 1199, + 1196, + 1197, + 1200 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1135, + "name": "useAdminCustomerGroups", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1136, + "name": "useAdminCustomerGroups", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of customer groups. The customer groups can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`name`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": ". \nThe customer groups can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list customer groups:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminCustomerGroups } from \"medusa-react\"\n\nconst CustomerGroups = () => {\n const { \n customer_groups,\n isLoading,\n } = useAdminCustomerGroups()\n\n return (\n
\n {isLoading && Loading...}\n {customer_groups && !customer_groups.length && (\n No Customer Groups\n )}\n {customer_groups && customer_groups.length > 0 && (\n
    \n {customer_groups.map(\n (customerGroup) => (\n
  • \n {customerGroup.name}\n
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default CustomerGroups\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the customer groups:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminCustomerGroups } from \"medusa-react\"\n\nconst CustomerGroups = () => {\n const { \n customer_groups,\n isLoading,\n } = useAdminCustomerGroups({\n expand: \"customers\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {customer_groups && !customer_groups.length && (\n No Customer Groups\n )}\n {customer_groups && customer_groups.length > 0 && (\n
    \n {customer_groups.map(\n (customerGroup) => (\n
  • \n {customerGroup.name}\n
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default CustomerGroups\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`10`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminCustomerGroups } from \"medusa-react\"\n\nconst CustomerGroups = () => {\n const { \n customer_groups,\n limit,\n offset,\n isLoading,\n } = useAdminCustomerGroups({\n expand: \"customers\",\n limit: 15,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {customer_groups && !customer_groups.length && (\n No Customer Groups\n )}\n {customer_groups && customer_groups.length > 0 && (\n
    \n {customer_groups.map(\n (customerGroup) => (\n
  • \n {customerGroup.name}\n
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default CustomerGroups\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1137, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved customer groups." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts", + "qualifiedName": "AdminGetCustomerGroupsParams" + }, + "name": "AdminGetCustomerGroupsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1138, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "AdminCustomerGroupsListRes" + }, + "name": "AdminCustomerGroupsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_customer_groups" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1139, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1140, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1140 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1141, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1144, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1145, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer-group.d.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1142, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1143, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1146, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1144, + 1145, + 1142, + 1143, + 1146 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1147, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1150, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1151, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer-group.d.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1148, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1149, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1152, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1150, + 1151, + 1148, + 1149, + 1152 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1153, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1156, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1157, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer-group.d.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1154, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1155, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1158, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1156, + 1157, + 1154, + 1155, + 1158 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1159, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1162, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1163, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer-group.d.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1160, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1161, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1164, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1162, + 1163, + 1160, + 1161, + 1164 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1208, + "name": "useAdminDeleteCustomerGroup", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1209, + "name": "useAdminDeleteCustomerGroup", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a customer group. This doesn't delete the customers associated with the customer group." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteCustomerGroup } from \"medusa-react\"\n\ntype Props = {\n customerGroupId: string\n}\n\nconst CustomerGroup = ({ customerGroupId }: Props) => {\n const deleteCustomerGroup = useAdminDeleteCustomerGroup(\n customerGroupId\n )\n // ...\n\n const handleDeleteCustomerGroup = () => {\n deleteCustomerGroup.mutate()\n }\n\n // ...\n}\n\nexport default CustomerGroup\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1210, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer group's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1211, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1216, + "name": "useAdminRemoveCustomersFromCustomerGroup", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1217, + "name": "useAdminRemoveCustomersFromCustomerGroup", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook removes a list of customers from a customer group. This doesn't delete the customer, \nonly the association between the customer and the customer group." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminRemoveCustomersFromCustomerGroup,\n} from \"medusa-react\"\n\ntype Props = {\n customerGroupId: string\n}\n\nconst CustomerGroup = ({ customerGroupId }: Props) => {\n const removeCustomers = \n useAdminRemoveCustomersFromCustomerGroup(\n customerGroupId\n )\n // ...\n\n const handleRemoveCustomer = (customerId: string) => {\n removeCustomers.mutate({\n customer_ids: [\n {\n id: customerId,\n },\n ],\n })\n }\n\n // ...\n}\n\nexport default CustomerGroup\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1218, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer group's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1219, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "AdminCustomerGroupsRes" + }, + "name": "AdminCustomerGroupsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/delete-customers-batch.d.ts", + "qualifiedName": "AdminDeleteCustomerGroupsGroupCustomerBatchReq" + }, + "name": "AdminDeleteCustomerGroupsGroupCustomerBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "AdminCustomerGroupsRes" + }, + "name": "AdminCustomerGroupsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/delete-customers-batch.d.ts", + "qualifiedName": "AdminDeleteCustomerGroupsGroupCustomerBatchReq" + }, + "name": "AdminDeleteCustomerGroupsGroupCustomerBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1204, + "name": "useAdminUpdateCustomerGroup", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1205, + "name": "useAdminUpdateCustomerGroup", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a customer group's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateCustomerGroup } from \"medusa-react\"\n\ntype Props = {\n customerGroupId: string\n}\n\nconst CustomerGroup = ({ customerGroupId }: Props) => {\n const updateCustomerGroup = useAdminUpdateCustomerGroup(\n customerGroupId\n )\n // ..\n\n const handleUpdate = (name: string) => {\n updateCustomerGroup.mutate({\n name,\n })\n }\n\n // ...\n}\n\nexport default CustomerGroup\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1206, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer group's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1207, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "AdminCustomerGroupsRes" + }, + "name": "AdminCustomerGroupsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts", + "qualifiedName": "AdminPostCustomerGroupsGroupReq" + }, + "name": "AdminPostCustomerGroupsGroupReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "AdminCustomerGroupsRes" + }, + "name": "AdminCustomerGroupsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts", + "qualifiedName": "AdminPostCustomerGroupsGroupReq" + }, + "name": "AdminPostCustomerGroupsGroupReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1212, + 1201, + 1118, + 1165, + 1135, + 1208, + 1216, + 1204 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 1118, + 1135, + 1165 + ] + }, + { + "title": "Mutations", + "children": [ + 1201, + 1204, + 1208, + 1212, + 1216 + ] + } + ] + }, + { + "id": 15, + "name": "Customers", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Customer API Routes](https://docs.medusajs.com/api/admin#customers).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nRelated Guide: [How to manage customers](https://docs.medusajs.com/modules/customers/admin/manage-customers)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1267, + "name": "useAdminCreateCustomer", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1268, + "name": "useAdminCreateCustomer", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a customer as an admin." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateCustomer } from \"medusa-react\"\n\ntype CustomerData = {\n first_name: string\n last_name: string\n email: string\n password: string\n}\n\nconst CreateCustomer = () => {\n const createCustomer = useAdminCreateCustomer()\n // ...\n\n const handleCreate = (customerData: CustomerData) => {\n createCustomer.mutate(customerData, {\n onSuccess: ({ customer }) => {\n console.log(customer.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateCustomer\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1269, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "AdminCustomersRes" + }, + "name": "AdminCustomersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts", + "qualifiedName": "AdminPostCustomersReq" + }, + "name": "AdminPostCustomersReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "AdminCustomersRes" + }, + "name": "AdminCustomersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts", + "qualifiedName": "AdminPostCustomersReq" + }, + "name": "AdminPostCustomersReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1251, + "name": "useAdminCustomer", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1252, + "name": "useAdminCustomer", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves the details of a customer." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCustomer } from \"medusa-react\"\n\ntype Props = {\n customerId: string\n}\n\nconst Customer = ({ customerId }: Props) => {\n const { customer, isLoading } = useAdminCustomer(\n customerId\n )\n\n return (\n
\n {isLoading && Loading...}\n {customer && {customer.first_name}}\n
\n )\n}\n\nexport default Customer\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1253, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1254, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "AdminCustomersRes" + }, + "name": "AdminCustomersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_customers" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1255, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1256, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + }, + { + "id": 1257, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1256, + 1257 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1258, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1259, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + }, + { + "id": 1260, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1259, + 1260 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1261, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1262, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + }, + { + "id": 1263, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1262, + 1263 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1264, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1265, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + }, + { + "id": 1266, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1265, + 1266 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1221, + "name": "useAdminCustomers", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1222, + "name": "useAdminCustomers", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of Customers. The customers can be filtered by fields such as \n" + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`groups`" + }, + { + "kind": "text", + "text": ". The customers can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list customers:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminCustomers } from \"medusa-react\"\n\nconst Customers = () => {\n const { customers, isLoading } = useAdminCustomers()\n\n return (\n
\n {isLoading && Loading...}\n {customers && !customers.length && (\n No customers\n )}\n {customers && customers.length > 0 && (\n
    \n {customers.map((customer) => (\n
  • {customer.first_name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Customers\n```" + }, + { + "kind": "text", + "text": "\n\nYou can specify relations to be retrieved within each customer. In addition, by default, only the first " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": " records are retrieved. \nYou can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminCustomers } from \"medusa-react\"\n\nconst Customers = () => {\n const { \n customers, \n limit,\n offset,\n isLoading\n } = useAdminCustomers({\n expand: \"billing_address\",\n limit: 20,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {customers && !customers.length && (\n No customers\n )}\n {customers && customers.length > 0 && (\n
    \n {customers.map((customer) => (\n
  • {customer.first_name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Customers\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1223, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved customers." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts", + "qualifiedName": "AdminGetCustomersParams" + }, + "name": "AdminGetCustomersParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1224, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "AdminCustomersListRes" + }, + "name": "AdminCustomersListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_customers" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1225, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1226, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1226 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1227, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1230, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1231, + "name": "customers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1228, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1229, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1232, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1230, + 1231, + 1228, + 1229, + 1232 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1233, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1236, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1237, + "name": "customers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1234, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1235, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1238, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1236, + 1237, + 1234, + 1235, + 1238 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1239, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1242, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1243, + "name": "customers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1240, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1241, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1244, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1242, + 1243, + 1240, + 1241, + 1244 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1245, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1248, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1249, + "name": "customers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1246, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1247, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1250, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1248, + 1249, + 1246, + 1247, + 1250 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1270, + "name": "useAdminUpdateCustomer", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1271, + "name": "useAdminUpdateCustomer", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a customer's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateCustomer } from \"medusa-react\"\n\ntype CustomerData = {\n first_name: string\n last_name: string\n email: string\n password: string\n}\n\ntype Props = {\n customerId: string\n}\n\nconst Customer = ({ customerId }: Props) => {\n const updateCustomer = useAdminUpdateCustomer(customerId)\n // ...\n\n const handleUpdate = (customerData: CustomerData) => {\n updateCustomer.mutate(customerData)\n }\n\n // ...\n}\n\nexport default Customer\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1272, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1273, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "AdminCustomersRes" + }, + "name": "AdminCustomersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts", + "qualifiedName": "AdminPostCustomersCustomerReq" + }, + "name": "AdminPostCustomersCustomerReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "AdminCustomersRes" + }, + "name": "AdminCustomersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts", + "qualifiedName": "AdminPostCustomersCustomerReq" + }, + "name": "AdminPostCustomersCustomerReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1267, + 1251, + 1221, + 1270 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 1221, + 1251 + ] + }, + { + "title": "Mutations", + "children": [ + 1267, + 1270 + ] + } + ] + }, + { + "id": 16, + "name": "Discounts", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Discount API Routes](https://docs.medusajs.com/api/admin#discounts).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nAdmins can create discounts with conditions and rules, providing them with advanced settings for variety of cases.\nThe methods in this class can be used to manage discounts, their conditions, resources, and more.\n\nRelated Guide: [How to manage discounts](https://docs.medusajs.com/modules/discounts/admin/manage-discounts)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1378, + "name": "useAdminAddDiscountConditionResourceBatch", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1379, + "name": "useAdminAddDiscountConditionResourceBatch", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a batch of resources to a discount condition. The type of resource depends on the type of discount condition. \nFor example, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": ", the resources being added should be products." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To add resources to a discount condition:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { \n useAdminAddDiscountConditionResourceBatch\n} from \"medusa-react\"\n\ntype Props = {\n discountId: string\n conditionId: string\n}\n\nconst DiscountCondition = ({\n discountId,\n conditionId\n}: Props) => {\n const addConditionResources = useAdminAddDiscountConditionResourceBatch(\n discountId,\n conditionId\n )\n // ...\n\n const handleAdd = (itemId: string) => {\n addConditionResources.mutate({\n resources: [\n {\n id: itemId\n }\n ]\n }, {\n onSuccess: ({ discount }) => {\n console.log(discount.id)\n }\n })\n }\n\n // ...\n}\n\nexport default DiscountCondition\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations to include in the returned discount:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { \n useAdminAddDiscountConditionResourceBatch\n} from \"medusa-react\"\n\ntype Props = {\n discountId: string\n conditionId: string\n}\n\nconst DiscountCondition = ({\n discountId,\n conditionId\n}: Props) => {\n const addConditionResources = useAdminAddDiscountConditionResourceBatch(\n discountId,\n conditionId,\n {\n expand: \"rule\"\n }\n )\n // ...\n\n const handleAdd = (itemId: string) => {\n addConditionResources.mutate({\n resources: [\n {\n id: itemId\n }\n ]\n }, {\n onSuccess: ({ discount }) => {\n console.log(discount.id)\n }\n })\n }\n\n // ...\n}\n\nexport default DiscountCondition\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1380, + "name": "discountId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the discount the condition belongs to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1381, + "name": "conditionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount condition's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1382, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configurations to apply on the retrieved discount." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/add-resources-to-condition-batch.d.ts", + "qualifiedName": "AdminPostDiscountsDiscountConditionsConditionBatchParams" + }, + "name": "AdminPostDiscountsDiscountConditionsConditionBatchParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1383, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/add-resources-to-condition-batch.d.ts", + "qualifiedName": "AdminPostDiscountsDiscountConditionsConditionBatchReq" + }, + "name": "AdminPostDiscountsDiscountConditionsConditionBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/add-resources-to-condition-batch.d.ts", + "qualifiedName": "AdminPostDiscountsDiscountConditionsConditionBatchReq" + }, + "name": "AdminPostDiscountsDiscountConditionsConditionBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1389, + "name": "useAdminCreateDiscount", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1390, + "name": "useAdminCreateDiscount", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a discount with a given set of rules that defines how the discount is applied." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminCreateDiscount,\n} from \"medusa-react\"\nimport { \n AllocationType, \n DiscountRuleType,\n} from \"@medusajs/medusa\"\n\nconst CreateDiscount = () => {\n const createDiscount = useAdminCreateDiscount()\n // ...\n\n const handleCreate = (\n currencyCode: string,\n regionId: string\n ) => {\n // ...\n createDiscount.mutate({\n code: currencyCode,\n rule: {\n type: DiscountRuleType.FIXED,\n value: 10,\n allocation: AllocationType.ITEM,\n },\n regions: [\n regionId,\n ],\n is_dynamic: false,\n is_disabled: false,\n })\n }\n\n // ...\n}\n\nexport default CreateDiscount\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1391, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts", + "qualifiedName": "AdminPostDiscountsReq" + }, + "name": "AdminPostDiscountsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts", + "qualifiedName": "AdminPostDiscountsReq" + }, + "name": "AdminPostDiscountsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1408, + "name": "useAdminCreateDynamicDiscountCode", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1409, + "name": "useAdminCreateDynamicDiscountCode", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a dynamic unique code that can map to a parent discount. This is useful if you want to \nautomatically generate codes with the same rules and conditions." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateDynamicDiscountCode } from \"medusa-react\"\n\ntype Props = {\n discountId: string\n}\n\nconst Discount = ({ discountId }: Props) => {\n const createDynamicDiscount = useAdminCreateDynamicDiscountCode(discountId)\n // ...\n\n const handleCreate = (\n code: string,\n usageLimit: number\n ) => {\n createDynamicDiscount.mutate({\n code,\n usage_limit: usageLimit\n }, {\n onSuccess: ({ discount }) => {\n console.log(discount.is_dynamic)\n }\n })\n }\n\n // ...\n}\n\nexport default Discount\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1410, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1411, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts", + "qualifiedName": "AdminPostDiscountsDiscountDynamicCodesReq" + }, + "name": "AdminPostDiscountsDiscountDynamicCodesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts", + "qualifiedName": "AdminPostDiscountsDiscountDynamicCodesReq" + }, + "name": "AdminPostDiscountsDiscountDynamicCodesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1396, + "name": "useAdminDeleteDiscount", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1397, + "name": "useAdminDeleteDiscount", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a discount. Deleting the discount will make it unavailable for customers to use." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteDiscount } from \"medusa-react\"\n\nconst Discount = () => {\n const deleteDiscount = useAdminDeleteDiscount(discount_id)\n // ...\n\n const handleDelete = () => {\n deleteDiscount.mutate()\n }\n\n // ...\n}\n\nexport default Discount\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1398, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1399, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1384, + "name": "useAdminDeleteDiscountConditionResourceBatch", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1385, + "name": "useAdminDeleteDiscountConditionResourceBatch", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook remove a batch of resources from a discount condition. This will only remove the association between the resource and \nthe discount condition, not the resource itself." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminDeleteDiscountConditionResourceBatch\n} from \"medusa-react\"\n\ntype Props = {\n discountId: string\n conditionId: string\n}\n\nconst DiscountCondition = ({\n discountId,\n conditionId\n}: Props) => {\n const deleteConditionResource = useAdminDeleteDiscountConditionResourceBatch(\n discountId,\n conditionId,\n )\n // ...\n\n const handleDelete = (itemId: string) => {\n deleteConditionResource.mutate({\n resources: [\n {\n id: itemId\n }\n ]\n }, {\n onSuccess: ({ discount }) => {\n console.log(discount.id)\n }\n })\n }\n\n // ...\n}\n\nexport default DiscountCondition\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1386, + "name": "discountId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the discount the condition belongs to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1387, + "name": "conditionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount condition's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1388, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/delete-resources-from-condition-batch.d.ts", + "qualifiedName": "AdminDeleteDiscountsDiscountConditionsConditionBatchReq" + }, + "name": "AdminDeleteDiscountsDiscountConditionsConditionBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/delete-resources-from-condition-batch.d.ts", + "qualifiedName": "AdminDeleteDiscountsDiscountConditionsConditionBatchReq" + }, + "name": "AdminDeleteDiscountsDiscountConditionsConditionBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1412, + "name": "useAdminDeleteDynamicDiscountCode", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1413, + "name": "useAdminDeleteDynamicDiscountCode", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a dynamic code from a discount." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The code of the dynamic discount to delete." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteDynamicDiscountCode } from \"medusa-react\"\n\ntype Props = {\n discountId: string\n}\n\nconst Discount = ({ discountId }: Props) => {\n const deleteDynamicDiscount = useAdminDeleteDynamicDiscountCode(discountId)\n // ...\n\n const handleDelete = (code: string) => {\n deleteDynamicDiscount.mutate(code, {\n onSuccess: ({ discount }) => {\n console.log(discount.is_dynamic)\n }\n })\n }\n\n // ...\n}\n\nexport default Discount\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1414, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1415, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1327, + "name": "useAdminDiscount", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1328, + "name": "useAdminDiscount", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a discount." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDiscount } from \"medusa-react\"\n\ntype Props = {\n discountId: string\n}\n\nconst Discount = ({ discountId }: Props) => {\n const { discount, isLoading } = useAdminDiscount(\n discountId\n )\n\n return (\n
\n {isLoading && Loading...}\n {discount && {discount.code}}\n
\n )\n}\n\nexport default Discount\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1329, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1330, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configurations to apply on the retrieved discount." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/get-discount.d.ts", + "qualifiedName": "AdminGetDiscountParams" + }, + "name": "AdminGetDiscountParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1331, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_discounts" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1332, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1333, + "name": "discount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount.d.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + }, + { + "id": 1334, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1333, + 1334 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1335, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1336, + "name": "discount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount.d.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + }, + { + "id": 1337, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1336, + 1337 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1338, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1339, + "name": "discount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount.d.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + }, + { + "id": 1340, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1339, + 1340 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1341, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1342, + "name": "discount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount.d.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + }, + { + "id": 1343, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1342, + 1343 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1400, + "name": "useAdminDiscountAddRegion", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1401, + "name": "useAdminDiscountAddRegion", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a Region to the list of Regions a Discount can be used in." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The ID of the region to add." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDiscountAddRegion } from \"medusa-react\"\n\ntype Props = {\n discountId: string\n}\n\nconst Discount = ({ discountId }: Props) => {\n const addRegion = useAdminDiscountAddRegion(discountId)\n // ...\n\n const handleAdd = (regionId: string) => {\n addRegion.mutate(regionId, {\n onSuccess: ({ discount }) => {\n console.log(discount.regions)\n }\n })\n }\n\n // ...\n}\n\nexport default Discount\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1402, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1403, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1416, + "name": "useAdminDiscountCreateCondition", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1417, + "name": "useAdminDiscountCreateCondition", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a discount condition. Only one of " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`product_types`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`product_collections`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`product_tags`" + }, + { + "kind": "text", + "text": ", and " + }, + { + "kind": "code", + "text": "`customer_groups`" + }, + { + "kind": "text", + "text": " \nshould be provided in the " + }, + { + "kind": "code", + "text": "`payload`" + }, + { + "kind": "text", + "text": " parameter, based on the type of discount condition. For example, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": ", \nthe " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": " field should be provided in the " + }, + { + "kind": "code", + "text": "`payload`" + }, + { + "kind": "text", + "text": " parameter." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { DiscountConditionOperator } from \"@medusajs/medusa\"\nimport { useAdminDiscountCreateCondition } from \"medusa-react\"\n\ntype Props = {\n discountId: string\n}\n\nconst Discount = ({ discountId }: Props) => {\n const createCondition = useAdminDiscountCreateCondition(discountId)\n // ...\n\n const handleCreateCondition = (\n operator: DiscountConditionOperator,\n products: string[]\n ) => {\n createCondition.mutate({\n operator,\n products\n }, {\n onSuccess: ({ discount }) => {\n console.log(discount.id)\n }\n })\n }\n\n // ...\n}\n\nexport default Discount\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1418, + "name": "discountId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1419, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/create-condition.d.ts", + "qualifiedName": "AdminPostDiscountsDiscountConditions" + }, + "name": "AdminPostDiscountsDiscountConditions", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/create-condition.d.ts", + "qualifiedName": "AdminPostDiscountsDiscountConditions" + }, + "name": "AdminPostDiscountsDiscountConditions", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1425, + "name": "useAdminDiscountRemoveCondition", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1426, + "name": "useAdminDiscountRemoveCondition", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a discount condition. This doesn't delete resources associated to the discount condition." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The ID of the condition to delete." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDiscountRemoveCondition } from \"medusa-react\"\n\ntype Props = {\n discountId: string\n}\n\nconst Discount = ({ discountId }: Props) => {\n const deleteCondition = useAdminDiscountRemoveCondition(\n discountId\n )\n // ...\n\n const handleDelete = (\n conditionId: string\n ) => {\n deleteCondition.mutate(conditionId, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(deleted)\n }\n })\n }\n\n // ...\n}\n\nexport default Discount\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1427, + "name": "discountId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1428, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1404, + "name": "useAdminDiscountRemoveRegion", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1405, + "name": "useAdminDiscountRemoveRegion", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook removes a Region from the list of Regions that a Discount can be used in. \nThis does not delete a region, only the association between it and the discount." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The ID of the region to remove." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDiscountRemoveRegion } from \"medusa-react\"\n\ntype Props = {\n discountId: string\n}\n\nconst Discount = ({ discountId }: Props) => {\n const deleteRegion = useAdminDiscountRemoveRegion(discountId)\n // ...\n\n const handleDelete = (regionId: string) => {\n deleteRegion.mutate(regionId, {\n onSuccess: ({ discount }) => {\n console.log(discount.regions)\n }\n })\n }\n\n // ...\n}\n\nexport default Discount\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1406, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1407, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1420, + "name": "useAdminDiscountUpdateCondition", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1421, + "name": "useAdminDiscountUpdateCondition", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update a discount condition. Only one of " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`product_types`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`product_collections`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`product_tags`" + }, + { + "kind": "text", + "text": ", and " + }, + { + "kind": "code", + "text": "`customer_groups`" + }, + { + "kind": "text", + "text": " \nshould be provided in the " + }, + { + "kind": "code", + "text": "`payload`" + }, + { + "kind": "text", + "text": " parameter, based on the type of discount condition. For example, if the discount condition's \ntype is " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": ", the " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": " field should be provided in the " + }, + { + "kind": "code", + "text": "`payload`" + }, + { + "kind": "text", + "text": " parameter." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDiscountUpdateCondition } from \"medusa-react\"\n\ntype Props = {\n discountId: string\n conditionId: string\n}\n\nconst DiscountCondition = ({\n discountId,\n conditionId\n}: Props) => {\n const update = useAdminDiscountUpdateCondition(\n discountId,\n conditionId\n )\n // ...\n\n const handleUpdate = (\n products: string[]\n ) => {\n update.mutate({\n products\n }, {\n onSuccess: ({ discount }) => {\n console.log(discount.id)\n }\n })\n }\n\n // ...\n}\n\nexport default DiscountCondition\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1422, + "name": "discountId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1423, + "name": "conditionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount condition's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1424, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/update-condition.d.ts", + "qualifiedName": "AdminPostDiscountsDiscountConditionsCondition" + }, + "name": "AdminPostDiscountsDiscountConditionsCondition", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/update-condition.d.ts", + "qualifiedName": "AdminPostDiscountsDiscountConditionsCondition" + }, + "name": "AdminPostDiscountsDiscountConditionsCondition", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1297, + "name": "useAdminDiscounts", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1298, + "name": "useAdminDiscounts", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of Discounts. The discounts can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`rule`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`is_dynamic`" + }, + { + "kind": "text", + "text": ". \nThe discounts can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list discounts:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminDiscounts } from \"medusa-react\"\n\nconst Discounts = () => {\n const { discounts, isLoading } = useAdminDiscounts()\n\n return (\n
\n {isLoading && Loading...}\n {discounts && !discounts.length && (\n No customers\n )}\n {discounts && discounts.length > 0 && (\n
    \n {discounts.map((discount) => (\n
  • {discount.code}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Discounts\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the discounts:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminDiscounts } from \"medusa-react\"\n\nconst Discounts = () => {\n const { discounts, isLoading } = useAdminDiscounts({\n expand: \"rule\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {discounts && !discounts.length && (\n No customers\n )}\n {discounts && discounts.length > 0 && (\n
    \n {discounts.map((discount) => (\n
  • {discount.code}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Discounts\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`20`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminDiscounts } from \"medusa-react\"\n\nconst Discounts = () => {\n const { \n discounts, \n limit,\n offset,\n isLoading\n } = useAdminDiscounts({\n expand: \"rule\",\n limit: 10,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {discounts && !discounts.length && (\n No customers\n )}\n {discounts && discounts.length > 0 && (\n
    \n {discounts.map((discount) => (\n
  • {discount.code}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Discounts\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1299, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved discounts." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts", + "qualifiedName": "AdminGetDiscountsParams" + }, + "name": "AdminGetDiscountsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1300, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsListRes" + }, + "name": "AdminDiscountsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_discounts" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1301, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1302, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1302 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1303, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1306, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1307, + "name": "discounts", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount.d.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1304, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1305, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1308, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1306, + 1307, + 1304, + 1305, + 1308 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1309, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1312, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1313, + "name": "discounts", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount.d.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1310, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1311, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1314, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1312, + 1313, + 1310, + 1311, + 1314 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1315, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1318, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1319, + "name": "discounts", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount.d.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1316, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1317, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1320, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1318, + 1319, + 1316, + 1317, + 1320 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1321, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1324, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1325, + "name": "discounts", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount.d.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1322, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1323, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1326, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1324, + 1325, + 1322, + 1323, + 1326 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1344, + "name": "useAdminGetDiscountByCode", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1345, + "name": "useAdminGetDiscountByCode", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a batch of resources to a discount condition. The type of resource depends on the type of discount condition. For example, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": ",\nthe resources being added should be products." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminGetDiscountByCode } from \"medusa-react\"\n\ntype Props = {\n discountCode: string\n}\n\nconst Discount = ({ discountCode }: Props) => {\n const { discount, isLoading } = useAdminGetDiscountByCode(\n discountCode\n )\n\n return (\n
\n {isLoading && Loading...}\n {discount && {discount.code}}\n
\n )\n}\n\nexport default Discount\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1346, + "name": "code", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the discount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1347, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_discounts" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1348, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1349, + "name": "discount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount.d.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + }, + { + "id": 1350, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1349, + 1350 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1351, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1352, + "name": "discount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount.d.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + }, + { + "id": 1353, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1352, + 1353 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1354, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1355, + "name": "discount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount.d.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + }, + { + "id": 1356, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1355, + 1356 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1357, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1358, + "name": "discount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount.d.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + }, + { + "id": 1359, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1358, + 1359 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1360, + "name": "useAdminGetDiscountCondition", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1361, + "name": "useAdminGetDiscountCondition", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retries a Discount Condition's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminGetDiscountCondition } from \"medusa-react\"\n\ntype Props = {\n discountId: string\n discountConditionId: string\n}\n\nconst DiscountCondition = ({\n discountId,\n discountConditionId\n}: Props) => {\n const { \n discount_condition, \n isLoading\n } = useAdminGetDiscountCondition(\n discountId,\n discountConditionId\n )\n\n return (\n
\n {isLoading && Loading...}\n {discount_condition && (\n {discount_condition.type}\n )}\n
\n )\n}\n\nexport default DiscountCondition\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1362, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the discount the condition belongs to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1363, + "name": "conditionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount condition's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1364, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configurations to apply on the retrieved discount condition." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/get-condition.d.ts", + "qualifiedName": "AdminGetDiscountsDiscountConditionsConditionParams" + }, + "name": "AdminGetDiscountsDiscountConditionsConditionParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1365, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountConditionsRes" + }, + "name": "AdminDiscountConditionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_discounts" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": "condition" + }, + { + "type": "intrinsic", + "name": "any" + } + ] + } + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1366, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1367, + "name": "discount_condition", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount-condition.d.ts", + "qualifiedName": "DiscountCondition" + }, + "name": "DiscountCondition", + "package": "@medusajs/medusa" + } + }, + { + "id": 1368, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1367, + 1368 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1369, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1370, + "name": "discount_condition", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount-condition.d.ts", + "qualifiedName": "DiscountCondition" + }, + "name": "DiscountCondition", + "package": "@medusajs/medusa" + } + }, + { + "id": 1371, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1370, + 1371 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1372, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1373, + "name": "discount_condition", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount-condition.d.ts", + "qualifiedName": "DiscountCondition" + }, + "name": "DiscountCondition", + "package": "@medusajs/medusa" + } + }, + { + "id": 1374, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1373, + 1374 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1375, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1376, + "name": "discount_condition", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/discount-condition.d.ts", + "qualifiedName": "DiscountCondition" + }, + "name": "DiscountCondition", + "package": "@medusajs/medusa" + } + }, + { + "id": 1377, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1376, + 1377 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1392, + "name": "useAdminUpdateDiscount", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1393, + "name": "useAdminUpdateDiscount", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a discount with a given set of rules that define how the discount is applied." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateDiscount } from \"medusa-react\"\n\ntype Props = {\n discountId: string\n}\n\nconst Discount = ({ discountId }: Props) => {\n const updateDiscount = useAdminUpdateDiscount(discountId)\n // ...\n\n const handleUpdate = (isDisabled: boolean) => {\n updateDiscount.mutate({\n is_disabled: isDisabled,\n })\n }\n\n // ...\n}\n\nexport default Discount\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1394, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1395, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts", + "qualifiedName": "AdminPostDiscountsDiscountReq" + }, + "name": "AdminPostDiscountsDiscountReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "AdminDiscountsRes" + }, + "name": "AdminDiscountsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts", + "qualifiedName": "AdminPostDiscountsDiscountReq" + }, + "name": "AdminPostDiscountsDiscountReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1378, + 1389, + 1408, + 1396, + 1384, + 1412, + 1327, + 1400, + 1416, + 1425, + 1404, + 1420, + 1297, + 1344, + 1360, + 1392 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 1297, + 1327, + 1344, + 1360 + ] + }, + { + "title": "Mutations", + "children": [ + 1378, + 1384, + 1389, + 1392, + 1396, + 1400, + 1404, + 1408, + 1412, + 1416, + 1420, + 1425 + ] + } + ] + }, + { + "id": 17, + "name": "Draft Orders", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Draft Order API Routes](https://docs.medusajs.com/api/admin#draft-orders).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA draft order is an order created manually by the admin. It allows admins to create orders without direct involvement from the customer.\n\nRelated Guide: [How to manage draft orders](https://docs.medusajs.com/modules/orders/admin/manage-draft-orders)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1476, + "name": "useAdminCreateDraftOrder", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1477, + "name": "useAdminCreateDraftOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a Draft Order. A draft order is not transformed into an order until payment is captured." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateDraftOrder } from \"medusa-react\"\n\ntype DraftOrderData = {\n email: string\n region_id: string\n items: {\n quantity: number,\n variant_id: string\n }[]\n shipping_methods: {\n option_id: string\n price: number\n }[]\n}\n\nconst CreateDraftOrder = () => {\n const createDraftOrder = useAdminCreateDraftOrder()\n // ...\n\n const handleCreate = (data: DraftOrderData) => {\n createDraftOrder.mutate(data, {\n onSuccess: ({ draft_order }) => {\n console.log(draft_order.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateDraftOrder\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1478, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminDraftOrdersRes" + }, + "name": "AdminDraftOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts", + "qualifiedName": "AdminPostDraftOrdersReq" + }, + "name": "AdminPostDraftOrdersReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminDraftOrdersRes" + }, + "name": "AdminDraftOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts", + "qualifiedName": "AdminPostDraftOrdersReq" + }, + "name": "AdminPostDraftOrdersReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1483, + "name": "useAdminDeleteDraftOrder", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1484, + "name": "useAdminDeleteDraftOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a Draft Order." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteDraftOrder } from \"medusa-react\"\n\ntype Props = {\n draftOrderId: string\n}\n\nconst DraftOrder = ({ draftOrderId }: Props) => {\n const deleteDraftOrder = useAdminDeleteDraftOrder(\n draftOrderId\n )\n // ...\n\n const handleDelete = () => {\n deleteDraftOrder.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default DraftOrder\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1485, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The draft order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1486, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1460, + "name": "useAdminDraftOrder", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1461, + "name": "useAdminDraftOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a Draft Order's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDraftOrder } from \"medusa-react\"\n\ntype Props = {\n draftOrderId: string\n}\n\nconst DraftOrder = ({ draftOrderId }: Props) => {\n const { \n draft_order, \n isLoading, \n } = useAdminDraftOrder(draftOrderId)\n\n return (\n
\n {isLoading && Loading...}\n {draft_order && {draft_order.display_id}}\n \n
\n )\n}\n\nexport default DraftOrder\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1462, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The draft order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1463, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminDraftOrdersRes" + }, + "name": "AdminDraftOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_draft_orders" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1464, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1465, + "name": "draft_order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/draft-order.d.ts", + "qualifiedName": "DraftOrder" + }, + "name": "DraftOrder", + "package": "@medusajs/medusa" + } + }, + { + "id": 1466, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1465, + 1466 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1467, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1468, + "name": "draft_order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/draft-order.d.ts", + "qualifiedName": "DraftOrder" + }, + "name": "DraftOrder", + "package": "@medusajs/medusa" + } + }, + { + "id": 1469, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1468, + 1469 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1470, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1471, + "name": "draft_order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/draft-order.d.ts", + "qualifiedName": "DraftOrder" + }, + "name": "DraftOrder", + "package": "@medusajs/medusa" + } + }, + { + "id": 1472, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1471, + 1472 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1473, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1474, + "name": "draft_order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/draft-order.d.ts", + "qualifiedName": "DraftOrder" + }, + "name": "DraftOrder", + "package": "@medusajs/medusa" + } + }, + { + "id": 1475, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1474, + 1475 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1491, + "name": "useAdminDraftOrderAddLineItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1492, + "name": "useAdminDraftOrderAddLineItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a Line Item in the Draft Order." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDraftOrderAddLineItem } from \"medusa-react\"\n\ntype Props = {\n draftOrderId: string\n}\n\nconst DraftOrder = ({ draftOrderId }: Props) => {\n const addLineItem = useAdminDraftOrderAddLineItem(\n draftOrderId\n )\n // ...\n\n const handleAdd = (quantity: number) => {\n addLineItem.mutate({\n quantity,\n }, {\n onSuccess: ({ draft_order }) => {\n console.log(draft_order.cart)\n }\n })\n }\n\n // ...\n}\n\nexport default DraftOrder\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1493, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The draft order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1494, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminDraftOrdersRes" + }, + "name": "AdminDraftOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts", + "qualifiedName": "AdminPostDraftOrdersDraftOrderLineItemsReq" + }, + "name": "AdminPostDraftOrdersDraftOrderLineItemsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminDraftOrdersRes" + }, + "name": "AdminDraftOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts", + "qualifiedName": "AdminPostDraftOrdersDraftOrderLineItemsReq" + }, + "name": "AdminPostDraftOrdersDraftOrderLineItemsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1487, + "name": "useAdminDraftOrderRegisterPayment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1488, + "name": "useAdminDraftOrderRegisterPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook capture the draft order's payment. This will also set the draft order's status to " + }, + { + "kind": "code", + "text": "`completed`" + }, + { + "kind": "text", + "text": " and create an order from the draft order. The payment is captured through Medusa's system payment,\nwhich is manual payment that isn't integrated with any third-party payment provider. It is assumed that the payment capturing is handled manually by the admin." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDraftOrderRegisterPayment } from \"medusa-react\"\n\ntype Props = {\n draftOrderId: string\n}\n\nconst DraftOrder = ({ draftOrderId }: Props) => {\n const registerPayment = useAdminDraftOrderRegisterPayment(\n draftOrderId\n )\n // ...\n\n const handlePayment = () => {\n registerPayment.mutate(void 0, {\n onSuccess: ({ order }) => {\n console.log(order.id)\n }\n })\n }\n\n // ...\n}\n\nexport default DraftOrder\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1489, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The draft order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1490, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminPostDraftOrdersDraftOrderRegisterPaymentRes" + }, + "name": "AdminPostDraftOrdersDraftOrderRegisterPaymentRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminPostDraftOrdersDraftOrderRegisterPaymentRes" + }, + "name": "AdminPostDraftOrdersDraftOrderRegisterPaymentRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1495, + "name": "useAdminDraftOrderRemoveLineItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1496, + "name": "useAdminDraftOrderRemoveLineItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a Line Item from a Draft Order." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The ID of the line item to remove." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDraftOrderRemoveLineItem } from \"medusa-react\"\n\ntype Props = {\n draftOrderId: string\n}\n\nconst DraftOrder = ({ draftOrderId }: Props) => {\n const deleteLineItem = useAdminDraftOrderRemoveLineItem(\n draftOrderId\n )\n // ...\n\n const handleDelete = (itemId: string) => {\n deleteLineItem.mutate(itemId, {\n onSuccess: ({ draft_order }) => {\n console.log(draft_order.cart)\n }\n })\n }\n\n // ...\n}\n\nexport default DraftOrder\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1497, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The draft order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1498, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminDraftOrdersRes" + }, + "name": "AdminDraftOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminDraftOrdersRes" + }, + "name": "AdminDraftOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1502, + "name": "useAdminDraftOrderUpdateLineItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1503, + "name": "useAdminDraftOrderUpdateLineItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a Line Item in a Draft Order." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDraftOrderUpdateLineItem } from \"medusa-react\"\n\ntype Props = {\n draftOrderId: string\n}\n\nconst DraftOrder = ({ draftOrderId }: Props) => {\n const updateLineItem = useAdminDraftOrderUpdateLineItem(\n draftOrderId\n )\n // ...\n\n const handleUpdate = (\n itemId: string,\n quantity: number\n ) => {\n updateLineItem.mutate({\n item_id: itemId,\n quantity,\n })\n }\n\n // ...\n}\n\nexport default DraftOrder\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1504, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The draft order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1505, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminDraftOrdersRes" + }, + "name": "AdminDraftOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 1499, + "name": "AdminDraftOrderUpdateLineItemReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminDraftOrdersRes" + }, + "name": "AdminDraftOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 1499, + "name": "AdminDraftOrderUpdateLineItemReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1430, + "name": "useAdminDraftOrders", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1431, + "name": "useAdminDraftOrders", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves an list of Draft Orders. The draft orders can be filtered by parameters such as " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": ". The draft orders can also paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list draft orders:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminDraftOrders } from \"medusa-react\"\n\nconst DraftOrders = () => {\n const { draft_orders, isLoading } = useAdminDraftOrders()\n\n return (\n
\n {isLoading && Loading...}\n {draft_orders && !draft_orders.length && (\n No Draft Orders\n )}\n {draft_orders && draft_orders.length > 0 && (\n
    \n {draft_orders.map((order) => (\n
  • {order.display_id}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default DraftOrders\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminDraftOrders } from \"medusa-react\"\n\nconst DraftOrders = () => {\n const { \n draft_orders, \n limit,\n offset,\n isLoading\n } = useAdminDraftOrders({\n limit: 20,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {draft_orders && !draft_orders.length && (\n No Draft Orders\n )}\n {draft_orders && draft_orders.length > 0 && (\n
    \n {draft_orders.map((order) => (\n
  • {order.display_id}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default DraftOrders\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1432, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved draft orders." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts", + "qualifiedName": "AdminGetDraftOrdersParams" + }, + "name": "AdminGetDraftOrdersParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1433, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminDraftOrdersListRes" + }, + "name": "AdminDraftOrdersListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_draft_orders" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1434, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1435, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1435 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1436, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1439, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1440, + "name": "draft_orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/draft-order.d.ts", + "qualifiedName": "DraftOrder" + }, + "name": "DraftOrder", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1437, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1438, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1441, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1439, + 1440, + 1437, + 1438, + 1441 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1442, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1445, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1446, + "name": "draft_orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/draft-order.d.ts", + "qualifiedName": "DraftOrder" + }, + "name": "DraftOrder", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1443, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1444, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1447, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1445, + 1446, + 1443, + 1444, + 1447 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1448, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1451, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1452, + "name": "draft_orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/draft-order.d.ts", + "qualifiedName": "DraftOrder" + }, + "name": "DraftOrder", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1449, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1450, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1453, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1451, + 1452, + 1449, + 1450, + 1453 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1454, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1457, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1458, + "name": "draft_orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/draft-order.d.ts", + "qualifiedName": "DraftOrder" + }, + "name": "DraftOrder", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1455, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1456, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1459, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1457, + 1458, + 1455, + 1456, + 1459 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1479, + "name": "useAdminUpdateDraftOrder", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1480, + "name": "useAdminUpdateDraftOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a Draft Order's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateDraftOrder } from \"medusa-react\"\n\ntype Props = {\n draftOrderId: string\n}\n\nconst DraftOrder = ({ draftOrderId }: Props) => {\n const updateDraftOrder = useAdminUpdateDraftOrder(\n draftOrderId\n )\n // ...\n\n const handleUpdate = (email: string) => {\n updateDraftOrder.mutate({\n email,\n }, {\n onSuccess: ({ draft_order }) => {\n console.log(draft_order.id)\n }\n })\n }\n\n // ...\n}\n\nexport default DraftOrder\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1481, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The draft order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1482, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminDraftOrdersRes" + }, + "name": "AdminDraftOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts", + "qualifiedName": "AdminPostDraftOrdersDraftOrderReq" + }, + "name": "AdminPostDraftOrdersDraftOrderReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "AdminDraftOrdersRes" + }, + "name": "AdminDraftOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts", + "qualifiedName": "AdminPostDraftOrdersDraftOrderReq" + }, + "name": "AdminPostDraftOrdersDraftOrderReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1476, + 1483, + 1460, + 1491, + 1487, + 1495, + 1502, + 1430, + 1479 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 1430, + 1460 + ] + }, + { + "title": "Mutations", + "children": [ + 1476, + 1479, + 1483, + 1487, + 1491, + 1495, + 1502 + ] + } + ] + }, + { + "id": 18, + "name": "Gift Cards", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Gift Card API Routes](https://docs.medusajs.com/api/admin#gift-cards).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nAdmins can create gift cards and send them directly to customers, specifying options like their balance, region, and more.\nThese gift cards are different than the saleable gift cards in a store, which are created and managed through " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useAdminCreateProduct", + "target": 2385 + }, + { + "kind": "text", + "text": ".\n\nRelated Guide: [How to manage gift cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-custom-gift-cards)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1553, + "name": "useAdminCreateGiftCard", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1554, + "name": "useAdminCreateGiftCard", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a gift card that can redeemed by its unique code. The Gift Card is only valid within one region." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateGiftCard } from \"medusa-react\"\n\nconst CreateCustomGiftCards = () => {\n const createGiftCard = useAdminCreateGiftCard()\n // ...\n \n const handleCreate = (\n regionId: string, \n value: number\n ) => {\n createGiftCard.mutate({\n region_id: regionId,\n value,\n }, {\n onSuccess: ({ gift_card }) => {\n console.log(gift_card.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateCustomGiftCards\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1555, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "AdminGiftCardsRes" + }, + "name": "AdminGiftCardsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts", + "qualifiedName": "AdminPostGiftCardsReq" + }, + "name": "AdminPostGiftCardsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "AdminGiftCardsRes" + }, + "name": "AdminGiftCardsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts", + "qualifiedName": "AdminPostGiftCardsReq" + }, + "name": "AdminPostGiftCardsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1560, + "name": "useAdminDeleteGiftCard", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1561, + "name": "useAdminDeleteGiftCard", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a gift card. Once deleted, it can't be used by customers." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteGiftCard } from \"medusa-react\"\n\ntype Props = {\n customGiftCardId: string\n}\n\nconst CustomGiftCard = ({ customGiftCardId }: Props) => {\n const deleteGiftCard = useAdminDeleteGiftCard(\n customGiftCardId\n )\n // ...\n \n const handleDelete = () => {\n deleteGiftCard.mutate(void 0, {\n onSuccess: ({ id, object, deleted}) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default CustomGiftCard\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1562, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The gift card's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1563, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1537, + "name": "useAdminGiftCard", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1538, + "name": "useAdminGiftCard", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a gift card's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminGiftCard } from \"medusa-react\"\n\ntype Props = {\n giftCardId: string\n}\n\nconst CustomGiftCard = ({ giftCardId }: Props) => {\n const { gift_card, isLoading } = useAdminGiftCard(giftCardId)\n \n return (\n
\n {isLoading && Loading...}\n {gift_card && {gift_card.code}}\n
\n )\n}\n\nexport default CustomGiftCard\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1539, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The gift card's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1540, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "AdminGiftCardsRes" + }, + "name": "AdminGiftCardsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_gift_cards" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1541, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1542, + "name": "gift_card", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/gift-card.d.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + }, + { + "id": 1543, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1542, + 1543 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1544, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1545, + "name": "gift_card", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/gift-card.d.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + }, + { + "id": 1546, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1545, + 1546 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1547, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1548, + "name": "gift_card", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/gift-card.d.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + }, + { + "id": 1549, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1548, + 1549 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1550, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1551, + "name": "gift_card", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/gift-card.d.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + }, + { + "id": 1552, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1551, + 1552 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1507, + "name": "useAdminGiftCards", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1508, + "name": "useAdminGiftCards", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of gift cards. The gift cards can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " passed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " \nparameter. The gift cards can also paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list gift cards:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminGiftCards } from \"medusa-react\"\n\nconst CustomGiftCards = () => {\n const { gift_cards, isLoading } = useAdminGiftCards()\n \n return (\n
\n {isLoading && Loading...}\n {gift_cards && !gift_cards.length && (\n No custom gift cards...\n )}\n {gift_cards && gift_cards.length > 0 && (\n
    \n {gift_cards.map((giftCard) => (\n
  • {giftCard.code}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default CustomGiftCards\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminGiftCards } from \"medusa-react\"\n\nconst CustomGiftCards = () => {\n const { \n gift_cards, \n limit,\n offset,\n isLoading\n } = useAdminGiftCards({\n limit: 20,\n offset: 0\n })\n \n return (\n
\n {isLoading && Loading...}\n {gift_cards && !gift_cards.length && (\n No custom gift cards...\n )}\n {gift_cards && gift_cards.length > 0 && (\n
    \n {gift_cards.map((giftCard) => (\n
  • {giftCard.code}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default CustomGiftCards\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1509, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved gift cards." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts", + "qualifiedName": "AdminGetGiftCardsParams" + }, + "name": "AdminGetGiftCardsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1510, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "AdminGiftCardsListRes" + }, + "name": "AdminGiftCardsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_gift_cards" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1511, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1512, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1512 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1513, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1516, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1517, + "name": "gift_cards", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/gift-card.d.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1514, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1515, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1518, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1516, + 1517, + 1514, + 1515, + 1518 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1519, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1522, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1523, + "name": "gift_cards", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/gift-card.d.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1520, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1521, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1524, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1522, + 1523, + 1520, + 1521, + 1524 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1525, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1528, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1529, + "name": "gift_cards", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/gift-card.d.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1526, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1527, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1530, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1528, + 1529, + 1526, + 1527, + 1530 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1531, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1534, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1535, + "name": "gift_cards", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/gift-card.d.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1532, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1533, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1536, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1534, + 1535, + 1532, + 1533, + 1536 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1556, + "name": "useAdminUpdateGiftCard", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1557, + "name": "useAdminUpdateGiftCard", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a gift card's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateGiftCard } from \"medusa-react\"\n\ntype Props = {\n customGiftCardId: string\n}\n\nconst CustomGiftCard = ({ customGiftCardId }: Props) => {\n const updateGiftCard = useAdminUpdateGiftCard(\n customGiftCardId\n )\n // ...\n \n const handleUpdate = (regionId: string) => {\n updateGiftCard.mutate({\n region_id: regionId,\n }, {\n onSuccess: ({ gift_card }) => {\n console.log(gift_card.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CustomGiftCard\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1558, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The gift card's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1559, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "AdminGiftCardsRes" + }, + "name": "AdminGiftCardsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts", + "qualifiedName": "AdminPostGiftCardsGiftCardReq" + }, + "name": "AdminPostGiftCardsGiftCardReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "AdminGiftCardsRes" + }, + "name": "AdminGiftCardsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts", + "qualifiedName": "AdminPostGiftCardsGiftCardReq" + }, + "name": "AdminPostGiftCardsGiftCardReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1553, + 1560, + 1537, + 1507, + 1556 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 1507, + 1537 + ] + }, + { + "title": "Mutations", + "children": [ + 1553, + 1556, + 1560 + ] + } + ] + }, + { + "id": 19, + "name": "Inventory Items", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Inventory Item API Routes](https://docs.medusajs.com/api/admin#inventory-items). \nTo use these hooks, make sure to install the\n[@medusajs/inventory](https://docs.medusajs.com/modules/multiwarehouse/install-modules#inventory-module) module in your Medusa backend.\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nInventory items, provided by the [Inventory Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module), can be \nused to manage the inventory of saleable items in your store.\n\nRelated Guide: [How to manage inventory items](https://docs.medusajs.com/modules/multiwarehouse/admin/manage-inventory-items)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1641, + "name": "useAdminCreateInventoryItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1642, + "name": "useAdminCreateInventoryItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates an Inventory Item for a product variant." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateInventoryItem } from \"medusa-react\"\n\nconst CreateInventoryItem = () => {\n const createInventoryItem = useAdminCreateInventoryItem()\n // ...\n\n const handleCreate = (variantId: string) => {\n createInventoryItem.mutate({\n variant_id: variantId,\n }, {\n onSuccess: ({ inventory_item }) => {\n console.log(inventory_item.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateInventoryItem\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1643, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsRes" + }, + "name": "AdminInventoryItemsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts", + "qualifiedName": "AdminPostInventoryItemsReq" + }, + "name": "AdminPostInventoryItemsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsRes" + }, + "name": "AdminInventoryItemsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts", + "qualifiedName": "AdminPostInventoryItemsReq" + }, + "name": "AdminPostInventoryItemsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1663, + "name": "useAdminCreateLocationLevel", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1664, + "name": "useAdminCreateLocationLevel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a Location Level for a given Inventory Item." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateLocationLevel } from \"medusa-react\"\n\ntype Props = {\n inventoryItemId: string\n}\n\nconst InventoryItem = ({ inventoryItemId }: Props) => {\n const createLocationLevel = useAdminCreateLocationLevel(\n inventoryItemId\n )\n // ...\n\n const handleCreateLocationLevel = (\n locationId: string,\n stockedQuantity: number\n ) => {\n createLocationLevel.mutate({\n location_id: locationId,\n stocked_quantity: stockedQuantity,\n }, {\n onSuccess: ({ inventory_item }) => {\n console.log(inventory_item.id)\n }\n })\n }\n\n // ...\n}\n\nexport default InventoryItem\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1665, + "name": "inventoryItemId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1666, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsRes" + }, + "name": "AdminInventoryItemsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/create-location-level.d.ts", + "qualifiedName": "AdminPostInventoryItemsItemLocationLevelsReq" + }, + "name": "AdminPostInventoryItemsItemLocationLevelsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsRes" + }, + "name": "AdminInventoryItemsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/create-location-level.d.ts", + "qualifiedName": "AdminPostInventoryItemsItemLocationLevelsReq" + }, + "name": "AdminPostInventoryItemsItemLocationLevelsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1648, + "name": "useAdminDeleteInventoryItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1649, + "name": "useAdminDeleteInventoryItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes an Inventory Item. This does not delete the associated product variant." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteInventoryItem } from \"medusa-react\"\n\ntype Props = {\n inventoryItemId: string\n}\n\nconst InventoryItem = ({ inventoryItemId }: Props) => {\n const deleteInventoryItem = useAdminDeleteInventoryItem(\n inventoryItemId\n )\n // ...\n\n const handleDelete = () => {\n deleteInventoryItem.mutate()\n }\n\n // ...\n}\n\nexport default InventoryItem\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1650, + "name": "inventoryItemId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1651, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1659, + "name": "useAdminDeleteLocationLevel", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1660, + "name": "useAdminDeleteLocationLevel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a location level of an Inventory Item." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The ID of the location level to delete." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteLocationLevel } from \"medusa-react\"\n\ntype Props = {\n inventoryItemId: string\n}\n\nconst InventoryItem = ({ inventoryItemId }: Props) => {\n const deleteLocationLevel = useAdminDeleteLocationLevel(\n inventoryItemId\n )\n // ...\n\n const handleDelete = (\n locationId: string\n ) => {\n deleteLocationLevel.mutate(locationId)\n }\n\n // ...\n}\n\nexport default InventoryItem\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1661, + "name": "inventoryItemId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1662, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsRes" + }, + "name": "AdminInventoryItemsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsRes" + }, + "name": "AdminInventoryItemsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1595, + "name": "useAdminInventoryItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1596, + "name": "useAdminInventoryItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves an Inventory Item's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminInventoryItem } from \"medusa-react\"\n\ntype Props = {\n inventoryItemId: string\n}\n\nconst InventoryItem = ({ inventoryItemId }: Props) => {\n const { \n inventory_item,\n isLoading\n } = useAdminInventoryItem(inventoryItemId)\n\n return (\n
\n {isLoading && Loading...}\n {inventory_item && (\n {inventory_item.sku}\n )}\n
\n )\n}\n\nexport default InventoryItem\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1597, + "name": "inventoryItemId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1598, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configurations applied on the retrieved inventory item." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/list-stock-locations.d.ts", + "qualifiedName": "AdminGetStockLocationsParams" + }, + "name": "AdminGetStockLocationsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1599, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsRes" + }, + "name": "AdminInventoryItemsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_inventory_items" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1600, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1601, + "name": "inventory_item", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "InventoryItemDTO" + }, + "name": "InventoryItemDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1602, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1601, + 1602 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1603, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1604, + "name": "inventory_item", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "InventoryItemDTO" + }, + "name": "InventoryItemDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1605, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1604, + 1605 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1606, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1607, + "name": "inventory_item", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "InventoryItemDTO" + }, + "name": "InventoryItemDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1608, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1607, + 1608 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1609, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1610, + "name": "inventory_item", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "InventoryItemDTO" + }, + "name": "InventoryItemDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1611, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1610, + 1611 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1612, + "name": "useAdminInventoryItemLocationLevels", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1613, + "name": "useAdminInventoryItemLocationLevels", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of inventory levels of an inventory item. The inventory levels can be filtered by fields \nsuch as " + }, + { + "kind": "code", + "text": "`location_id`" + }, + { + "kind": "text", + "text": " passed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminInventoryItemLocationLevels,\n} from \"medusa-react\"\n\ntype Props = {\n inventoryItemId: string\n}\n\nconst InventoryItem = ({ inventoryItemId }: Props) => {\n const { \n inventory_item,\n isLoading, \n } = useAdminInventoryItemLocationLevels(inventoryItemId)\n\n return (\n
\n {isLoading && Loading...}\n {inventory_item && (\n
    \n {inventory_item.location_levels.map((level) => (\n {level.stocked_quantity}\n ))}\n
\n )}\n
\n )\n}\n\nexport default InventoryItem\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1614, + "name": "inventoryItemId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the inventory item that the location levels belong to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1615, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on the retrieved location levels." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/list-location-levels.d.ts", + "qualifiedName": "AdminGetInventoryItemsItemLocationLevelsParams" + }, + "name": "AdminGetInventoryItemsItemLocationLevelsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1616, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsLocationLevelsRes" + }, + "name": "AdminInventoryItemsLocationLevelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_inventory_items" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1617, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1618, + "name": "inventory_item", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1619, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1620, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1621, + "name": "location_levels", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "InventoryLevelDTO" + }, + "name": "InventoryLevelDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1620, + 1621 + ] + } + ] + } + } + }, + { + "id": 1622, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1618, + 1622 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1623, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1624, + "name": "inventory_item", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1625, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1626, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1627, + "name": "location_levels", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "InventoryLevelDTO" + }, + "name": "InventoryLevelDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1626, + 1627 + ] + } + ] + } + } + }, + { + "id": 1628, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1624, + 1628 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1629, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1630, + "name": "inventory_item", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1631, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1632, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1633, + "name": "location_levels", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "InventoryLevelDTO" + }, + "name": "InventoryLevelDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1632, + 1633 + ] + } + ] + } + } + }, + { + "id": 1634, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1630, + 1634 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1635, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1636, + "name": "inventory_item", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1637, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1638, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1639, + "name": "location_levels", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "InventoryLevelDTO" + }, + "name": "InventoryLevelDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1638, + 1639 + ] + } + ] + } + } + }, + { + "id": 1640, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1636, + 1640 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1565, + "name": "useAdminInventoryItems", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1566, + "name": "useAdminInventoryItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of inventory items. The inventory items can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`location_id`" + }, + { + "kind": "text", + "text": " passed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter.\nThe inventory items can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list inventory items:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminInventoryItems } from \"medusa-react\"\n\nfunction InventoryItems() {\n const { \n inventory_items,\n isLoading \n } = useAdminInventoryItems()\n\n return (\n
\n {isLoading && Loading...}\n {inventory_items && !inventory_items.length && (\n No Items\n )}\n {inventory_items && inventory_items.length > 0 && (\n
    \n {inventory_items.map(\n (item) => (\n
  • {item.id}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default InventoryItems\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`20`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminInventoryItems } from \"medusa-react\"\n\nfunction InventoryItems() {\n const { \n inventory_items,\n limit,\n offset,\n isLoading\n } = useAdminInventoryItems({\n limit: 10,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {inventory_items && !inventory_items.length && (\n No Items\n )}\n {inventory_items && inventory_items.length > 0 && (\n
    \n {inventory_items.map(\n (item) => (\n
  • {item.id}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default InventoryItems\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1567, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations applied on the retrieved inventory items." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts", + "qualifiedName": "AdminGetInventoryItemsParams" + }, + "name": "AdminGetInventoryItemsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1568, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsListWithVariantsAndLocationLevelsRes" + }, + "name": "AdminInventoryItemsListWithVariantsAndLocationLevelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_inventory_items" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1569, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1570, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1570 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1571, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1574, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1575, + "name": "inventory_items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "DecoratedInventoryItemDTO" + }, + "name": "DecoratedInventoryItemDTO", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1572, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1573, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1576, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1574, + 1575, + 1572, + 1573, + 1576 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1577, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1580, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1581, + "name": "inventory_items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "DecoratedInventoryItemDTO" + }, + "name": "DecoratedInventoryItemDTO", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1578, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1579, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1582, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1580, + 1581, + 1578, + 1579, + 1582 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1583, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1586, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1587, + "name": "inventory_items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "DecoratedInventoryItemDTO" + }, + "name": "DecoratedInventoryItemDTO", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1584, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1585, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1588, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1586, + 1587, + 1584, + 1585, + 1588 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1589, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1592, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1593, + "name": "inventory_items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "DecoratedInventoryItemDTO" + }, + "name": "DecoratedInventoryItemDTO", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1590, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1591, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1594, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1592, + 1593, + 1590, + 1591, + 1594 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1644, + "name": "useAdminUpdateInventoryItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1645, + "name": "useAdminUpdateInventoryItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates an Inventory Item's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateInventoryItem } from \"medusa-react\"\n\ntype Props = {\n inventoryItemId: string\n}\n\nconst InventoryItem = ({ inventoryItemId }: Props) => {\n const updateInventoryItem = useAdminUpdateInventoryItem(\n inventoryItemId\n )\n // ...\n\n const handleUpdate = (origin_country: string) => {\n updateInventoryItem.mutate({\n origin_country,\n }, {\n onSuccess: ({ inventory_item }) => {\n console.log(inventory_item.origin_country)\n }\n })\n }\n\n // ...\n}\n\nexport default InventoryItem\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1646, + "name": "inventoryItemId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1647, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsRes" + }, + "name": "AdminInventoryItemsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts", + "qualifiedName": "AdminPostInventoryItemsInventoryItemReq" + }, + "name": "AdminPostInventoryItemsInventoryItemReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsRes" + }, + "name": "AdminInventoryItemsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts", + "qualifiedName": "AdminPostInventoryItemsInventoryItemReq" + }, + "name": "AdminPostInventoryItemsInventoryItemReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1655, + "name": "useAdminUpdateLocationLevel", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1656, + "name": "useAdminUpdateLocationLevel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a location level's details for a given inventory item." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateLocationLevel } from \"medusa-react\"\n\ntype Props = {\n inventoryItemId: string\n}\n\nconst InventoryItem = ({ inventoryItemId }: Props) => {\n const updateLocationLevel = useAdminUpdateLocationLevel(\n inventoryItemId\n )\n // ...\n\n const handleUpdate = (\n stockLocationId: string,\n stockedQuantity: number\n ) => {\n updateLocationLevel.mutate({\n stockLocationId,\n stocked_quantity: stockedQuantity,\n }, {\n onSuccess: ({ inventory_item }) => {\n console.log(inventory_item.id)\n }\n })\n }\n\n // ...\n}\n\nexport default InventoryItem\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1657, + "name": "inventoryItemId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1658, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsRes" + }, + "name": "AdminInventoryItemsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 1652, + "name": "AdminUpdateLocationLevelReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "AdminInventoryItemsRes" + }, + "name": "AdminInventoryItemsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 1652, + "name": "AdminUpdateLocationLevelReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1641, + 1663, + 1648, + 1659, + 1595, + 1612, + 1565, + 1644, + 1655 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 1565, + 1595, + 1612 + ] + }, + { + "title": "Mutations", + "children": [ + 1641, + 1644, + 1648, + 1655, + 1659, + 1663 + ] + } + ] + }, + { + "id": 20, + "name": "Invites", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Invite API Routes](https://docs.medusajs.com/api/admin#invites).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nAn admin can invite new users to manage their team. This would allow new users to authenticate as admins and perform admin functionalities.\n\nRelated Guide: [How to manage invites](https://docs.medusajs.com/modules/users/admin/manage-invites)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1683, + "name": "useAdminAcceptInvite", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1684, + "name": "useAdminAcceptInvite", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook accepts an Invite. This will also delete the invite and create a new user that can log in and perform admin functionalities. \nThe user will have the email associated with the invite, and the password provided in the mutation function's parameter." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminAcceptInvite } from \"medusa-react\"\n\nconst AcceptInvite = () => {\n const acceptInvite = useAdminAcceptInvite()\n // ...\n\n const handleAccept = (\n token: string,\n firstName: string,\n lastName: string,\n password: string\n ) => {\n acceptInvite.mutate({\n token,\n user: {\n first_name: firstName,\n last_name: lastName,\n password,\n },\n }, {\n onSuccess: () => {\n // invite accepted successfully.\n }\n })\n }\n\n // ...\n}\n\nexport default AcceptInvite\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1685, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts", + "qualifiedName": "AdminPostInvitesInviteAcceptReq" + }, + "name": "AdminPostInvitesInviteAcceptReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts", + "qualifiedName": "AdminPostInvitesInviteAcceptReq" + }, + "name": "AdminPostInvitesInviteAcceptReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1693, + "name": "useAdminDeleteInvite", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1694, + "name": "useAdminDeleteInvite", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes an invite. Only invites that weren't accepted can be deleted." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteInvite } from \"medusa-react\"\n\ntype Props = {\n inviteId: string\n}\n\nconst DeleteInvite = ({ inviteId }: Props) => {\n const deleteInvite = useAdminDeleteInvite(inviteId)\n // ...\n\n const handleDelete = () => {\n deleteInvite.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default Invite\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1695, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The invite's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1696, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1668, + "name": "useAdminInvites", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1669, + "name": "useAdminInvites", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of invites." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminInvites } from \"medusa-react\"\n\nconst Invites = () => {\n const { invites, isLoading } = useAdminInvites()\n\n return (\n
\n {isLoading && Loading...}\n {invites && !invites.length && (\n No Invites)\n }\n {invites && invites.length > 0 && (\n
    \n {invites.map((invite) => (\n
  • {invite.user_email}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Invites\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1670, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/invites/index.d.ts", + "qualifiedName": "AdminListInvitesRes" + }, + "name": "AdminListInvitesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_invites" + }, + { + "type": "literal", + "value": "list" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1671, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1672, + "name": "invites", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/invite.d.ts", + "qualifiedName": "Invite" + }, + "name": "Invite", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1673, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1672, + 1673 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1674, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1675, + "name": "invites", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/invite.d.ts", + "qualifiedName": "Invite" + }, + "name": "Invite", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1676, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1675, + 1676 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1677, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1678, + "name": "invites", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/invite.d.ts", + "qualifiedName": "Invite" + }, + "name": "Invite", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1679, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1678, + 1679 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1680, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1681, + "name": "invites", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/invite.d.ts", + "qualifiedName": "Invite" + }, + "name": "Invite", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1682, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1681, + 1682 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1686, + "name": "useAdminResendInvite", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1687, + "name": "useAdminResendInvite", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook resends an invite. This renews the expiry date by seven days and generates a new token for the invite. It also triggers the " + }, + { + "kind": "code", + "text": "`invite.created`" + }, + { + "kind": "text", + "text": " event, \nso if you have a Notification Provider installed that handles this event, a notification should be sent to the email associated with the \ninvite to allow them to accept the invite." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminResendInvite } from \"medusa-react\"\n\ntype Props = {\n inviteId: string\n}\n\nconst ResendInvite = ({ inviteId }: Props) => {\n const resendInvite = useAdminResendInvite(inviteId)\n // ...\n\n const handleResend = () => {\n resendInvite.mutate(void 0, {\n onSuccess: () => {\n // invite resent successfully\n }\n })\n }\n\n // ...\n}\n\nexport default ResendInvite\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1688, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The invite's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1689, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "unknown" + }, + { + "type": "intrinsic", + "name": "unknown" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "unknown" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1683, + 1693, + 1668, + 1686 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 1668 + ] + }, + { + "title": "Mutations", + "children": [ + 1683, + 1686, + 1693 + ] + } + ] + }, + { + "id": 21, + "name": "Notes", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Note API Routes](https://docs.medusajs.com/api/admin#notes).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nNotes are created by admins and can be associated with any resource. For example, an admin can add a note to an order for additional details or remarks." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1744, + "name": "useAdminCreateNote", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1745, + "name": "useAdminCreateNote", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a Note which can be associated with any resource." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateNote } from \"medusa-react\"\n\nconst CreateNote = () => {\n const createNote = useAdminCreateNote()\n // ...\n\n const handleCreate = () => {\n createNote.mutate({\n resource_id: \"order_123\",\n resource_type: \"order\",\n value: \"We delivered this order\"\n }, {\n onSuccess: ({ note }) => {\n console.log(note.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateNote\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1746, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "AdminNotesRes" + }, + "name": "AdminNotesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/create-note.d.ts", + "qualifiedName": "AdminPostNotesReq" + }, + "name": "AdminPostNotesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "AdminNotesRes" + }, + "name": "AdminNotesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/create-note.d.ts", + "qualifiedName": "AdminPostNotesReq" + }, + "name": "AdminPostNotesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1751, + "name": "useAdminDeleteNote", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1752, + "name": "useAdminDeleteNote", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a Note." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteNote } from \"medusa-react\"\n\ntype Props = {\n noteId: string\n}\n\nconst Note = ({ noteId }: Props) => {\n const deleteNote = useAdminDeleteNote(noteId)\n // ...\n\n const handleDelete = () => {\n deleteNote.mutate()\n }\n\n // ...\n}\n\nexport default Note\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1753, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The note's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1754, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1728, + "name": "useAdminNote", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1729, + "name": "useAdminNote", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a note's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminNote } from \"medusa-react\"\n\ntype Props = {\n noteId: string\n}\n\nconst Note = ({ noteId }: Props) => {\n const { note, isLoading } = useAdminNote(noteId)\n\n return (\n
\n {isLoading && Loading...}\n {note && {note.resource_type}}\n
\n )\n}\n\nexport default Note\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1730, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The note's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1731, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "AdminNotesRes" + }, + "name": "AdminNotesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_notes" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1732, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1733, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/note.d.ts", + "qualifiedName": "Note" + }, + "name": "Note", + "package": "@medusajs/medusa" + } + }, + { + "id": 1734, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1733, + 1734 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1735, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1736, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/note.d.ts", + "qualifiedName": "Note" + }, + "name": "Note", + "package": "@medusajs/medusa" + } + }, + { + "id": 1737, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1736, + 1737 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1738, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1739, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/note.d.ts", + "qualifiedName": "Note" + }, + "name": "Note", + "package": "@medusajs/medusa" + } + }, + { + "id": 1740, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1739, + 1740 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1741, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1742, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/note.d.ts", + "qualifiedName": "Note" + }, + "name": "Note", + "package": "@medusajs/medusa" + } + }, + { + "id": 1743, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1742, + 1743 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1698, + "name": "useAdminNotes", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1699, + "name": "useAdminNotes", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of notes. The notes can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`resource_id`" + }, + { + "kind": "text", + "text": " passed in \nthe " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The notes can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list notes:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminNotes } from \"medusa-react\"\n\nconst Notes = () => {\n const { notes, isLoading } = useAdminNotes()\n\n return (\n
\n {isLoading && Loading...}\n {notes && !notes.length && No Notes}\n {notes && notes.length > 0 && (\n
    \n {notes.map((note) => (\n
  • {note.resource_type}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Notes\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminNotes } from \"medusa-react\"\n\nconst Notes = () => {\n const { \n notes, \n limit,\n offset,\n isLoading\n } = useAdminNotes({\n limit: 40,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {notes && !notes.length && No Notes}\n {notes && notes.length > 0 && (\n
    \n {notes.map((note) => (\n
  • {note.resource_type}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Notes\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1700, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations applied on retrieved notes." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts", + "qualifiedName": "AdminGetNotesParams" + }, + "name": "AdminGetNotesParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1701, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "AdminNotesListRes" + }, + "name": "AdminNotesListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_notes" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1702, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1703, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1703 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1704, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1707, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1705, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1708, + "name": "notes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/note.d.ts", + "qualifiedName": "Note" + }, + "name": "Note", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1706, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1709, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1707, + 1705, + 1708, + 1706, + 1709 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1710, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1713, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1711, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1714, + "name": "notes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/note.d.ts", + "qualifiedName": "Note" + }, + "name": "Note", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1712, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1715, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1713, + 1711, + 1714, + 1712, + 1715 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1716, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1719, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1717, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1720, + "name": "notes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/note.d.ts", + "qualifiedName": "Note" + }, + "name": "Note", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1718, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1721, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1719, + 1717, + 1720, + 1718, + 1721 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1722, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1725, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1723, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1726, + "name": "notes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/note.d.ts", + "qualifiedName": "Note" + }, + "name": "Note", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1724, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1727, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1725, + 1723, + 1726, + 1724, + 1727 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1747, + "name": "useAdminUpdateNote", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1748, + "name": "useAdminUpdateNote", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a Note's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateNote } from \"medusa-react\"\n\ntype Props = {\n noteId: string\n}\n\nconst Note = ({ noteId }: Props) => {\n const updateNote = useAdminUpdateNote(noteId)\n // ...\n\n const handleUpdate = (\n value: string\n ) => {\n updateNote.mutate({\n value\n }, {\n onSuccess: ({ note }) => {\n console.log(note.value)\n }\n })\n }\n\n // ...\n}\n\nexport default Note\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1749, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The note's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1750, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "AdminNotesRes" + }, + "name": "AdminNotesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/update-note.d.ts", + "qualifiedName": "AdminPostNotesNoteReq" + }, + "name": "AdminPostNotesNoteReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "AdminNotesRes" + }, + "name": "AdminNotesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/update-note.d.ts", + "qualifiedName": "AdminPostNotesNoteReq" + }, + "name": "AdminPostNotesNoteReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1744, + 1751, + 1728, + 1698, + 1747 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 1698, + 1728 + ] + }, + { + "title": "Mutations", + "children": [ + 1744, + 1747, + 1751 + ] + } + ] + }, + { + "id": 22, + "name": "Notifications", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Notification API Routes](https://docs.medusajs.com/api/admin#notifications).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nNotifications are sent to customers to inform them of new updates. For example, a notification can be sent to the customer when their order is place or its state is updated.\nThe notification's type, such as an email or SMS, is determined by the notification provider installed on the Medusa backend." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1756, + "name": "useAdminNotifications", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1757, + "name": "useAdminNotifications", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of notifications. The notifications can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`event_name`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`resource_type`" + }, + { + "kind": "text", + "text": " passed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter.\nThe notifications can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list notifications:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminNotifications } from \"medusa-react\"\n\nconst Notifications = () => {\n const { notifications, isLoading } = useAdminNotifications()\n\n return (\n
\n {isLoading && Loading...}\n {notifications && !notifications.length && (\n No Notifications\n )}\n {notifications && notifications.length > 0 && (\n
    \n {notifications.map((notification) => (\n
  • {notification.to}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Notifications\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the notifications:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminNotifications } from \"medusa-react\"\n\nconst Notifications = () => {\n const { notifications, isLoading } = useAdminNotifications({\n expand: \"provider\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {notifications && !notifications.length && (\n No Notifications\n )}\n {notifications && notifications.length > 0 && (\n
    \n {notifications.map((notification) => (\n
  • {notification.to}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Notifications\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminNotifications } from \"medusa-react\"\n\nconst Notifications = () => {\n const { \n notifications, \n limit,\n offset,\n isLoading\n } = useAdminNotifications({\n expand: \"provider\",\n limit: 20,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {notifications && !notifications.length && (\n No Notifications\n )}\n {notifications && notifications.length > 0 && (\n
    \n {notifications.map((notification) => (\n
  • {notification.to}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Notifications\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1758, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations applied to the retrieved notifications." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts", + "qualifiedName": "AdminGetNotificationsParams" + }, + "name": "AdminGetNotificationsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1759, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notifications/index.d.ts", + "qualifiedName": "AdminNotificationsListRes" + }, + "name": "AdminNotificationsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_notifications" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1760, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1761, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1761 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1762, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1765, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1763, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1766, + "name": "notifications", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/notification.d.ts", + "qualifiedName": "Notification" + }, + "name": "Notification", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1764, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1767, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1765, + 1763, + 1766, + 1764, + 1767 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1768, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1771, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1769, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1772, + "name": "notifications", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/notification.d.ts", + "qualifiedName": "Notification" + }, + "name": "Notification", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1770, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1773, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1771, + 1769, + 1772, + 1770, + 1773 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1774, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1777, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1775, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1778, + "name": "notifications", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/notification.d.ts", + "qualifiedName": "Notification" + }, + "name": "Notification", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1776, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1779, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1777, + 1775, + 1778, + 1776, + 1779 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1780, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1783, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1781, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1784, + "name": "notifications", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/notification.d.ts", + "qualifiedName": "Notification" + }, + "name": "Notification", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1782, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1785, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1783, + 1781, + 1784, + 1782, + 1785 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1786, + "name": "useAdminResendNotification", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1787, + "name": "useAdminResendNotification", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook resends a previously sent notifications, with the same data but optionally to a different address." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminResendNotification } from \"medusa-react\"\n\ntype Props = {\n notificationId: string\n}\n\nconst Notification = ({ notificationId }: Props) => {\n const resendNotification = useAdminResendNotification(\n notificationId\n )\n // ...\n\n const handleResend = () => {\n resendNotification.mutate({}, {\n onSuccess: ({ notification }) => {\n console.log(notification.id)\n }\n })\n }\n\n // ...\n}\n\nexport default Notification\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1788, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the notification." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1789, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notifications/index.d.ts", + "qualifiedName": "AdminNotificationsRes" + }, + "name": "AdminNotificationsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notifications/resend-notification.d.ts", + "qualifiedName": "AdminPostNotificationsNotificationResendReq" + }, + "name": "AdminPostNotificationsNotificationResendReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notifications/index.d.ts", + "qualifiedName": "AdminNotificationsRes" + }, + "name": "AdminNotificationsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notifications/resend-notification.d.ts", + "qualifiedName": "AdminPostNotificationsNotificationResendReq" + }, + "name": "AdminPostNotificationsNotificationResendReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1756, + 1786 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 1756 + ] + }, + { + "title": "Mutations", + "children": [ + 1786 + ] + } + ] + }, + { + "id": 23, + "name": "Order Edits", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Order Edit API Routes](https://docs.medusajs.com/api/admin#order-edits).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nAn admin can edit an order to remove, add, or update an item's quantity. When an admin edits an order, they're stored as an " + }, + { + "kind": "code", + "text": "`OrderEdit`" + }, + { + "kind": "text", + "text": ".\n\nRelated Guide: [How to edit an order](https://docs.medusajs.com/modules/orders/admin/edit-order)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1872, + "name": "useAdminCancelOrderEdit", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1873, + "name": "useAdminCancelOrderEdit", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook cancels an order edit." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminCancelOrderEdit,\n} from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n}\n\nconst OrderEdit = ({ orderEditId }: Props) => {\n const cancelOrderEdit = \n useAdminCancelOrderEdit(\n orderEditId\n )\n \n const handleCancel = () => {\n cancelOrderEdit.mutate(void 0, {\n onSuccess: ({ order_edit }) => {\n console.log(\n order_edit.id\n )\n }\n })\n }\n\n // ...\n}\n\nexport default OrderEdit\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1874, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1875, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1876, + "name": "useAdminConfirmOrderEdit", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1877, + "name": "useAdminConfirmOrderEdit", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook confirms an order edit. This will reflect the changes in the order edit on the associated order." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminConfirmOrderEdit } from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n}\n\nconst OrderEdit = ({ orderEditId }: Props) => {\n const confirmOrderEdit = useAdminConfirmOrderEdit(\n orderEditId\n )\n \n const handleConfirmOrderEdit = () => {\n confirmOrderEdit.mutate(void 0, {\n onSuccess: ({ order_edit }) => {\n console.log(\n order_edit.confirmed_at,\n order_edit.confirmed_by\n )\n }\n })\n }\n\n // ...\n}\n\nexport default OrderEdit\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1878, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1879, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1838, + "name": "useAdminCreateOrderEdit", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1839, + "name": "useAdminCreateOrderEdit", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates an order edit." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateOrderEdit } from \"medusa-react\"\n\nconst CreateOrderEdit = () => {\n const createOrderEdit = useAdminCreateOrderEdit()\n\n const handleCreateOrderEdit = (orderId: string) => {\n createOrderEdit.mutate({\n order_id: orderId,\n }, {\n onSuccess: ({ order_edit }) => {\n console.log(order_edit.id)\n }\n })\n }\n \n // ...\n}\n\nexport default CreateOrderEdit\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1840, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/create-order-edit.d.ts", + "qualifiedName": "AdminPostOrderEditsReq" + }, + "name": "AdminPostOrderEditsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/create-order-edit.d.ts", + "qualifiedName": "AdminPostOrderEditsReq" + }, + "name": "AdminPostOrderEditsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1841, + "name": "useAdminDeleteOrderEdit", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1842, + "name": "useAdminDeleteOrderEdit", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes an order edit. Only order edits that have the status " + }, + { + "kind": "code", + "text": "`created`" + }, + { + "kind": "text", + "text": " can be deleted." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteOrderEdit } from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n}\n\nconst OrderEdit = ({ orderEditId }: Props) => {\n const deleteOrderEdit = useAdminDeleteOrderEdit(\n orderEditId\n )\n \n const handleDelete = () => {\n deleteOrderEdit.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default OrderEdit\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1843, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Order Edit's ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1844, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1845, + "name": "useAdminDeleteOrderEditItemChange", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1846, + "name": "useAdminDeleteOrderEditItemChange", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a line item change that indicates the addition, deletion, or update of a line item in the original order." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteOrderEditItemChange } from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n itemChangeId: string\n}\n\nconst OrderEditItemChange = ({\n orderEditId,\n itemChangeId\n}: Props) => {\n const deleteItemChange = useAdminDeleteOrderEditItemChange(\n orderEditId, \n itemChangeId\n )\n \n const handleDeleteItemChange = () => {\n deleteItemChange.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default OrderEditItemChange\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1847, + "name": "orderEditId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1848, + "name": "itemChangeId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item change's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1849, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditItemChangeDeleteRes" + }, + "name": "AdminOrderEditItemChangeDeleteRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditItemChangeDeleteRes" + }, + "name": "AdminOrderEditItemChangeDeleteRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1791, + "name": "useAdminOrderEdit", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1792, + "name": "useAdminOrderEdit", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves an order edit's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "A simple example that retrieves an order edit by its ID:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminOrderEdit } from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n}\n\nconst OrderEdit = ({ orderEditId }: Props) => {\n const { \n order_edit, \n isLoading, \n } = useAdminOrderEdit(orderEditId)\n\n return (\n
\n {isLoading && Loading...}\n {order_edit && {order_edit.status}}\n
\n )\n}\n\nexport default OrderEdit\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminOrderEdit } from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n}\n\nconst OrderEdit = ({ orderEditId }: Props) => {\n const { \n order_edit, \n isLoading, \n } = useAdminOrderEdit(\n orderEditId,\n {\n expand: \"order\"\n }\n )\n\n return (\n
\n {isLoading && Loading...}\n {order_edit && {order_edit.status}}\n
\n )\n}\n\nexport default OrderEdit\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1793, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1794, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configurations to apply on the retrieved order edit." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/get-order-edit.d.ts", + "qualifiedName": "GetOrderEditsOrderEditParams" + }, + "name": "GetOrderEditsOrderEditParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1795, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_order_edits" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1796, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1797, + "name": "order_edit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order-edit.d.ts", + "qualifiedName": "OrderEdit" + }, + "name": "OrderEdit", + "package": "@medusajs/medusa" + } + }, + { + "id": 1798, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1797, + 1798 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1799, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1800, + "name": "order_edit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order-edit.d.ts", + "qualifiedName": "OrderEdit" + }, + "name": "OrderEdit", + "package": "@medusajs/medusa" + } + }, + { + "id": 1801, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1800, + 1801 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1802, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1803, + "name": "order_edit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order-edit.d.ts", + "qualifiedName": "OrderEdit" + }, + "name": "OrderEdit", + "package": "@medusajs/medusa" + } + }, + { + "id": 1804, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1803, + 1804 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1805, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1806, + "name": "order_edit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order-edit.d.ts", + "qualifiedName": "OrderEdit" + }, + "name": "OrderEdit", + "package": "@medusajs/medusa" + } + }, + { + "id": 1807, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1806, + 1807 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1864, + "name": "useAdminOrderEditAddLineItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1865, + "name": "useAdminOrderEditAddLineItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a line item change in the order edit that indicates adding an item in the original order. \nThe item will not be added to the original order until the order edit is confirmed." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminOrderEditAddLineItem } from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n}\n\nconst OrderEdit = ({ orderEditId }: Props) => {\n const addLineItem = useAdminOrderEditAddLineItem(\n orderEditId\n )\n\n const handleAddLineItem = \n (quantity: number, variantId: string) => {\n addLineItem.mutate({\n quantity,\n variant_id: variantId,\n }, {\n onSuccess: ({ order_edit }) => {\n console.log(order_edit.changes)\n }\n })\n }\n \n // ...\n}\n\nexport default OrderEdit\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1866, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1867, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts", + "qualifiedName": "AdminPostOrderEditsEditLineItemsReq" + }, + "name": "AdminPostOrderEditsEditLineItemsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts", + "qualifiedName": "AdminPostOrderEditsEditLineItemsReq" + }, + "name": "AdminPostOrderEditsEditLineItemsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1855, + "name": "useAdminOrderEditDeleteLineItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1856, + "name": "useAdminOrderEditDeleteLineItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a line item change in the order edit that indicates deleting an item in the original order. \nThe item in the original order will not be deleted until the order edit is confirmed." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminOrderEditDeleteLineItem } from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n itemId: string\n}\n\nconst OrderEditLineItem = ({\n orderEditId,\n itemId\n}: Props) => {\n const removeLineItem = useAdminOrderEditDeleteLineItem(\n orderEditId, \n itemId\n )\n \n const handleRemoveLineItem = () => {\n removeLineItem.mutate(void 0, {\n onSuccess: ({ order_edit }) => {\n console.log(order_edit.changes)\n }\n })\n }\n\n // ...\n}\n\nexport default OrderEditLineItem\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1857, + "name": "orderEditId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1858, + "name": "itemId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1859, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1850, + "name": "useAdminOrderEditUpdateLineItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1851, + "name": "useAdminOrderEditUpdateLineItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates or updates a line item change in the order edit that indicates addition, deletion, or update of a line item \ninto an original order. Line item changes are only reflected on the original order after the order edit is confirmed." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminOrderEditUpdateLineItem } from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n itemId: string\n}\n\nconst OrderEditItemChange = ({\n orderEditId,\n itemId\n}: Props) => {\n const updateLineItem = useAdminOrderEditUpdateLineItem(\n orderEditId, \n itemId\n )\n \n const handleUpdateLineItem = (quantity: number) => {\n updateLineItem.mutate({\n quantity,\n }, {\n onSuccess: ({ order_edit }) => {\n console.log(order_edit.items)\n }\n })\n }\n\n // ...\n}\n\nexport default OrderEditItemChange\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1852, + "name": "orderEditId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1853, + "name": "itemId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1854, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/update-order-edit-line-item.d.ts", + "qualifiedName": "AdminPostOrderEditsEditLineItemsLineItemReq" + }, + "name": "AdminPostOrderEditsEditLineItemsLineItemReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/update-order-edit-line-item.d.ts", + "qualifiedName": "AdminPostOrderEditsEditLineItemsLineItemReq" + }, + "name": "AdminPostOrderEditsEditLineItemsLineItemReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1808, + "name": "useAdminOrderEdits", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1809, + "name": "useAdminOrderEdits", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of order edits. The order edits can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`order_id`" + }, + { + "kind": "text", + "text": " passed to the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. \nThe order edits can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list order edits:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminOrderEdits } from \"medusa-react\"\n\nconst OrderEdits = () => {\n const { order_edits, isLoading } = useAdminOrderEdits()\n\n return (\n
\n {isLoading && Loading...}\n {order_edits && !order_edits.length && (\n No Order Edits\n )}\n {order_edits && order_edits.length > 0 && (\n
    \n {order_edits.map((orderEdit) => (\n
  • \n {orderEdit.status}\n
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default OrderEdits\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the order edits:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminOrderEdits } from \"medusa-react\"\n\nconst OrderEdits = () => {\n const { order_edits, isLoading } = useAdminOrderEdits({\n expand: \"order\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {order_edits && !order_edits.length && (\n No Order Edits\n )}\n {order_edits && order_edits.length > 0 && (\n
    \n {order_edits.map((orderEdit) => (\n
  • \n {orderEdit.status}\n
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default OrderEdits\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminOrderEdits } from \"medusa-react\"\n\nconst OrderEdits = () => {\n const { \n order_edits,\n limit,\n offset,\n isLoading\n } = useAdminOrderEdits({\n expand: \"order\",\n limit: 20,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {order_edits && !order_edits.length && (\n No Order Edits\n )}\n {order_edits && order_edits.length > 0 && (\n
    \n {order_edits.map((orderEdit) => (\n
  • \n {orderEdit.status}\n
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default OrderEdits\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1810, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations applied to retrieved order edits." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts", + "qualifiedName": "GetOrderEditsParams" + }, + "name": "GetOrderEditsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1811, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsListRes" + }, + "name": "AdminOrderEditsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_order_edits" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1812, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1813, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1813 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1814, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1817, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1815, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1816, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1818, + "name": "order_edits", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order-edit.d.ts", + "qualifiedName": "OrderEdit" + }, + "name": "OrderEdit", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1819, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1817, + 1815, + 1816, + 1818, + 1819 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1820, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1823, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1821, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1822, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1824, + "name": "order_edits", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order-edit.d.ts", + "qualifiedName": "OrderEdit" + }, + "name": "OrderEdit", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1825, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1823, + 1821, + 1822, + 1824, + 1825 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1826, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1829, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1827, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1828, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1830, + "name": "order_edits", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order-edit.d.ts", + "qualifiedName": "OrderEdit" + }, + "name": "OrderEdit", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1831, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1829, + 1827, + 1828, + 1830, + 1831 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1832, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1835, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1833, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1834, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1836, + "name": "order_edits", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order-edit.d.ts", + "qualifiedName": "OrderEdit" + }, + "name": "OrderEdit", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1837, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1835, + 1833, + 1834, + 1836, + 1837 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1868, + "name": "useAdminRequestOrderEditConfirmation", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1869, + "name": "useAdminRequestOrderEditConfirmation", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook requests customer confirmation of an order edit. This would emit the event " + }, + { + "kind": "code", + "text": "`order-edit.requested`" + }, + { + "kind": "text", + "text": " which Notification Providers listen to and send\na notification to the customer about the order edit." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminRequestOrderEditConfirmation,\n} from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n}\n\nconst OrderEdit = ({ orderEditId }: Props) => {\n const requestOrderConfirmation = \n useAdminRequestOrderEditConfirmation(\n orderEditId\n )\n \n const handleRequestConfirmation = () => {\n requestOrderConfirmation.mutate(void 0, {\n onSuccess: ({ order_edit }) => {\n console.log(\n order_edit.requested_at, \n order_edit.requested_by\n )\n }\n })\n }\n\n // ...\n}\n\nexport default OrderEdit\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1870, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1871, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1860, + "name": "useAdminUpdateOrderEdit", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1861, + "name": "useAdminUpdateOrderEdit", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates an Order Edit's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateOrderEdit } from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n}\n\nconst OrderEdit = ({ orderEditId }: Props) => {\n const updateOrderEdit = useAdminUpdateOrderEdit(\n orderEditId, \n )\n \n const handleUpdate = (\n internalNote: string\n ) => {\n updateOrderEdit.mutate({\n internal_note: internalNote\n }, {\n onSuccess: ({ order_edit }) => {\n console.log(order_edit.internal_note)\n }\n })\n }\n\n // ...\n}\n\nexport default OrderEdit\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1862, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1863, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/update-order-edit.d.ts", + "qualifiedName": "AdminPostOrderEditsOrderEditReq" + }, + "name": "AdminPostOrderEditsOrderEditReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "AdminOrderEditsRes" + }, + "name": "AdminOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/update-order-edit.d.ts", + "qualifiedName": "AdminPostOrderEditsOrderEditReq" + }, + "name": "AdminPostOrderEditsOrderEditReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1872, + 1876, + 1838, + 1841, + 1845, + 1791, + 1864, + 1855, + 1850, + 1808, + 1868, + 1860 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 1791, + 1808 + ] + }, + { + "title": "Mutations", + "children": [ + 1838, + 1841, + 1845, + 1850, + 1855, + 1860, + 1864, + 1868, + 1872, + 1876 + ] + } + ] + }, + { + "id": 24, + "name": "Orders", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Order API Routes](https://docs.medusajs.com/api/admin#orders).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nOrders are purchases made by customers, typically through a storefront using cart. Managing orders include managing fulfillment, payment, claims, reservations, and more.\n\nRelated Guide: [How to manage orders](https://docs.medusajs.com/modules/orders/admin/manage-orders)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1992, + "name": "useAdminAddShippingMethod", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1993, + "name": "useAdminAddShippingMethod", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a shipping method to an order. If another shipping method exists with the same shipping profile, the previous shipping method will be replaced." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminAddShippingMethod } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const addShippingMethod = useAdminAddShippingMethod(\n orderId\n )\n // ...\n\n const handleAddShippingMethod = (\n optionId: string,\n price: number\n ) => {\n addShippingMethod.mutate({\n option_id: optionId,\n price\n }, {\n onSuccess: ({ order }) => {\n console.log(order.shipping_methods)\n }\n })\n }\n\n // ...\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1994, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1995, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts", + "qualifiedName": "AdminPostOrdersOrderShippingMethodsReq" + }, + "name": "AdminPostOrdersOrderShippingMethodsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts", + "qualifiedName": "AdminPostOrdersOrderShippingMethodsReq" + }, + "name": "AdminPostOrdersOrderShippingMethodsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1996, + "name": "useAdminArchiveOrder", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1997, + "name": "useAdminArchiveOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The hook archives an order and change its status." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminArchiveOrder } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const archiveOrder = useAdminArchiveOrder(\n orderId\n )\n // ...\n\n const handleArchivingOrder = () => {\n archiveOrder.mutate(void 0, {\n onSuccess: ({ order }) => {\n console.log(order.status)\n }\n })\n }\n\n // ...\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1998, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1999, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1980, + "name": "useAdminCancelFulfillment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1981, + "name": "useAdminCancelFulfillment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook cancels an order's fulfillment and change its fulfillment status to " + }, + { + "kind": "code", + "text": "`canceled`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The fulfillment's ID." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCancelFulfillment } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const cancelFulfillment = useAdminCancelFulfillment(\n orderId\n )\n // ...\n\n const handleCancel = (\n fulfillmentId: string\n ) => {\n cancelFulfillment.mutate(fulfillmentId, {\n onSuccess: ({ order }) => {\n console.log(order.fulfillments)\n }\n })\n }\n\n // ...\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1982, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1983, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1960, + "name": "useAdminCancelOrder", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1961, + "name": "useAdminCancelOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook cancels an order and change its status. This will also cancel any associated fulfillments and payments, \nand it may fail if the payment or fulfillment Provider is unable to cancel the payment/fulfillment." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCancelOrder } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const cancelOrder = useAdminCancelOrder(\n orderId\n )\n // ...\n\n const handleCancel = () => {\n cancelOrder.mutate(void 0, {\n onSuccess: ({ order }) => {\n console.log(order.status)\n }\n })\n }\n\n // ...\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1962, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1963, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1968, + "name": "useAdminCapturePayment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1969, + "name": "useAdminCapturePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook captures all the payments associated with an order. The payment of canceled orders can't be captured." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCapturePayment } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const capturePayment = useAdminCapturePayment(\n orderId\n )\n // ...\n\n const handleCapture = () => {\n capturePayment.mutate(void 0, {\n onSuccess: ({ order }) => {\n console.log(order.status)\n }\n })\n }\n\n // ...\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1970, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1971, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1964, + "name": "useAdminCompleteOrder", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1965, + "name": "useAdminCompleteOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook completes an order and change its status. A canceled order can't be completed." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCompleteOrder } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const completeOrder = useAdminCompleteOrder(\n orderId\n )\n // ...\n\n const handleComplete = () => {\n completeOrder.mutate(void 0, {\n onSuccess: ({ order }) => {\n console.log(order.status)\n }\n })\n }\n\n // ...\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1966, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1967, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1976, + "name": "useAdminCreateFulfillment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1977, + "name": "useAdminCreateFulfillment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a Fulfillment of an Order using the fulfillment provider, and change the order's \nfulfillment status to either " + }, + { + "kind": "code", + "text": "`partially_fulfilled`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`fulfilled`" + }, + { + "kind": "text", + "text": ", depending on\nwhether all the items were fulfilled." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateFulfillment } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const createFulfillment = useAdminCreateFulfillment(\n orderId\n )\n // ...\n\n const handleCreateFulfillment = (\n itemId: string,\n quantity: number\n ) => {\n createFulfillment.mutate({\n items: [\n {\n item_id: itemId,\n quantity,\n },\n ],\n }, {\n onSuccess: ({ order }) => {\n console.log(order.fulfillments)\n }\n })\n }\n\n // ...\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1978, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1979, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts", + "qualifiedName": "AdminPostOrdersOrderFulfillmentsReq" + }, + "name": "AdminPostOrdersOrderFulfillmentsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts", + "qualifiedName": "AdminPostOrdersOrderFulfillmentsReq" + }, + "name": "AdminPostOrdersOrderFulfillmentsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1984, + "name": "useAdminCreateShipment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1985, + "name": "useAdminCreateShipment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a shipment and mark a fulfillment as shipped. This changes the order's fulfillment status to either \n" + }, + { + "kind": "code", + "text": "`partially_shipped`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`shipped`" + }, + { + "kind": "text", + "text": ", depending on whether all the items were shipped." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateShipment } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const createShipment = useAdminCreateShipment(\n orderId\n )\n // ...\n\n const handleCreate = (\n fulfillmentId: string\n ) => {\n createShipment.mutate({\n fulfillment_id: fulfillmentId,\n }, {\n onSuccess: ({ order }) => {\n console.log(order.fulfillment_status)\n }\n })\n }\n\n // ...\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1986, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1987, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/create-shipment.d.ts", + "qualifiedName": "AdminPostOrdersOrderShipmentReq" + }, + "name": "AdminPostOrdersOrderShipmentReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/create-shipment.d.ts", + "qualifiedName": "AdminPostOrdersOrderShipmentReq" + }, + "name": "AdminPostOrdersOrderShipmentReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1936, + "name": "useAdminOrder", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1937, + "name": "useAdminOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieve an order's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "A simple example that retrieves an order by its ID:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminOrder } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const { \n order, \n isLoading, \n } = useAdminOrder(orderId)\n\n return (\n
\n {isLoading && Loading...}\n {order && {order.display_id}}\n \n
\n )\n}\n\nexport default Order\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminOrder } from \"medusa-react\"\n\nconst Order = (\n orderId: string\n) => {\n const { \n order, \n isLoading, \n } = useAdminOrder(orderId, {\n expand: \"customer\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {order && {order.display_id}}\n \n
\n )\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1938, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1939, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configurations to apply on the retrieved order." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "FindParams" + }, + "name": "FindParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1940, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1941, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1942, + "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": 1943, + "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": "Properties", + "children": [ + 1942, + 1943 + ] + } + ] + } + } + ] + } + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1944, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1945, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 1946, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1945, + 1946 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1947, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1948, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 1949, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1948, + 1949 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1950, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1951, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 1952, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1951, + 1952 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1953, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1954, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 1955, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1954, + 1955 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1906, + "name": "useAdminOrders", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1907, + "name": "useAdminOrders", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of orders. The orders can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`status`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`display_id`" + }, + { + "kind": "text", + "text": " passed \nin the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The order can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list orders:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminOrders } from \"medusa-react\"\n\nconst Orders = () => {\n const { orders, isLoading } = useAdminOrders()\n\n return (\n
\n {isLoading && Loading...}\n {orders && !orders.length && No Orders}\n {orders && orders.length > 0 && (\n
    \n {orders.map((order) => (\n
  • {order.display_id}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Orders\n```" + }, + { + "kind": "text", + "text": "\n\nYou can use the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter to pass filters and specify relations that should be retrieved within the orders. In addition,\nBy default, only the first " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminOrders } from \"medusa-react\"\n\nconst Orders = () => {\n const { \n orders,\n limit,\n offset,\n isLoading\n } = useAdminOrders({\n expand: \"customers\",\n limit: 20,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {orders && !orders.length && No Orders}\n {orders && orders.length > 0 && (\n
    \n {orders.map((order) => (\n
  • {order.display_id}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Orders\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1908, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations applied on the retrieved orders." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts", + "qualifiedName": "AdminGetOrdersParams" + }, + "name": "AdminGetOrdersParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 1909, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersListRes" + }, + "name": "AdminOrdersListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_orders" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1910, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1911, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1911 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1912, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1915, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1913, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1914, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1916, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1917, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1915, + 1913, + 1914, + 1916, + 1917 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1918, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1921, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1919, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1920, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1922, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1923, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1921, + 1919, + 1920, + 1922, + 1923 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1924, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1927, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1925, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1926, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1928, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1929, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1927, + 1925, + 1926, + 1928, + 1929 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1930, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1933, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1931, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1932, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1934, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1935, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1933, + 1931, + 1932, + 1934, + 1935 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1972, + "name": "useAdminRefundPayment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1973, + "name": "useAdminRefundPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook refunds an amount for an order. The amount must be less than or equal the " + }, + { + "kind": "code", + "text": "`refundable_amount`" + }, + { + "kind": "text", + "text": " of the order." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminRefundPayment } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const refundPayment = useAdminRefundPayment(\n orderId\n )\n // ...\n\n const handleRefund = (\n amount: number,\n reason: string\n ) => {\n refundPayment.mutate({\n amount,\n reason,\n }, {\n onSuccess: ({ order }) => {\n console.log(order.refunds)\n }\n })\n }\n\n // ...\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1974, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1975, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts", + "qualifiedName": "AdminPostOrdersOrderRefundsReq" + }, + "name": "AdminPostOrdersOrderRefundsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts", + "qualifiedName": "AdminPostOrdersOrderRefundsReq" + }, + "name": "AdminPostOrdersOrderRefundsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1988, + "name": "useAdminRequestReturn", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1989, + "name": "useAdminRequestReturn", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook requests and create a return for items in an order. If the return shipping method is specified, it will be automatically fulfilled." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminRequestReturn } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const requestReturn = useAdminRequestReturn(\n orderId\n )\n // ...\n\n const handleRequestingReturn = (\n itemId: string,\n quantity: number\n ) => {\n requestReturn.mutate({\n items: [\n {\n item_id: itemId,\n quantity\n }\n ]\n }, {\n onSuccess: ({ order }) => {\n console.log(order.returns)\n }\n })\n }\n\n // ...\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1990, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1991, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/request-return.d.ts", + "qualifiedName": "AdminPostOrdersOrderReturnsReq" + }, + "name": "AdminPostOrdersOrderReturnsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/request-return.d.ts", + "qualifiedName": "AdminPostOrdersOrderReturnsReq" + }, + "name": "AdminPostOrdersOrderReturnsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1956, + "name": "useAdminUpdateOrder", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1957, + "name": "useAdminUpdateOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates an order's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateOrder } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const updateOrder = useAdminUpdateOrder(\n orderId\n )\n\n const handleUpdate = (\n email: string\n ) => {\n updateOrder.mutate({\n email,\n }, {\n onSuccess: ({ order }) => {\n console.log(order.email)\n }\n })\n }\n\n // ...\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1958, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1959, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/update-order.d.ts", + "qualifiedName": "AdminPostOrdersOrderReq" + }, + "name": "AdminPostOrdersOrderReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/update-order.d.ts", + "qualifiedName": "AdminPostOrdersOrderReq" + }, + "name": "AdminPostOrdersOrderReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1992, + 1996, + 1980, + 1960, + 1968, + 1964, + 1976, + 1984, + 1936, + 1906, + 1972, + 1988, + 1956 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 1906, + 1936 + ] + }, + { + "title": "Mutations", + "children": [ + 1956, + 1960, + 1964, + 1968, + 1972, + 1976, + 1980, + 1984, + 1988, + 1992, + 1996 + ] + } + ] + }, + { + "id": 25, + "name": "Payment Collections", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Payment Collection API Routes](https://docs.medusajs.com/api/admin#payment-collections).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA payment collection is useful for managing additional payments, such as for Order Edits, or installment payments." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2017, + "name": "useAdminDeletePaymentCollection", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2018, + "name": "useAdminDeletePaymentCollection", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a payment collection. Only payment collections with the statuses " + }, + { + "kind": "code", + "text": "`canceled`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`not_paid`" + }, + { + "kind": "text", + "text": " can be deleted." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeletePaymentCollection } from \"medusa-react\"\n\ntype Props = {\n paymentCollectionId: string\n}\n\nconst PaymentCollection = ({ paymentCollectionId }: Props) => {\n const deleteCollection = useAdminDeletePaymentCollection(\n paymentCollectionId\n )\n // ...\n\n const handleDelete = () => {\n deleteCollection.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default PaymentCollection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2019, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2020, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts", + "qualifiedName": "AdminPaymentCollectionDeleteRes" + }, + "name": "AdminPaymentCollectionDeleteRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts", + "qualifiedName": "AdminPaymentCollectionDeleteRes" + }, + "name": "AdminPaymentCollectionDeleteRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2025, + "name": "useAdminMarkPaymentCollectionAsAuthorized", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2026, + "name": "useAdminMarkPaymentCollectionAsAuthorized", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook sets the status of a payment collection as " + }, + { + "kind": "code", + "text": "`authorized`" + }, + { + "kind": "text", + "text": ". This will also change the " + }, + { + "kind": "code", + "text": "`authorized_amount`" + }, + { + "kind": "text", + "text": " of the payment collection." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminMarkPaymentCollectionAsAuthorized } from \"medusa-react\"\n\ntype Props = {\n paymentCollectionId: string\n}\n\nconst PaymentCollection = ({ paymentCollectionId }: Props) => {\n const markAsAuthorized = useAdminMarkPaymentCollectionAsAuthorized(\n paymentCollectionId\n )\n // ...\n\n const handleAuthorization = () => {\n markAsAuthorized.mutate(void 0, {\n onSuccess: ({ payment_collection }) => {\n console.log(payment_collection.status)\n }\n })\n }\n\n // ...\n}\n\nexport default PaymentCollection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2027, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2028, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts", + "qualifiedName": "AdminPaymentCollectionsRes" + }, + "name": "AdminPaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts", + "qualifiedName": "AdminPaymentCollectionsRes" + }, + "name": "AdminPaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2001, + "name": "useAdminPaymentCollection", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2002, + "name": "useAdminPaymentCollection", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a Payment Collection's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminPaymentCollection } from \"medusa-react\"\n\ntype Props = {\n paymentCollectionId: string\n}\n\nconst PaymentCollection = ({ paymentCollectionId }: Props) => {\n const { \n payment_collection, \n isLoading, \n } = useAdminPaymentCollection(paymentCollectionId)\n\n return (\n
\n {isLoading && Loading...}\n {payment_collection && (\n {payment_collection.status}\n )}\n \n
\n )\n}\n\nexport default PaymentCollection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2003, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2004, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts", + "qualifiedName": "AdminPaymentCollectionsRes" + }, + "name": "AdminPaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "paymentCollection" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2005, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2006, + "name": "payment_collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment-collection.d.ts", + "qualifiedName": "PaymentCollection" + }, + "name": "PaymentCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 2007, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2006, + 2007 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2008, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2009, + "name": "payment_collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment-collection.d.ts", + "qualifiedName": "PaymentCollection" + }, + "name": "PaymentCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 2010, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2009, + 2010 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2011, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2012, + "name": "payment_collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment-collection.d.ts", + "qualifiedName": "PaymentCollection" + }, + "name": "PaymentCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 2013, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2012, + 2013 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2014, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2015, + "name": "payment_collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment-collection.d.ts", + "qualifiedName": "PaymentCollection" + }, + "name": "PaymentCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 2016, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2015, + 2016 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2021, + "name": "useAdminUpdatePaymentCollection", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2022, + "name": "useAdminUpdatePaymentCollection", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a payment collection's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdatePaymentCollection } from \"medusa-react\"\n\ntype Props = {\n paymentCollectionId: string\n}\n\nconst PaymentCollection = ({ paymentCollectionId }: Props) => {\n const updateCollection = useAdminUpdatePaymentCollection(\n paymentCollectionId\n )\n // ...\n\n const handleUpdate = (\n description: string\n ) => {\n updateCollection.mutate({\n description\n }, {\n onSuccess: ({ payment_collection }) => {\n console.log(payment_collection.description)\n }\n })\n }\n\n // ...\n}\n\nexport default PaymentCollection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2023, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2024, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts", + "qualifiedName": "AdminPaymentCollectionsRes" + }, + "name": "AdminPaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/update-payment-collection.d.ts", + "qualifiedName": "AdminUpdatePaymentCollectionsReq" + }, + "name": "AdminUpdatePaymentCollectionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts", + "qualifiedName": "AdminPaymentCollectionsRes" + }, + "name": "AdminPaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/update-payment-collection.d.ts", + "qualifiedName": "AdminUpdatePaymentCollectionsReq" + }, + "name": "AdminUpdatePaymentCollectionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2017, + 2025, + 2001, + 2021 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2001 + ] + }, + { + "title": "Mutations", + "children": [ + 2017, + 2021, + 2025 + ] + } + ] + }, + { + "id": 26, + "name": "Payments", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Payment API Routes](https://docs.medusajs.com/api/admin#payments).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA payment can be related to an order, swap, return, or more. It can be captured or refunded." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2030, + "name": "useAdminPayment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2031, + "name": "useAdminPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a payment's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminPayment } from \"medusa-react\"\n\ntype Props = {\n paymentId: string\n}\n\nconst Payment = ({ paymentId }: Props) => {\n const { \n payment, \n isLoading, \n } = useAdminPayment(paymentId)\n\n return (\n
\n {isLoading && Loading...}\n {payment && {payment.amount}}\n \n
\n )\n}\n\nexport default Payment\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2032, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2033, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payments/index.d.ts", + "qualifiedName": "AdminPaymentRes" + }, + "name": "AdminPaymentRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "payment" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2034, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2035, + "name": "payment", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment.d.ts", + "qualifiedName": "Payment" + }, + "name": "Payment", + "package": "@medusajs/medusa" + } + }, + { + "id": 2036, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2035, + 2036 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2037, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2038, + "name": "payment", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment.d.ts", + "qualifiedName": "Payment" + }, + "name": "Payment", + "package": "@medusajs/medusa" + } + }, + { + "id": 2039, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2038, + 2039 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2040, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2041, + "name": "payment", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment.d.ts", + "qualifiedName": "Payment" + }, + "name": "Payment", + "package": "@medusajs/medusa" + } + }, + { + "id": 2042, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2041, + 2042 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2043, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2044, + "name": "payment", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment.d.ts", + "qualifiedName": "Payment" + }, + "name": "Payment", + "package": "@medusajs/medusa" + } + }, + { + "id": 2045, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2044, + 2045 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2046, + "name": "useAdminPaymentsCapturePayment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2047, + "name": "useAdminPaymentsCapturePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook captures a payment." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminPaymentsCapturePayment } from \"medusa-react\"\n\ntype Props = {\n paymentId: string\n}\n\nconst Payment = ({ paymentId }: Props) => {\n const capture = useAdminPaymentsCapturePayment(\n paymentId\n )\n // ...\n\n const handleCapture = () => {\n capture.mutate(void 0, {\n onSuccess: ({ payment }) => {\n console.log(payment.amount)\n }\n })\n }\n\n // ...\n}\n\nexport default Payment\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2048, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2049, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payments/index.d.ts", + "qualifiedName": "AdminPaymentRes" + }, + "name": "AdminPaymentRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payments/index.d.ts", + "qualifiedName": "AdminPaymentRes" + }, + "name": "AdminPaymentRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2050, + "name": "useAdminPaymentsRefundPayment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2051, + "name": "useAdminPaymentsRefundPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook refunds a payment. The payment must be captured first." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { RefundReason } from \"@medusajs/medusa\"\nimport { useAdminPaymentsRefundPayment } from \"medusa-react\"\n\ntype Props = {\n paymentId: string\n}\n\nconst Payment = ({ paymentId }: Props) => {\n const refund = useAdminPaymentsRefundPayment(\n paymentId\n )\n // ...\n\n const handleRefund = (\n amount: number,\n reason: RefundReason,\n note: string\n ) => {\n refund.mutate({\n amount,\n reason,\n note\n }, {\n onSuccess: ({ refund }) => {\n console.log(refund.amount)\n }\n })\n }\n\n // ...\n}\n\nexport default Payment\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2052, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2053, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payments/index.d.ts", + "qualifiedName": "AdminRefundRes" + }, + "name": "AdminRefundRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payments/refund-payment.d.ts", + "qualifiedName": "AdminPostPaymentRefundsReq" + }, + "name": "AdminPostPaymentRefundsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payments/index.d.ts", + "qualifiedName": "AdminRefundRes" + }, + "name": "AdminRefundRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payments/refund-payment.d.ts", + "qualifiedName": "AdminPostPaymentRefundsReq" + }, + "name": "AdminPostPaymentRefundsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2030, + 2046, + 2050 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2030 + ] + }, + { + "title": "Mutations", + "children": [ + 2046, + 2050 + ] + } + ] + }, + { + "id": 27, + "name": "Price Lists", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Price List API Routes](https://docs.medusajs.com/api/admin#price-lists).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA price list are special prices applied to products based on a set of conditions, such as customer group.\n\nRelated Guide: [How to manage price lists](https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2152, + "name": "useAdminCreatePriceList", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2153, + "name": "useAdminCreatePriceList", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a price list." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n PriceListStatus, \n PriceListType, \n} from \"@medusajs/medusa\"\nimport { useAdminCreatePriceList } from \"medusa-react\"\n\ntype CreateData = {\n name: string\n description: string\n type: PriceListType\n status: PriceListStatus\n prices: {\n amount: number\n variant_id: string\n currency_code: string\n max_quantity: number\n }[]\n}\n\nconst CreatePriceList = () => {\n const createPriceList = useAdminCreatePriceList()\n // ...\n\n const handleCreate = (\n data: CreateData\n ) => {\n createPriceList.mutate(data, {\n onSuccess: ({ price_list }) => {\n console.log(price_list.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreatePriceList\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2154, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListRes" + }, + "name": "AdminPriceListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts", + "qualifiedName": "AdminPostPriceListsPriceListReq" + }, + "name": "AdminPostPriceListsPriceListReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListRes" + }, + "name": "AdminPriceListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts", + "qualifiedName": "AdminPostPriceListsPriceListReq" + }, + "name": "AdminPostPriceListsPriceListReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2163, + "name": "useAdminCreatePriceListPrices", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2164, + "name": "useAdminCreatePriceListPrices", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds or updates a list of prices in a price list." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreatePriceListPrices } from \"medusa-react\"\n\ntype PriceData = {\n amount: number\n variant_id: string\n currency_code: string\n}\n\ntype Props = {\n priceListId: string\n}\n\nconst PriceList = ({\n priceListId\n}: Props) => {\n const addPrices = useAdminCreatePriceListPrices(priceListId)\n // ...\n\n const handleAddPrices = (prices: PriceData[]) => {\n addPrices.mutate({\n prices\n }, {\n onSuccess: ({ price_list }) => {\n console.log(price_list.prices)\n }\n })\n }\n\n // ...\n}\n\nexport default PriceList\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2165, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2166, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListRes" + }, + "name": "AdminPriceListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts", + "qualifiedName": "AdminPostPriceListPricesPricesReq" + }, + "name": "AdminPostPriceListPricesPricesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListRes" + }, + "name": "AdminPriceListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts", + "qualifiedName": "AdminPostPriceListPricesPricesReq" + }, + "name": "AdminPostPriceListPricesPricesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2159, + "name": "useAdminDeletePriceList", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2160, + "name": "useAdminDeletePriceList", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a price list and its associated prices." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeletePriceList } from \"medusa-react\"\n\ntype Props = {\n priceListId: string\n}\n\nconst PriceList = ({\n priceListId\n}: Props) => {\n const deletePriceList = useAdminDeletePriceList(priceListId)\n // ...\n\n const handleDelete = () => {\n deletePriceList.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default PriceList\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2161, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2162, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2167, + "name": "useAdminDeletePriceListPrices", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2168, + "name": "useAdminDeletePriceListPrices", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a list of prices in a price list." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeletePriceListPrices } from \"medusa-react\"\n\ntype Props = {\n priceListId: string\n}\n\nconst PriceList = ({\n priceListId\n}: Props) => {\n const deletePrices = useAdminDeletePriceListPrices(priceListId)\n // ...\n\n const handleDeletePrices = (priceIds: string[]) => {\n deletePrices.mutate({\n price_ids: priceIds\n }, {\n onSuccess: ({ ids, deleted, object }) => {\n console.log(ids)\n }\n })\n }\n\n // ...\n}\n\nexport default PriceList\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2169, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2170, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListDeleteBatchRes" + }, + "name": "AdminPriceListDeleteBatchRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/delete-prices-batch.d.ts", + "qualifiedName": "AdminDeletePriceListPricesPricesReq" + }, + "name": "AdminDeletePriceListPricesPricesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListDeleteBatchRes" + }, + "name": "AdminPriceListDeleteBatchRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/delete-prices-batch.d.ts", + "qualifiedName": "AdminDeletePriceListPricesPricesReq" + }, + "name": "AdminDeletePriceListPricesPricesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2175, + "name": "useAdminDeletePriceListProductPrices", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2176, + "name": "useAdminDeletePriceListProductPrices", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes all the prices related to a specific product in a price list." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminDeletePriceListProductPrices\n} from \"medusa-react\"\n\ntype Props = {\n priceListId: string\n productId: string\n}\n\nconst PriceListProduct = ({\n priceListId,\n productId\n}: Props) => {\n const deleteProductPrices = useAdminDeletePriceListProductPrices(\n priceListId,\n productId\n )\n // ...\n\n const handleDeleteProductPrices = () => {\n deleteProductPrices.mutate(void 0, {\n onSuccess: ({ ids, deleted, object }) => {\n console.log(ids)\n }\n })\n }\n\n // ...\n}\n\nexport default PriceListProduct\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2177, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2178, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2179, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListDeleteBatchRes" + }, + "name": "AdminPriceListDeleteBatchRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListDeleteBatchRes" + }, + "name": "AdminPriceListDeleteBatchRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2171, + "name": "useAdminDeletePriceListProductsPrices", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2172, + "name": "useAdminDeletePriceListProductsPrices", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes all the prices associated with multiple products in a price list." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeletePriceListProductsPrices } from \"medusa-react\"\n\ntype Props = {\n priceListId: string\n}\n\nconst PriceList = ({\n priceListId\n}: Props) => {\n const deleteProductsPrices = useAdminDeletePriceListProductsPrices(\n priceListId\n )\n // ...\n\n const handleDeleteProductsPrices = (productIds: string[]) => {\n deleteProductsPrices.mutate({\n product_ids: productIds\n }, {\n onSuccess: ({ ids, deleted, object }) => {\n console.log(ids)\n }\n })\n }\n\n // ...\n}\n\nexport default PriceList\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2173, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2174, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListDeleteBatchRes" + }, + "name": "AdminPriceListDeleteBatchRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/delete-products-prices-batch.d.ts", + "qualifiedName": "AdminDeletePriceListsPriceListProductsPricesBatchReq" + }, + "name": "AdminDeletePriceListsPriceListProductsPricesBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListDeleteBatchRes" + }, + "name": "AdminPriceListDeleteBatchRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/delete-products-prices-batch.d.ts", + "qualifiedName": "AdminDeletePriceListsPriceListProductsPricesBatchReq" + }, + "name": "AdminDeletePriceListsPriceListProductsPricesBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2180, + "name": "useAdminDeletePriceListVariantPrices", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2181, + "name": "useAdminDeletePriceListVariantPrices", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes all the prices related to a specific product variant in a price list." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminDeletePriceListVariantPrices\n} from \"medusa-react\"\n\ntype Props = {\n priceListId: string\n variantId: string\n}\n\nconst PriceListVariant = ({\n priceListId,\n variantId\n}: Props) => {\n const deleteVariantPrices = useAdminDeletePriceListVariantPrices(\n priceListId,\n variantId\n )\n // ...\n\n const handleDeleteVariantPrices = () => {\n deleteVariantPrices.mutate(void 0, {\n onSuccess: ({ ids, deleted, object }) => {\n console.log(ids)\n }\n })\n }\n\n // ...\n}\n\nexport default PriceListVariant\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2182, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2183, + "name": "variantId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product variant's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2184, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListDeleteBatchRes" + }, + "name": "AdminPriceListDeleteBatchRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListDeleteBatchRes" + }, + "name": "AdminPriceListDeleteBatchRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2136, + "name": "useAdminPriceList", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2137, + "name": "useAdminPriceList", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a price list's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminPriceList } from \"medusa-react\"\n\ntype Props = {\n priceListId: string\n}\n\nconst PriceList = ({\n priceListId\n}: Props) => {\n const { \n price_list, \n isLoading, \n } = useAdminPriceList(priceListId)\n\n return (\n
\n {isLoading && Loading...}\n {price_list && {price_list.name}}\n
\n )\n}\n\nexport default PriceList\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2138, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2139, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListRes" + }, + "name": "AdminPriceListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_price_lists" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2140, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2141, + "name": "price_list", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/price-list.d.ts", + "qualifiedName": "PriceList" + }, + "name": "PriceList", + "package": "@medusajs/medusa" + } + }, + { + "id": 2142, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2141, + 2142 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2143, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2144, + "name": "price_list", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/price-list.d.ts", + "qualifiedName": "PriceList" + }, + "name": "PriceList", + "package": "@medusajs/medusa" + } + }, + { + "id": 2145, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2144, + 2145 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2146, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2147, + "name": "price_list", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/price-list.d.ts", + "qualifiedName": "PriceList" + }, + "name": "PriceList", + "package": "@medusajs/medusa" + } + }, + { + "id": 2148, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2147, + 2148 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2149, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2150, + "name": "price_list", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/price-list.d.ts", + "qualifiedName": "PriceList" + }, + "name": "PriceList", + "package": "@medusajs/medusa" + } + }, + { + "id": 2151, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2150, + 2151 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2107, + "name": "useAdminPriceListProducts", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2108, + "name": "useAdminPriceListProducts", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a price list's products. The products can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`status`" + }, + { + "kind": "text", + "text": " \npassed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The products can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list products in a price list:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminPriceListProducts } from \"medusa-react\"\n\ntype Props = {\n priceListId: string\n}\n\nconst PriceListProducts = ({\n priceListId\n}: Props) => {\n const { products, isLoading } = useAdminPriceListProducts(\n priceListId\n )\n\n return (\n
\n {isLoading && Loading...}\n {products && !products.length && (\n No Price Lists\n )}\n {products && products.length > 0 && (\n
    \n {products.map((product) => (\n
  • {product.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default PriceListProducts\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the products:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminPriceListProducts } from \"medusa-react\"\n\ntype Props = {\n priceListId: string\n}\n\nconst PriceListProducts = ({\n priceListId\n}: Props) => {\n const { products, isLoading } = useAdminPriceListProducts(\n priceListId,\n {\n expand: \"variants\"\n }\n )\n\n return (\n
\n {isLoading && Loading...}\n {products && !products.length && (\n No Price Lists\n )}\n {products && products.length > 0 && (\n
    \n {products.map((product) => (\n
  • {product.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default PriceListProducts\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminPriceListProducts } from \"medusa-react\"\n\ntype Props = {\n priceListId: string\n}\n\nconst PriceListProducts = ({\n priceListId\n}: Props) => {\n const { \n products,\n limit,\n offset,\n isLoading\n } = useAdminPriceListProducts(\n priceListId,\n {\n expand: \"variants\",\n limit: 20,\n offset: 0\n }\n )\n\n return (\n
\n {isLoading && Loading...}\n {products && !products.length && (\n No Price Lists\n )}\n {products && products.length > 0 && (\n
    \n {products.map((product) => (\n
  • {product.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default PriceListProducts\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2109, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2110, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations applied on the retrieved products." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts", + "qualifiedName": "AdminGetPriceListsPriceListProductsParams" + }, + "name": "AdminGetPriceListsPriceListProductsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2111, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsListRes" + }, + "name": "AdminProductsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_price_lists" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": "products" + }, + { + "type": "intrinsic", + "name": "any" + } + ] + } + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2112, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2115, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2113, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2114, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2116, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product.d.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + ] + } + } + }, + { + "id": 2117, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2115, + 2113, + 2114, + 2116, + 2117 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2118, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2121, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2119, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2120, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2122, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product.d.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + ] + } + } + }, + { + "id": 2123, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2121, + 2119, + 2120, + 2122, + 2123 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2124, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2127, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2125, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2126, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2128, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product.d.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + ] + } + } + }, + { + "id": 2129, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2127, + 2125, + 2126, + 2128, + 2129 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2130, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2133, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2131, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2132, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2134, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product.d.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + ] + } + } + }, + { + "id": 2135, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2133, + 2131, + 2132, + 2134, + 2135 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2077, + "name": "useAdminPriceLists", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2078, + "name": "useAdminPriceLists", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of price lists. The price lists can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`status`" + }, + { + "kind": "text", + "text": " passed \nin the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The price lists can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list price lists:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminPriceLists } from \"medusa-react\"\n\nconst PriceLists = () => {\n const { price_lists, isLoading } = useAdminPriceLists()\n\n return (\n
\n {isLoading && Loading...}\n {price_lists && !price_lists.length && (\n No Price Lists\n )}\n {price_lists && price_lists.length > 0 && (\n
    \n {price_lists.map((price_list) => (\n
  • {price_list.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default PriceLists\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the price lists:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminPriceLists } from \"medusa-react\"\n\nconst PriceLists = () => {\n const { price_lists, isLoading } = useAdminPriceLists({\n expand: \"prices\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {price_lists && !price_lists.length && (\n No Price Lists\n )}\n {price_lists && price_lists.length > 0 && (\n
    \n {price_lists.map((price_list) => (\n
  • {price_list.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default PriceLists\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`10`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminPriceLists } from \"medusa-react\"\n\nconst PriceLists = () => {\n const { \n price_lists, \n limit,\n offset,\n isLoading\n } = useAdminPriceLists({\n expand: \"prices\",\n limit: 20,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {price_lists && !price_lists.length && (\n No Price Lists\n )}\n {price_lists && price_lists.length > 0 && (\n
    \n {price_lists.map((price_list) => (\n
  • {price_list.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default PriceLists\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2079, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved price lists." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts", + "qualifiedName": "AdminGetPriceListPaginationParams" + }, + "name": "AdminGetPriceListPaginationParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2080, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListsListRes" + }, + "name": "AdminPriceListsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_price_lists" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2081, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2082, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2082 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2083, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2086, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2084, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2085, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2087, + "name": "price_lists", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/price-list.d.ts", + "qualifiedName": "PriceList" + }, + "name": "PriceList", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2088, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2086, + 2084, + 2085, + 2087, + 2088 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2089, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2092, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2090, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2091, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2093, + "name": "price_lists", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/price-list.d.ts", + "qualifiedName": "PriceList" + }, + "name": "PriceList", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2094, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2092, + 2090, + 2091, + 2093, + 2094 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2095, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2098, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2096, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2097, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2099, + "name": "price_lists", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/price-list.d.ts", + "qualifiedName": "PriceList" + }, + "name": "PriceList", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2100, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2098, + 2096, + 2097, + 2099, + 2100 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2101, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2104, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2102, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2103, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2105, + "name": "price_lists", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/price-list.d.ts", + "qualifiedName": "PriceList" + }, + "name": "PriceList", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2106, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2104, + 2102, + 2103, + 2105, + 2106 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2155, + "name": "useAdminUpdatePriceList", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2156, + "name": "useAdminUpdatePriceList", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a price list's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdatePriceList } from \"medusa-react\"\n\ntype Props = {\n priceListId: string\n}\n\nconst PriceList = ({\n priceListId\n}: Props) => {\n const updatePriceList = useAdminUpdatePriceList(priceListId)\n // ...\n\n const handleUpdate = (\n endsAt: Date\n ) => {\n updatePriceList.mutate({\n ends_at: endsAt,\n }, {\n onSuccess: ({ price_list }) => {\n console.log(price_list.ends_at)\n }\n })\n }\n\n // ...\n}\n\nexport default PriceList\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2157, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2158, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListRes" + }, + "name": "AdminPriceListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts", + "qualifiedName": "AdminPostPriceListsPriceListPriceListReq" + }, + "name": "AdminPostPriceListsPriceListPriceListReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "AdminPriceListRes" + }, + "name": "AdminPriceListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts", + "qualifiedName": "AdminPostPriceListsPriceListPriceListReq" + }, + "name": "AdminPostPriceListsPriceListPriceListReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2152, + 2163, + 2159, + 2167, + 2175, + 2171, + 2180, + 2136, + 2107, + 2077, + 2155 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2077, + 2107, + 2136 + ] + }, + { + "title": "Mutations", + "children": [ + 2152, + 2155, + 2159, + 2163, + 2167, + 2171, + 2175, + 2180 + ] + } + ] + }, + { + "id": 28, + "name": "Product Categories", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Product Category API Routes](https://docs.medusajs.com/api/admin#product-categories).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nProducts can be categoriezed into categories. A product can be added into more than one category.\n\nRelated Guide: [How to manage product categories](https://docs.medusajs.com/modules/products/admin/manage-categories)." + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "text", + "text": "product_categories" + } + ] + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2244, + "name": "useAdminAddProductsToCategory", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2245, + "name": "useAdminAddProductsToCategory", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a list of products to a product category." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminAddProductsToCategory } from \"medusa-react\"\n\ntype ProductsData = {\n id: string\n}\n\ntype Props = {\n productCategoryId: string\n}\n\nconst Category = ({\n productCategoryId\n}: Props) => {\n const addProducts = useAdminAddProductsToCategory(\n productCategoryId\n )\n // ...\n\n const handleAddProducts = (\n productIds: ProductsData[]\n ) => {\n addProducts.mutate({\n product_ids: productIds\n }, {\n onSuccess: ({ product_category }) => {\n console.log(product_category.products)\n }\n })\n }\n\n // ...\n}\n\nexport default Category\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2246, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product category's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2247, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "AdminProductCategoriesCategoryRes" + }, + "name": "AdminProductCategoriesCategoryRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/add-products-batch.d.ts", + "qualifiedName": "AdminPostProductCategoriesCategoryProductsBatchReq" + }, + "name": "AdminPostProductCategoriesCategoryProductsBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "AdminProductCategoriesCategoryRes" + }, + "name": "AdminProductCategoriesCategoryRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/add-products-batch.d.ts", + "qualifiedName": "AdminPostProductCategoriesCategoryProductsBatchReq" + }, + "name": "AdminPostProductCategoriesCategoryProductsBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2233, + "name": "useAdminCreateProductCategory", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2234, + "name": "useAdminCreateProductCategory", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a product category." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateProductCategory } from \"medusa-react\"\n\nconst CreateCategory = () => {\n const createCategory = useAdminCreateProductCategory()\n // ...\n\n const handleCreate = (\n name: string\n ) => {\n createCategory.mutate({\n name,\n }, {\n onSuccess: ({ product_category }) => {\n console.log(product_category.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateCategory\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2235, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "AdminProductCategoriesCategoryRes" + }, + "name": "AdminProductCategoriesCategoryRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/create-product-category.d.ts", + "qualifiedName": "AdminPostProductCategoriesReq" + }, + "name": "AdminPostProductCategoriesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "AdminProductCategoriesCategoryRes" + }, + "name": "AdminProductCategoriesCategoryRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/create-product-category.d.ts", + "qualifiedName": "AdminPostProductCategoriesReq" + }, + "name": "AdminPostProductCategoriesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2240, + "name": "useAdminDeleteProductCategory", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2241, + "name": "useAdminDeleteProductCategory", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a product category. This does not delete associated products." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteProductCategory } from \"medusa-react\"\n\ntype Props = {\n productCategoryId: string\n}\n\nconst Category = ({\n productCategoryId\n}: Props) => {\n const deleteCategory = useAdminDeleteProductCategory(\n productCategoryId\n )\n // ...\n\n const handleDelete = () => {\n deleteCategory.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default Category\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2242, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product category's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2243, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2248, + "name": "useAdminDeleteProductsFromCategory", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2249, + "name": "useAdminDeleteProductsFromCategory", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook removes a list of products from a product category." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteProductsFromCategory } from \"medusa-react\"\n\ntype ProductsData = {\n id: string\n}\n\ntype Props = {\n productCategoryId: string\n}\n\nconst Category = ({\n productCategoryId\n}: Props) => {\n const deleteProducts = useAdminDeleteProductsFromCategory(\n productCategoryId\n )\n // ...\n\n const handleDeleteProducts = (\n productIds: ProductsData[]\n ) => {\n deleteProducts.mutate({\n product_ids: productIds\n }, {\n onSuccess: ({ product_category }) => {\n console.log(product_category.products)\n }\n })\n }\n\n // ...\n}\n\nexport default Category\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2250, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product category's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2251, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "AdminProductCategoriesCategoryRes" + }, + "name": "AdminProductCategoriesCategoryRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/delete-products-batch.d.ts", + "qualifiedName": "AdminDeleteProductCategoriesCategoryProductsBatchReq" + }, + "name": "AdminDeleteProductCategoriesCategoryProductsBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "AdminProductCategoriesCategoryRes" + }, + "name": "AdminProductCategoriesCategoryRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/delete-products-batch.d.ts", + "qualifiedName": "AdminDeleteProductCategoriesCategoryProductsBatchReq" + }, + "name": "AdminDeleteProductCategoriesCategoryProductsBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2186, + "name": "useAdminProductCategories", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2187, + "name": "useAdminProductCategories", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook" + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list product categories:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminProductCategories } from \"medusa-react\"\n\nfunction Categories() {\n const { \n product_categories,\n isLoading \n } = useAdminProductCategories()\n\n return (\n
\n {isLoading && Loading...}\n {product_categories && !product_categories.length && (\n No Categories\n )}\n {product_categories && product_categories.length > 0 && (\n
    \n {product_categories.map(\n (category) => (\n
  • {category.name}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default Categories\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the product category:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminProductCategories } from \"medusa-react\"\n\nfunction Categories() {\n const { \n product_categories,\n isLoading \n } = useAdminProductCategories({\n expand: \"category_children\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {product_categories && !product_categories.length && (\n No Categories\n )}\n {product_categories && product_categories.length > 0 && (\n
    \n {product_categories.map(\n (category) => (\n
  • {category.name}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default Categories\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`100`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminProductCategories } from \"medusa-react\"\n\nfunction Categories() {\n const { \n product_categories,\n limit,\n offset,\n isLoading \n } = useAdminProductCategories({\n expand: \"category_children\",\n limit: 20,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {product_categories && !product_categories.length && (\n No Categories\n )}\n {product_categories && product_categories.length > 0 && (\n
    \n {product_categories.map(\n (category) => (\n
  • {category.name}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default Categories\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2188, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved product categories." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/list-product-categories.d.ts", + "qualifiedName": "AdminGetProductCategoriesParams" + }, + "name": "AdminGetProductCategoriesParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2189, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "AdminProductCategoriesListRes" + }, + "name": "AdminProductCategoriesListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "product_categories" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2190, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2191, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2191 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2192, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2195, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2193, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2194, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2196, + "name": "product_categories", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2197, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2195, + 2193, + 2194, + 2196, + 2197 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2198, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2201, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2199, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2200, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2202, + "name": "product_categories", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2203, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2201, + 2199, + 2200, + 2202, + 2203 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2204, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2207, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2205, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2206, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2208, + "name": "product_categories", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2209, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2207, + 2205, + 2206, + 2208, + 2209 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2210, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2213, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2211, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2212, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2214, + "name": "product_categories", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2215, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2213, + 2211, + 2212, + 2214, + 2215 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2216, + "name": "useAdminProductCategory", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2217, + "name": "useAdminProductCategory", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a product category's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "A simple example that retrieves an order by its ID:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminProductCategory } from \"medusa-react\"\n\ntype Props = {\n productCategoryId: string\n}\n\nconst Category = ({\n productCategoryId\n}: Props) => {\n const { \n product_category, \n isLoading, \n } = useAdminProductCategory(productCategoryId)\n\n return (\n
\n {isLoading && Loading...}\n {product_category && (\n {product_category.name}\n )}\n \n
\n )\n}\n\nexport default Category\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminProductCategory } from \"medusa-react\"\n\ntype Props = {\n productCategoryId: string\n}\n\nconst Category = ({\n productCategoryId\n}: Props) => {\n const { \n product_category, \n isLoading, \n } = useAdminProductCategory(productCategoryId, {\n expand: \"category_children\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {product_category && (\n {product_category.name}\n )}\n \n
\n )\n}\n\nexport default Category\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2218, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product category's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2219, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configurations to apply on the retrieved product category." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/get-product-category.d.ts", + "qualifiedName": "AdminGetProductCategoryParams" + }, + "name": "AdminGetProductCategoryParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2220, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "AdminProductCategoriesCategoryRes" + }, + "name": "AdminProductCategoriesCategoryRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "product_categories" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2221, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2222, + "name": "product_category", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + }, + { + "id": 2223, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2222, + 2223 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2224, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2225, + "name": "product_category", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + }, + { + "id": 2226, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2225, + 2226 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2227, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2228, + "name": "product_category", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + }, + { + "id": 2229, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2228, + 2229 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2230, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2231, + "name": "product_category", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + }, + { + "id": 2232, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2231, + 2232 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2236, + "name": "useAdminUpdateProductCategory", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2237, + "name": "useAdminUpdateProductCategory", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a product category." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateProductCategory } from \"medusa-react\"\n\ntype Props = {\n productCategoryId: string\n}\n\nconst Category = ({\n productCategoryId\n}: Props) => {\n const updateCategory = useAdminUpdateProductCategory(\n productCategoryId\n )\n // ...\n\n const handleUpdate = (\n name: string\n ) => {\n updateCategory.mutate({\n name,\n }, {\n onSuccess: ({ product_category }) => {\n console.log(product_category.id)\n }\n })\n }\n\n // ...\n}\n\nexport default Category\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2238, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product category's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2239, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "AdminProductCategoriesCategoryRes" + }, + "name": "AdminProductCategoriesCategoryRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/update-product-category.d.ts", + "qualifiedName": "AdminPostProductCategoriesCategoryReq" + }, + "name": "AdminPostProductCategoriesCategoryReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "AdminProductCategoriesCategoryRes" + }, + "name": "AdminProductCategoriesCategoryRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/update-product-category.d.ts", + "qualifiedName": "AdminPostProductCategoriesCategoryReq" + }, + "name": "AdminPostProductCategoriesCategoryReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2244, + 2233, + 2240, + 2248, + 2186, + 2216, + 2236 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2186, + 2216 + ] + }, + { + "title": "Mutations", + "children": [ + 2233, + 2236, + 2240, + 2244, + 2248 + ] + } + ] + }, + { + "id": 11, + "name": "Product Collections", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Product Collection API Routes](https://docs.medusajs.com/api/admin#product-collections).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA product collection is used to organize products for different purposes such as marketing or discount purposes. For example, you can create a Summer Collection." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 1014, + "name": "useAdminAddProductsToCollection", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1015, + "name": "useAdminAddProductsToCollection", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds products to a collection." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminAddProductsToCollection } from \"medusa-react\"\n\ntype Props = {\n collectionId: string\n}\n\nconst Collection = ({ collectionId }: Props) => {\n const addProducts = useAdminAddProductsToCollection(collectionId)\n // ...\n\n const handleAddProducts = (productIds: string[]) => {\n addProducts.mutate({\n product_ids: productIds\n }, {\n onSuccess: ({ collection }) => {\n console.log(collection.products)\n }\n })\n }\n\n // ...\n}\n\nexport default Collection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1016, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1017, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "AdminCollectionsRes" + }, + "name": "AdminCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/add-products.d.ts", + "qualifiedName": "AdminPostProductsToCollectionReq" + }, + "name": "AdminPostProductsToCollectionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "AdminCollectionsRes" + }, + "name": "AdminCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/add-products.d.ts", + "qualifiedName": "AdminPostProductsToCollectionReq" + }, + "name": "AdminPostProductsToCollectionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 987, + "name": "useAdminCollection", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 988, + "name": "useAdminCollection", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a product collection by its ID. The products associated with it are expanded and returned as well." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCollection } from \"medusa-react\"\n\ntype Props = {\n collectionId: string\n}\n\nconst Collection = ({ collectionId }: Props) => {\n const { collection, isLoading } = useAdminCollection(collectionId)\n\n return (\n
\n {isLoading && Loading...}\n {collection && {collection.title}}\n
\n )\n}\n\nexport default Collection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 989, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 990, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "AdminCollectionsRes" + }, + "name": "AdminCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_collections" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 991, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 992, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 993, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 992, + 993 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 994, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 995, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 996, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 995, + 996 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 997, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 998, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 999, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 998, + 999 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1000, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1001, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 1002, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1001, + 1002 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 957, + "name": "useAdminCollections", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 958, + "name": "useAdminCollections", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of product collections. The product collections can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`handle`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`title`" + }, + { + "kind": "text", + "text": ".\nThe collections can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list product collections:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminCollections } from \"medusa-react\"\n\nconst Collections = () => {\n const { collections, isLoading } = useAdminCollections()\n\n return (\n
\n {isLoading && Loading...}\n {collections && !collections.length && \n No Product Collections\n }\n {collections && collections.length > 0 && (\n
    \n {collections.map((collection) => (\n
  • {collection.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Collections\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`10`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminCollections } from \"medusa-react\"\n\nconst Collections = () => {\n const { collections, limit, offset, isLoading } = useAdminCollections({\n limit: 15,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {collections && !collections.length && \n No Product Collections\n }\n {collections && collections.length > 0 && (\n
    \n {collections.map((collection) => (\n
  • {collection.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Collections\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 959, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved product collections." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts", + "qualifiedName": "AdminGetCollectionsParams" + }, + "name": "AdminGetCollectionsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 960, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "AdminCollectionsListRes" + }, + "name": "AdminCollectionsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_collections" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 961, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 962, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 962 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 963, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 967, + "name": "collections", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 966, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 964, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 965, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 968, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 967, + 966, + 964, + 965, + 968 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 969, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 973, + "name": "collections", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 972, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 970, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 971, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 974, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 973, + 972, + 970, + 971, + 974 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 975, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 979, + "name": "collections", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 978, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 976, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 977, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 980, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 979, + 978, + 976, + 977, + 980 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 981, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 985, + "name": "collections", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 984, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 982, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 983, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 986, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 985, + 984, + 982, + 983, + 986 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1003, + "name": "useAdminCreateCollection", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1004, + "name": "useAdminCreateCollection", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a product collection." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateCollection } from \"medusa-react\"\n\nconst CreateCollection = () => {\n const createCollection = useAdminCreateCollection()\n // ...\n\n const handleCreate = (title: string) => {\n createCollection.mutate({\n title\n }, {\n onSuccess: ({ collection }) => {\n console.log(collection.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateCollection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1005, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "AdminCollectionsRes" + }, + "name": "AdminCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts", + "qualifiedName": "AdminPostCollectionsReq" + }, + "name": "AdminPostCollectionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "AdminCollectionsRes" + }, + "name": "AdminCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts", + "qualifiedName": "AdminPostCollectionsReq" + }, + "name": "AdminPostCollectionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1010, + "name": "useAdminDeleteCollection", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1011, + "name": "useAdminDeleteCollection", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a product collection. This does not delete associated products." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteCollection } from \"medusa-react\"\n\ntype Props = {\n collectionId: string\n}\n\nconst Collection = ({ collectionId }: Props) => {\n const deleteCollection = useAdminDeleteCollection(collectionId)\n // ...\n\n const handleDelete = (title: string) => {\n deleteCollection.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default Collection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1012, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1013, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1018, + "name": "useAdminRemoveProductsFromCollection", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1019, + "name": "useAdminRemoveProductsFromCollection", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook removes a list of products from a collection. This would not delete the product, \nonly the association between the product and the collection." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminRemoveProductsFromCollection } from \"medusa-react\"\n\ntype Props = {\n collectionId: string\n}\n\nconst Collection = ({ collectionId }: Props) => {\n const removeProducts = useAdminRemoveProductsFromCollection(collectionId)\n // ...\n\n const handleRemoveProducts = (productIds: string[]) => {\n removeProducts.mutate({\n product_ids: productIds\n }, {\n onSuccess: ({ id, object, removed_products }) => {\n console.log(removed_products)\n }\n })\n }\n\n // ...\n}\n\nexport default Collection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1020, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1021, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "AdminDeleteProductsFromCollectionRes" + }, + "name": "AdminDeleteProductsFromCollectionRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/remove-products.d.ts", + "qualifiedName": "AdminDeleteProductsFromCollectionReq" + }, + "name": "AdminDeleteProductsFromCollectionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "AdminDeleteProductsFromCollectionRes" + }, + "name": "AdminDeleteProductsFromCollectionRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/remove-products.d.ts", + "qualifiedName": "AdminDeleteProductsFromCollectionReq" + }, + "name": "AdminDeleteProductsFromCollectionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1006, + "name": "useAdminUpdateCollection", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1007, + "name": "useAdminUpdateCollection", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a product collection's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateCollection } from \"medusa-react\"\n\ntype Props = {\n collectionId: string\n}\n\nconst Collection = ({ collectionId }: Props) => {\n const updateCollection = useAdminUpdateCollection(collectionId)\n // ...\n\n const handleUpdate = (title: string) => {\n updateCollection.mutate({\n title\n }, {\n onSuccess: ({ collection }) => {\n console.log(collection.id)\n }\n })\n }\n\n // ...\n}\n\nexport default Collection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1008, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1009, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "AdminCollectionsRes" + }, + "name": "AdminCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts", + "qualifiedName": "AdminPostCollectionsCollectionReq" + }, + "name": "AdminPostCollectionsCollectionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "AdminCollectionsRes" + }, + "name": "AdminCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts", + "qualifiedName": "AdminPostCollectionsCollectionReq" + }, + "name": "AdminPostCollectionsCollectionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 1014, + 987, + 957, + 1003, + 1010, + 1018, + 1006 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 957, + 987 + ] + }, + { + "title": "Mutations", + "children": [ + 1003, + 1006, + 1010, + 1014, + 1018 + ] + } + ] + }, + { + "id": 29, + "name": "Product Tags", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Product Tag API Routes](https://docs.medusajs.com/api/admin#product-tags).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nProduct tags are string values created when you create or update a product with a new tag.\nProducts can have more than one tag, and products can share tags. This allows admins to associate products to similar tags that can be used to filter products." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2253, + "name": "useAdminProductTags", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2254, + "name": "useAdminProductTags", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of product tags. The product tags can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " passed \nin the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The product tags can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list product tags:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminProductTags } from \"medusa-react\"\n\nfunction ProductTags() {\n const { \n product_tags,\n isLoading \n } = useAdminProductTags()\n\n return (\n
\n {isLoading && Loading...}\n {product_tags && !product_tags.length && (\n No Product Tags\n )}\n {product_tags && product_tags.length > 0 && (\n
    \n {product_tags.map(\n (tag) => (\n
  • {tag.value}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default ProductTags\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`10`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminProductTags } from \"medusa-react\"\n\nfunction ProductTags() {\n const { \n product_tags,\n limit,\n offset,\n isLoading \n } = useAdminProductTags({\n limit: 20,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {product_tags && !product_tags.length && (\n No Product Tags\n )}\n {product_tags && product_tags.length > 0 && (\n
    \n {product_tags.map(\n (tag) => (\n
  • {tag.value}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default ProductTags\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2255, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved product tags." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts", + "qualifiedName": "AdminGetProductTagsParams" + }, + "name": "AdminGetProductTagsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2256, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-tags/index.d.ts", + "qualifiedName": "AdminProductTagsListRes" + }, + "name": "AdminProductTagsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_product_tags" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2257, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2258, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2258 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2259, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2262, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2260, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2261, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2263, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-tag.d.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2264, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2262, + 2260, + 2261, + 2263, + 2264 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2265, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2268, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2266, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2267, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2269, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-tag.d.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2270, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2268, + 2266, + 2267, + 2269, + 2270 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2271, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2274, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2272, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2273, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2275, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-tag.d.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2276, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2274, + 2272, + 2273, + 2275, + 2276 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2277, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2280, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2278, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2279, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2281, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-tag.d.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2282, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2280, + 2278, + 2279, + 2281, + 2282 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2253 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2253 + ] + } + ] + }, + { + "id": 30, + "name": "Product Types", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Product Type API Routes](https://docs.medusajs.com/api/admin#product-types).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nProduct types are string values created when you create or update a product with a new type.\nProducts can have one type, and products can share types. This allows admins to associate products with a type that can be used to filter products." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2284, + "name": "useAdminProductTypes", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2285, + "name": "useAdminProductTypes", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of product types. The product types can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " passed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter.\nThe product types can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list product types:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminProductTypes } from \"medusa-react\"\n\nfunction ProductTypes() {\n const { \n product_types,\n isLoading \n } = useAdminProductTypes()\n\n return (\n
\n {isLoading && Loading...}\n {product_types && !product_types.length && (\n No Product Tags\n )}\n {product_types && product_types.length > 0 && (\n
    \n {product_types.map(\n (type) => (\n
  • {type.value}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default ProductTypes\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`20`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminProductTypes } from \"medusa-react\"\n\nfunction ProductTypes() {\n const { \n product_types,\n limit,\n offset,\n isLoading \n } = useAdminProductTypes({\n limit: 10,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {product_types && !product_types.length && (\n No Product Tags\n )}\n {product_types && product_types.length > 0 && (\n
    \n {product_types.map(\n (type) => (\n
  • {type.value}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default ProductTypes\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2286, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved product types." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts", + "qualifiedName": "AdminGetProductTypesParams" + }, + "name": "AdminGetProductTypesParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2287, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-types/index.d.ts", + "qualifiedName": "AdminProductTypesListRes" + }, + "name": "AdminProductTypesListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_product_types" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2288, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2289, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2289 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2290, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2293, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2291, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2292, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2294, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-type.d.ts", + "qualifiedName": "ProductType" + }, + "name": "ProductType", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2295, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2293, + 2291, + 2292, + 2294, + 2295 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2296, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2299, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2297, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2298, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2300, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-type.d.ts", + "qualifiedName": "ProductType" + }, + "name": "ProductType", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2301, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2299, + 2297, + 2298, + 2300, + 2301 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2302, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2305, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2303, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2304, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2306, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-type.d.ts", + "qualifiedName": "ProductType" + }, + "name": "ProductType", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2307, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2305, + 2303, + 2304, + 2306, + 2307 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2308, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2311, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2309, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2310, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2312, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-type.d.ts", + "qualifiedName": "ProductType" + }, + "name": "ProductType", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2313, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2311, + 2309, + 2310, + 2312, + 2313 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2284 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2284 + ] + } + ] + }, + { + "id": 46, + "name": "Product Variants", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries listed here are used to send requests to the [Admin Product Variant API Routes](https://docs.medusajs.com/api/admin#product-variants).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nProduct variants are the actual salable item in your store. Each variant is a combination of the different option values available on the product.\n\nRelated Guide: [How to manage product variants](https://docs.medusajs.com/modules/products/admin/manage-products#manage-product-variants)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 3330, + "name": "useAdminVariant", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3331, + "name": "useAdminVariant", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a product variant's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "A simple example that retrieves a product variant by its ID:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminVariant } from \"medusa-react\"\n\ntype Props = {\n variantId: string\n}\n\nconst Variant = ({ variantId }: Props) => {\n const { variant, isLoading } = useAdminVariant(\n variantId\n )\n\n return (\n
\n {isLoading && Loading...}\n {variant && {variant.title}}\n
\n )\n}\n\nexport default Variant\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminVariant } from \"medusa-react\"\n\ntype Props = {\n variantId: string\n}\n\nconst Variant = ({ variantId }: Props) => {\n const { variant, isLoading } = useAdminVariant(\n variantId, {\n expand: \"options\"\n }\n )\n\n return (\n
\n {isLoading && Loading...}\n {variant && {variant.title}}\n
\n )\n}\n\nexport default Variant\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3332, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product variant's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3333, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configurations to apply on the retrieved product variant." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/get-variant.d.ts", + "qualifiedName": "AdminGetVariantParams" + }, + "name": "AdminGetVariantParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 3334, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/index.d.ts", + "qualifiedName": "AdminVariantsRes" + }, + "name": "AdminVariantsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_variants" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 3335, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3337, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3336, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedVariant" + }, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3337, + 3336 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3338, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3340, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3339, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedVariant" + }, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3340, + 3339 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3341, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3343, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3342, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedVariant" + }, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3343, + 3342 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3344, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3346, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3345, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedVariant" + }, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3346, + 3345 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 3300, + "name": "useAdminVariants", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3301, + "name": "useAdminVariants", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of product variants. The product variant can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`title`" + }, + { + "kind": "text", + "text": " \npassed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The product variant can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list product variants:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminVariants } from \"medusa-react\"\n\nconst Variants = () => {\n const { variants, isLoading } = useAdminVariants()\n\n return (\n
\n {isLoading && Loading...}\n {variants && !variants.length && (\n No Variants\n )}\n {variants && variants.length > 0 && (\n
    \n {variants.map((variant) => (\n
  • {variant.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Variants\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the product variants:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminVariants } from \"medusa-react\"\n\nconst Variants = () => {\n const { variants, isLoading } = useAdminVariants({\n expand: \"options\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {variants && !variants.length && (\n No Variants\n )}\n {variants && variants.length > 0 && (\n
    \n {variants.map((variant) => (\n
  • {variant.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Variants\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`100`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminVariants } from \"medusa-react\"\n\nconst Variants = () => {\n const { \n variants, \n limit,\n offset,\n isLoading\n } = useAdminVariants({\n expand: \"options\",\n limit: 50,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {variants && !variants.length && (\n No Variants\n )}\n {variants && variants.length > 0 && (\n
    \n {variants.map((variant) => (\n
  • {variant.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Variants\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3302, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved product variants." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts", + "qualifiedName": "AdminGetVariantsParams" + }, + "name": "AdminGetVariantsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 3303, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/index.d.ts", + "qualifiedName": "AdminVariantsListRes" + }, + "name": "AdminVariantsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_variants" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 3304, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3305, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3305 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 3306, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3309, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3307, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3308, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3311, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3310, + "name": "variants", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedVariant" + }, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3309, + 3307, + 3308, + 3311, + 3310 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3312, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3315, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3313, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3314, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3317, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3316, + "name": "variants", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedVariant" + }, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3315, + 3313, + 3314, + 3317, + 3316 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3318, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3321, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3319, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3320, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3323, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3322, + "name": "variants", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedVariant" + }, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3321, + 3319, + 3320, + 3323, + 3322 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3324, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3327, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3325, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3326, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3329, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3328, + "name": "variants", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedVariant" + }, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3327, + 3325, + 3326, + 3329, + 3328 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 3347, + "name": "useAdminVariantsInventory", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3348, + "name": "useAdminVariantsInventory", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves the available inventory of a product variant." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminVariantsInventory } from \"medusa-react\"\n\ntype Props = {\n variantId: string\n}\n\nconst VariantInventory = ({ variantId }: Props) => {\n const { variant, isLoading } = useAdminVariantsInventory(\n variantId\n )\n\n return (\n
\n {isLoading && Loading...}\n {variant && variant.inventory.length === 0 && (\n Variant doesn't have inventory details\n )}\n {variant && variant.inventory.length > 0 && (\n
    \n {variant.inventory.map((inventory) => (\n
  • {inventory.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default VariantInventory\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3349, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product variant's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3350, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts", + "qualifiedName": "AdminGetVariantsVariantInventoryRes" + }, + "name": "AdminGetVariantsVariantInventoryRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_variants" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 3351, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3353, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3352, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts", + "qualifiedName": "VariantInventory" + }, + "name": "VariantInventory", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3353, + 3352 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3354, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3356, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3355, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts", + "qualifiedName": "VariantInventory" + }, + "name": "VariantInventory", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3356, + 3355 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3357, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3359, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3358, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts", + "qualifiedName": "VariantInventory" + }, + "name": "VariantInventory", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3359, + 3358 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3360, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3362, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3361, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts", + "qualifiedName": "VariantInventory" + }, + "name": "VariantInventory", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3362, + 3361 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 3330, + 3300, + 3347 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 3300, + 3330, + 3347 + ] + } + ] + }, + { + "id": 31, + "name": "Products", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Product API Routes](https://docs.medusajs.com/api/admin#products).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nProducts are saleable items in a store. This also includes [saleable gift cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-gift-card-product) in a store.\n\nRelated Guide: [How to manage products](https://docs.medusajs.com/modules/products/admin/manage-products)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2385, + "name": "useAdminCreateProduct", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2386, + "name": "useAdminCreateProduct", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a new Product. This hook can also be used to create a gift card if the " + }, + { + "kind": "code", + "text": "`is_giftcard`" + }, + { + "kind": "text", + "text": " field is set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateProduct } from \"medusa-react\"\n\ntype CreateProductData = {\n title: string\n is_giftcard: boolean\n discountable: boolean\n options: {\n title: string\n }[]\n variants: {\n title: string\n prices: {\n amount: number\n currency_code :string\n }[]\n options: {\n value: string\n }[]\n }[],\n collection_id: string\n categories: {\n id: string\n }[]\n type: {\n value: string\n }\n tags: {\n value: string\n }[]\n}\n\nconst CreateProduct = () => {\n const createProduct = useAdminCreateProduct()\n // ...\n\n const handleCreate = (productData: CreateProductData) => {\n createProduct.mutate(productData, {\n onSuccess: ({ product }) => {\n console.log(product.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateProduct\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2387, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/create-product.d.ts", + "qualifiedName": "AdminPostProductsReq" + }, + "name": "AdminPostProductsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/create-product.d.ts", + "qualifiedName": "AdminPostProductsReq" + }, + "name": "AdminPostProductsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2411, + "name": "useAdminCreateProductOption", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2412, + "name": "useAdminCreateProductOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a product option to a product." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateProductOption } from \"medusa-react\"\n\ntype Props = {\n productId: string\n}\n\nconst CreateProductOption = ({ productId }: Props) => {\n const createOption = useAdminCreateProductOption(\n productId\n )\n // ...\n\n const handleCreate = (\n title: string\n ) => {\n createOption.mutate({\n title\n }, {\n onSuccess: ({ product }) => {\n console.log(product.options)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateProductOption\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2413, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2414, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/add-option.d.ts", + "qualifiedName": "AdminPostProductsProductOptionsReq" + }, + "name": "AdminPostProductsProductOptionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/add-option.d.ts", + "qualifiedName": "AdminPostProductsProductOptionsReq" + }, + "name": "AdminPostProductsProductOptionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2396, + "name": "useAdminCreateVariant", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2397, + "name": "useAdminCreateVariant", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a product variant associated with a product. Each product variant must have a unique combination of product option values." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateVariant } from \"medusa-react\"\n\ntype CreateVariantData = {\n title: string\n prices: {\n amount: number\n currency_code: string\n }[]\n options: {\n option_id: string\n value: string\n }[]\n}\n\ntype Props = {\n productId: string\n}\n\nconst CreateProductVariant = ({ productId }: Props) => {\n const createVariant = useAdminCreateVariant(\n productId\n )\n // ...\n\n const handleCreate = (\n variantData: CreateVariantData\n ) => {\n createVariant.mutate(variantData, {\n onSuccess: ({ product }) => {\n console.log(product.variants)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateProductVariant\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2398, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2399, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/create-variant.d.ts", + "qualifiedName": "AdminPostProductsProductVariantsReq" + }, + "name": "AdminPostProductsProductVariantsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/create-variant.d.ts", + "qualifiedName": "AdminPostProductsProductVariantsReq" + }, + "name": "AdminPostProductsProductVariantsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2392, + "name": "useAdminDeleteProduct", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2393, + "name": "useAdminDeleteProduct", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a product and its associated product variants and options." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteProduct } from \"medusa-react\"\n\ntype Props = {\n productId: string\n}\n\nconst Product = ({ productId }: Props) => {\n const deleteProduct = useAdminDeleteProduct(\n productId\n )\n // ...\n\n const handleDelete = () => {\n deleteProduct.mutate(void 0, {\n onSuccess: ({ id, object, deleted}) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default Product\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2394, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2395, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsDeleteRes" + }, + "name": "AdminProductsDeleteRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsDeleteRes" + }, + "name": "AdminProductsDeleteRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2422, + "name": "useAdminDeleteProductOption", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2423, + "name": "useAdminDeleteProductOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a product option. If there are product variants that use this product option, \nthey must be deleted before deleting the product option." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The ID of the product option to delete." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteProductOption } from \"medusa-react\"\n\ntype Props = {\n productId: string\n optionId: string\n}\n\nconst ProductOption = ({\n productId,\n optionId\n}: Props) => {\n const deleteOption = useAdminDeleteProductOption(\n productId\n )\n // ...\n\n const handleDelete = () => {\n deleteOption.mutate(optionId, {\n onSuccess: ({ option_id, object, deleted, product }) => {\n console.log(product.options)\n }\n })\n }\n\n // ...\n}\n\nexport default ProductOption\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2424, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2425, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsDeleteOptionRes" + }, + "name": "AdminProductsDeleteOptionRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsDeleteOptionRes" + }, + "name": "AdminProductsDeleteOptionRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2407, + "name": "useAdminDeleteVariant", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2408, + "name": "useAdminDeleteVariant", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a product variant." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The ID of the product variant to delete." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteVariant } from \"medusa-react\"\n\ntype Props = {\n productId: string\n variantId: string\n}\n\nconst ProductVariant = ({\n productId,\n variantId\n}: Props) => {\n const deleteVariant = useAdminDeleteVariant(\n productId\n )\n // ...\n\n const handleDelete = () => {\n deleteVariant.mutate(variantId, {\n onSuccess: ({ variant_id, object, deleted, product }) => {\n console.log(product.variants)\n }\n })\n }\n\n // ...\n}\n\nexport default ProductVariant\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2409, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2410, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsDeleteVariantRes" + }, + "name": "AdminProductsDeleteVariantRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsDeleteVariantRes" + }, + "name": "AdminProductsDeleteVariantRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2345, + "name": "useAdminProduct", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2346, + "name": "useAdminProduct", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a product's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminProduct } from \"medusa-react\"\n\ntype Props = {\n productId: string\n}\n\nconst Product = ({ productId }: Props) => {\n const { \n product, \n isLoading, \n } = useAdminProduct(productId)\n\n return (\n
\n {isLoading && Loading...}\n {product && {product.title}}\n \n
\n )\n}\n\nexport default Product\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2347, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2348, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configurations to apply on the retrieved product." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/get-product.d.ts", + "qualifiedName": "AdminGetProductParams" + }, + "name": "AdminGetProductParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2349, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_products" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2350, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2351, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product.d.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + } + }, + { + "id": 2352, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2351, + 2352 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2353, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2354, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product.d.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + } + }, + { + "id": 2355, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2354, + 2355 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2356, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2357, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product.d.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + } + }, + { + "id": 2358, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2357, + 2358 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2359, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2360, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product.d.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + } + }, + { + "id": 2361, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2360, + 2361 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2362, + "name": "useAdminProductTagUsage", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2363, + "name": "useAdminProductTagUsage", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of Product Tags with how many times each is used in products." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminProductTagUsage } from \"medusa-react\"\n\nconst ProductTags = (productId: string) => {\n const { tags, isLoading } = useAdminProductTagUsage()\n\n return (\n
\n {isLoading && Loading...}\n {tags && !tags.length && No Product Tags}\n {tags && tags.length > 0 && (\n
    \n {tags.map((tag) => (\n
  • {tag.value} - {tag.usage_count}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default ProductTags\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2364, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsListTagsRes" + }, + "name": "AdminProductsListTagsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_products" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2365, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2369, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2366, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "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/dist/models/product-tag.d.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "value" + }, + { + "type": "literal", + "value": "id" + } + ] + } + ], + "name": "Pick", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2367, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2368, + "name": "usage_count", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2368 + ] + } + ] + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2369, + 2366 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2370, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2374, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2371, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "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/dist/models/product-tag.d.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "value" + }, + { + "type": "literal", + "value": "id" + } + ] + } + ], + "name": "Pick", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2372, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2373, + "name": "usage_count", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2373 + ] + } + ] + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2374, + 2371 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2375, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2379, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2376, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "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/dist/models/product-tag.d.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "value" + }, + { + "type": "literal", + "value": "id" + } + ] + } + ], + "name": "Pick", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2377, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2378, + "name": "usage_count", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2378 + ] + } + ] + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2379, + 2376 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2380, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2384, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2381, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "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/dist/models/product-tag.d.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "value" + }, + { + "type": "literal", + "value": "id" + } + ] + } + ], + "name": "Pick", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2382, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2383, + "name": "usage_count", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2383 + ] + } + ] + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2384, + 2381 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2315, + "name": "useAdminProducts", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2316, + "name": "useAdminProducts", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of products. The products can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`status`" + }, + { + "kind": "text", + "text": " passed in \nthe " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The products can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list products:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminProducts } from \"medusa-react\"\n\nconst Products = () => {\n const { products, isLoading } = useAdminProducts()\n\n return (\n
\n {isLoading && Loading...}\n {products && !products.length && No Products}\n {products && products.length > 0 && (\n
    \n {products.map((product) => (\n
  • {product.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Products\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the products:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminProducts } from \"medusa-react\"\n\nconst Products = () => {\n const { products, isLoading } = useAdminProducts({\n expand: \"images\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {products && !products.length && No Products}\n {products && products.length > 0 && (\n
    \n {products.map((product) => (\n
  • {product.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Products\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminProducts } from \"medusa-react\"\n\nconst Products = () => {\n const { \n products, \n limit,\n offset,\n isLoading\n } = useAdminProducts({\n expand: \"images\",\n limit: 20,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {products && !products.length && No Products}\n {products && products.length > 0 && (\n
    \n {products.map((product) => (\n
  • {product.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Products\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2317, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved products." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/list-products.d.ts", + "qualifiedName": "AdminGetProductsParams" + }, + "name": "AdminGetProductsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2318, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsListRes" + }, + "name": "AdminProductsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_products" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2319, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2320, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2320 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2321, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2324, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2322, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2323, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2325, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product.d.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + ] + } + } + }, + { + "id": 2326, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2324, + 2322, + 2323, + 2325, + 2326 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2327, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2330, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2328, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2329, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2331, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product.d.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + ] + } + } + }, + { + "id": 2332, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2330, + 2328, + 2329, + 2331, + 2332 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2333, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2336, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2334, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2335, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2337, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product.d.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + ] + } + } + }, + { + "id": 2338, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2336, + 2334, + 2335, + 2337, + 2338 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2339, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2342, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2340, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2341, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2343, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product.d.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + ] + } + } + }, + { + "id": 2344, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2342, + 2340, + 2341, + 2343, + 2344 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2388, + "name": "useAdminUpdateProduct", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2389, + "name": "useAdminUpdateProduct", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a Product's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateProduct } from \"medusa-react\"\n\ntype Props = {\n productId: string\n}\n\nconst Product = ({ productId }: Props) => {\n const updateProduct = useAdminUpdateProduct(\n productId\n )\n // ...\n\n const handleUpdate = (\n title: string\n ) => {\n updateProduct.mutate({\n title,\n }, {\n onSuccess: ({ product }) => {\n console.log(product.id)\n }\n })\n }\n\n // ...\n}\n\nexport default Product\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2390, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2391, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/update-product.d.ts", + "qualifiedName": "AdminPostProductsProductReq" + }, + "name": "AdminPostProductsProductReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/update-product.d.ts", + "qualifiedName": "AdminPostProductsProductReq" + }, + "name": "AdminPostProductsProductReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2418, + "name": "useAdminUpdateProductOption", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2419, + "name": "useAdminUpdateProductOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a product option's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateProductOption } from \"medusa-react\"\n\ntype Props = {\n productId: string\n optionId: string\n}\n\nconst ProductOption = ({\n productId,\n optionId\n}: Props) => {\n const updateOption = useAdminUpdateProductOption(\n productId\n )\n // ...\n\n const handleUpdate = (\n title: string\n ) => {\n updateOption.mutate({\n option_id: optionId,\n title,\n }, {\n onSuccess: ({ product }) => {\n console.log(product.options)\n }\n })\n }\n\n // ...\n}\n\nexport default ProductOption\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2420, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2421, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 2415, + "name": "AdminUpdateProductOptionReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 2415, + "name": "AdminUpdateProductOptionReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2403, + "name": "useAdminUpdateVariant", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2404, + "name": "useAdminUpdateVariant", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a product variant's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateVariant } from \"medusa-react\"\n\ntype Props = {\n productId: string\n variantId: string\n}\n\nconst ProductVariant = ({\n productId,\n variantId\n}: Props) => {\n const updateVariant = useAdminUpdateVariant(\n productId\n )\n // ...\n\n const handleUpdate = (title: string) => {\n updateVariant.mutate({\n variant_id: variantId,\n title,\n }, {\n onSuccess: ({ product }) => {\n console.log(product.variants)\n }\n })\n }\n\n // ...\n}\n\nexport default ProductVariant\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2405, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2406, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 2400, + "name": "AdminUpdateVariantReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "AdminProductsRes" + }, + "name": "AdminProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 2400, + "name": "AdminUpdateVariantReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2385, + 2411, + 2396, + 2392, + 2422, + 2407, + 2345, + 2362, + 2315, + 2388, + 2418, + 2403 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2315, + 2345, + 2362 + ] + }, + { + "title": "Mutations", + "children": [ + 2385, + 2388, + 2392, + 2396, + 2403, + 2407, + 2411, + 2418, + 2422 + ] + } + ] + }, + { + "id": 32, + "name": "Publishable API Keys", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Publishable API Key API Routes](https://docs.medusajs.com/api/admin#publishable-api-keys).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nPublishable API Keys can be used to scope Store API calls with an API key, determining what resources are retrieved when querying the API.\nFor example, a publishable API key can be associated with one or more sales channels.\n\nWhen it is passed in the header of a request to the List Product store API Route,\nthe sales channels are inferred from the key and only products associated with those sales channels are retrieved.\n\nAdmins can manage publishable API keys and their associated resources. Currently, only Sales Channels are supported as a resource.\n\nRelated Guide: [How to manage publishable API keys](https://docs.medusajs.com/development/publishable-api-keys/admin/manage-publishable-api-keys)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2527, + "name": "useAdminAddPublishableKeySalesChannelsBatch", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2528, + "name": "useAdminAddPublishableKeySalesChannelsBatch", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a list of sales channels to a publishable API key." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport {\n useAdminAddPublishableKeySalesChannelsBatch,\n} from \"medusa-react\"\n\ntype Props = {\n publishableApiKeyId: string\n}\n\nconst PublishableApiKey = ({\n publishableApiKeyId\n}: Props) => {\n const addSalesChannels = \n useAdminAddPublishableKeySalesChannelsBatch(\n publishableApiKeyId\n )\n // ...\n\n const handleAdd = (salesChannelId: string) => {\n addSalesChannels.mutate({\n sales_channel_ids: [\n {\n id: salesChannelId,\n },\n ],\n }, {\n onSuccess: ({ publishable_api_key }) => {\n console.log(publishable_api_key.id)\n }\n })\n }\n\n // ...\n}\n\nexport default PublishableApiKey\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2529, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The publishable API key's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2530, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/add-channels-batch.d.ts", + "qualifiedName": "AdminPostPublishableApiKeySalesChannelsBatchReq" + }, + "name": "AdminPostPublishableApiKeySalesChannelsBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/add-channels-batch.d.ts", + "qualifiedName": "AdminPostPublishableApiKeySalesChannelsBatchReq" + }, + "name": "AdminPostPublishableApiKeySalesChannelsBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2512, + "name": "useAdminCreatePublishableApiKey", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2513, + "name": "useAdminCreatePublishableApiKey", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a publishable API key." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreatePublishableApiKey } from \"medusa-react\"\n\nconst CreatePublishableApiKey = () => {\n const createKey = useAdminCreatePublishableApiKey()\n // ...\n\n const handleCreate = (title: string) => {\n createKey.mutate({\n title,\n }, {\n onSuccess: ({ publishable_api_key }) => {\n console.log(publishable_api_key.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreatePublishableApiKey\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2514, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/create-publishable-api-key.d.ts", + "qualifiedName": "AdminPostPublishableApiKeysReq" + }, + "name": "AdminPostPublishableApiKeysReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/create-publishable-api-key.d.ts", + "qualifiedName": "AdminPostPublishableApiKeysReq" + }, + "name": "AdminPostPublishableApiKeysReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2519, + "name": "useAdminDeletePublishableApiKey", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2520, + "name": "useAdminDeletePublishableApiKey", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a publishable API key. Associated resources, such as sales channels, are not deleted." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeletePublishableApiKey } from \"medusa-react\"\n\ntype Props = {\n publishableApiKeyId: string\n}\n\nconst PublishableApiKey = ({\n publishableApiKeyId\n}: Props) => {\n const deleteKey = useAdminDeletePublishableApiKey(\n publishableApiKeyId\n )\n // ...\n\n const handleDelete = () => {\n deleteKey.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default PublishableApiKey\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2521, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The publishable API key's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2522, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2449, + "name": "useAdminPublishableApiKey", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2450, + "name": "useAdminPublishableApiKey", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a publishable API key's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminPublishableApiKey,\n} from \"medusa-react\"\n\ntype Props = {\n publishableApiKeyId: string\n}\n\nconst PublishableApiKey = ({\n publishableApiKeyId\n}: Props) => {\n const { publishable_api_key, isLoading } = \n useAdminPublishableApiKey(\n publishableApiKeyId\n )\n \n \n return (\n
\n {isLoading && Loading...}\n {publishable_api_key && {publishable_api_key.title}}\n
\n )\n}\n\nexport default PublishableApiKey\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2451, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The publishable API key's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2452, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_publishable_api_keys" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2453, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2454, + "name": "publishable_api_key", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/publishable-api-key.d.ts", + "qualifiedName": "PublishableApiKey" + }, + "name": "PublishableApiKey", + "package": "@medusajs/medusa" + } + }, + { + "id": 2455, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2454, + 2455 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2456, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2457, + "name": "publishable_api_key", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/publishable-api-key.d.ts", + "qualifiedName": "PublishableApiKey" + }, + "name": "PublishableApiKey", + "package": "@medusajs/medusa" + } + }, + { + "id": 2458, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2457, + 2458 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2459, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2460, + "name": "publishable_api_key", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/publishable-api-key.d.ts", + "qualifiedName": "PublishableApiKey" + }, + "name": "PublishableApiKey", + "package": "@medusajs/medusa" + } + }, + { + "id": 2461, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2460, + 2461 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2462, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2463, + "name": "publishable_api_key", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/publishable-api-key.d.ts", + "qualifiedName": "PublishableApiKey" + }, + "name": "PublishableApiKey", + "package": "@medusajs/medusa" + } + }, + { + "id": 2464, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2463, + 2464 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2495, + "name": "useAdminPublishableApiKeySalesChannels", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2496, + "name": "useAdminPublishableApiKeySalesChannels", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook lists the sales channels associated with a publishable API key. The sales channels can be \nfiltered by fields such as " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " passed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminPublishableApiKeySalesChannels,\n} from \"medusa-react\"\n\ntype Props = {\n publishableApiKeyId: string\n}\n\nconst SalesChannels = ({\n publishableApiKeyId\n}: Props) => {\n const { sales_channels, isLoading } = \n useAdminPublishableApiKeySalesChannels(\n publishableApiKeyId\n )\n\n return (\n
\n {isLoading && Loading...}\n {sales_channels && !sales_channels.length && (\n No Sales Channels\n )}\n {sales_channels && sales_channels.length > 0 && (\n
    \n {sales_channels.map((salesChannel) => (\n
  • {salesChannel.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default SalesChannels\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2497, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The publishable API Key's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2498, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on the retrieved sales channels." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.d.ts", + "qualifiedName": "GetPublishableApiKeySalesChannelsParams" + }, + "name": "GetPublishableApiKeySalesChannelsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2499, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysListSalesChannelsRes" + }, + "name": "AdminPublishableApiKeysListSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_publishable_api_keys" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": "sales_channels" + }, + { + "type": "intrinsic", + "name": "any" + } + ] + } + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2500, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2502, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2501, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/sales-channel.d.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2502, + 2501 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2503, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2505, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2504, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/sales-channel.d.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2505, + 2504 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2506, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2508, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2507, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/sales-channel.d.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2508, + 2507 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2509, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2511, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2510, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/sales-channel.d.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2511, + 2510 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2465, + "name": "useAdminPublishableApiKeys", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2466, + "name": "useAdminPublishableApiKeys", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of publishable API keys. The publishable API keys can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " passed in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": ". \nThe publishable API keys can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list publishable API keys:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { PublishableApiKey } from \"@medusajs/medusa\"\nimport { useAdminPublishableApiKeys } from \"medusa-react\"\n\nconst PublishableApiKeys = () => {\n const { publishable_api_keys, isLoading } = \n useAdminPublishableApiKeys()\n\n return (\n
\n {isLoading && Loading...}\n {publishable_api_keys && !publishable_api_keys.length && (\n No Publishable API Keys\n )}\n {publishable_api_keys && \n publishable_api_keys.length > 0 && (\n
    \n {publishable_api_keys.map(\n (publishableApiKey: PublishableApiKey) => (\n
  • \n {publishableApiKey.title}\n
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default PublishableApiKeys\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`20`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { PublishableApiKey } from \"@medusajs/medusa\"\nimport { useAdminPublishableApiKeys } from \"medusa-react\"\n\nconst PublishableApiKeys = () => {\n const { \n publishable_api_keys, \n limit,\n offset,\n isLoading\n } = \n useAdminPublishableApiKeys({\n limit: 50,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {publishable_api_keys && !publishable_api_keys.length && (\n No Publishable API Keys\n )}\n {publishable_api_keys && \n publishable_api_keys.length > 0 && (\n
    \n {publishable_api_keys.map(\n (publishableApiKey: PublishableApiKey) => (\n
  • \n {publishableApiKey.title}\n
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default PublishableApiKeys\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2467, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved publishable API keys." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-keys.d.ts", + "qualifiedName": "GetPublishableApiKeysParams" + }, + "name": "GetPublishableApiKeysParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2468, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysListRes" + }, + "name": "AdminPublishableApiKeysListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_publishable_api_keys" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2469, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2470, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2470 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2471, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2474, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2472, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2473, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2475, + "name": "publishable_api_keys", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/publishable-api-key.d.ts", + "qualifiedName": "PublishableApiKey" + }, + "name": "PublishableApiKey", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2476, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2474, + 2472, + 2473, + 2475, + 2476 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2477, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2480, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2478, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2479, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2481, + "name": "publishable_api_keys", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/publishable-api-key.d.ts", + "qualifiedName": "PublishableApiKey" + }, + "name": "PublishableApiKey", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2482, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2480, + 2478, + 2479, + 2481, + 2482 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2483, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2486, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2484, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2485, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2487, + "name": "publishable_api_keys", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/publishable-api-key.d.ts", + "qualifiedName": "PublishableApiKey" + }, + "name": "PublishableApiKey", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2488, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2486, + 2484, + 2485, + 2487, + 2488 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2489, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2492, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2490, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2491, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2493, + "name": "publishable_api_keys", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/publishable-api-key.d.ts", + "qualifiedName": "PublishableApiKey" + }, + "name": "PublishableApiKey", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2494, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2492, + 2490, + 2491, + 2493, + 2494 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2531, + "name": "useAdminRemovePublishableKeySalesChannelsBatch", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2532, + "name": "useAdminRemovePublishableKeySalesChannelsBatch", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook removes a list of sales channels from a publishable API key. This doesn't delete the sales channels and only \nremoves the association between them and the publishable API key." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminRemovePublishableKeySalesChannelsBatch,\n} from \"medusa-react\"\n\ntype Props = {\n publishableApiKeyId: string\n}\n\nconst PublishableApiKey = ({\n publishableApiKeyId\n}: Props) => {\n const deleteSalesChannels = \n useAdminRemovePublishableKeySalesChannelsBatch(\n publishableApiKeyId\n )\n // ...\n\n const handleDelete = (salesChannelId: string) => {\n deleteSalesChannels.mutate({\n sales_channel_ids: [\n {\n id: salesChannelId,\n },\n ],\n }, {\n onSuccess: ({ publishable_api_key }) => {\n console.log(publishable_api_key.id)\n }\n })\n }\n\n // ...\n}\n\nexport default PublishableApiKey\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2533, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The publishable API key's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2534, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/delete-channels-batch.d.ts", + "qualifiedName": "AdminDeletePublishableApiKeySalesChannelsBatchReq" + }, + "name": "AdminDeletePublishableApiKeySalesChannelsBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/delete-channels-batch.d.ts", + "qualifiedName": "AdminDeletePublishableApiKeySalesChannelsBatchReq" + }, + "name": "AdminDeletePublishableApiKeySalesChannelsBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2523, + "name": "useAdminRevokePublishableApiKey", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2524, + "name": "useAdminRevokePublishableApiKey", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook revokes a publishable API key. Revoking the publishable API Key can't be undone, and the key can't be used in future requests." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminRevokePublishableApiKey } from \"medusa-react\"\n\ntype Props = {\n publishableApiKeyId: string\n}\n\nconst PublishableApiKey = ({\n publishableApiKeyId\n}: Props) => {\n const revokeKey = useAdminRevokePublishableApiKey(\n publishableApiKeyId\n )\n // ...\n\n const handleRevoke = () => {\n revokeKey.mutate(void 0, {\n onSuccess: ({ publishable_api_key }) => {\n console.log(publishable_api_key.revoked_at)\n }\n })\n }\n\n // ...\n}\n\nexport default PublishableApiKey\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2525, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The publishable API key's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2526, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2515, + "name": "useAdminUpdatePublishableApiKey", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2516, + "name": "useAdminUpdatePublishableApiKey", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a publishable API key's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdatePublishableApiKey } from \"medusa-react\"\n\ntype Props = {\n publishableApiKeyId: string\n}\n\nconst PublishableApiKey = ({\n publishableApiKeyId\n}: Props) => {\n const updateKey = useAdminUpdatePublishableApiKey(\n publishableApiKeyId\n )\n // ...\n\n const handleUpdate = (title: string) => {\n updateKey.mutate({\n title,\n }, {\n onSuccess: ({ publishable_api_key }) => {\n console.log(publishable_api_key.id)\n }\n })\n }\n\n // ...\n}\n\nexport default PublishableApiKey\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2517, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The publishable API key's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2518, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/update-publishable-api-key.d.ts", + "qualifiedName": "AdminPostPublishableApiKeysPublishableApiKeyReq" + }, + "name": "AdminPostPublishableApiKeysPublishableApiKeyReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "AdminPublishableApiKeysRes" + }, + "name": "AdminPublishableApiKeysRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/update-publishable-api-key.d.ts", + "qualifiedName": "AdminPostPublishableApiKeysPublishableApiKeyReq" + }, + "name": "AdminPostPublishableApiKeysPublishableApiKeyReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2527, + 2512, + 2519, + 2449, + 2495, + 2465, + 2531, + 2523, + 2515 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2449, + 2465, + 2495 + ] + }, + { + "title": "Mutations", + "children": [ + 2512, + 2515, + 2519, + 2523, + 2527, + 2531 + ] + } + ] + }, + { + "id": 33, + "name": "Regions", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Region API Routes](https://docs.medusajs.com/api/admin#regions).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nRegions are different countries or geographical regions that the commerce store serves customers in.\nAdmins can manage these regions, their providers, and more.\n\nRelated Guide: [How to manage regions](https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2598, + "name": "useAdminCreateRegion", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2599, + "name": "useAdminCreateRegion", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a region." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateRegion } from \"medusa-react\"\n\ntype CreateData = {\n name: string\n currency_code: string\n tax_rate: number\n payment_providers: string[]\n fulfillment_providers: string[]\n countries: string[]\n}\n\nconst CreateRegion = () => {\n const createRegion = useAdminCreateRegion()\n // ...\n\n const handleCreate = (regionData: CreateData) => {\n createRegion.mutate(regionData, {\n onSuccess: ({ region }) => {\n console.log(region.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateRegion\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2600, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/create-region.d.ts", + "qualifiedName": "AdminPostRegionsReq" + }, + "name": "AdminPostRegionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/create-region.d.ts", + "qualifiedName": "AdminPostRegionsReq" + }, + "name": "AdminPostRegionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2605, + "name": "useAdminDeleteRegion", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2606, + "name": "useAdminDeleteRegion", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a region. Associated resources, such as providers or currencies are not deleted. Associated tax rates are deleted." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteRegion } from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Region = ({\n regionId\n}: Props) => {\n const deleteRegion = useAdminDeleteRegion(regionId)\n // ...\n\n const handleDelete = () => {\n deleteRegion.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default Region\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2607, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2608, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2566, + "name": "useAdminRegion", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2567, + "name": "useAdminRegion", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a region's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminRegion } from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Region = ({\n regionId\n}: Props) => {\n const { region, isLoading } = useAdminRegion(\n regionId\n )\n\n return (\n
\n {isLoading && Loading...}\n {region && {region.name}}\n
\n )\n}\n\nexport default Region\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2568, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2569, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_regions" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2570, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2571, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + }, + { + "id": 2572, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2571, + 2572 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2573, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2574, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + }, + { + "id": 2575, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2574, + 2575 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2576, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2577, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + }, + { + "id": 2578, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2577, + 2578 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2579, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2580, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + }, + { + "id": 2581, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2580, + 2581 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2609, + "name": "useAdminRegionAddCountry", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2610, + "name": "useAdminRegionAddCountry", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a country to the list of countries in a region." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminRegionAddCountry } from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Region = ({\n regionId\n}: Props) => {\n const addCountry = useAdminRegionAddCountry(regionId)\n // ...\n\n const handleAddCountry = (\n countryCode: string\n ) => {\n addCountry.mutate({\n country_code: countryCode\n }, {\n onSuccess: ({ region }) => {\n console.log(region.countries)\n }\n })\n }\n\n // ...\n}\n\nexport default Region\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2611, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2612, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/add-country.d.ts", + "qualifiedName": "AdminPostRegionsRegionCountriesReq" + }, + "name": "AdminPostRegionsRegionCountriesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/add-country.d.ts", + "qualifiedName": "AdminPostRegionsRegionCountriesReq" + }, + "name": "AdminPostRegionsRegionCountriesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2617, + "name": "useAdminRegionAddFulfillmentProvider", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2618, + "name": "useAdminRegionAddFulfillmentProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a fulfillment provider to the list of fulfullment providers in a region." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminRegionAddFulfillmentProvider\n} from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Region = ({\n regionId\n}: Props) => {\n const addFulfillmentProvider = \n useAdminRegionAddFulfillmentProvider(regionId)\n // ...\n\n const handleAddFulfillmentProvider = (\n providerId: string\n ) => {\n addFulfillmentProvider.mutate({\n provider_id: providerId\n }, {\n onSuccess: ({ region }) => {\n console.log(region.fulfillment_providers)\n }\n })\n }\n\n // ...\n}\n\nexport default Region\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2619, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2620, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/add-fulfillment-provider.d.ts", + "qualifiedName": "AdminPostRegionsRegionFulfillmentProvidersReq" + }, + "name": "AdminPostRegionsRegionFulfillmentProvidersReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/add-fulfillment-provider.d.ts", + "qualifiedName": "AdminPostRegionsRegionFulfillmentProvidersReq" + }, + "name": "AdminPostRegionsRegionFulfillmentProvidersReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2625, + "name": "useAdminRegionAddPaymentProvider", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2626, + "name": "useAdminRegionAddPaymentProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a payment provider to the list of payment providers in a region." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminRegionAddPaymentProvider\n} from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Region = ({\n regionId\n}: Props) => {\n const addPaymentProvider = \n useAdminRegionAddPaymentProvider(regionId)\n // ...\n\n const handleAddPaymentProvider = (\n providerId: string\n ) => {\n addPaymentProvider.mutate({\n provider_id: providerId\n }, {\n onSuccess: ({ region }) => {\n console.log(region.payment_providers)\n }\n })\n }\n\n // ...\n}\n\nexport default Region\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2627, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2628, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/add-payment-provider.d.ts", + "qualifiedName": "AdminPostRegionsRegionPaymentProvidersReq" + }, + "name": "AdminPostRegionsRegionPaymentProvidersReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/add-payment-provider.d.ts", + "qualifiedName": "AdminPostRegionsRegionPaymentProvidersReq" + }, + "name": "AdminPostRegionsRegionPaymentProvidersReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2621, + "name": "useAdminRegionDeleteFulfillmentProvider", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2622, + "name": "useAdminRegionDeleteFulfillmentProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a fulfillment provider from a region. The fulfillment provider will still be available for usage in other regions." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The fulfillment provider's ID to delete from the region." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminRegionDeleteFulfillmentProvider\n} from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Region = ({\n regionId\n}: Props) => {\n const removeFulfillmentProvider = \n useAdminRegionDeleteFulfillmentProvider(regionId)\n // ...\n\n const handleRemoveFulfillmentProvider = (\n providerId: string\n ) => {\n removeFulfillmentProvider.mutate(providerId, {\n onSuccess: ({ region }) => {\n console.log(region.fulfillment_providers)\n }\n })\n }\n\n // ...\n}\n\nexport default Region\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2623, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2624, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2629, + "name": "useAdminRegionDeletePaymentProvider", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2630, + "name": "useAdminRegionDeletePaymentProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a payment provider from a region. The payment provider will still be available for usage in other regions." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The ID of the payment provider to delete from the region." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminRegionDeletePaymentProvider\n} from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Region = ({\n regionId\n}: Props) => {\n const removePaymentProvider = \n useAdminRegionDeletePaymentProvider(regionId)\n // ...\n\n const handleRemovePaymentProvider = (\n providerId: string\n ) => {\n removePaymentProvider.mutate(providerId, {\n onSuccess: ({ region }) => {\n console.log(region.payment_providers)\n }\n })\n }\n\n // ...\n}\n\nexport default Region\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2631, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2632, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2582, + "name": "useAdminRegionFulfillmentOptions", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2583, + "name": "useAdminRegionFulfillmentOptions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of fulfillment options available in a region." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminRegionFulfillmentOptions\n} from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Region = ({\n regionId\n}: Props) => {\n const { \n fulfillment_options, \n isLoading\n } = useAdminRegionFulfillmentOptions(\n regionId\n )\n\n return (\n
\n {isLoading && Loading...}\n {fulfillment_options && !fulfillment_options.length && (\n No Regions\n )}\n {fulfillment_options && \n fulfillment_options.length > 0 && (\n
    \n {fulfillment_options.map((option) => (\n
  • \n {option.provider_id}\n
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Region\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2584, + "name": "regionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2585, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminGetRegionsRegionFulfillmentOptionsRes" + }, + "name": "AdminGetRegionsRegionFulfillmentOptionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_regions" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2586, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2587, + "name": "fulfillment_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "FulfillmentOption" + }, + "name": "FulfillmentOption", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2588, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2587, + 2588 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2589, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2590, + "name": "fulfillment_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "FulfillmentOption" + }, + "name": "FulfillmentOption", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2591, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2590, + 2591 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2592, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2593, + "name": "fulfillment_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "FulfillmentOption" + }, + "name": "FulfillmentOption", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2594, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2593, + 2594 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2595, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2596, + "name": "fulfillment_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "FulfillmentOption" + }, + "name": "FulfillmentOption", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2597, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2596, + 2597 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2613, + "name": "useAdminRegionRemoveCountry", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2614, + "name": "useAdminRegionRemoveCountry", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a country from the list of countries in a region. The country will still be available in the system, and it can be used in other regions." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The code of the country to delete from the region." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminRegionRemoveCountry } from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Region = ({\n regionId\n}: Props) => {\n const removeCountry = useAdminRegionRemoveCountry(regionId)\n // ...\n\n const handleRemoveCountry = (\n countryCode: string\n ) => {\n removeCountry.mutate(countryCode, {\n onSuccess: ({ region }) => {\n console.log(region.countries)\n }\n })\n }\n\n // ...\n}\n\nexport default Region\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2615, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2616, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2536, + "name": "useAdminRegions", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2537, + "name": "useAdminRegions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of Regions. The regions can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " passed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. \nThe regions can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list regions:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminRegions } from \"medusa-react\"\n\nconst Regions = () => {\n const { regions, isLoading } = useAdminRegions()\n\n return (\n
\n {isLoading && Loading...}\n {regions && !regions.length && No Regions}\n {regions && regions.length > 0 && (\n
    \n {regions.map((region) => (\n
  • {region.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Regions\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminRegions } from \"medusa-react\"\n\nconst Regions = () => {\n const { \n regions, \n limit,\n offset,\n isLoading\n } = useAdminRegions({\n limit: 20,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {regions && !regions.length && No Regions}\n {regions && regions.length > 0 && (\n
    \n {regions.map((region) => (\n
  • {region.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Regions\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2538, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved regions." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts", + "qualifiedName": "AdminGetRegionsParams" + }, + "name": "AdminGetRegionsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2539, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsListRes" + }, + "name": "AdminRegionsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_regions" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2540, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2541, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2541 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2542, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2545, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2543, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2544, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2546, + "name": "regions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2547, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2545, + 2543, + 2544, + 2546, + 2547 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2548, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2551, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2549, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2550, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2552, + "name": "regions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2553, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2551, + 2549, + 2550, + 2552, + 2553 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2554, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2557, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2555, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2556, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2558, + "name": "regions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2559, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2557, + 2555, + 2556, + 2558, + 2559 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2560, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2563, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2561, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2562, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2564, + "name": "regions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2565, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2563, + 2561, + 2562, + 2564, + 2565 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2601, + "name": "useAdminUpdateRegion", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2602, + "name": "useAdminUpdateRegion", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a region's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateRegion } from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Region = ({\n regionId\n}: Props) => {\n const updateRegion = useAdminUpdateRegion(regionId)\n // ...\n\n const handleUpdate = (\n countries: string[]\n ) => {\n updateRegion.mutate({\n countries,\n }, {\n onSuccess: ({ region }) => {\n console.log(region.id)\n }\n })\n }\n\n // ...\n}\n\nexport default Region\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2603, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2604, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/update-region.d.ts", + "qualifiedName": "AdminPostRegionsRegionReq" + }, + "name": "AdminPostRegionsRegionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "AdminRegionsRes" + }, + "name": "AdminRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/update-region.d.ts", + "qualifiedName": "AdminPostRegionsRegionReq" + }, + "name": "AdminPostRegionsRegionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2598, + 2605, + 2566, + 2609, + 2617, + 2625, + 2621, + 2629, + 2582, + 2613, + 2536, + 2601 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2536, + 2566, + 2582 + ] + }, + { + "title": "Mutations", + "children": [ + 2598, + 2601, + 2605, + 2609, + 2613, + 2617, + 2621, + 2625, + 2629 + ] + } + ] + }, + { + "id": 34, + "name": "Reservations", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Reservation API Routes](https://docs.medusajs.com/api/admin#reservations).\nTo use these hooks, make sure to install the\n[@medusajs/inventory](https://docs.medusajs.com/modules/multiwarehouse/install-modules#inventory-module) module in your Medusa backend.\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nReservations, provided by the [Inventory Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module), \nare quantities of an item that are reserved, typically when an order is placed but not yet fulfilled.\nReservations can be associated with any resources, but commonly with line items of an order.\n\nRelated Guide: [How to manage item allocations in orders](https://docs.medusajs.com/modules/multiwarehouse/admin/manage-item-allocations-in-orders)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2633, + "name": "useAdminCreateReservation", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2634, + "name": "useAdminCreateReservation", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a reservation which can be associated with any resource, such as an order's line item." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateReservation } from \"medusa-react\"\n\nconst CreateReservation = () => {\n const createReservation = useAdminCreateReservation()\n // ...\n\n const handleCreate = (\n locationId: string,\n inventoryItemId: string,\n quantity: number\n ) => {\n createReservation.mutate({\n location_id: locationId,\n inventory_item_id: inventoryItemId,\n quantity,\n }, {\n onSuccess: ({ reservation }) => {\n console.log(reservation.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateReservation\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2635, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "AdminReservationsRes" + }, + "name": "AdminReservationsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts", + "qualifiedName": "AdminPostReservationsReq" + }, + "name": "AdminPostReservationsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "AdminReservationsRes" + }, + "name": "AdminReservationsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts", + "qualifiedName": "AdminPostReservationsReq" + }, + "name": "AdminPostReservationsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2640, + "name": "useAdminDeleteReservation", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2641, + "name": "useAdminDeleteReservation", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a reservation. Associated resources, such as the line item, will not be deleted." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteReservation } from \"medusa-react\"\n\ntype Props = {\n reservationId: string\n}\n\nconst Reservation = ({ reservationId }: Props) => {\n const deleteReservation = useAdminDeleteReservation(\n reservationId\n )\n // ...\n\n const handleDelete = () => {\n deleteReservation.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default Reservation\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2642, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reservation's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2643, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2675, + "name": "useAdminReservation", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2676, + "name": "useAdminReservation", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a reservation's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminReservation } from \"medusa-react\"\n\ntype Props = {\n reservationId: string\n}\n\nconst Reservation = ({ reservationId }: Props) => {\n const { reservation, isLoading } = useAdminReservation(\n reservationId\n )\n\n return (\n
\n {isLoading && Loading...}\n {reservation && (\n {reservation.inventory_item_id}\n )}\n
\n )\n}\n\nexport default Reservation\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2677, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reservation's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2678, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "AdminReservationsRes" + }, + "name": "AdminReservationsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_reservations" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2679, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2680, + "name": "reservation", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "ReservationItemDTO" + }, + "name": "ReservationItemDTO", + "package": "@medusajs/types" + } + }, + { + "id": 2681, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2680, + 2681 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2682, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2683, + "name": "reservation", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "ReservationItemDTO" + }, + "name": "ReservationItemDTO", + "package": "@medusajs/types" + } + }, + { + "id": 2684, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2683, + 2684 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2685, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2686, + "name": "reservation", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "ReservationItemDTO" + }, + "name": "ReservationItemDTO", + "package": "@medusajs/types" + } + }, + { + "id": 2687, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2686, + 2687 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2688, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2689, + "name": "reservation", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "ReservationItemDTO" + }, + "name": "ReservationItemDTO", + "package": "@medusajs/types" + } + }, + { + "id": 2690, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2689, + 2690 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2645, + "name": "useAdminReservations", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2646, + "name": "useAdminReservations", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of reservations. The reservations can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`location_id`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`quantity`" + }, + { + "kind": "text", + "text": " \npassed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The reservations can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list reservations:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminReservations } from \"medusa-react\"\n\nconst Reservations = () => {\n const { reservations, isLoading } = useAdminReservations()\n\n return (\n
\n {isLoading && Loading...}\n {reservations && !reservations.length && (\n No Reservations\n )}\n {reservations && reservations.length > 0 && (\n
    \n {reservations.map((reservation) => (\n
  • {reservation.quantity}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Reservations\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the reservations:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminReservations } from \"medusa-react\"\n\nconst Reservations = () => {\n const { \n reservations, \n isLoading\n } = useAdminReservations({\n expand: \"location\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {reservations && !reservations.length && (\n No Reservations\n )}\n {reservations && reservations.length > 0 && (\n
    \n {reservations.map((reservation) => (\n
  • {reservation.quantity}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Reservations\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`20`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminReservations } from \"medusa-react\"\n\nconst Reservations = () => {\n const { \n reservations,\n limit,\n offset, \n isLoading\n } = useAdminReservations({\n expand: \"location\",\n limit: 10,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {reservations && !reservations.length && (\n No Reservations\n )}\n {reservations && reservations.length > 0 && (\n
    \n {reservations.map((reservation) => (\n
  • {reservation.quantity}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Reservations\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2647, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination parameters to apply on the retrieved reservations." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/list-reservations.d.ts", + "qualifiedName": "AdminGetReservationsParams" + }, + "name": "AdminGetReservationsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2648, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "AdminReservationsListRes" + }, + "name": "AdminReservationsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_reservations" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2649, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2650, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2650 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2651, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2654, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2652, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2653, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2655, + "name": "reservations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "ReservationItemDTO" + }, + "name": "ReservationItemDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 2656, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2654, + 2652, + 2653, + 2655, + 2656 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2657, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2660, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2658, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2659, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2661, + "name": "reservations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "ReservationItemDTO" + }, + "name": "ReservationItemDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 2662, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2660, + 2658, + 2659, + 2661, + 2662 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2663, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2666, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2664, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2665, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2667, + "name": "reservations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "ReservationItemDTO" + }, + "name": "ReservationItemDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 2668, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2666, + 2664, + 2665, + 2667, + 2668 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2669, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2672, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2670, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2671, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2673, + "name": "reservations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/inventory/common.d.ts", + "qualifiedName": "ReservationItemDTO" + }, + "name": "ReservationItemDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 2674, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2672, + 2670, + 2671, + 2673, + 2674 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2636, + "name": "useAdminUpdateReservation", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2637, + "name": "useAdminUpdateReservation", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a reservation's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateReservation } from \"medusa-react\"\n\ntype Props = {\n reservationId: string\n}\n\nconst Reservation = ({ reservationId }: Props) => {\n const updateReservation = useAdminUpdateReservation(\n reservationId\n )\n // ...\n\n const handleUpdate = (\n quantity: number\n ) => {\n updateReservation.mutate({\n quantity,\n })\n }\n\n // ...\n}\n\nexport default Reservation\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2638, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reservation's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2639, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "AdminReservationsRes" + }, + "name": "AdminReservationsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/update-reservation.d.ts", + "qualifiedName": "AdminPostReservationsReservationReq" + }, + "name": "AdminPostReservationsReservationReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "AdminReservationsRes" + }, + "name": "AdminReservationsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/update-reservation.d.ts", + "qualifiedName": "AdminPostReservationsReservationReq" + }, + "name": "AdminPostReservationsReservationReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2633, + 2640, + 2675, + 2645, + 2636 + ] + } + ], + "categories": [ + { + "title": "Mutations", + "children": [ + 2633, + 2636, + 2640 + ] + }, + { + "title": "Queries", + "children": [ + 2645, + 2675 + ] + } + ] + }, + { + "id": 35, + "name": "Return Reasons", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Return Reason API Routes](https://docs.medusajs.com/api/admin#return-reasons).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nReturn reasons are key-value pairs that are used to specify why an order return is being created.\nAdmins can manage available return reasons, and they can be used by both admins and customers when creating a return.\n\nRelated Guide: [How to manage return reasons](https://docs.medusajs.com/modules/orders/admin/manage-returns#manage-return-reasons)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2723, + "name": "useAdminCreateReturnReason", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2724, + "name": "useAdminCreateReturnReason", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a return reason." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateReturnReason } from \"medusa-react\"\n\nconst CreateReturnReason = () => {\n const createReturnReason = useAdminCreateReturnReason()\n // ...\n\n const handleCreate = (\n label: string,\n value: string\n ) => {\n createReturnReason.mutate({\n label,\n value,\n }, {\n onSuccess: ({ return_reason }) => {\n console.log(return_reason.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateReturnReason\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2725, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "AdminReturnReasonsRes" + }, + "name": "AdminReturnReasonsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts", + "qualifiedName": "AdminPostReturnReasonsReq" + }, + "name": "AdminPostReturnReasonsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "AdminReturnReasonsRes" + }, + "name": "AdminReturnReasonsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts", + "qualifiedName": "AdminPostReturnReasonsReq" + }, + "name": "AdminPostReturnReasonsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2730, + "name": "useAdminDeleteReturnReason", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2731, + "name": "useAdminDeleteReturnReason", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a return reason." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteReturnReason } from \"medusa-react\"\n\ntype Props = {\n returnReasonId: string\n}\n\nconst ReturnReason = ({ returnReasonId }: Props) => {\n const deleteReturnReason = useAdminDeleteReturnReason(\n returnReasonId\n )\n // ...\n\n const handleDelete = () => {\n deleteReturnReason.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default ReturnReason\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2732, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return reason's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2733, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "unknown" + }, + { + "type": "intrinsic", + "name": "unknown" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "intrinsic", + "name": "unknown" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2707, + "name": "useAdminReturnReason", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2708, + "name": "useAdminReturnReason", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a return reason's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminReturnReason } from \"medusa-react\"\n\ntype Props = {\n returnReasonId: string\n}\n\nconst ReturnReason = ({ returnReasonId }: Props) => {\n const { return_reason, isLoading } = useAdminReturnReason(\n returnReasonId\n )\n\n return (\n
\n {isLoading && Loading...}\n {return_reason && {return_reason.label}}\n
\n )\n}\n\nexport default ReturnReason\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2709, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return reason's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2710, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "AdminReturnReasonsRes" + }, + "name": "AdminReturnReasonsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_return_reasons" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2711, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2713, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2712, + "name": "return_reason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2713, + 2712 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2714, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2716, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2715, + "name": "return_reason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2716, + 2715 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2717, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2719, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2718, + "name": "return_reason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2719, + 2718 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2720, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2722, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2721, + "name": "return_reason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2722, + 2721 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2692, + "name": "useAdminReturnReasons", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2693, + "name": "useAdminReturnReasons", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of return reasons." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminReturnReasons } from \"medusa-react\"\n\nconst ReturnReasons = () => {\n const { return_reasons, isLoading } = useAdminReturnReasons()\n\n return (\n
\n {isLoading && Loading...}\n {return_reasons && !return_reasons.length && (\n No Return Reasons\n )}\n {return_reasons && return_reasons.length > 0 && (\n
    \n {return_reasons.map((reason) => (\n
  • \n {reason.label}: {reason.value}\n
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default ReturnReasons\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2694, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "AdminReturnReasonsListRes" + }, + "name": "AdminReturnReasonsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_return_reasons" + }, + { + "type": "literal", + "value": "list" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2695, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2697, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2696, + "name": "return_reasons", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2697, + 2696 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2698, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2700, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2699, + "name": "return_reasons", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2700, + 2699 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2701, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2703, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2702, + "name": "return_reasons", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2703, + 2702 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2704, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2706, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2705, + "name": "return_reasons", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2706, + 2705 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2726, + "name": "useAdminUpdateReturnReason", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2727, + "name": "useAdminUpdateReturnReason", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a return reason's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateReturnReason } from \"medusa-react\"\n\ntype Props = {\n returnReasonId: string\n}\n\nconst ReturnReason = ({ returnReasonId }: Props) => {\n const updateReturnReason = useAdminUpdateReturnReason(\n returnReasonId\n )\n // ...\n\n const handleUpdate = (\n label: string\n ) => {\n updateReturnReason.mutate({\n label,\n }, {\n onSuccess: ({ return_reason }) => {\n console.log(return_reason.label)\n }\n })\n }\n\n // ...\n}\n\nexport default ReturnReason\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2728, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return reason's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2729, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "AdminReturnReasonsRes" + }, + "name": "AdminReturnReasonsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts", + "qualifiedName": "AdminPostReturnReasonsReasonReq" + }, + "name": "AdminPostReturnReasonsReasonReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "AdminReturnReasonsRes" + }, + "name": "AdminReturnReasonsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts", + "qualifiedName": "AdminPostReturnReasonsReasonReq" + }, + "name": "AdminPostReturnReasonsReasonReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2723, + 2730, + 2707, + 2692, + 2726 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2692, + 2707 + ] + }, + { + "title": "Mutations", + "children": [ + 2723, + 2726, + 2730 + ] + } + ] + }, + { + "id": 36, + "name": "Returns", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Return API Routes](https://docs.medusajs.com/api/admin#returns).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA return can be created by a customer or an admin to return items in an order.\nAdmins can manage these returns and change their state.\n\nRelated Guide: [How to manage returns](https://docs.medusajs.com/modules/orders/admin/manage-returns)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2766, + "name": "useAdminCancelReturn", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2767, + "name": "useAdminCancelReturn", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook registers a return as canceled. The return can be associated with an order, claim, or swap." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCancelReturn } from \"medusa-react\"\n\ntype Props = {\n returnId: string\n}\n\nconst Return = ({ returnId }: Props) => {\n const cancelReturn = useAdminCancelReturn(\n returnId\n )\n // ...\n\n const handleCancel = () => {\n cancelReturn.mutate(void 0, {\n onSuccess: ({ order }) => {\n console.log(order.returns)\n }\n })\n }\n\n // ...\n}\n\nexport default Return\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2768, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2769, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/returns/index.d.ts", + "qualifiedName": "AdminReturnsCancelRes" + }, + "name": "AdminReturnsCancelRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/returns/index.d.ts", + "qualifiedName": "AdminReturnsCancelRes" + }, + "name": "AdminReturnsCancelRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2762, + "name": "useAdminReceiveReturn", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2763, + "name": "useAdminReceiveReturn", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook marks a return as received. This also updates the status of associated order, claim, or swap accordingly." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminReceiveReturn } from \"medusa-react\"\n\ntype ReceiveReturnData = {\n items: {\n item_id: string\n quantity: number\n }[]\n}\n\ntype Props = {\n returnId: string\n}\n\nconst Return = ({ returnId }: Props) => {\n const receiveReturn = useAdminReceiveReturn(\n returnId\n )\n // ...\n\n const handleReceive = (data: ReceiveReturnData) => {\n receiveReturn.mutate(data, {\n onSuccess: ({ return: dataReturn }) => {\n console.log(dataReturn.status)\n }\n })\n }\n\n // ...\n}\n\nexport default Return\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2764, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2765, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/returns/index.d.ts", + "qualifiedName": "AdminReturnsRes" + }, + "name": "AdminReturnsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/returns/receive-return.d.ts", + "qualifiedName": "AdminPostReturnsReturnReceiveReq" + }, + "name": "AdminPostReturnsReturnReceiveReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/returns/index.d.ts", + "qualifiedName": "AdminReturnsRes" + }, + "name": "AdminReturnsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/returns/receive-return.d.ts", + "qualifiedName": "AdminPostReturnsReturnReceiveReq" + }, + "name": "AdminPostReturnsReturnReceiveReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2735, + "name": "useAdminReturns", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2736, + "name": "useAdminReturns", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of Returns. The returns can be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminReturns } from \"medusa-react\"\n\nconst Returns = () => {\n const { returns, isLoading } = useAdminReturns()\n\n return (\n
\n {isLoading && Loading...}\n {returns && !returns.length && (\n No Returns\n )}\n {returns && returns.length > 0 && (\n
    \n {returns.map((returnData) => (\n
  • \n {returnData.status}\n
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Returns\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2737, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/returns/index.d.ts", + "qualifiedName": "AdminReturnsListRes" + }, + "name": "AdminReturnsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_returns" + }, + { + "type": "literal", + "value": "list" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2738, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2741, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2739, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2740, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2743, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2742, + "name": "returns", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return.d.ts", + "qualifiedName": "Return" + }, + "name": "Return", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2741, + 2739, + 2740, + 2743, + 2742 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2744, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2747, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2745, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2746, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2749, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2748, + "name": "returns", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return.d.ts", + "qualifiedName": "Return" + }, + "name": "Return", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2747, + 2745, + 2746, + 2749, + 2748 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2750, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2753, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2751, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2752, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2755, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2754, + "name": "returns", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return.d.ts", + "qualifiedName": "Return" + }, + "name": "Return", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2753, + 2751, + 2752, + 2755, + 2754 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2756, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2759, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2757, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2758, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2761, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2760, + "name": "returns", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return.d.ts", + "qualifiedName": "Return" + }, + "name": "Return", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2759, + 2757, + 2758, + 2761, + 2760 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2766, + 2762, + 2735 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2735 + ] + }, + { + "title": "Mutations", + "children": [ + 2762, + 2766 + ] + } + ] + }, + { + "id": 37, + "name": "Sales Channels", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Sales Channel API Routes](https://docs.medusajs.com/api/admin#sales-channels).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA sales channel indicates a channel where products can be sold in. For example, a webshop or a mobile app.\nAdmins can manage sales channels and the products available in them.\n\nRelated Guide: [How to manage sales channels](https://docs.medusajs.com/modules/sales-channels/admin/manage)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2836, + "name": "useAdminAddLocationToSalesChannel", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2837, + "name": "useAdminAddLocationToSalesChannel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook associates a stock location with a sales channel. It requires the \n[@medusajs/stock-location](https://docs.medusajs.com/modules/multiwarehouse/install-modules#stock-location-module) module to be installed in\nyour Medusa backend." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminAddLocationToSalesChannel\n} from \"medusa-react\"\n\ntype Props = {\n salesChannelId: string\n}\n\nconst SalesChannel = ({ salesChannelId }: Props) => {\n const addLocation = useAdminAddLocationToSalesChannel()\n // ...\n\n const handleAddLocation = (locationId: string) => {\n addLocation.mutate({\n sales_channel_id: salesChannelId,\n location_id: locationId\n }, {\n onSuccess: ({ sales_channel }) => {\n console.log(sales_channel.locations)\n }\n })\n }\n\n // ...\n}\n\nexport default SalesChannel\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2838, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2839, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2841, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The location's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2840, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The sales channel's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2841, + 2840 + ] + } + ] + } + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2842, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2844, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The location's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2843, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The sales channel's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2844, + 2843 + ] + } + ] + } + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2832, + "name": "useAdminAddProductsToSalesChannel", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2833, + "name": "useAdminAddProductsToSalesChannel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a list of products to a sales channel." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminAddProductsToSalesChannel } from \"medusa-react\"\n\ntype Props = {\n salesChannelId: string\n}\n\nconst SalesChannel = ({ salesChannelId }: Props) => {\n const addProducts = useAdminAddProductsToSalesChannel(\n salesChannelId\n )\n // ...\n\n const handleAddProducts = (productId: string) => {\n addProducts.mutate({\n product_ids: [\n {\n id: productId,\n },\n ],\n }, {\n onSuccess: ({ sales_channel }) => {\n console.log(sales_channel.id)\n }\n })\n }\n\n // ...\n}\n\nexport default SalesChannel\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2834, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The sales channel's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2835, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/add-product-batch.d.ts", + "qualifiedName": "AdminPostSalesChannelsChannelProductsBatchReq" + }, + "name": "AdminPostSalesChannelsChannelProductsBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/add-product-batch.d.ts", + "qualifiedName": "AdminPostSalesChannelsChannelProductsBatchReq" + }, + "name": "AdminPostSalesChannelsChannelProductsBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2817, + "name": "useAdminCreateSalesChannel", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2818, + "name": "useAdminCreateSalesChannel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a sales channel." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateSalesChannel } from \"medusa-react\"\n\nconst CreateSalesChannel = () => {\n const createSalesChannel = useAdminCreateSalesChannel()\n // ...\n\n const handleCreate = (name: string, description: string) => {\n createSalesChannel.mutate({\n name,\n description,\n }, {\n onSuccess: ({ sales_channel }) => {\n console.log(sales_channel.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateSalesChannel\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2819, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts", + "qualifiedName": "AdminPostSalesChannelsReq" + }, + "name": "AdminPostSalesChannelsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts", + "qualifiedName": "AdminPostSalesChannelsReq" + }, + "name": "AdminPostSalesChannelsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2828, + "name": "useAdminDeleteProductsFromSalesChannel", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2829, + "name": "useAdminDeleteProductsFromSalesChannel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook removes a list of products from a sales channel. This doesn't delete the product. It only removes the \nassociation between the product and the sales channel." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminDeleteProductsFromSalesChannel, \n} from \"medusa-react\"\n\ntype Props = {\n salesChannelId: string\n}\n\nconst SalesChannel = ({ salesChannelId }: Props) => {\n const deleteProducts = useAdminDeleteProductsFromSalesChannel(\n salesChannelId\n )\n // ...\n\n const handleDeleteProducts = (productId: string) => {\n deleteProducts.mutate({\n product_ids: [\n {\n id: productId,\n },\n ],\n }, {\n onSuccess: ({ sales_channel }) => {\n console.log(sales_channel.id)\n }\n })\n }\n\n // ...\n}\n\nexport default SalesChannel\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2830, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The sales channel's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2831, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/delete-products-batch.d.ts", + "qualifiedName": "AdminDeleteSalesChannelsChannelProductsBatchReq" + }, + "name": "AdminDeleteSalesChannelsChannelProductsBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/delete-products-batch.d.ts", + "qualifiedName": "AdminDeleteSalesChannelsChannelProductsBatchReq" + }, + "name": "AdminDeleteSalesChannelsChannelProductsBatchReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2824, + "name": "useAdminDeleteSalesChannel", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2825, + "name": "useAdminDeleteSalesChannel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a sales channel. Associated products, stock locations, and other resources are not deleted." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteSalesChannel } from \"medusa-react\"\n\ntype Props = {\n salesChannelId: string\n}\n\nconst SalesChannel = ({ salesChannelId }: Props) => {\n const deleteSalesChannel = useAdminDeleteSalesChannel(\n salesChannelId\n )\n // ...\n\n const handleDelete = () => {\n deleteSalesChannel.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default SalesChannel\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2826, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The sales channel's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2827, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2845, + "name": "useAdminRemoveLocationFromSalesChannel", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2846, + "name": "useAdminRemoveLocationFromSalesChannel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook removes a stock location from a sales channel. This only removes the association between the stock \nlocation and the sales channel. It does not delete the stock location. This hook requires the \n[@medusajs/stock-location](https://docs.medusajs.com/modules/multiwarehouse/install-modules#stock-location-module) module to be installed in\nyour Medusa backend." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminRemoveLocationFromSalesChannel\n} from \"medusa-react\"\n\ntype Props = {\n salesChannelId: string\n}\n\nconst SalesChannel = ({ salesChannelId }: Props) => {\n const removeLocation = useAdminRemoveLocationFromSalesChannel()\n // ...\n\n const handleRemoveLocation = (locationId: string) => {\n removeLocation.mutate({\n sales_channel_id: salesChannelId,\n location_id: locationId\n }, {\n onSuccess: ({ sales_channel }) => {\n console.log(sales_channel.locations)\n }\n })\n }\n\n // ...\n}\n\nexport default SalesChannel\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2847, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2848, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2850, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The location's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2849, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The sales channel's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2850, + 2849 + ] + } + ] + } + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2851, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2853, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The location's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2852, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The sales channel's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2853, + 2852 + ] + } + ] + } + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2771, + "name": "useAdminSalesChannel", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2772, + "name": "useAdminSalesChannel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a sales channel's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminSalesChannel } from \"medusa-react\"\n\ntype Props = {\n salesChannelId: string\n}\n\nconst SalesChannel = ({ salesChannelId }: Props) => {\n const { \n sales_channel, \n isLoading, \n } = useAdminSalesChannel(salesChannelId)\n\n return (\n
\n {isLoading && Loading...}\n {sales_channel && {sales_channel.name}}\n
\n )\n}\n\nexport default SalesChannel\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2773, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The sales channel's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2774, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_sales_channels" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2775, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2777, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2776, + "name": "sales_channel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/sales-channel.d.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2777, + 2776 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2778, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2780, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2779, + "name": "sales_channel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/sales-channel.d.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2780, + 2779 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2781, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2783, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2782, + "name": "sales_channel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/sales-channel.d.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2783, + 2782 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2784, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2786, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2785, + "name": "sales_channel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/sales-channel.d.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2786, + 2785 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2787, + "name": "useAdminSalesChannels", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2788, + "name": "useAdminSalesChannels", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of sales channels. The sales channels can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`name`" + }, + { + "kind": "text", + "text": " \npassed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The sales channels can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list sales channels:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminSalesChannels } from \"medusa-react\"\n\nconst SalesChannels = () => {\n const { sales_channels, isLoading } = useAdminSalesChannels()\n\n return (\n
\n {isLoading && Loading...}\n {sales_channels && !sales_channels.length && (\n No Sales Channels\n )}\n {sales_channels && sales_channels.length > 0 && (\n
    \n {sales_channels.map((salesChannel) => (\n
  • {salesChannel.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default SalesChannels\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the sales channels:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminSalesChannels } from \"medusa-react\"\n\nconst SalesChannels = () => {\n const { \n sales_channels, \n isLoading\n } = useAdminSalesChannels({\n expand: \"locations\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {sales_channels && !sales_channels.length && (\n No Sales Channels\n )}\n {sales_channels && sales_channels.length > 0 && (\n
    \n {sales_channels.map((salesChannel) => (\n
  • {salesChannel.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default SalesChannels\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`20`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminSalesChannels } from \"medusa-react\"\n\nconst SalesChannels = () => {\n const { \n sales_channels, \n limit,\n offset,\n isLoading\n } = useAdminSalesChannels({\n expand: \"locations\",\n limit: 10,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {sales_channels && !sales_channels.length && (\n No Sales Channels\n )}\n {sales_channels && sales_channels.length > 0 && (\n
    \n {sales_channels.map((salesChannel) => (\n
  • {salesChannel.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default SalesChannels\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2789, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations applied on the retrieved sales channels." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts", + "qualifiedName": "AdminGetSalesChannelsParams" + }, + "name": "AdminGetSalesChannelsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2790, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsListRes" + }, + "name": "AdminSalesChannelsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_sales_channels" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2791, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2792, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2792 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2793, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2796, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2794, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2795, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2798, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2797, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/sales-channel.d.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2796, + 2794, + 2795, + 2798, + 2797 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2799, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2802, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2800, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2801, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2804, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2803, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/sales-channel.d.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2802, + 2800, + 2801, + 2804, + 2803 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2805, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2808, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2806, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2807, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2810, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2809, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/sales-channel.d.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2808, + 2806, + 2807, + 2810, + 2809 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2811, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2814, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2812, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2813, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2816, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2815, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/sales-channel.d.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2814, + 2812, + 2813, + 2816, + 2815 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2820, + "name": "useAdminUpdateSalesChannel", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2821, + "name": "useAdminUpdateSalesChannel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a sales channel's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateSalesChannel } from \"medusa-react\"\n\ntype Props = {\n salesChannelId: string\n}\n\nconst SalesChannel = ({ salesChannelId }: Props) => {\n const updateSalesChannel = useAdminUpdateSalesChannel(\n salesChannelId\n )\n // ...\n\n const handleUpdate = (\n is_disabled: boolean\n ) => {\n updateSalesChannel.mutate({\n is_disabled,\n }, {\n onSuccess: ({ sales_channel }) => {\n console.log(sales_channel.is_disabled)\n }\n })\n }\n\n // ...\n}\n\nexport default SalesChannel\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2822, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The sales channel's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2823, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts", + "qualifiedName": "AdminPostSalesChannelsSalesChannelReq" + }, + "name": "AdminPostSalesChannelsSalesChannelReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "AdminSalesChannelsRes" + }, + "name": "AdminSalesChannelsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts", + "qualifiedName": "AdminPostSalesChannelsSalesChannelReq" + }, + "name": "AdminPostSalesChannelsSalesChannelReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2836, + 2832, + 2817, + 2828, + 2824, + 2845, + 2771, + 2787, + 2820 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2771, + 2787 + ] + }, + { + "title": "Mutations", + "children": [ + 2817, + 2820, + 2824, + 2828, + 2832, + 2836, + 2845 + ] + } + ] + }, + { + "id": 38, + "name": "Shipping Options", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Shipping Option API Routes](https://docs.medusajs.com/api/admin#shipping-options).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA shipping option is used to define the available shipping methods during checkout or when creating a return.\nAdmins can create an unlimited number of shipping options, each associated with a shipping profile and fulfillment provider, among other resources.\n\nRelated Guide: [Shipping Option architecture](https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2901, + "name": "useAdminCreateShippingOption", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2902, + "name": "useAdminCreateShippingOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a shipping option." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateShippingOption } from \"medusa-react\"\n\ntype CreateShippingOption = {\n name: string\n provider_id: string\n data: Record\n price_type: string\n amount: number\n}\n\ntype Props = {\n regionId: string\n}\n\nconst Region = ({ regionId }: Props) => {\n const createShippingOption = useAdminCreateShippingOption()\n // ...\n\n const handleCreate = (\n data: CreateShippingOption\n ) => {\n createShippingOption.mutate({\n ...data,\n region_id: regionId\n }, {\n onSuccess: ({ shipping_option }) => {\n console.log(shipping_option.id)\n }\n })\n }\n\n // ...\n}\n\nexport default Region\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2903, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "AdminShippingOptionsRes" + }, + "name": "AdminShippingOptionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts", + "qualifiedName": "AdminPostShippingOptionsReq" + }, + "name": "AdminPostShippingOptionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "AdminShippingOptionsRes" + }, + "name": "AdminShippingOptionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts", + "qualifiedName": "AdminPostShippingOptionsReq" + }, + "name": "AdminPostShippingOptionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2908, + "name": "useAdminDeleteShippingOption", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2909, + "name": "useAdminDeleteShippingOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a shipping option. Once deleted, it can't be used when creating orders or returns." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteShippingOption } from \"medusa-react\"\n\ntype Props = {\n shippingOptionId: string\n}\n\nconst ShippingOption = ({ shippingOptionId }: Props) => {\n const deleteShippingOption = useAdminDeleteShippingOption(\n shippingOptionId\n )\n // ...\n\n const handleDelete = () => {\n deleteShippingOption.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default ShippingOption\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2910, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping option's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2911, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "unknown" + }, + { + "type": "intrinsic", + "name": "unknown" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "intrinsic", + "name": "unknown" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2885, + "name": "useAdminShippingOption", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2886, + "name": "useAdminShippingOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a shipping option's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminShippingOption } from \"medusa-react\"\n\ntype Props = {\n shippingOptionId: string\n}\n\nconst ShippingOption = ({ shippingOptionId }: Props) => {\n const {\n shipping_option, \n isLoading\n } = useAdminShippingOption(\n shippingOptionId\n )\n\n return (\n
\n {isLoading && Loading...}\n {shipping_option && {shipping_option.name}}\n
\n )\n}\n\nexport default ShippingOption\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2887, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping option's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2888, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "AdminShippingOptionsRes" + }, + "name": "AdminShippingOptionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_shipping_options" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2889, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2891, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2890, + "name": "shipping_option", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-option.d.ts", + "qualifiedName": "ShippingOption" + }, + "name": "ShippingOption", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2891, + 2890 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2892, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2894, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2893, + "name": "shipping_option", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-option.d.ts", + "qualifiedName": "ShippingOption" + }, + "name": "ShippingOption", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2894, + 2893 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2895, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2897, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2896, + "name": "shipping_option", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-option.d.ts", + "qualifiedName": "ShippingOption" + }, + "name": "ShippingOption", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2897, + 2896 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2898, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2900, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2899, + "name": "shipping_option", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-option.d.ts", + "qualifiedName": "ShippingOption" + }, + "name": "ShippingOption", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2900, + 2899 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2855, + "name": "useAdminShippingOptions", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2856, + "name": "useAdminShippingOptions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of shipping options. The shipping options can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`region_id`" + }, + { + "kind": "text", + "text": " \nor " + }, + { + "kind": "code", + "text": "`is_return`" + }, + { + "kind": "text", + "text": " passed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminShippingOptions } from \"medusa-react\"\n\nconst ShippingOptions = () => {\n const {\n shipping_options, \n isLoading\n } = useAdminShippingOptions()\n\n return (\n
\n {isLoading && Loading...}\n {shipping_options && !shipping_options.length && (\n No Shipping Options\n )}\n {shipping_options && shipping_options.length > 0 && (\n
    \n {shipping_options.map((option) => (\n
  • {option.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default ShippingOptions\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2857, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on the retrieved shipping options." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts", + "qualifiedName": "AdminGetShippingOptionsParams" + }, + "name": "AdminGetShippingOptionsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2858, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "AdminShippingOptionsListRes" + }, + "name": "AdminShippingOptionsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_shipping_options" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2859, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2860, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2860 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2861, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2864, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2862, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2863, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2866, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2865, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-option.d.ts", + "qualifiedName": "ShippingOption" + }, + "name": "ShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2864, + 2862, + 2863, + 2866, + 2865 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2867, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2870, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2868, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2869, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2872, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2871, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-option.d.ts", + "qualifiedName": "ShippingOption" + }, + "name": "ShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2870, + 2868, + 2869, + 2872, + 2871 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2873, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2876, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2874, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2875, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2878, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2877, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-option.d.ts", + "qualifiedName": "ShippingOption" + }, + "name": "ShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2876, + 2874, + 2875, + 2878, + 2877 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2879, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2882, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2880, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2881, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2884, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2883, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-option.d.ts", + "qualifiedName": "ShippingOption" + }, + "name": "ShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2882, + 2880, + 2881, + 2884, + 2883 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2904, + "name": "useAdminUpdateShippingOption", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2905, + "name": "useAdminUpdateShippingOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a shipping option's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateShippingOption } from \"medusa-react\"\n\ntype Props = {\n shippingOptionId: string\n}\n\nconst ShippingOption = ({ shippingOptionId }: Props) => {\n const updateShippingOption = useAdminUpdateShippingOption(\n shippingOptionId\n )\n // ...\n\n const handleUpdate = (\n name: string,\n requirements: {\n id: string,\n type: string,\n amount: number\n }[]\n ) => {\n updateShippingOption.mutate({\n name,\n requirements\n }, {\n onSuccess: ({ shipping_option }) => {\n console.log(shipping_option.requirements)\n }\n })\n }\n\n // ...\n}\n\nexport default ShippingOption\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2906, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping option's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2907, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "AdminShippingOptionsRes" + }, + "name": "AdminShippingOptionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts", + "qualifiedName": "AdminPostShippingOptionsOptionReq" + }, + "name": "AdminPostShippingOptionsOptionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "AdminShippingOptionsRes" + }, + "name": "AdminShippingOptionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts", + "qualifiedName": "AdminPostShippingOptionsOptionReq" + }, + "name": "AdminPostShippingOptionsOptionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2901, + 2908, + 2885, + 2855, + 2904 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2855, + 2885 + ] + }, + { + "title": "Mutations", + "children": [ + 2901, + 2904, + 2908 + ] + } + ] + }, + { + "id": 39, + "name": "Shipping Profiles", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Shipping Profile API Routes](https://docs.medusajs.com/api/admin#shipping-profiles).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA shipping profile is used to group products that can be shipped in the same manner.\nThey are created by the admin and they're not associated with a fulfillment provider.\n\nRelated Guide: [Shipping Profile architecture](https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-profile)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2944, + "name": "useAdminCreateShippingProfile", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2945, + "name": "useAdminCreateShippingProfile", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a shipping profile." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { ShippingProfileType } from \"@medusajs/medusa\"\nimport { useAdminCreateShippingProfile } from \"medusa-react\"\n\nconst CreateShippingProfile = () => {\n const createShippingProfile = useAdminCreateShippingProfile()\n // ...\n\n const handleCreate = (\n name: string,\n type: ShippingProfileType\n ) => {\n createShippingProfile.mutate({\n name,\n type\n }, {\n onSuccess: ({ shipping_profile }) => {\n console.log(shipping_profile.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateShippingProfile\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2946, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "AdminShippingProfilesRes" + }, + "name": "AdminShippingProfilesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/create-shipping-profile.d.ts", + "qualifiedName": "AdminPostShippingProfilesReq" + }, + "name": "AdminPostShippingProfilesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "AdminShippingProfilesRes" + }, + "name": "AdminShippingProfilesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/create-shipping-profile.d.ts", + "qualifiedName": "AdminPostShippingProfilesReq" + }, + "name": "AdminPostShippingProfilesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2951, + "name": "useAdminDeleteShippingProfile", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2952, + "name": "useAdminDeleteShippingProfile", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a shipping profile. Associated shipping options are deleted as well." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteShippingProfile } from \"medusa-react\"\n\ntype Props = {\n shippingProfileId: string\n}\n\nconst ShippingProfile = ({ shippingProfileId }: Props) => {\n const deleteShippingProfile = useAdminDeleteShippingProfile(\n shippingProfileId\n )\n // ...\n\n const handleDelete = () => {\n deleteShippingProfile.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default ShippingProfile\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2953, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping profile's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2954, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2928, + "name": "useAdminShippingProfile", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2929, + "name": "useAdminShippingProfile", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a shipping profile's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminShippingProfile } from \"medusa-react\"\n\ntype Props = {\n shippingProfileId: string\n}\n\nconst ShippingProfile = ({ shippingProfileId }: Props) => {\n const { \n shipping_profile, \n isLoading\n } = useAdminShippingProfile(\n shippingProfileId\n )\n\n return (\n
\n {isLoading && Loading...}\n {shipping_profile && (\n {shipping_profile.name}\n )}\n
\n )\n}\n\nexport default ShippingProfile\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2930, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping option's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2931, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "AdminShippingProfilesRes" + }, + "name": "AdminShippingProfilesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_shippingProfiles" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2932, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2934, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2933, + "name": "shipping_profile", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-profile.d.ts", + "qualifiedName": "ShippingProfile" + }, + "name": "ShippingProfile", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2934, + 2933 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2935, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2937, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2936, + "name": "shipping_profile", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-profile.d.ts", + "qualifiedName": "ShippingProfile" + }, + "name": "ShippingProfile", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2937, + 2936 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2938, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2940, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2939, + "name": "shipping_profile", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-profile.d.ts", + "qualifiedName": "ShippingProfile" + }, + "name": "ShippingProfile", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2940, + 2939 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2941, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2943, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2942, + "name": "shipping_profile", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-profile.d.ts", + "qualifiedName": "ShippingProfile" + }, + "name": "ShippingProfile", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2943, + 2942 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2913, + "name": "useAdminShippingProfiles", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2914, + "name": "useAdminShippingProfiles", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of shipping profiles." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminShippingProfiles } from \"medusa-react\"\n\nconst ShippingProfiles = () => {\n const { \n shipping_profiles, \n isLoading\n } = useAdminShippingProfiles()\n\n return (\n
\n {isLoading && Loading...}\n {shipping_profiles && !shipping_profiles.length && (\n No Shipping Profiles\n )}\n {shipping_profiles && shipping_profiles.length > 0 && (\n
    \n {shipping_profiles.map((profile) => (\n
  • {profile.name}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default ShippingProfiles\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2915, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "AdminShippingProfilesListRes" + }, + "name": "AdminShippingProfilesListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_shippingProfiles" + }, + { + "type": "literal", + "value": "list" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2916, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2918, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2917, + "name": "shipping_profiles", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-profile.d.ts", + "qualifiedName": "ShippingProfile" + }, + "name": "ShippingProfile", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2918, + 2917 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2919, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2921, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2920, + "name": "shipping_profiles", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-profile.d.ts", + "qualifiedName": "ShippingProfile" + }, + "name": "ShippingProfile", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2921, + 2920 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2922, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2924, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2923, + "name": "shipping_profiles", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-profile.d.ts", + "qualifiedName": "ShippingProfile" + }, + "name": "ShippingProfile", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2924, + 2923 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2925, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2927, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2926, + "name": "shipping_profiles", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/shipping-profile.d.ts", + "qualifiedName": "ShippingProfile" + }, + "name": "ShippingProfile", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2927, + 2926 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2947, + "name": "useAdminUpdateShippingProfile", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2948, + "name": "useAdminUpdateShippingProfile", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a shipping profile's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { ShippingProfileType } from \"@medusajs/medusa\"\nimport { useAdminUpdateShippingProfile } from \"medusa-react\"\n\ntype Props = {\n shippingProfileId: string\n}\n\nconst ShippingProfile = ({ shippingProfileId }: Props) => {\n const updateShippingProfile = useAdminUpdateShippingProfile(\n shippingProfileId\n )\n // ...\n\n const handleUpdate = (\n name: string,\n type: ShippingProfileType\n ) => {\n updateShippingProfile.mutate({\n name,\n type\n }, {\n onSuccess: ({ shipping_profile }) => {\n console.log(shipping_profile.name)\n }\n })\n }\n\n // ...\n}\n\nexport default ShippingProfile\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2949, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping profile's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2950, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "AdminShippingProfilesRes" + }, + "name": "AdminShippingProfilesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts", + "qualifiedName": "AdminPostShippingProfilesProfileReq" + }, + "name": "AdminPostShippingProfilesProfileReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "AdminShippingProfilesRes" + }, + "name": "AdminShippingProfilesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts", + "qualifiedName": "AdminPostShippingProfilesProfileReq" + }, + "name": "AdminPostShippingProfilesProfileReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 2944, + 2951, + 2928, + 2913, + 2947 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2913, + 2928 + ] + }, + { + "title": "Mutations", + "children": [ + 2944, + 2947, + 2951 + ] + } + ] + }, + { + "id": 40, + "name": "Stock Locations", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Stock Location API Routes](https://docs.medusajs.com/api/admin#stock-locations).\nTo use these hooks, make sure to install the\n[@medusajs/stock-location](https://docs.medusajs.com/modules/multiwarehouse/install-modules#stock-location-module) module in your Medusa backend.\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA stock location, provided by the [Stock Location module](https://docs.medusajs.com/modules/multiwarehouse/stock-location-module), \nindicates a physical address that stock-kept items, such as physical products, can be stored in.\nAn admin can create and manage available stock locations.\n\nRelated Guide: [How to manage stock locations](https://docs.medusajs.com/modules/multiwarehouse/admin/manage-stock-locations)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 3002, + "name": "useAdminCreateStockLocation", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3003, + "name": "useAdminCreateStockLocation", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a stock location." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateStockLocation } from \"medusa-react\"\n\nconst CreateStockLocation = () => {\n const createStockLocation = useAdminCreateStockLocation()\n // ...\n\n const handleCreate = (name: string) => {\n createStockLocation.mutate({\n name,\n }, {\n onSuccess: ({ stock_location }) => {\n console.log(stock_location.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateStockLocation\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3004, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "AdminStockLocationsRes" + }, + "name": "AdminStockLocationsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts", + "qualifiedName": "AdminPostStockLocationsReq" + }, + "name": "AdminPostStockLocationsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "AdminStockLocationsRes" + }, + "name": "AdminStockLocationsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts", + "qualifiedName": "AdminPostStockLocationsReq" + }, + "name": "AdminPostStockLocationsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3009, + "name": "useAdminDeleteStockLocation", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3010, + "name": "useAdminDeleteStockLocation", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a stock location." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteStockLocation } from \"medusa-react\"\n\ntype Props = {\n stockLocationId: string\n}\n\nconst StockLocation = ({ stockLocationId }: Props) => {\n const deleteLocation = useAdminDeleteStockLocation(\n stockLocationId\n )\n // ...\n\n const handleDelete = () => {\n deleteLocation.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n}\n\nexport default StockLocation\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3011, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The stock location's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3012, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 2986, + "name": "useAdminStockLocation", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2987, + "name": "useAdminStockLocation", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a stock location's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminStockLocation } from \"medusa-react\"\n\ntype Props = {\n stockLocationId: string\n}\n\nconst StockLocation = ({ stockLocationId }: Props) => {\n const { \n stock_location,\n isLoading\n } = useAdminStockLocation(stockLocationId)\n\n return (\n
\n {isLoading && Loading...}\n {stock_location && (\n {stock_location.name}\n )}\n
\n )\n}\n\nexport default StockLocation\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2988, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The stock location's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2989, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "AdminStockLocationsRes" + }, + "name": "AdminStockLocationsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_stock_locations" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2990, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2992, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2991, + "name": "stock_location", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/stock-location/common.d.ts", + "qualifiedName": "StockLocationExpandedDTO" + }, + "name": "StockLocationExpandedDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2992, + 2991 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2993, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2995, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2994, + "name": "stock_location", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/stock-location/common.d.ts", + "qualifiedName": "StockLocationExpandedDTO" + }, + "name": "StockLocationExpandedDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2995, + 2994 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2996, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2998, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2997, + "name": "stock_location", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/stock-location/common.d.ts", + "qualifiedName": "StockLocationExpandedDTO" + }, + "name": "StockLocationExpandedDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2998, + 2997 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2999, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3001, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3000, + "name": "stock_location", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/stock-location/common.d.ts", + "qualifiedName": "StockLocationExpandedDTO" + }, + "name": "StockLocationExpandedDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3001, + 3000 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 2956, + "name": "useAdminStockLocations", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2957, + "name": "useAdminStockLocations", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of stock locations. The stock locations can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`name`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " passed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter.\nThe stock locations can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list stock locations:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminStockLocations } from \"medusa-react\"\n\nfunction StockLocations() {\n const { \n stock_locations,\n isLoading\n } = useAdminStockLocations()\n\n return (\n
\n {isLoading && Loading...}\n {stock_locations && !stock_locations.length && (\n No Locations\n )}\n {stock_locations && stock_locations.length > 0 && (\n
    \n {stock_locations.map(\n (location) => (\n
  • {location.name}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default StockLocations\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the stock locations:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminStockLocations } from \"medusa-react\"\n\nfunction StockLocations() {\n const { \n stock_locations,\n isLoading\n } = useAdminStockLocations({\n expand: \"address\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {stock_locations && !stock_locations.length && (\n No Locations\n )}\n {stock_locations && stock_locations.length > 0 && (\n
    \n {stock_locations.map(\n (location) => (\n
  • {location.name}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default StockLocations\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`20`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminStockLocations } from \"medusa-react\"\n\nfunction StockLocations() {\n const { \n stock_locations,\n limit,\n offset,\n isLoading\n } = useAdminStockLocations({\n expand: \"address\",\n limit: 10,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {stock_locations && !stock_locations.length && (\n No Locations\n )}\n {stock_locations && stock_locations.length > 0 && (\n
    \n {stock_locations.map(\n (location) => (\n
  • {location.name}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default StockLocations\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2958, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved stock locations." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/list-stock-locations.d.ts", + "qualifiedName": "AdminGetStockLocationsParams" + }, + "name": "AdminGetStockLocationsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 2959, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "AdminStockLocationsListRes" + }, + "name": "AdminStockLocationsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_stock_locations" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2960, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2961, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2961 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2962, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2965, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2963, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2964, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2967, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2966, + "name": "stock_locations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/stock-location/common.d.ts", + "qualifiedName": "StockLocationExpandedDTO" + }, + "name": "StockLocationExpandedDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2965, + 2963, + 2964, + 2967, + 2966 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2968, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2971, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2969, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2970, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2973, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2972, + "name": "stock_locations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/stock-location/common.d.ts", + "qualifiedName": "StockLocationExpandedDTO" + }, + "name": "StockLocationExpandedDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2971, + 2969, + 2970, + 2973, + 2972 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2974, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2977, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2975, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2976, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2979, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2978, + "name": "stock_locations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/stock-location/common.d.ts", + "qualifiedName": "StockLocationExpandedDTO" + }, + "name": "StockLocationExpandedDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2977, + 2975, + 2976, + 2979, + 2978 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2980, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2983, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2981, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2982, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2985, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 2984, + "name": "stock_locations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/stock-location/common.d.ts", + "qualifiedName": "StockLocationExpandedDTO" + }, + "name": "StockLocationExpandedDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2983, + 2981, + 2982, + 2985, + 2984 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 3005, + "name": "useAdminUpdateStockLocation", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3006, + "name": "useAdminUpdateStockLocation", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a stock location's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateStockLocation } from \"medusa-react\"\n\ntype Props = {\n stockLocationId: string\n}\n\nconst StockLocation = ({ stockLocationId }: Props) => {\n const updateLocation = useAdminUpdateStockLocation(\n stockLocationId\n )\n // ...\n\n const handleUpdate = (\n name: string\n ) => {\n updateLocation.mutate({\n name\n }, {\n onSuccess: ({ stock_location }) => {\n console.log(stock_location.name)\n }\n })\n }\n}\n\nexport default StockLocation\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3007, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The stock location's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3008, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "AdminStockLocationsRes" + }, + "name": "AdminStockLocationsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts", + "qualifiedName": "AdminPostStockLocationsLocationReq" + }, + "name": "AdminPostStockLocationsLocationReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "AdminStockLocationsRes" + }, + "name": "AdminStockLocationsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts", + "qualifiedName": "AdminPostStockLocationsLocationReq" + }, + "name": "AdminPostStockLocationsLocationReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 3002, + 3009, + 2986, + 2956, + 3005 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 2956, + 2986 + ] + }, + { + "title": "Mutations", + "children": [ + 3002, + 3005, + 3009 + ] + } + ] + }, + { + "id": 41, + "name": "Stores", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Store API Routes](https://docs.medusajs.com/api/admin#store).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA store indicates the general configurations and details about the commerce store. By default, there's only one store in the Medusa backend.\nAdmins can manage the store and its details or configurations." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 3062, + "name": "useAdminAddStoreCurrency", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3063, + "name": "useAdminAddStoreCurrency", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a currency code to the available currencies in a store. This doesn't create new currencies, as currencies are defined within the Medusa backend. \nTo create a currency, you can [create a migration](https://docs.medusajs.com/development/entities/migrations/create) that inserts the currency into the database." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The code of the currency to add to the store." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminAddStoreCurrency } from \"medusa-react\"\n\nconst Store = () => {\n const addCurrency = useAdminAddStoreCurrency()\n // ...\n\n const handleAdd = (code: string) => {\n addCurrency.mutate(code, {\n onSuccess: ({ store }) => {\n console.log(store.currencies)\n }\n })\n }\n\n // ...\n}\n\nexport default Store\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3064, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "AdminStoresRes" + }, + "name": "AdminStoresRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "AdminStoresRes" + }, + "name": "AdminStoresRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3065, + "name": "useAdminDeleteStoreCurrency", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3066, + "name": "useAdminDeleteStoreCurrency", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a currency code from the available currencies in a store. This doesn't completely \ndelete the currency and it can be added again later to the store." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The code of the currency to remove from the store." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteStoreCurrency } from \"medusa-react\"\n\nconst Store = () => {\n const deleteCurrency = useAdminDeleteStoreCurrency()\n // ...\n\n const handleAdd = (code: string) => {\n deleteCurrency.mutate(code, {\n onSuccess: ({ store }) => {\n console.log(store.currencies)\n }\n })\n }\n\n // ...\n}\n\nexport default Store\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3067, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "AdminStoresRes" + }, + "name": "AdminStoresRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "AdminStoresRes" + }, + "name": "AdminStoresRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3044, + "name": "useAdminStore", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3045, + "name": "useAdminStore", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves the store's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminStore } from \"medusa-react\"\n\nconst Store = () => {\n const { \n store,\n isLoading\n } = useAdminStore()\n\n return (\n
\n {isLoading && Loading...}\n {store && {store.name}}\n
\n )\n}\n\nexport default Store\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3046, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "AdminExtendedStoresRes" + }, + "name": "AdminExtendedStoresRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_store" + }, + { + "type": "literal", + "value": "detail" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 3047, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3049, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3048, + "name": "store", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/store.d.ts", + "qualifiedName": "ExtendedStoreDTO" + }, + "name": "ExtendedStoreDTO", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3049, + 3048 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3050, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3052, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3051, + "name": "store", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/store.d.ts", + "qualifiedName": "ExtendedStoreDTO" + }, + "name": "ExtendedStoreDTO", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3052, + 3051 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3053, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3055, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3054, + "name": "store", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/store.d.ts", + "qualifiedName": "ExtendedStoreDTO" + }, + "name": "ExtendedStoreDTO", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3055, + 3054 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3056, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3058, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3057, + "name": "store", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/store.d.ts", + "qualifiedName": "ExtendedStoreDTO" + }, + "name": "ExtendedStoreDTO", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3058, + 3057 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 3014, + "name": "useAdminStorePaymentProviders", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3015, + "name": "useAdminStorePaymentProviders", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of available payment providers in a store." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminStorePaymentProviders } from \"medusa-react\"\n\nconst PaymentProviders = () => {\n const { \n payment_providers,\n isLoading\n } = useAdminStorePaymentProviders()\n\n return (\n
\n {isLoading && Loading...}\n {payment_providers && !payment_providers.length && (\n No Payment Providers\n )}\n {payment_providers && \n payment_providers.length > 0 &&(\n
    \n {payment_providers.map((provider) => (\n
  • {provider.id}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default PaymentProviders\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3016, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "AdminPaymentProvidersList" + }, + "name": "AdminPaymentProvidersList", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_store" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 3017, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3018, + "name": "payment_providers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment-provider.d.ts", + "qualifiedName": "PaymentProvider" + }, + "name": "PaymentProvider", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3019, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3018, + 3019 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3020, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3021, + "name": "payment_providers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment-provider.d.ts", + "qualifiedName": "PaymentProvider" + }, + "name": "PaymentProvider", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3022, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3021, + 3022 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3023, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3024, + "name": "payment_providers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment-provider.d.ts", + "qualifiedName": "PaymentProvider" + }, + "name": "PaymentProvider", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3025, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3024, + 3025 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3026, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3027, + "name": "payment_providers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment-provider.d.ts", + "qualifiedName": "PaymentProvider" + }, + "name": "PaymentProvider", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3028, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3027, + 3028 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 3029, + "name": "useAdminStoreTaxProviders", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3030, + "name": "useAdminStoreTaxProviders", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of available tax providers in a store." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminStoreTaxProviders } from \"medusa-react\"\n\nconst TaxProviders = () => {\n const { \n tax_providers,\n isLoading\n } = useAdminStoreTaxProviders()\n\n return (\n
\n {isLoading && Loading...}\n {tax_providers && !tax_providers.length && (\n No Tax Providers\n )}\n {tax_providers && \n tax_providers.length > 0 &&(\n
    \n {tax_providers.map((provider) => (\n
  • {provider.id}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default TaxProviders\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3031, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "AdminTaxProvidersList" + }, + "name": "AdminTaxProvidersList", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_store" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 3032, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3034, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3033, + "name": "tax_providers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/tax-provider.d.ts", + "qualifiedName": "TaxProvider" + }, + "name": "TaxProvider", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3034, + 3033 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3035, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3037, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3036, + "name": "tax_providers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/tax-provider.d.ts", + "qualifiedName": "TaxProvider" + }, + "name": "TaxProvider", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3037, + 3036 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3038, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3040, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3039, + "name": "tax_providers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/tax-provider.d.ts", + "qualifiedName": "TaxProvider" + }, + "name": "TaxProvider", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3040, + 3039 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3041, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3043, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3042, + "name": "tax_providers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/tax-provider.d.ts", + "qualifiedName": "TaxProvider" + }, + "name": "TaxProvider", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3043, + 3042 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 3059, + "name": "useAdminUpdateStore", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3060, + "name": "useAdminUpdateStore", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates the store's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateStore } from \"medusa-react\"\n\nfunction Store() {\n const updateStore = useAdminUpdateStore()\n // ...\n\n const handleUpdate = (\n name: string\n ) => {\n updateStore.mutate({\n name\n }, {\n onSuccess: ({ store }) => {\n console.log(store.name)\n }\n })\n }\n}\n\nexport default Store\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3061, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "AdminStoresRes" + }, + "name": "AdminStoresRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/update-store.d.ts", + "qualifiedName": "AdminPostStoreReq" + }, + "name": "AdminPostStoreReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "AdminStoresRes" + }, + "name": "AdminStoresRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/update-store.d.ts", + "qualifiedName": "AdminPostStoreReq" + }, + "name": "AdminPostStoreReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 3062, + 3065, + 3044, + 3014, + 3029, + 3059 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 3014, + 3029, + 3044 + ] + }, + { + "title": "Mutations", + "children": [ + 3059, + 3062, + 3065 + ] + } + ] + }, + { + "id": 42, + "name": "Swaps", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Swap API Routes](https://docs.medusajs.com/api/admin#swaps).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA swap is created by a customer or an admin to exchange an item with a new one.\nCreating a swap implicitely includes creating a return for the item being exchanged.\n\nRelated Guide: [How to manage swaps](https://docs.medusajs.com/modules/orders/admin/manage-swaps)" + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 3119, + "name": "useAdminCancelSwap", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3120, + "name": "useAdminCancelSwap", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook cancels a swap and change its status." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The swap's ID." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCancelSwap } from \"medusa-react\"\n\ntype Props = {\n orderId: string,\n swapId: string\n}\n\nconst Swap = ({\n orderId,\n swapId\n}: Props) => {\n const cancelSwap = useAdminCancelSwap(\n orderId\n )\n // ...\n\n const handleCancel = () => {\n cancelSwap.mutate(swapId, {\n onSuccess: ({ order }) => {\n console.log(order.swaps)\n }\n })\n }\n\n // ...\n}\n\nexport default Swap\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3121, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3122, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3145, + "name": "useAdminCancelSwapFulfillment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3146, + "name": "useAdminCancelSwapFulfillment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook cancels a swap's fulfillment and change its fulfillment status to " + }, + { + "kind": "code", + "text": "`canceled`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCancelSwapFulfillment } from \"medusa-react\"\n\ntype Props = {\n orderId: string,\n swapId: string\n}\n\nconst Swap = ({\n orderId,\n swapId\n}: Props) => {\n const cancelFulfillment = useAdminCancelSwapFulfillment(\n orderId\n )\n // ...\n\n const handleCancelFulfillment = (\n fulfillmentId: string\n ) => {\n cancelFulfillment.mutate({\n swap_id: swapId,\n fulfillment_id: fulfillmentId,\n })\n }\n\n // ...\n}\n\nexport default Swap\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3147, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3148, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 3149, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3151, + "name": "fulfillment_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3150, + "name": "swap_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3151, + 3150 + ] + } + ] + } + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 3152, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3154, + "name": "fulfillment_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3153, + "name": "swap_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3154, + 3153 + ] + } + ] + } + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3115, + "name": "useAdminCreateSwap", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3116, + "name": "useAdminCreateSwap", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a swap for an order. This includes creating a return that is associated with the swap." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateSwap } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst CreateSwap = ({ orderId }: Props) => {\n const createSwap = useAdminCreateSwap(orderId)\n // ...\n\n const handleCreate = (\n returnItems: {\n item_id: string,\n quantity: number\n }[]\n ) => {\n createSwap.mutate({\n return_items: returnItems\n }, {\n onSuccess: ({ order }) => {\n console.log(order.swaps)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateSwap\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3117, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3118, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts", + "qualifiedName": "AdminPostOrdersOrderSwapsReq" + }, + "name": "AdminPostOrdersOrderSwapsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts", + "qualifiedName": "AdminPostOrdersOrderSwapsReq" + }, + "name": "AdminPostOrdersOrderSwapsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3133, + "name": "useAdminCreateSwapShipment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3134, + "name": "useAdminCreateSwapShipment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a shipment for a swap and mark its fulfillment as shipped. This changes the swap's fulfillment status\nto either " + }, + { + "kind": "code", + "text": "`shipped`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`partially_shipped`" + }, + { + "kind": "text", + "text": ", depending on whether all the items were shipped." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateSwapShipment } from \"medusa-react\"\n\ntype Props = {\n orderId: string,\n swapId: string\n}\n\nconst Swap = ({\n orderId,\n swapId\n}: Props) => {\n const createShipment = useAdminCreateSwapShipment(\n orderId\n )\n // ...\n\n const handleCreateShipment = (\n fulfillmentId: string\n ) => {\n createShipment.mutate({\n swap_id: swapId,\n fulfillment_id: fulfillmentId,\n }, {\n onSuccess: ({ order }) => {\n console.log(order.swaps)\n }\n })\n }\n\n // ...\n}\n\nexport default Swap\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3135, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3136, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 3130, + "name": "AdminCreateSwapShipmentReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 3130, + "name": "AdminCreateSwapShipmentReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3126, + "name": "useAdminFulfillSwap", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3127, + "name": "useAdminFulfillSwap", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a Fulfillment for a Swap and change its fulfillment status to " + }, + { + "kind": "code", + "text": "`fulfilled`" + }, + { + "kind": "text", + "text": ". If it requires any additional actions,\nits fulfillment status may change to " + }, + { + "kind": "code", + "text": "`requires_action`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminFulfillSwap } from \"medusa-react\"\n\ntype Props = {\n orderId: string,\n swapId: string\n}\n\nconst Swap = ({\n orderId,\n swapId\n}: Props) => {\n const fulfillSwap = useAdminFulfillSwap(\n orderId\n )\n // ...\n\n const handleFulfill = () => {\n fulfillSwap.mutate({\n swap_id: swapId,\n }, {\n onSuccess: ({ order }) => {\n console.log(order.swaps)\n }\n })\n }\n\n // ...\n}\n\nexport default Swap\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3128, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3129, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 3123, + "name": "AdminFulfillSwapReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 3123, + "name": "AdminFulfillSwapReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3137, + "name": "useAdminProcessSwapPayment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3138, + "name": "useAdminProcessSwapPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook process a swap's payment either by refunding or issuing a payment. This depends on the " + }, + { + "kind": "code", + "text": "`difference_due`" + }, + { + "kind": "text", + "text": " \nof the swap. If " + }, + { + "kind": "code", + "text": "`difference_due`" + }, + { + "kind": "text", + "text": " is negative, the amount is refunded. If " + }, + { + "kind": "code", + "text": "`difference_due`" + }, + { + "kind": "text", + "text": " is positive, the amount is captured." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The swap's ID." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminProcessSwapPayment } from \"medusa-react\"\n\ntype Props = {\n orderId: string,\n swapId: string\n}\n\nconst Swap = ({\n orderId,\n swapId\n}: Props) => {\n const processPayment = useAdminProcessSwapPayment(\n orderId\n )\n // ...\n\n const handleProcessPayment = () => {\n processPayment.mutate(swapId, {\n onSuccess: ({ order }) => {\n console.log(order.swaps)\n }\n })\n }\n\n // ...\n}\n\nexport default Swap\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3139, + "name": "orderId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3140, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "AdminOrdersRes" + }, + "name": "AdminOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3099, + "name": "useAdminSwap", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3100, + "name": "useAdminSwap", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a swap's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminSwap } from \"medusa-react\"\n\ntype Props = {\n swapId: string\n}\n\nconst Swap = ({ swapId }: Props) => {\n const { swap, isLoading } = useAdminSwap(swapId)\n\n return (\n
\n {isLoading && Loading...}\n {swap && {swap.id}}\n
\n )\n}\n\nexport default Swap\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3101, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The swap's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3102, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/swaps/index.d.ts", + "qualifiedName": "AdminSwapsRes" + }, + "name": "AdminSwapsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_swaps" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 3103, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3105, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3104, + "name": "swap", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/swap.d.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3105, + 3104 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3106, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3108, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3107, + "name": "swap", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/swap.d.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3108, + 3107 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3109, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3111, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3110, + "name": "swap", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/swap.d.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3111, + 3110 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3112, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3114, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3113, + "name": "swap", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/swap.d.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3114, + 3113 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 3069, + "name": "useAdminSwaps", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3070, + "name": "useAdminSwaps", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of swaps. The swaps can be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list swaps:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminSwaps } from \"medusa-react\"\n\nconst Swaps = () => {\n const { swaps, isLoading } = useAdminSwaps()\n\n return (\n
\n {isLoading && Loading...}\n {swaps && !swaps.length && No Swaps}\n {swaps && swaps.length > 0 && (\n
    \n {swaps.map((swap) => (\n
  • {swap.payment_status}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Swaps\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminSwaps } from \"medusa-react\"\n\nconst Swaps = () => {\n const { \n swaps, \n limit,\n offset,\n isLoading\n } = useAdminSwaps({\n limit: 10,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {swaps && !swaps.length && No Swaps}\n {swaps && swaps.length > 0 && (\n
    \n {swaps.map((swap) => (\n
  • {swap.payment_status}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Swaps\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3071, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Pagination configurations to apply on the retrieved swaps." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/swaps/list-swaps.d.ts", + "qualifiedName": "AdminGetSwapsParams" + }, + "name": "AdminGetSwapsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 3072, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/swaps/index.d.ts", + "qualifiedName": "AdminSwapsListRes" + }, + "name": "AdminSwapsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_swaps" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 3073, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3074, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3074 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 3075, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3078, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3076, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3077, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3080, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3079, + "name": "swaps", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/swap.d.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3078, + 3076, + 3077, + 3080, + 3079 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3081, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3084, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3082, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3083, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3086, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3085, + "name": "swaps", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/swap.d.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3084, + 3082, + 3083, + 3086, + 3085 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3087, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3090, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3088, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3089, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3092, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3091, + "name": "swaps", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/swap.d.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3090, + 3088, + 3089, + 3092, + 3091 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3093, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3096, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3094, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3095, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3098, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3097, + "name": "swaps", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/swap.d.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3096, + 3094, + 3095, + 3098, + 3097 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 3119, + 3145, + 3115, + 3133, + 3126, + 3137, + 3099, + 3069 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 3069, + 3099 + ] + }, + { + "title": "Mutations", + "children": [ + 3115, + 3119, + 3126, + 3133, + 3137, + 3145 + ] + } + ] + }, + { + "id": 43, + "name": "Tax Rates", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin Tax Rate API Routes](https://docs.medusajs.com/api/admin#tax-rates).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nEach region has at least a default tax rate. Admins can create and manage additional tax rates that can be applied for certain conditions, such as for specific product types.\n\nRelated Guide: [How to manage tax rates](https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 3214, + "name": "useAdminCreateProductTaxRates", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3215, + "name": "useAdminCreateProductTaxRates", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds products to a tax rate." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateProductTaxRates } from \"medusa-react\"\n\ntype Props = {\n taxRateId: string\n}\n\nconst TaxRate = ({ taxRateId }: Props) => {\n const addProduct = useAdminCreateProductTaxRates(taxRateId)\n // ...\n\n const handleAddProduct = (productIds: string[]) => {\n addProduct.mutate({\n products: productIds,\n }, {\n onSuccess: ({ tax_rate }) => {\n console.log(tax_rate.products)\n }\n })\n }\n\n // ...\n}\n\nexport default TaxRate\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3216, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3217, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/add-to-products.d.ts", + "qualifiedName": "AdminPostTaxRatesTaxRateProductsReq" + }, + "name": "AdminPostTaxRatesTaxRateProductsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/add-to-products.d.ts", + "qualifiedName": "AdminPostTaxRatesTaxRateProductsReq" + }, + "name": "AdminPostTaxRatesTaxRateProductsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3222, + "name": "useAdminCreateProductTypeTaxRates", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3223, + "name": "useAdminCreateProductTypeTaxRates", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds product types to a tax rate." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminCreateProductTypeTaxRates,\n} from \"medusa-react\"\n\ntype Props = {\n taxRateId: string\n}\n\nconst TaxRate = ({ taxRateId }: Props) => {\n const addProductTypes = useAdminCreateProductTypeTaxRates(\n taxRateId\n )\n // ...\n\n const handleAddProductTypes = (productTypeIds: string[]) => {\n addProductTypes.mutate({\n product_types: productTypeIds,\n }, {\n onSuccess: ({ tax_rate }) => {\n console.log(tax_rate.product_types)\n }\n })\n }\n\n // ...\n}\n\nexport default TaxRate\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3224, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3225, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/add-to-product-types.d.ts", + "qualifiedName": "AdminPostTaxRatesTaxRateProductTypesReq" + }, + "name": "AdminPostTaxRatesTaxRateProductTypesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/add-to-product-types.d.ts", + "qualifiedName": "AdminPostTaxRatesTaxRateProductTypesReq" + }, + "name": "AdminPostTaxRatesTaxRateProductTypesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3230, + "name": "useAdminCreateShippingTaxRates", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3231, + "name": "useAdminCreateShippingTaxRates", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds shipping options to a tax rate." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateShippingTaxRates } from \"medusa-react\"\n\ntype Props = {\n taxRateId: string\n}\n\nconst TaxRate = ({ taxRateId }: Props) => {\n const addShippingOption = useAdminCreateShippingTaxRates(\n taxRateId\n )\n // ...\n\n const handleAddShippingOptions = (\n shippingOptionIds: string[]\n ) => {\n addShippingOption.mutate({\n shipping_options: shippingOptionIds,\n }, {\n onSuccess: ({ tax_rate }) => {\n console.log(tax_rate.shipping_options)\n }\n })\n }\n\n // ...\n}\n\nexport default TaxRate\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3232, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3233, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/add-to-shipping-options.d.ts", + "qualifiedName": "AdminPostTaxRatesTaxRateShippingOptionsReq" + }, + "name": "AdminPostTaxRatesTaxRateShippingOptionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/add-to-shipping-options.d.ts", + "qualifiedName": "AdminPostTaxRatesTaxRateShippingOptionsReq" + }, + "name": "AdminPostTaxRatesTaxRateShippingOptionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3203, + "name": "useAdminCreateTaxRate", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3204, + "name": "useAdminCreateTaxRate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a tax rate." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateTaxRate } from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst CreateTaxRate = ({ regionId }: Props) => {\n const createTaxRate = useAdminCreateTaxRate()\n // ...\n\n const handleCreate = (\n code: string,\n name: string,\n rate: number\n ) => {\n createTaxRate.mutate({\n code,\n name,\n region_id: regionId,\n rate,\n }, {\n onSuccess: ({ tax_rate }) => {\n console.log(tax_rate.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateTaxRate\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3205, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts", + "qualifiedName": "AdminPostTaxRatesReq" + }, + "name": "AdminPostTaxRatesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts", + "qualifiedName": "AdminPostTaxRatesReq" + }, + "name": "AdminPostTaxRatesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3218, + "name": "useAdminDeleteProductTaxRates", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3219, + "name": "useAdminDeleteProductTaxRates", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook removes products from a tax rate. This only removes the association between the products and the tax rate. It does not delete the products." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteProductTaxRates } from \"medusa-react\"\n\ntype Props = {\n taxRateId: string\n}\n\nconst TaxRate = ({ taxRateId }: Props) => {\n const removeProduct = useAdminDeleteProductTaxRates(taxRateId)\n // ...\n\n const handleRemoveProduct = (productIds: string[]) => {\n removeProduct.mutate({\n products: productIds,\n }, {\n onSuccess: ({ tax_rate }) => {\n console.log(tax_rate.products)\n }\n })\n }\n\n // ...\n}\n\nexport default TaxRate\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3220, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3221, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts", + "qualifiedName": "AdminDeleteTaxRatesTaxRateProductsReq" + }, + "name": "AdminDeleteTaxRatesTaxRateProductsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts", + "qualifiedName": "AdminDeleteTaxRatesTaxRateProductsReq" + }, + "name": "AdminDeleteTaxRatesTaxRateProductsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3226, + "name": "useAdminDeleteProductTypeTaxRates", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3227, + "name": "useAdminDeleteProductTypeTaxRates", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook removes product types from a tax rate. This only removes the association between the \nproduct types and the tax rate. It does not delete the product types." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { \n useAdminDeleteProductTypeTaxRates,\n} from \"medusa-react\"\n\ntype Props = {\n taxRateId: string\n}\n\nconst TaxRate = ({ taxRateId }: Props) => {\n const removeProductTypes = useAdminDeleteProductTypeTaxRates(\n taxRateId\n )\n // ...\n\n const handleRemoveProductTypes = (\n productTypeIds: string[]\n ) => {\n removeProductTypes.mutate({\n product_types: productTypeIds,\n }, {\n onSuccess: ({ tax_rate }) => {\n console.log(tax_rate.product_types)\n }\n })\n }\n\n // ...\n}\n\nexport default TaxRate\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3228, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3229, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts", + "qualifiedName": "AdminDeleteTaxRatesTaxRateProductTypesReq" + }, + "name": "AdminDeleteTaxRatesTaxRateProductTypesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts", + "qualifiedName": "AdminDeleteTaxRatesTaxRateProductTypesReq" + }, + "name": "AdminDeleteTaxRatesTaxRateProductTypesReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3234, + "name": "useAdminDeleteShippingTaxRates", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3235, + "name": "useAdminDeleteShippingTaxRates", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook removes shipping options from a tax rate. This only removes the association between \nthe shipping options and the tax rate. It does not delete the shipping options." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteShippingTaxRates } from \"medusa-react\"\n\ntype Props = {\n taxRateId: string\n}\n\nconst TaxRate = ({ taxRateId }: Props) => {\n const removeShippingOptions = useAdminDeleteShippingTaxRates(\n taxRateId\n )\n // ...\n\n const handleRemoveShippingOptions = (\n shippingOptionIds: string[]\n ) => {\n removeShippingOptions.mutate({\n shipping_options: shippingOptionIds,\n }, {\n onSuccess: ({ tax_rate }) => {\n console.log(tax_rate.shipping_options)\n }\n })\n }\n\n // ...\n}\n\nexport default TaxRate\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3236, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3237, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts", + "qualifiedName": "AdminDeleteTaxRatesTaxRateShippingOptionsReq" + }, + "name": "AdminDeleteTaxRatesTaxRateShippingOptionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts", + "qualifiedName": "AdminDeleteTaxRatesTaxRateShippingOptionsReq" + }, + "name": "AdminDeleteTaxRatesTaxRateShippingOptionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3210, + "name": "useAdminDeleteTaxRate", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3211, + "name": "useAdminDeleteTaxRate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a tax rate. Resources associated with the tax rate, such as products or product types, are not deleted." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteTaxRate } from \"medusa-react\"\n\ntype Props = {\n taxRateId: string\n}\n\nconst TaxRate = ({ taxRateId }: Props) => {\n const deleteTaxRate = useAdminDeleteTaxRate(taxRateId)\n // ...\n\n const handleDelete = () => {\n deleteTaxRate.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default TaxRate\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3212, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3213, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3186, + "name": "useAdminTaxRate", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3187, + "name": "useAdminTaxRate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a tax rate's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "A simple example that retrieves a tax rate by its ID:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminTaxRate } from \"medusa-react\"\n\ntype Props = {\n taxRateId: string\n}\n\nconst TaxRate = ({ taxRateId }: Props) => {\n const { tax_rate, isLoading } = useAdminTaxRate(taxRateId)\n\n return (\n
\n {isLoading && Loading...}\n {tax_rate && {tax_rate.code}}\n
\n )\n}\n\nexport default TaxRate\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminTaxRate } from \"medusa-react\"\n\nconst TaxRate = (taxRateId: string) => {\n const { tax_rate, isLoading } = useAdminTaxRate(taxRateId, {\n expand: [\"shipping_options\"]\n })\n\n return (\n
\n {isLoading && Loading...}\n {tax_rate && {tax_rate.code}}\n
\n )\n}\n\nexport default TaxRate\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3188, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3189, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configurations to apply on retrieved tax rates." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts", + "qualifiedName": "AdminGetTaxRatesParams" + }, + "name": "AdminGetTaxRatesParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 3190, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_tax_rates" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 3191, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3193, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3192, + "name": "tax_rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/tax-rate.d.ts", + "qualifiedName": "TaxRate" + }, + "name": "TaxRate", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3193, + 3192 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3194, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3196, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3195, + "name": "tax_rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/tax-rate.d.ts", + "qualifiedName": "TaxRate" + }, + "name": "TaxRate", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3196, + 3195 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3197, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3199, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3198, + "name": "tax_rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/tax-rate.d.ts", + "qualifiedName": "TaxRate" + }, + "name": "TaxRate", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3199, + 3198 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3200, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3202, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3201, + "name": "tax_rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/tax-rate.d.ts", + "qualifiedName": "TaxRate" + }, + "name": "TaxRate", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3202, + 3201 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 3156, + "name": "useAdminTaxRates", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3157, + "name": "useAdminTaxRates", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of tax rates. The tax rates can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`name`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`rate`" + }, + { + "kind": "text", + "text": " \npassed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The tax rates can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list tax rates:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminTaxRates } from \"medusa-react\"\n\nconst TaxRates = () => {\n const { \n tax_rates, \n isLoading\n } = useAdminTaxRates()\n\n return (\n
\n {isLoading && Loading...}\n {tax_rates && !tax_rates.length && (\n No Tax Rates\n )}\n {tax_rates && tax_rates.length > 0 && (\n
    \n {tax_rates.map((tax_rate) => (\n
  • {tax_rate.code}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default TaxRates\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the tax rates:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminTaxRates } from \"medusa-react\"\n\nconst TaxRates = () => {\n const { \n tax_rates, \n isLoading\n } = useAdminTaxRates({\n expand: [\"shipping_options\"]\n })\n\n return (\n
\n {isLoading && Loading...}\n {tax_rates && !tax_rates.length && (\n No Tax Rates\n )}\n {tax_rates && tax_rates.length > 0 && (\n
    \n {tax_rates.map((tax_rate) => (\n
  • {tax_rate.code}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default TaxRates\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useAdminTaxRates } from \"medusa-react\"\n\nconst TaxRates = () => {\n const { \n tax_rates, \n limit,\n offset,\n isLoading\n } = useAdminTaxRates({\n expand: [\"shipping_options\"],\n limit: 10,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {tax_rates && !tax_rates.length && (\n No Tax Rates\n )}\n {tax_rates && tax_rates.length > 0 && (\n
    \n {tax_rates.map((tax_rate) => (\n
  • {tax_rate.code}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default TaxRates\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3158, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations applied to the retrieved tax rates." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts", + "qualifiedName": "AdminGetTaxRatesParams" + }, + "name": "AdminGetTaxRatesParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 3159, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesListRes" + }, + "name": "AdminTaxRatesListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_tax_rates" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 3160, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3161, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3161 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 3162, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3165, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3163, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3164, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3167, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3166, + "name": "tax_rates", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/tax-rate.d.ts", + "qualifiedName": "TaxRate" + }, + "name": "TaxRate", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3165, + 3163, + 3164, + 3167, + 3166 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3168, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3171, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3169, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3170, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3173, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3172, + "name": "tax_rates", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/tax-rate.d.ts", + "qualifiedName": "TaxRate" + }, + "name": "TaxRate", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3171, + 3169, + 3170, + 3173, + 3172 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3174, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3177, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3175, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3176, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3179, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3178, + "name": "tax_rates", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/tax-rate.d.ts", + "qualifiedName": "TaxRate" + }, + "name": "TaxRate", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3177, + 3175, + 3176, + 3179, + 3178 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3180, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3183, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3181, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3182, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3185, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3184, + "name": "tax_rates", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/tax-rate.d.ts", + "qualifiedName": "TaxRate" + }, + "name": "TaxRate", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3183, + 3181, + 3182, + 3185, + 3184 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 3206, + "name": "useAdminUpdateTaxRate", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3207, + "name": "useAdminUpdateTaxRate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a tax rate's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateTaxRate } from \"medusa-react\"\n\ntype Props = {\n taxRateId: string\n}\n\nconst TaxRate = ({ taxRateId }: Props) => {\n const updateTaxRate = useAdminUpdateTaxRate(taxRateId)\n // ...\n\n const handleUpdate = (\n name: string\n ) => {\n updateTaxRate.mutate({\n name\n }, {\n onSuccess: ({ tax_rate }) => {\n console.log(tax_rate.name)\n }\n })\n }\n\n // ...\n}\n\nexport default TaxRate\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3208, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3209, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts", + "qualifiedName": "AdminPostTaxRatesTaxRateReq" + }, + "name": "AdminPostTaxRatesTaxRateReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "AdminTaxRatesRes" + }, + "name": "AdminTaxRatesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts", + "qualifiedName": "AdminPostTaxRatesTaxRateReq" + }, + "name": "AdminPostTaxRatesTaxRateReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 3214, + 3222, + 3230, + 3203, + 3218, + 3226, + 3234, + 3210, + 3186, + 3156, + 3206 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 3156, + 3186 + ] + }, + { + "title": "Mutations", + "children": [ + 3203, + 3206, + 3210, + 3214, + 3218, + 3222, + 3226, + 3230, + 3234 + ] + } + ] + }, + { + "id": 44, + "name": "Uploads", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Mutations listed here are used to send requests to the [Admin Upload API Routes](https://docs.medusajs.com/api/admin#uploads).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nThe methods in this class are used to upload any type of resources. For example, they can be used to upload CSV files that are used to import products into the store.\n\nRelated Guide: [How to upload CSV file when importing a product](https://docs.medusajs.com/modules/products/admin/import-products#1-upload-csv-file)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 3244, + "name": "useAdminCreatePresignedDownloadUrl", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3245, + "name": "useAdminCreatePresignedDownloadUrl", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates and retrieve a presigned or public download URL for a file. The URL creation is handled by the file service installed on the Medusa backend." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreatePresignedDownloadUrl } from \"medusa-react\"\n\nconst Image = () => {\n const createPresignedUrl = useAdminCreatePresignedDownloadUrl()\n // ...\n\n const handlePresignedUrl = (fileKey: string) => {\n createPresignedUrl.mutate({\n file_key: fileKey\n }, {\n onSuccess: ({ download_url }) => {\n console.log(download_url)\n }\n })\n }\n\n // ...\n}\n\nexport default Image\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3246, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/uploads/index.d.ts", + "qualifiedName": "AdminUploadsDownloadUrlRes" + }, + "name": "AdminUploadsDownloadUrlRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/uploads/get-download-url.d.ts", + "qualifiedName": "AdminPostUploadsDownloadUrlReq" + }, + "name": "AdminPostUploadsDownloadUrlReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/uploads/index.d.ts", + "qualifiedName": "AdminUploadsDownloadUrlRes" + }, + "name": "AdminUploadsDownloadUrlRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/uploads/get-download-url.d.ts", + "qualifiedName": "AdminPostUploadsDownloadUrlReq" + }, + "name": "AdminPostUploadsDownloadUrlReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3247, + "name": "useAdminDeleteFile", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3248, + "name": "useAdminDeleteFile", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes an uploaded file from storage. The file is deleted using the installed file service on the Medusa backend." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteFile } from \"medusa-react\"\n\nconst Image = () => {\n const deleteFile = useAdminDeleteFile()\n // ...\n\n const handleDeleteFile = (fileKey: string) => {\n deleteFile.mutate({\n file_key: fileKey\n }, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default Image\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3249, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/uploads/delete-upload.d.ts", + "qualifiedName": "AdminDeleteUploadsReq" + }, + "name": "AdminDeleteUploadsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/uploads/delete-upload.d.ts", + "qualifiedName": "AdminDeleteUploadsReq" + }, + "name": "AdminDeleteUploadsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3238, + "name": "useAdminUploadFile", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3239, + "name": "useAdminUploadFile", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook uploads a file to a public bucket or storage. The file upload is handled by the file service installed on the Medusa backend." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUploadFile } from \"medusa-react\"\n\nconst UploadFile = () => {\n const uploadFile = useAdminUploadFile()\n // ...\n\n const handleFileUpload = (file: File) => {\n uploadFile.mutate(file, {\n onSuccess: ({ uploads }) => {\n console.log(uploads[0].key)\n }\n })\n }\n\n // ...\n}\n\nexport default UploadFile\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3240, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/uploads/index.d.ts", + "qualifiedName": "AdminUploadsRes" + }, + "name": "AdminUploadsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "AdminCreateUploadPayload" + }, + "name": "AdminCreateUploadPayload", + "package": "@medusajs/medusa-js" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/uploads/index.d.ts", + "qualifiedName": "AdminUploadsRes" + }, + "name": "AdminUploadsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "AdminCreateUploadPayload" + }, + "name": "AdminCreateUploadPayload", + "package": "@medusajs/medusa-js" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3241, + "name": "useAdminUploadProtectedFile", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3242, + "name": "useAdminUploadProtectedFile", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook uploads a file to an ACL or a non-public bucket. The file upload is handled by the file service installed on the Medusa backend." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUploadProtectedFile } from \"medusa-react\"\n\nconst UploadFile = () => {\n const uploadFile = useAdminUploadProtectedFile()\n // ...\n\n const handleFileUpload = (file: File) => {\n uploadFile.mutate(file, {\n onSuccess: ({ uploads }) => {\n console.log(uploads[0].key)\n }\n })\n }\n\n // ...\n}\n\nexport default UploadFile\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3243, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/uploads/index.d.ts", + "qualifiedName": "AdminUploadsRes" + }, + "name": "AdminUploadsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "AdminCreateUploadPayload" + }, + "name": "AdminCreateUploadPayload", + "package": "@medusajs/medusa-js" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/uploads/index.d.ts", + "qualifiedName": "AdminUploadsRes" + }, + "name": "AdminUploadsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "AdminCreateUploadPayload" + }, + "name": "AdminCreateUploadPayload", + "package": "@medusajs/medusa-js" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 3244, + 3247, + 3238, + 3241 + ] + } + ], + "categories": [ + { + "title": "Mutations", + "children": [ + 3238, + 3241, + 3244, + 3247 + ] + } + ] + }, + { + "id": 45, + "name": "Users", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Admin User API Routes](https://docs.medusajs.com/api/admin#users).\n\nAll hooks listed require " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "user authentication", + "target": 853 + }, + { + "kind": "text", + "text": ".\n\nA store can have more than one user, each having the same privileges. Admins can manage users, their passwords, and more.\n\nRelated Guide: [How to manage users](https://docs.medusajs.com/modules/users/admin/manage-users)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 3282, + "name": "useAdminCreateUser", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3283, + "name": "useAdminCreateUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates an admin user. The user has the same privileges as all admin users, and will be able to \nauthenticate and perform admin functionalities right after creation." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminCreateUser } from \"medusa-react\"\n\nconst CreateUser = () => {\n const createUser = useAdminCreateUser()\n // ...\n\n const handleCreateUser = () => {\n createUser.mutate({\n email: \"user@example.com\",\n password: \"supersecret\",\n }, {\n onSuccess: ({ user }) => {\n console.log(user.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateUser\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3284, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "AdminUserRes" + }, + "name": "AdminUserRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "AdminCreateUserPayload" + }, + "name": "AdminCreateUserPayload", + "package": "@medusajs/medusa-js" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "AdminUserRes" + }, + "name": "AdminUserRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "AdminCreateUserPayload" + }, + "name": "AdminCreateUserPayload", + "package": "@medusajs/medusa-js" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3289, + "name": "useAdminDeleteUser", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3290, + "name": "useAdminDeleteUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a user. Once deleted, the user will not be able to authenticate or perform admin functionalities." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminDeleteUser } from \"medusa-react\"\n\ntype Props = {\n userId: string\n}\n\nconst User = ({ userId }: Props) => {\n const deleteUser = useAdminDeleteUser(userId)\n // ...\n\n const handleDeleteUser = () => {\n deleteUser.mutate(void 0, {\n onSuccess: ({ id, object, deleted }) => {\n console.log(id)\n }\n })\n }\n\n // ...\n}\n\nexport default User\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3291, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3292, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "DeleteResponse" + }, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3293, + "name": "useAdminResetPassword", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3294, + "name": "useAdminResetPassword", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook resets the password of an admin user using their reset password token. You must generate a reset password token first \nfor the user using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useAdminSendResetPasswordToken", + "target": 3296, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " hook, then use that token to reset the password in this hook." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminResetPassword } from \"medusa-react\"\n\nconst ResetPassword = () => {\n const resetPassword = useAdminResetPassword()\n // ...\n\n const handleResetPassword = (\n token: string,\n password: string\n ) => {\n resetPassword.mutate({\n token,\n password,\n }, {\n onSuccess: ({ user }) => {\n console.log(user.id)\n }\n })\n }\n\n // ...\n}\n\nexport default ResetPassword\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3295, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "AdminUserRes" + }, + "name": "AdminUserRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/reset-password.d.ts", + "qualifiedName": "AdminResetPasswordRequest" + }, + "name": "AdminResetPasswordRequest", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "AdminUserRes" + }, + "name": "AdminUserRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/reset-password.d.ts", + "qualifiedName": "AdminResetPasswordRequest" + }, + "name": "AdminResetPasswordRequest", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3296, + "name": "useAdminSendResetPasswordToken", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3297, + "name": "useAdminSendResetPasswordToken", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook generates a password token for an admin user with a given email. This also triggers the " + }, + { + "kind": "code", + "text": "`user.password_reset`" + }, + { + "kind": "text", + "text": " event. So, if you have a Notification Service installed\nthat can handle this event, a notification, such as an email, will be sent to the user. The token is triggered as part of the " + }, + { + "kind": "code", + "text": "`user.password_reset`" + }, + { + "kind": "text", + "text": " event's payload. \nThat token must be used later to reset the password using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useAdminResetPassword", + "target": 3293, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " hook." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminSendResetPasswordToken } from \"medusa-react\"\n\nconst Login = () => {\n const requestPasswordReset = useAdminSendResetPasswordToken()\n // ...\n\n const handleResetPassword = (\n email: string\n ) => {\n requestPasswordReset.mutate({\n email\n }, {\n onSuccess: () => {\n // successful\n }\n })\n }\n\n // ...\n}\n\nexport default Login\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3298, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/reset-password-token.d.ts", + "qualifiedName": "AdminResetPasswordTokenRequest" + }, + "name": "AdminResetPasswordTokenRequest", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/reset-password-token.d.ts", + "qualifiedName": "AdminResetPasswordTokenRequest" + }, + "name": "AdminResetPasswordTokenRequest", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3285, + "name": "useAdminUpdateUser", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3286, + "name": "useAdminUpdateUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates an admin user's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUpdateUser } from \"medusa-react\"\n\ntype Props = {\n userId: string\n}\n\nconst User = ({ userId }: Props) => {\n const updateUser = useAdminUpdateUser(userId)\n // ...\n\n const handleUpdateUser = (\n firstName: string\n ) => {\n updateUser.mutate({\n first_name: firstName,\n }, {\n onSuccess: ({ user }) => {\n console.log(user.first_name)\n }\n })\n }\n\n // ...\n}\n\nexport default User\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3287, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3288, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "AdminUserRes" + }, + "name": "AdminUserRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "AdminUpdateUserPayload" + }, + "name": "AdminUpdateUserPayload", + "package": "@medusajs/medusa-js" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "AdminUserRes" + }, + "name": "AdminUserRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "AdminUpdateUserPayload" + }, + "name": "AdminUpdateUserPayload", + "package": "@medusajs/medusa-js" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 3266, + "name": "useAdminUser", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3267, + "name": "useAdminUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves an admin user's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUser } from \"medusa-react\"\n\ntype Props = {\n userId: string\n}\n\nconst User = ({ userId }: Props) => {\n const { user, isLoading } = useAdminUser(\n userId\n )\n\n return (\n
\n {isLoading && Loading...}\n {user && {user.first_name} {user.last_name}}\n
\n )\n}\n\nexport default User\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3268, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3269, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "AdminUserRes" + }, + "name": "AdminUserRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_users" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 3270, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3272, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3271, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/user.d.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3272, + 3271 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3273, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3275, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3274, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/user.d.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3275, + 3274 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3276, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3278, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3277, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/user.d.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3278, + 3277 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3279, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3281, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3280, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/user.d.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3281, + 3280 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 3251, + "name": "useAdminUsers", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3252, + "name": "useAdminUsers", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves all admin users." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminUsers } from \"medusa-react\"\n\nconst Users = () => {\n const { users, isLoading } = useAdminUsers()\n\n return (\n
\n {isLoading && Loading...}\n {users && !users.length && No Users}\n {users && users.length > 0 && (\n
    \n {users.map((user) => (\n
  • {user.email}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Users\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3253, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "AdminUsersListRes" + }, + "name": "AdminUsersListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_users" + }, + { + "type": "literal", + "value": "list" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 3254, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3256, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3255, + "name": "users", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "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/dist/models/user.d.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3256, + 3255 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3257, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3259, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3258, + "name": "users", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "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/dist/models/user.d.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3259, + 3258 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3260, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3262, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3261, + "name": "users", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "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/dist/models/user.d.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3262, + 3261 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 3263, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3265, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 3264, + "name": "users", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "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/dist/models/user.d.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3265, + 3264 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 3282, + 3289, + 3293, + 3296, + 3285, + 3266, + 3251 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 3251, + 3266 + ] + }, + { + "title": "Mutations", + "children": [ + 3282, + 3285, + 3289, + 3293, + 3296 + ] + } + ] + } + ], + "groups": [ + { + "title": "Namespaces", + "children": [ + 8, + 9, + 10, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 11, + 29, + 30, + 46, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45 + ] + } + ] + }, + { + "id": 47, + "name": "Store", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@namespaceMember" + ] + }, + "children": [ + { + "id": 48, + "name": "Carts", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Store Cart API Routes](https://docs.medusajs.com/api/store#carts).\n\nA cart is a virtual shopping bag that customers can use to add items they want to purchase.\nA cart is then used to checkout and place an order.\n\nThe hooks listed have general examples on how to use them, but it's highly recommended to use the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "CartProvider", + "target": 174 + }, + { + "kind": "text", + "text": " provider and\nthe " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useCart", + "target": 169 + }, + { + "kind": "text", + "text": " hook to manage your cart and access the current cart across your application.\n\nRelated Guide: [How to implement cart functionality in your storefront](https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 229, + "name": "useAddShippingMethodToCart", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 230, + "name": "useAddShippingMethodToCart", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook adds a shipping method to the cart. The validation of the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field is handled by the fulfillment provider of the chosen shipping option." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAddShippingMethodToCart } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Cart = ({ cartId }: Props) => {\n const addShippingMethod = useAddShippingMethodToCart(cartId)\n\n const handleAddShippingMethod = (\n optionId: string\n ) => {\n addShippingMethod.mutate({\n option_id: optionId,\n }, {\n onSuccess: ({ cart }) => {\n console.log(cart.shipping_methods)\n }\n })\n }\n \n // ...\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 231, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 232, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/add-shipping-method.d.ts", + "qualifiedName": "StorePostCartsCartShippingMethodReq" + }, + "name": "StorePostCartsCartShippingMethodReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/add-shipping-method.d.ts", + "qualifiedName": "StorePostCartsCartShippingMethodReq" + }, + "name": "StorePostCartsCartShippingMethodReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 202, + "name": "useCompleteCart", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 203, + "name": "useCompleteCart", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook completes a cart and place an order or create a swap, based on the cart's type. This includes attempting to authorize the cart's payment.\nIf authorizing the payment requires more action, the cart will not be completed and the order will not be placed or the swap will not be created.\nAn idempotency key will be generated if none is provided in the header " + }, + { + "kind": "code", + "text": "`Idempotency-Key`" + }, + { + "kind": "text", + "text": " and added to\nthe response. If an error occurs during cart completion or the request is interrupted for any reason, the cart completion can be retried by passing the idempotency\nkey in the " + }, + { + "kind": "code", + "text": "`Idempotency-Key`" + }, + { + "kind": "text", + "text": " header." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCompleteCart } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Cart = ({ cartId }: Props) => {\n const completeCart = useCompleteCart(cartId)\n\n const handleComplete = () => {\n completeCart.mutate(void 0, {\n onSuccess: ({ data, type }) => {\n console.log(data.id, type)\n }\n })\n }\n \n // ...\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 204, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 205, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCompleteCartRes" + }, + "name": "StoreCompleteCartRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCompleteCartRes" + }, + "name": "StoreCompleteCartRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 195, + "name": "useCreateCart", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 196, + "name": "useCreateCart", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a Cart. Although optional, specifying the cart's region and sales channel can affect the cart's pricing and\nthe products that can be added to the cart respectively.\n\nSo, make sure to set those early on and change them if necessary, such as when the customer changes their region.\n\nIf a customer is logged in, make sure to pass its ID or email within the cart's details so that the cart is attached to the customer." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCreateCart } from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Cart = ({ regionId }: Props) => {\n const createCart = useCreateCart()\n\n const handleCreate = () => {\n createCart.mutate({\n region_id: regionId\n // creates an empty cart\n }, {\n onSuccess: ({ cart }) => {\n console.log(cart.items)\n }\n })\n }\n \n // ...\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 197, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/create-cart.d.ts", + "qualifiedName": "StorePostCartReq" + }, + "name": "StorePostCartReq", + "package": "@medusajs/medusa" + } + ] + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/create-cart.d.ts", + "qualifiedName": "StorePostCartReq" + }, + "name": "StorePostCartReq", + "package": "@medusajs/medusa" + } + ] + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 206, + "name": "useCreatePaymentSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 207, + "name": "useCreatePaymentSession", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates Payment Sessions for each of the available Payment Providers in the Cart's Region. If there's only one payment session created,\nit will be selected by default. The creation of the payment session uses the payment provider and may require sending requests to third-party services." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCreatePaymentSession } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Cart = ({ cartId }: Props) => {\n const createPaymentSession = useCreatePaymentSession(cartId)\n\n const handleComplete = () => {\n createPaymentSession.mutate(void 0, {\n onSuccess: ({ cart }) => {\n console.log(cart.payment_sessions)\n }\n })\n }\n \n // ...\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 208, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 209, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 236, + "name": "useDeletePaymentSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 237, + "name": "useDeletePaymentSession", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a Payment Session in a Cart. May be useful if a payment has failed. The totals will be recalculated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useDeletePaymentSession } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Cart = ({ cartId }: Props) => {\n const deletePaymentSession = useDeletePaymentSession(cartId)\n\n const handleDeletePaymentSession = (\n providerId: string\n ) => {\n deletePaymentSession.mutate({\n provider_id: providerId,\n }, {\n onSuccess: ({ cart }) => {\n console.log(cart.payment_sessions)\n }\n })\n }\n \n // ...\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 238, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 239, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 233, + "name": "DeletePaymentSessionMutationData", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 233, + "name": "DeletePaymentSessionMutationData", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 178, + "name": "useGetCart", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 179, + "name": "useGetCart", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a Cart's details. This includes recalculating its totals." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useGetCart } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Cart = ({ cartId }: Props) => {\n const { cart, isLoading } = useGetCart(cartId)\n\n return (\n
\n {isLoading && Loading...}\n {cart && cart.items.length === 0 && (\n Cart is empty\n )}\n {cart && cart.items.length > 0 && (\n
    \n {cart.items.map((item) => (\n
  • {item.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 180, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 181, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "carts" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 182, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 183, + "name": "cart", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/cart.d.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" + } + }, + { + "id": 184, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 183, + 184 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 185, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 186, + "name": "cart", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/cart.d.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" + } + }, + { + "id": 187, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 186, + 187 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 188, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 189, + "name": "cart", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/cart.d.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" + } + }, + { + "id": 190, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 189, + 190 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 191, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 192, + "name": "cart", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/cart.d.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" + } + }, + { + "id": 193, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 192, + 193 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 221, + "name": "useRefreshPaymentSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 222, + "name": "useRefreshPaymentSession", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook refreshes a Payment Session to ensure that it is in sync with the Cart. This is usually not necessary, but is provided for edge cases." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useRefreshPaymentSession } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Cart = ({ cartId }: Props) => {\n const refreshPaymentSession = useRefreshPaymentSession(cartId)\n\n const handleRefresh = (\n providerId: string\n ) => {\n refreshPaymentSession.mutate({\n provider_id: providerId,\n }, {\n onSuccess: ({ cart }) => {\n console.log(cart.payment_sessions)\n }\n })\n }\n \n // ...\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 223, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 224, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 218, + "name": "RefreshPaymentSessionMutationData", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 218, + "name": "RefreshPaymentSessionMutationData", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 225, + "name": "useSetPaymentSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 226, + "name": "useSetPaymentSession", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook selects the Payment Session that will be used to complete the cart. This is typically used when the customer chooses their preferred payment method during checkout.\nThe totals of the cart will be recalculated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useSetPaymentSession } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Cart = ({ cartId }: Props) => {\n const setPaymentSession = useSetPaymentSession(cartId)\n\n const handleSetPaymentSession = (\n providerId: string\n ) => {\n setPaymentSession.mutate({\n provider_id: providerId,\n }, {\n onSuccess: ({ cart }) => {\n console.log(cart.payment_session)\n }\n })\n }\n \n // ...\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 227, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 228, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/set-payment-session.d.ts", + "qualifiedName": "StorePostCartsCartPaymentSessionReq" + }, + "name": "StorePostCartsCartPaymentSessionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/set-payment-session.d.ts", + "qualifiedName": "StorePostCartsCartPaymentSessionReq" + }, + "name": "StorePostCartsCartPaymentSessionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 240, + "name": "useStartCheckout", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 241, + "name": "useStartCheckout", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook allows you to create a cart and set its payment session as a preparation for checkout.\nIt performs the same actions as the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useCreateCart", + "target": 195, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useCreatePaymentSession", + "target": 206, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " hooks." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useStartCheckout } from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Checkout = ({ regionId }: Props) => {\n const startCheckout = useStartCheckout()\n\n const handleCheckout = () => {\n startCheckout.mutate({\n region_id: regionId,\n }, {\n onSuccess: (cart) => {\n console.log(cart.payment_sessions)\n }\n })\n }\n \n // ...\n}\n\nexport default Checkout\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 242, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/cart.d.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" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/create-cart.d.ts", + "qualifiedName": "StorePostCartReq" + }, + "name": "StorePostCartReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/cart.d.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" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/create-cart.d.ts", + "qualifiedName": "StorePostCartReq" + }, + "name": "StorePostCartReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 198, + "name": "useUpdateCart", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 199, + "name": "useUpdateCart", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a Cart's details. If the cart has payment sessions and the region was not changed, \nthe payment sessions are updated. The cart's totals are also recalculated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useUpdateCart } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Cart = ({ cartId }: Props) => {\n const updateCart = useUpdateCart(cartId)\n\n const handleUpdate = (\n email: string\n ) => {\n updateCart.mutate({\n email\n }, {\n onSuccess: ({ cart }) => {\n console.log(cart.email)\n }\n })\n }\n \n // ...\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 200, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 201, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/update-cart.d.ts", + "qualifiedName": "StorePostCartsCartReq" + }, + "name": "StorePostCartsCartReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/update-cart.d.ts", + "qualifiedName": "StorePostCartsCartReq" + }, + "name": "StorePostCartsCartReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 210, + "name": "useUpdatePaymentSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 211, + "name": "useUpdatePaymentSession", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a Payment Session with additional data. This can be useful depending on the payment provider used.\nAll payment sessions are updated and cart totals are recalculated afterwards." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useUpdatePaymentSession } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Cart = ({ cartId }: Props) => {\n const updatePaymentSession = useUpdatePaymentSession(cartId)\n\n const handleUpdate = (\n providerId: string,\n data: Record\n ) => {\n updatePaymentSession.mutate({\n provider_id: providerId,\n data\n }, {\n onSuccess: ({ cart }) => {\n console.log(cart.payment_session)\n }\n })\n }\n \n // ...\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 212, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 213, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intersection", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 214, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 215, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment provider's identifier." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 215 + ] + } + ] + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/update-payment-session.d.ts", + "qualifiedName": "StorePostCartsCartPaymentSessionUpdateReq" + }, + "name": "StorePostCartsCartPaymentSessionUpdateReq", + "package": "@medusajs/medusa" + } + ] + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intersection", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 216, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 217, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment provider's identifier." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 217 + ] + } + ] + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/update-payment-session.d.ts", + "qualifiedName": "StorePostCartsCartPaymentSessionUpdateReq" + }, + "name": "StorePostCartsCartPaymentSessionUpdateReq", + "package": "@medusajs/medusa" + } + ] + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 229, + 202, + 195, + 206, + 236, + 178, + 221, + 225, + 240, + 198, + 210 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 178 + ] + }, + { + "title": "Mutations", + "children": [ + 195, + 198, + 202, + 206, + 210, + 221, + 225, + 229, + 236, + 240 + ] + } + ] + }, + { + "id": 50, + "name": "Customers", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Store Customer API Routes](https://docs.medusajs.com/api/store#customers_postcustomers).\n\nA customer can register and manage their information such as addresses, orders, payment methods, and more.\n\nRelated Guide: [How to implement customer profiles in your storefront](https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 356, + "name": "useCreateCustomer", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 357, + "name": "useCreateCustomer", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook registers a new customer. This will also automatically authenticate the customer and set their login session in the response Cookie header.\nSubsequent requests sent with other hooks are sent with the Cookie session automatically." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCreateCustomer } from \"medusa-react\"\n\nconst RegisterCustomer = () => {\n const createCustomer = useCreateCustomer()\n // ...\n\n const handleCreate = (\n customerData: {\n first_name: string\n last_name: string\n email: string\n password: string\n }\n ) => {\n // ...\n createCustomer.mutate(customerData, {\n onSuccess: ({ customer }) => {\n console.log(customer.id)\n }\n })\n }\n\n // ...\n}\n\nexport default RegisterCustomer\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 358, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "StoreCustomersRes" + }, + "name": "StoreCustomersRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/create-customer.d.ts", + "qualifiedName": "StorePostCustomersReq" + }, + "name": "StorePostCustomersReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "StoreCustomersRes" + }, + "name": "StoreCustomersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/create-customer.d.ts", + "qualifiedName": "StorePostCustomersReq" + }, + "name": "StorePostCustomersReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 328, + "name": "useCustomerOrders", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 329, + "name": "useCustomerOrders", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of the logged-in customer's orders. The orders can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`status`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`fulfillment_status`" + }, + { + "kind": "text", + "text": ". The orders can also be paginated.\nThis hook requires [customer authentication](https://docs.medusajs.com/medusa-react/overview#customer-authentication)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCustomerOrders } from \"medusa-react\"\n\nconst Orders = () => {\n // refetch a function that can be used to\n // re-retrieve orders after the customer logs in\n const { orders, isLoading } = useCustomerOrders()\n\n return (\n
\n {isLoading && Loading orders...}\n {orders?.length && (\n
    \n {orders.map((order) => (\n
  • {order.display_id}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Orders\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 330, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved orders." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/list-orders.d.ts", + "qualifiedName": "StoreGetCustomersCustomerOrdersParams" + }, + "name": "StoreGetCustomersCustomerOrdersParams", + "package": "@medusajs/medusa" + }, + "defaultValue": "..." + }, + { + "id": 331, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "StoreCustomersListOrdersRes" + }, + "name": "StoreCustomersListOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "customers" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": "orders" + } + ] + } + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 332, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 335, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 333, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 334, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 336, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 337, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 335, + 333, + 334, + 336, + 337 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 338, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 341, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 339, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 340, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 342, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 343, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 341, + 339, + 340, + 342, + 343 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 344, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 347, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 345, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 346, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 348, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 349, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 347, + 345, + 346, + 348, + 349 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 350, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 353, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 351, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 352, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 354, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 355, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 353, + 351, + 352, + 354, + 355 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 313, + "name": "useMeCustomer", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 314, + "name": "useMeCustomer", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves the logged-in customer's details. It requires [customer authentication](https://docs.medusajs.com/medusa-react/overview#customer-authentication)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useMeCustomer } from \"medusa-react\"\n\nconst Customer = () => {\n const { customer, isLoading } = useMeCustomer()\n\n return (\n
\n {isLoading && Loading...}\n {customer && (\n {customer.first_name} {customer.last_name}\n )}\n
\n )\n}\n\nexport default Customer\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 315, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "StoreCustomersRes" + }, + "name": "StoreCustomersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "customers" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 316, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 317, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + }, + { + "id": 318, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 317, + 318 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 319, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 320, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + }, + { + "id": 321, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 320, + 321 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 322, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 323, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + }, + { + "id": 324, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 323, + 324 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 325, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 326, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/customer.d.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + }, + { + "id": 327, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 326, + 327 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 362, + "name": "useUpdateMe", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 363, + "name": "useUpdateMe", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates the logged-in customer's details. This hook requires [customer authentication](https://docs.medusajs.com/medusa-react/overview#customer-authentication)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useUpdateMe } from \"medusa-react\"\n\ntype Props = {\n customerId: string\n}\n\nconst Customer = ({ customerId }: Props) => {\n const updateCustomer = useUpdateMe()\n // ...\n\n const handleUpdate = (\n firstName: string\n ) => {\n // ...\n updateCustomer.mutate({\n id: customerId,\n first_name: firstName,\n }, {\n onSuccess: ({ customer }) => {\n console.log(customer.first_name)\n }\n })\n }\n\n // ...\n}\n\nexport default Customer\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 364, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "StoreCustomersRes" + }, + "name": "StoreCustomersRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 359, + "name": "UpdateMeReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "StoreCustomersRes" + }, + "name": "StoreCustomersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 359, + "name": "UpdateMeReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 356, + 328, + 313, + 362 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 313, + 328 + ] + }, + { + "title": "Mutations", + "children": [ + 356, + 362 + ] + } + ] + }, + { + "id": 51, + "name": "Gift Cards", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries listed here are used to send requests to the [Store Gift Card API Routes](https://docs.medusajs.com/api/store#gift-cards).\n\nCustomers can use gift cards during checkout to deduct the gift card's balance from the checkout total.\n\nRelated Guide: [How to use gift cards in a storefront](https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 366, + "name": "useGiftCard", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 367, + "name": "useGiftCard", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a Gift Card's details by its associated unique code." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useGiftCard } from \"medusa-react\"\n\ntype Props = {\n giftCardCode: string\n}\n\nconst GiftCard = ({ giftCardCode }: Props) => {\n const { gift_card, isLoading, isError } = useGiftCard(\n giftCardCode\n )\n\n return (\n
\n {isLoading && Loading...}\n {gift_card && {gift_card.value}}\n {isError && Gift Card does not exist}\n
\n )\n}\n\nexport default GiftCard\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 368, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The gift card's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 369, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/gift-cards/index.d.ts", + "qualifiedName": "StoreGiftCardsRes" + }, + "name": "StoreGiftCardsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "gift_cards" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 370, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 371, + "name": "gift_card", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/gift-card.d.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + }, + { + "id": 372, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 371, + 372 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 373, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 374, + "name": "gift_card", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/gift-card.d.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + }, + { + "id": 375, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 374, + 375 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 376, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 377, + "name": "gift_card", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/gift-card.d.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + }, + { + "id": 378, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 377, + 378 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 379, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 380, + "name": "gift_card", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/gift-card.d.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + }, + { + "id": 381, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 380, + 381 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 366 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 366 + ] + } + ] + }, + { + "id": 52, + "name": "Line Items", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Mutations listed here are used to send requests to the Line Item API Routes part of the [Store Cart API Routes](https://docs.medusajs.com/api/store#carts).\n\nThe hooks listed have general examples on how to use them, but it's highly recommended to use the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "CartProvider", + "target": 174 + }, + { + "kind": "text", + "text": " provider and\nthe " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useCart", + "target": 169 + }, + { + "kind": "text", + "text": " hook to manage your cart and access the current cart across your application." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 382, + "name": "useCreateLineItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 383, + "name": "useCreateLineItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook generates a Line Item with a given Product Variant and adds it to the Cart." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCreateLineItem } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Cart = ({ cartId }: Props) => {\n const createLineItem = useCreateLineItem(cartId)\n\n const handleAddItem = (\n variantId: string,\n quantity: number\n ) => {\n createLineItem.mutate({\n variant_id: variantId,\n quantity,\n }, {\n onSuccess: ({ cart }) => {\n console.log(cart.items)\n }\n })\n }\n\n // ...\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 384, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 385, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/create-line-item/index.d.ts", + "qualifiedName": "StorePostCartsCartLineItemsReq" + }, + "name": "StorePostCartsCartLineItemsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/create-line-item/index.d.ts", + "qualifiedName": "StorePostCartsCartLineItemsReq" + }, + "name": "StorePostCartsCartLineItemsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 393, + "name": "useDeleteLineItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 394, + "name": "useDeleteLineItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook deletes a line item from a cart. The payment sessions will be updated and the totals will be recalculated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useDeleteLineItem } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Cart = ({ cartId }: Props) => {\n const deleteLineItem = useDeleteLineItem(cartId)\n\n const handleDeleteItem = (\n lineItemId: string\n ) => {\n deleteLineItem.mutate({\n lineId: lineItemId,\n }, {\n onSuccess: ({ cart }) => {\n console.log(cart.items)\n }\n })\n }\n\n // ...\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 395, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 396, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 397, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 398, + "name": "lineId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 398 + ] + } + ] + } + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 399, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 400, + "name": "lineId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 400 + ] + } + ] + } + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 389, + "name": "useUpdateLineItem", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 390, + "name": "useUpdateLineItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook updates a line item's data." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useUpdateLineItem } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Cart = ({ cartId }: Props) => {\n const updateLineItem = useUpdateLineItem(cartId)\n\n const handleUpdateItem = (\n lineItemId: string,\n quantity: number\n ) => {\n updateLineItem.mutate({\n lineId: lineItemId,\n quantity,\n }, {\n onSuccess: ({ cart }) => {\n console.log(cart.items)\n }\n })\n }\n\n // ...\n}\n\nexport default Cart\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 391, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 392, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 386, + "name": "UpdateLineItemReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": 386, + "name": "UpdateLineItemReq", + "package": "medusa-react" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 382, + 393, + 389 + ] + } + ], + "categories": [ + { + "title": "Mutations", + "children": [ + 382, + 389, + 393 + ] + } + ] + }, + { + "id": 53, + "name": "Order Edits", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Store Order Edits API Routes](https://docs.medusajs.com/api/store#order-edits).\n\nOrder edits are changes made to items in an order such as adding, updating their quantity, or deleting them. Order edits are created by the admin.\nA customer can review order edit requests created by an admin and confirm or decline them.\n\nRelated Guide: [How to handle order edits in a storefront](https://docs.medusajs.com/modules/orders/storefront/handle-order-edits)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 422, + "name": "useCompleteOrderEdit", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 423, + "name": "useCompleteOrderEdit", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook completes and confirms an Order Edit and reflect its changes on the original order. Any additional payment required must \nbe authorized first using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useAuthorizePaymentSession", + "target": 538 + }, + { + "kind": "text", + "text": " hook." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCompleteOrderEdit } from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n}\n\nconst OrderEdit = ({ orderEditId }: Props) => {\n const completeOrderEdit = useCompleteOrderEdit(\n orderEditId\n )\n // ...\n\n const handleCompleteOrderEdit = () => {\n completeOrderEdit.mutate(void 0, {\n onSuccess: ({ order_edit }) => {\n console.log(order_edit.confirmed_at)\n }\n })\n }\n\n // ...\n}\n\nexport default OrderEdit\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 424, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 425, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/order-edits/index.d.ts", + "qualifiedName": "StoreOrderEditsRes" + }, + "name": "StoreOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/order-edits/index.d.ts", + "qualifiedName": "StoreOrderEditsRes" + }, + "name": "StoreOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 418, + "name": "useDeclineOrderEdit", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "useDeclineOrderEdit", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook declines an Order Edit. The changes are not reflected on the original order." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useDeclineOrderEdit } from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n}\n\nconst OrderEdit = ({ orderEditId }: Props) => {\n const declineOrderEdit = useDeclineOrderEdit(orderEditId)\n // ...\n\n const handleDeclineOrderEdit = (\n declinedReason: string\n ) => {\n declineOrderEdit.mutate({\n declined_reason: declinedReason,\n }, {\n onSuccess: ({ order_edit }) => {\n console.log(order_edit.declined_at)\n }\n })\n }\n\n // ...\n}\n\nexport default OrderEdit\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 420, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 421, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/order-edits/index.d.ts", + "qualifiedName": "StoreOrderEditsRes" + }, + "name": "StoreOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/order-edits/decline-order-edit.d.ts", + "qualifiedName": "StorePostOrderEditsOrderEditDecline" + }, + "name": "StorePostOrderEditsOrderEditDecline", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/order-edits/index.d.ts", + "qualifiedName": "StoreOrderEditsRes" + }, + "name": "StoreOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/order-edits/decline-order-edit.d.ts", + "qualifiedName": "StorePostOrderEditsOrderEditDecline" + }, + "name": "StorePostOrderEditsOrderEditDecline", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 402, + "name": "useOrderEdit", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 403, + "name": "useOrderEdit", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves an Order Edit's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useOrderEdit } from \"medusa-react\"\n\ntype Props = {\n orderEditId: string\n}\n\nconst OrderEdit = ({ orderEditId }: Props) => {\n const { order_edit, isLoading } = useOrderEdit(orderEditId)\n\n return (\n
\n {isLoading && Loading...}\n {order_edit && (\n
    \n {order_edit.changes.map((change) => (\n
  • {change.type}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default OrderEdit\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 404, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 405, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/order-edits/index.d.ts", + "qualifiedName": "StoreOrderEditsRes" + }, + "name": "StoreOrderEditsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "orderEdit" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 406, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 407, + "name": "order_edit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order-edit.d.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" + } + }, + { + "id": 408, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 407, + 408 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 409, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 410, + "name": "order_edit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order-edit.d.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" + } + }, + { + "id": 411, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 410, + 411 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 412, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 413, + "name": "order_edit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order-edit.d.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" + } + }, + { + "id": 414, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 413, + 414 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 415, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 416, + "name": "order_edit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order-edit.d.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" + } + }, + { + "id": 417, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 416, + 417 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 422, + 418, + 402 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 402 + ] + }, + { + "title": "Mutations", + "children": [ + 418, + 422 + ] + } + ] + }, + { + "id": 54, + "name": "Orders", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Store Order API Routes](https://docs.medusajs.com/api/store#orders).\n\nOrders are purchases made by customers, typically through a storefront.\nOrders are placed and created using " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "cart", + "target": 48 + }, + { + "kind": "text", + "text": " hooks. The listed hooks allow retrieving and claiming orders.\n\nRelated Guide: [How to retrieve order details in a storefront](https://docs.medusajs.com/modules/orders/storefront/retrieve-order-details)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 465, + "name": "useCartOrder", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 466, + "name": "useCartOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves an order's details by the ID of the cart that was used to create the order." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCartOrder } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Order = ({ cartId }: Props) => {\n const { \n order, \n isLoading, \n } = useCartOrder(cartId)\n\n return (\n
\n {isLoading && Loading...}\n {order && {order.display_id}}\n \n
\n )\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 467, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 468, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "StoreOrdersRes" + }, + "name": "StoreOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "orders" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "literal", + "value": "cart" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 469, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 470, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 471, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 470, + 471 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 472, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 473, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 474, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 473, + 474 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 475, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 476, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 477, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 476, + 477 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 478, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 479, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 480, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 479, + 480 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 506, + "name": "useGrantOrderAccess", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 507, + "name": "useGrantOrderAccess", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook verifies the claim order token provided to the customer when they request ownership of an order." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useGrantOrderAccess } from \"medusa-react\"\n\nconst ClaimOrder = () => {\n const confirmOrderRequest = useGrantOrderAccess()\n\n const handleOrderRequestConfirmation = (\n token: string\n ) => {\n confirmOrderRequest.mutate({\n token\n }, {\n onSuccess: () => {\n // successful\n },\n onError: () => {\n // an error occurred.\n }\n })\n }\n \n // ...\n}\n\nexport default ClaimOrder\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 508, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 509, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 510, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 510 + ] + } + ] + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/confirm-order-request.d.ts", + "qualifiedName": "StorePostCustomersCustomerAcceptClaimReq" + }, + "name": "StorePostCustomersCustomerAcceptClaimReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 511, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 512, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 512 + ] + } + ] + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/confirm-order-request.d.ts", + "qualifiedName": "StorePostCustomersCustomerAcceptClaimReq" + }, + "name": "StorePostCustomersCustomerAcceptClaimReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 449, + "name": "useOrder", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 450, + "name": "useOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves an Order's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useOrder } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\nconst Order = ({ orderId }: Props) => {\n const { \n order, \n isLoading, \n } = useOrder(orderId)\n\n return (\n
\n {isLoading && Loading...}\n {order && {order.display_id}}\n \n
\n )\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 451, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 452, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "StoreOrdersRes" + }, + "name": "StoreOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "orders" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 453, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 454, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 455, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 454, + 455 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 456, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 457, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 458, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 457, + 458 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 459, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 460, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 461, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 460, + 461 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 462, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 463, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 464, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 463, + 464 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 481, + "name": "useOrders", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 482, + "name": "useOrders", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook looks up an order using filters. If the filters don't narrow down the results to a single order, a " + }, + { + "kind": "code", + "text": "`404`" + }, + { + "kind": "text", + "text": " response is returned with no orders." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useOrders } from \"medusa-react\"\n\ntype Props = {\n displayId: number\n email: string\n}\n\nconst Order = ({\n displayId,\n email\n}: Props) => {\n const { \n order, \n isLoading, \n } = useOrders({\n display_id: displayId,\n email,\n })\n\n return (\n
\n {isLoading && Loading...}\n {order && {order.display_id}}\n \n
\n )\n}\n\nexport default Order\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 483, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters used to retrieve the order." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts", + "qualifiedName": "StoreGetOrdersParams" + }, + "name": "StoreGetOrdersParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 484, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "StoreOrdersRes" + }, + "name": "StoreOrdersRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "orders" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 485, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 486, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts", + "qualifiedName": "StoreGetOrdersParams" + }, + "name": "StoreGetOrdersParams", + "package": "@medusajs/medusa" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 486 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 487, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 488, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 489, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 488, + 489 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 490, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 491, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 492, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 491, + 492 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 493, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 494, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 495, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 494, + 495 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 496, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 497, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/order.d.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 498, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 497, + 498 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 499, + "name": "useRequestOrderAccess", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 500, + "name": "useRequestOrderAccess", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook allows the logged-in customer to claim ownership of one or more orders. This generates a token that can be used later on to verify the claim \nusing the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useGrantOrderAccess", + "target": 506, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " hook. This also emits the event " + }, + { + "kind": "code", + "text": "`order-update-token.created`" + }, + { + "kind": "text", + "text": ". So, if you have a notification provider installed \nthat handles this event and sends the customer a notification, such as an email, the customer should receive instructions on how to \nfinalize their claim ownership." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useRequestOrderAccess } from \"medusa-react\"\n\nconst ClaimOrder = () => {\n const claimOrder = useRequestOrderAccess()\n\n const handleClaimOrder = (\n orderIds: string[]\n ) => {\n claimOrder.mutate({\n order_ids: orderIds\n }, {\n onSuccess: () => {\n // successful\n },\n onError: () => {\n // an error occurred.\n }\n })\n }\n \n // ...\n}\n\nexport default ClaimOrder\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 501, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 502, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 503, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 503 + ] + } + ] + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/request-order.d.ts", + "qualifiedName": "StorePostCustomersCustomerOrderClaimReq" + }, + "name": "StorePostCustomersCustomerOrderClaimReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 504, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 505, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 505 + ] + } + ] + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/request-order.d.ts", + "qualifiedName": "StorePostCustomersCustomerOrderClaimReq" + }, + "name": "StorePostCustomersCustomerOrderClaimReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 465, + 506, + 449, + 481, + 499 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 449, + 465, + 481 + ] + }, + { + "title": "Mutations", + "children": [ + 499, + 506 + ] + } + ] + }, + { + "id": 55, + "name": "Payment Collections", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Store Payment Collection API Routes](https://docs.medusajs.com/api/store#payment-collections).\n\nA payment collection is useful for managing additional payments, such as for Order Edits, or installment payments." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 538, + "name": "useAuthorizePaymentSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 539, + "name": "useAuthorizePaymentSession", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook authorizes a Payment Session of a Payment Collection." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The payment session's ID." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAuthorizePaymentSession } from \"medusa-react\"\n\ntype Props = {\n paymentCollectionId: string\n}\n\nconst PaymentCollection = ({\n paymentCollectionId\n}: Props) => {\n const authorizePaymentSession = useAuthorizePaymentSession(\n paymentCollectionId\n )\n // ...\n\n const handleAuthorizePayment = (paymentSessionId: string) => {\n authorizePaymentSession.mutate(paymentSessionId, {\n onSuccess: ({ payment_collection }) => {\n console.log(payment_collection.payment_sessions)\n }\n })\n }\n\n // ...\n}\n\nexport default PaymentCollection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 540, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 541, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "StorePaymentCollectionsRes" + }, + "name": "StorePaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "StorePaymentCollectionsRes" + }, + "name": "StorePaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 542, + "name": "useAuthorizePaymentSessionsBatch", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 543, + "name": "useAuthorizePaymentSessionsBatch", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook authorize the Payment Sessions of a Payment Collection." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAuthorizePaymentSessionsBatch } from \"medusa-react\"\n\ntype Props = {\n paymentCollectionId: string\n}\n\nconst PaymentCollection = ({\n paymentCollectionId\n}: Props) => {\n const authorizePaymentSessions = useAuthorizePaymentSessionsBatch(\n paymentCollectionId\n )\n // ...\n\n const handleAuthorizePayments = (paymentSessionIds: string[]) => {\n authorizePaymentSessions.mutate({\n session_ids: paymentSessionIds\n }, {\n onSuccess: ({ payment_collection }) => {\n console.log(payment_collection.payment_sessions)\n }\n })\n }\n\n // ...\n}\n\nexport default PaymentCollection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 544, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 545, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "StorePaymentCollectionsRes" + }, + "name": "StorePaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/authorize-batch-payment-sessions.d.ts", + "qualifiedName": "StorePostPaymentCollectionsBatchSessionsAuthorizeReq" + }, + "name": "StorePostPaymentCollectionsBatchSessionsAuthorizeReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "StorePaymentCollectionsRes" + }, + "name": "StorePaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/authorize-batch-payment-sessions.d.ts", + "qualifiedName": "StorePostPaymentCollectionsBatchSessionsAuthorizeReq" + }, + "name": "StorePostPaymentCollectionsBatchSessionsAuthorizeReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 530, + "name": "useManageMultiplePaymentSessions", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 531, + "name": "useManageMultiplePaymentSessions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates, updates, or deletes a list of payment sessions of a Payment Collections. If a payment session is not provided in the " + }, + { + "kind": "code", + "text": "`sessions`" + }, + { + "kind": "text", + "text": " array, it's deleted." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To add two new payment sessions:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useManageMultiplePaymentSessions } from \"medusa-react\"\n\ntype Props = {\n paymentCollectionId: string\n}\n\nconst PaymentCollection = ({\n paymentCollectionId\n}: Props) => {\n const managePaymentSessions = useManageMultiplePaymentSessions(\n paymentCollectionId\n )\n\n const handleManagePaymentSessions = () => {\n managePaymentSessions.mutate({\n // Total amount = 10000\n sessions: [\n {\n provider_id: \"stripe\",\n amount: 5000,\n },\n {\n provider_id: \"manual\",\n amount: 5000,\n },\n ]\n }, {\n onSuccess: ({ payment_collection }) => {\n console.log(payment_collection.payment_sessions)\n }\n })\n }\n \n // ...\n}\n\nexport default PaymentCollection\n```" + }, + { + "kind": "text", + "text": "\n\nTo update a payment session and another one by not including it in the payload:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useManageMultiplePaymentSessions } from \"medusa-react\"\n\ntype Props = {\n paymentCollectionId: string\n}\n\nconst PaymentCollection = ({\n paymentCollectionId\n}: Props) => {\n const managePaymentSessions = useManageMultiplePaymentSessions(\n paymentCollectionId\n )\n\n const handleManagePaymentSessions = () => {\n managePaymentSessions.mutate({\n // Total amount = 10000\n sessions: [\n {\n provider_id: \"stripe\",\n amount: 10000,\n session_id: \"ps_123456\"\n },\n ]\n }, {\n onSuccess: ({ payment_collection }) => {\n console.log(payment_collection.payment_sessions)\n }\n })\n }\n \n // ...\n}\n\nexport default PaymentCollection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 532, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 533, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "StorePaymentCollectionsRes" + }, + "name": "StorePaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/manage-batch-payment-sessions.d.ts", + "qualifiedName": "StorePostPaymentCollectionsBatchSessionsReq" + }, + "name": "StorePostPaymentCollectionsBatchSessionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "StorePaymentCollectionsRes" + }, + "name": "StorePaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/manage-batch-payment-sessions.d.ts", + "qualifiedName": "StorePostPaymentCollectionsBatchSessionsReq" + }, + "name": "StorePostPaymentCollectionsBatchSessionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 534, + "name": "useManagePaymentSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 535, + "name": "useManagePaymentSession", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a Payment Session for a payment provider in a Payment Collection." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useManagePaymentSession } from \"medusa-react\"\n\ntype Props = {\n paymentCollectionId: string\n}\n\nconst PaymentCollection = ({\n paymentCollectionId\n}: Props) => {\n const managePaymentSession = useManagePaymentSession(\n paymentCollectionId\n )\n\n const handleManagePaymentSession = (\n providerId: string\n ) => {\n managePaymentSession.mutate({\n provider_id: providerId\n }, {\n onSuccess: ({ payment_collection }) => {\n console.log(payment_collection.payment_sessions)\n }\n })\n }\n \n // ...\n}\n\nexport default PaymentCollection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 536, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 537, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "StorePaymentCollectionsRes" + }, + "name": "StorePaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/manage-payment-session.d.ts", + "qualifiedName": "StorePaymentCollectionSessionsReq" + }, + "name": "StorePaymentCollectionSessionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "StorePaymentCollectionsRes" + }, + "name": "StorePaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/manage-payment-session.d.ts", + "qualifiedName": "StorePaymentCollectionSessionsReq" + }, + "name": "StorePaymentCollectionSessionsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 514, + "name": "usePaymentCollection", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 515, + "name": "usePaymentCollection", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a Payment Collection's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { usePaymentCollection } from \"medusa-react\"\n\ntype Props = {\n paymentCollectionId: string\n}\n\nconst PaymentCollection = ({\n paymentCollectionId\n}: Props) => {\n const { \n payment_collection, \n isLoading\n } = usePaymentCollection(\n paymentCollectionId\n )\n\n return (\n
\n {isLoading && Loading...}\n {payment_collection && (\n {payment_collection.status}\n )}\n
\n )\n}\n\nexport default PaymentCollection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 516, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 517, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "StorePaymentCollectionsRes" + }, + "name": "StorePaymentCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "paymentCollection" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 518, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 519, + "name": "payment_collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment-collection.d.ts", + "qualifiedName": "PaymentCollection" + }, + "name": "PaymentCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 520, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 519, + 520 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 521, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 522, + "name": "payment_collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment-collection.d.ts", + "qualifiedName": "PaymentCollection" + }, + "name": "PaymentCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 523, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 522, + 523 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 524, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 525, + "name": "payment_collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment-collection.d.ts", + "qualifiedName": "PaymentCollection" + }, + "name": "PaymentCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 526, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 525, + 526 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 527, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 528, + "name": "payment_collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/payment-collection.d.ts", + "qualifiedName": "PaymentCollection" + }, + "name": "PaymentCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 529, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 528, + 529 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 546, + "name": "usePaymentCollectionRefreshPaymentSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 547, + "name": "usePaymentCollectionRefreshPaymentSession", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook refreshes a Payment Session's data to ensure that it is in sync with the Payment Collection." + } + ], + "blockTags": [ + { + "tag": "@typeParamDefinition", + "content": [ + { + "kind": "text", + "text": "string - The payment session's ID." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { usePaymentCollectionRefreshPaymentSession } from \"medusa-react\"\n\ntype Props = {\n paymentCollectionId: string\n}\n\nconst PaymentCollection = ({\n paymentCollectionId\n}: Props) => {\n const refreshPaymentSession = usePaymentCollectionRefreshPaymentSession(\n paymentCollectionId\n )\n // ...\n\n const handleRefreshPaymentSession = (paymentSessionId: string) => {\n refreshPaymentSession.mutate(paymentSessionId, {\n onSuccess: ({ payment_session }) => {\n console.log(payment_session.status)\n }\n })\n }\n\n // ...\n}\n\nexport default PaymentCollection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 548, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 549, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "StorePaymentCollectionsSessionRes" + }, + "name": "StorePaymentCollectionsSessionRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "StorePaymentCollectionsSessionRes" + }, + "name": "StorePaymentCollectionsSessionRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 538, + 542, + 530, + 534, + 514, + 546 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 514 + ] + }, + { + "title": "Mutations", + "children": [ + 530, + 534, + 538, + 542, + 546 + ] + } + ] + }, + { + "id": 56, + "name": "Product Categories", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries listed here are used to send requests to the [Store Product Category API Routes](https://docs.medusajs.com/api/store#product-categories_getproductcategories).\n\nProducts can be categoriezed into categories. A product can be associated more than one category.\n\nRelated Guide: [How to use product categories in a storefront](https://docs.medusajs.com/modules/products/storefront/use-categories)." + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "text", + "text": "product_categories" + } + ] + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 551, + "name": "useProductCategories", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 552, + "name": "useProductCategories", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of product categories. The product categories can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`handle`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " passed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. \nThe product categories can also be paginated. This hook can also be used to retrieve a product category by its handle." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list product categories:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useProductCategories } from \"medusa-react\"\n\nfunction Categories() {\n const { \n product_categories, \n isLoading,\n } = useProductCategories()\n\n return (\n
\n {isLoading && Loading...}\n {product_categories && !product_categories.length && (\n No Categories\n )}\n {product_categories && product_categories.length > 0 && (\n
    \n {product_categories.map(\n (category) => (\n
  • {category.name}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default Categories\n```" + }, + { + "kind": "text", + "text": "\n\nTo retrieve a product category by its handle:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useProductCategories } from \"medusa-react\"\n\nfunction Categories(\n handle: string\n) {\n const { \n product_categories, \n isLoading,\n } = useProductCategories({\n handle\n })\n\n return (\n
\n {isLoading && Loading...}\n {product_categories && !product_categories.length && (\n No Categories\n )}\n {product_categories && product_categories.length > 0 && (\n
    \n {product_categories.map(\n (category) => (\n
  • {category.name}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default Categories\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the product categories:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useProductCategories } from \"medusa-react\"\n\nfunction Categories(\n handle: string\n) {\n const { \n product_categories, \n isLoading,\n } = useProductCategories({\n handle,\n expand: \"products\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {product_categories && !product_categories.length && (\n No Categories\n )}\n {product_categories && product_categories.length > 0 && (\n
    \n {product_categories.map(\n (category) => (\n
  • {category.name}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default Categories\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`100`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport { useProductCategories } from \"medusa-react\"\n\nfunction Categories(\n handle: string\n) {\n const { \n product_categories,\n limit,\n offset, \n isLoading,\n } = useProductCategories({\n handle,\n expand: \"products\",\n limit: 50,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {product_categories && !product_categories.length && (\n No Categories\n )}\n {product_categories && product_categories.length > 0 && (\n
    \n {product_categories.map(\n (category) => (\n
  • {category.name}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default Categories\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 553, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved product categories." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-categories/list-product-categories.d.ts", + "qualifiedName": "StoreGetProductCategoriesParams" + }, + "name": "StoreGetProductCategoriesParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 554, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-categories/index.d.ts", + "qualifiedName": "StoreGetProductCategoriesRes" + }, + "name": "StoreGetProductCategoriesRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "product_categories" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 555, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 556, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 556 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 557, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 560, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 558, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 559, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 561, + "name": "product_categories", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 562, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 560, + 558, + 559, + 561, + 562 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 563, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 566, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 564, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 565, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 567, + "name": "product_categories", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 568, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 566, + 564, + 565, + 567, + 568 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 569, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 572, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 570, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 571, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 573, + "name": "product_categories", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 574, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 572, + 570, + 571, + 573, + 574 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 575, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 578, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 576, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 577, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 579, + "name": "product_categories", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 580, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 578, + 576, + 577, + 579, + 580 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 581, + "name": "useProductCategory", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 582, + "name": "useProductCategory", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a Product Category's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "A simple example that retrieves a product category by its ID:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useProductCategory } from \"medusa-react\"\n\ntype Props = {\n categoryId: string\n}\n\nconst Category = ({ categoryId }: Props) => {\n const { product_category, isLoading } = useProductCategory(\n categoryId\n )\n\n return (\n
\n {isLoading && Loading...}\n {product_category && {product_category.name}}\n
\n )\n}\n\nexport default Category\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useProductCategory } from \"medusa-react\"\n\ntype Props = {\n categoryId: string\n}\n\nconst Category = ({ categoryId }: Props) => {\n const { product_category, isLoading } = useProductCategory(\n categoryId,\n {\n expand: \"products\"\n }\n )\n\n return (\n
\n {isLoading && Loading...}\n {product_category && {product_category.name}}\n
\n )\n}\n\nexport default Category\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 583, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product category's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 584, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configurations to apply on the retrieved product categories." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-categories/get-product-category.d.ts", + "qualifiedName": "StoreGetProductCategoriesCategoryParams" + }, + "name": "StoreGetProductCategoriesCategoryParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 585, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-categories/index.d.ts", + "qualifiedName": "StoreGetProductCategoriesCategoryRes" + }, + "name": "StoreGetProductCategoriesCategoryRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "product_categories" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 586, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 587, + "name": "product_category", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + }, + { + "id": 588, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 587, + 588 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 589, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 590, + "name": "product_category", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + }, + { + "id": 591, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 590, + 591 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 592, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 593, + "name": "product_category", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + }, + { + "id": 594, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 593, + 594 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 595, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 596, + "name": "product_category", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-category.d.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + }, + { + "id": 597, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 596, + 597 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 551, + 581 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 551, + 581 + ] + } + ] + }, + { + "id": 49, + "name": "Product Collections", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries listed here are used to send requests to the [Store Product Collection API Routes](https://docs.medusajs.com/api/store#product-collections).\n\nA product collection is used to organize products for different purposes such as marketing or discount purposes. For example, you can create a Summer Collection.\nUsing the methods in this class, you can list or retrieve a collection's details and products." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 244, + "name": "useCollection", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 245, + "name": "useCollection", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a product collection's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCollection } from \"medusa-react\"\n\ntype Props = {\n collectionId: string\n}\n\nconst ProductCollection = ({ collectionId }: Props) => {\n const { collection, isLoading } = useCollection(collectionId)\n\n return (\n
\n {isLoading && Loading...}\n {collection && {collection.title}}\n
\n )\n}\n\nexport default ProductCollection\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 246, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 247, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/collections/index.d.ts", + "qualifiedName": "StoreCollectionsRes" + }, + "name": "StoreCollectionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "collections" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 248, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 249, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 250, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 249, + 250 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 251, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 252, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 253, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 252, + 253 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 254, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 255, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 256, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 255, + 256 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 257, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 258, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + }, + { + "id": 259, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 258, + 259 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 260, + "name": "useCollections", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 261, + "name": "useCollections", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of product collections. The product collections can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`handle`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " passed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. \nThe product collections can also be paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list product collections:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useCollections } from \"medusa-react\"\n\nconst ProductCollections = () => {\n const { collections, isLoading } = useCollections()\n\n return (\n
\n {isLoading && Loading...}\n {collections && collections.length === 0 && (\n No Product Collections\n )}\n {collections && collections.length > 0 && (\n
    \n {collections.map((collection) => (\n
  • {collection.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default ProductCollections\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`10`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useCollections } from \"medusa-react\"\n\nconst ProductCollections = () => {\n const { \n collections, \n limit,\n offset,\n isLoading\n } = useCollections({\n limit: 20,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {collections && collections.length === 0 && (\n No Product Collections\n )}\n {collections && collections.length > 0 && (\n
    \n {collections.map((collection) => (\n
  • {collection.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default ProductCollections\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 262, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved product collections." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/collections/list-collections.d.ts", + "qualifiedName": "StoreGetCollectionsParams" + }, + "name": "StoreGetCollectionsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 263, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/collections/index.d.ts", + "qualifiedName": "StoreCollectionsListRes" + }, + "name": "StoreCollectionsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "collections" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 264, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 265, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 265 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 266, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 270, + "name": "collections", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 269, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 267, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 268, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 271, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 270, + 269, + 267, + 268, + 271 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 272, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 276, + "name": "collections", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 275, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 273, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 274, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 277, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 276, + 275, + 273, + 274, + 277 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 278, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 282, + "name": "collections", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 281, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 279, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 280, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 283, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 282, + 281, + 279, + 280, + 283 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 284, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 288, + "name": "collections", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-collection.d.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 287, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 285, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 286, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 289, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 288, + 287, + 285, + 286, + 289 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 244, + 260 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 244, + 260 + ] + } + ] + }, + { + "id": 57, + "name": "Product Tags", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries listed here are used to send requests to the [Store Product Tag API Routes](https://docs.medusajs.com/api/store#product-tags).\n\nProduct tags are string values that can be used to filter products by.\nProducts can have more than one tag, and products can share tags." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 599, + "name": "useProductTags", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 600, + "name": "useProductTags", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of product tags. The product tags can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " \npassed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The product tags can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list product tags:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useProductTags } from \"medusa-react\"\n\nfunction Tags() {\n const { \n product_tags, \n isLoading,\n } = useProductTags()\n\n return (\n
\n {isLoading && Loading...}\n {product_tags && !product_tags.length && (\n No Product Tags\n )}\n {product_tags && product_tags.length > 0 && (\n
    \n {product_tags.map(\n (tag) => (\n
  • {tag.value}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default Tags\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`20`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useProductTags } from \"medusa-react\"\n\nfunction Tags() {\n const { \n product_tags, \n limit,\n offset,\n isLoading,\n } = useProductTags({\n limit: 10,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {product_tags && !product_tags.length && (\n No Product Tags\n )}\n {product_tags && product_tags.length > 0 && (\n
    \n {product_tags.map(\n (tag) => (\n
  • {tag.value}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default Tags\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 601, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved product tags." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-tags/list-product-tags.d.ts", + "qualifiedName": "StoreGetProductTagsParams" + }, + "name": "StoreGetProductTagsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 602, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-tags/index.d.ts", + "qualifiedName": "StoreProductTagsListRes" + }, + "name": "StoreProductTagsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "product_tags" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 603, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 604, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 604 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 605, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 608, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 606, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 607, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 609, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-tag.d.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 610, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 608, + 606, + 607, + 609, + 610 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 611, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 614, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 612, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 613, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 615, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-tag.d.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 616, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 614, + 612, + 613, + 615, + 616 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 617, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 620, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 618, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 619, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 621, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-tag.d.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 622, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 620, + 618, + 619, + 621, + 622 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 623, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 626, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 624, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 625, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 627, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-tag.d.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 628, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 626, + 624, + 625, + 627, + 628 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 599 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 599 + ] + } + ] + }, + { + "id": 58, + "name": "Product Types", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries listed here are used to send requests to the [Store Product Type API Routes](https://docs.medusajs.com/api/store#product-types).\n\nProduct types are string values that can be used to filter products by.\nProducts can have more than one tag, and products can share types." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 630, + "name": "useProductTypes", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 631, + "name": "useProductTypes", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of product types. The product types can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " passed \nin the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The product types can also be sorted or paginated." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list product types:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useProductTypes } from \"medusa-react\"\n\nfunction Types() {\n const { \n product_types, \n isLoading,\n } = useProductTypes()\n\n return (\n
\n {isLoading && Loading...}\n {product_types && !product_types.length && (\n No Product Types\n )}\n {product_types && product_types.length > 0 && (\n
    \n {product_types.map(\n (type) => (\n
  • {type.value}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default Types\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`20`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useProductTypes } from \"medusa-react\"\n\nfunction Types() {\n const { \n product_types,\n limit,\n offset, \n isLoading,\n } = useProductTypes({\n limit: 10,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {product_types && !product_types.length && (\n No Product Types\n )}\n {product_types && product_types.length > 0 && (\n
    \n {product_types.map(\n (type) => (\n
  • {type.value}
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default Types\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 632, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on retrieved product types." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts", + "qualifiedName": "StoreGetProductTypesParams" + }, + "name": "StoreGetProductTypesParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 633, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-types/index.d.ts", + "qualifiedName": "StoreProductTypesListRes" + }, + "name": "StoreProductTypesListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "product_types" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 634, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 635, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 635 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 636, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 639, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 637, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 638, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 640, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-type.d.ts", + "qualifiedName": "ProductType" + }, + "name": "ProductType", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 641, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 639, + 637, + 638, + 640, + 641 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 642, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 645, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 643, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 644, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 646, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-type.d.ts", + "qualifiedName": "ProductType" + }, + "name": "ProductType", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 647, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 645, + 643, + 644, + 646, + 647 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 648, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 651, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 649, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 650, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 652, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-type.d.ts", + "qualifiedName": "ProductType" + }, + "name": "ProductType", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 653, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 651, + 649, + 650, + 652, + 653 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 654, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 657, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 655, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 656, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 658, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-type.d.ts", + "qualifiedName": "ProductType" + }, + "name": "ProductType", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 659, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 657, + 655, + 656, + 658, + 659 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 630 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 630 + ] + } + ] + }, + { + "id": 59, + "name": "Products", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries listed here are used to send requests to the [Store Product API Routes](https://docs.medusajs.com/api/store#products).\n\nProducts are saleable items in a store. This also includes [saleable gift cards](https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards) in a store.\nUsing the methods in this class, you can filter products by categories, collections, sales channels, and more.\n\nRelated Guide: [How to show products in a storefront](https://docs.medusajs.com/modules/products/storefront/show-products)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 691, + "name": "useProduct", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 692, + "name": "useProduct", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a Product's details. For accurate and correct pricing of the product based on the customer's context, it's highly recommended to pass fields such as\n" + }, + { + "kind": "code", + "text": "`region_id`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`currency_code`" + }, + { + "kind": "text", + "text": ", and " + }, + { + "kind": "code", + "text": "`cart_id`" + }, + { + "kind": "text", + "text": " when available.\n\nPassing " + }, + { + "kind": "code", + "text": "`sales_channel_id`" + }, + { + "kind": "text", + "text": " ensures retrieving only products available in the current sales channel.\nYou can alternatively use a publishable API key in the request header instead of passing a " + }, + { + "kind": "code", + "text": "`sales_channel_id`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useProduct } from \"medusa-react\"\n\ntype Props = {\n productId: string\n}\n\nconst Product = ({ productId }: Props) => {\n const { product, isLoading } = useProduct(productId)\n\n return (\n
\n {isLoading && Loading...}\n {product && {product.title}}\n
\n )\n}\n\nexport default Product\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 693, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 694, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/index.d.ts", + "qualifiedName": "StoreProductsRes" + }, + "name": "StoreProductsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "products" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 695, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 696, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + }, + { + "id": 697, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 696, + 697 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 698, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 699, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + }, + { + "id": 700, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 699, + 700 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 701, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 702, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + }, + { + "id": 703, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 702, + 703 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 704, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 705, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + }, + { + "id": 706, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 705, + 706 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 661, + "name": "useProducts", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 662, + "name": "useProducts", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of products. The products can be filtered by fields such as " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`q`" + }, + { + "kind": "text", + "text": " passed in the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter. The products can also be sorted or paginated.\nThis hook can also be used to retrieve a product by its handle.\n\nFor accurate and correct pricing of the products based on the customer's context, it's highly recommended to pass fields such as\n" + }, + { + "kind": "code", + "text": "`region_id`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`currency_code`" + }, + { + "kind": "text", + "text": ", and " + }, + { + "kind": "code", + "text": "`cart_id`" + }, + { + "kind": "text", + "text": " when available.\n\nPassing " + }, + { + "kind": "code", + "text": "`sales_channel_id`" + }, + { + "kind": "text", + "text": " ensures retrieving only products available in the specified sales channel.\nYou can alternatively use a publishable API key in the request header instead of passing a " + }, + { + "kind": "code", + "text": "`sales_channel_id`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To list products:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useProducts } from \"medusa-react\"\n\nconst Products = () => {\n const { products, isLoading } = useProducts()\n\n return (\n
\n {isLoading && Loading...}\n {products && !products.length && No Products}\n {products && products.length > 0 && (\n
    \n {products.map((product) => (\n
  • {product.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Products\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify relations that should be retrieved within the products:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useProducts } from \"medusa-react\"\n\nconst Products = () => {\n const { products, isLoading } = useProducts({\n expand: \"variants\"\n })\n\n return (\n
\n {isLoading && Loading...}\n {products && !products.length && No Products}\n {products && products.length > 0 && (\n
    \n {products.map((product) => (\n
  • {product.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Products\n```" + }, + { + "kind": "text", + "text": "\n\nBy default, only the first " + }, + { + "kind": "code", + "text": "`100`" + }, + { + "kind": "text", + "text": " records are retrieved. You can control pagination by specifying the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " properties:\n\n" + }, + { + "kind": "code", + "text": "```tsx\nimport React from \"react\"\nimport { useProducts } from \"medusa-react\"\n\nconst Products = () => {\n const { \n products,\n limit,\n offset, \n isLoading\n } = useProducts({\n expand: \"variants\",\n limit: 50,\n offset: 0\n })\n\n return (\n
\n {isLoading && Loading...}\n {products && !products.length && No Products}\n {products && products.length > 0 && (\n
    \n {products.map((product) => (\n
  • {product.title}
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Products\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 663, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations to apply on the retrieved products." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/list-products.d.ts", + "qualifiedName": "StoreGetProductsParams" + }, + "name": "StoreGetProductsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 664, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/index.d.ts", + "qualifiedName": "StoreProductsListRes" + }, + "name": "StoreProductsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "products" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 665, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 666, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/list-products.d.ts", + "qualifiedName": "StoreGetProductsParams" + }, + "name": "StoreGetProductsParams", + "package": "@medusajs/medusa" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 666 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 667, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 670, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 668, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 669, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 671, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 672, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 670, + 668, + 669, + 671, + 672 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 673, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 676, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 674, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 675, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 677, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 678, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 676, + 674, + 675, + 677, + 678 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 679, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 682, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 680, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 681, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 683, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 684, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 682, + 680, + 681, + 683, + 684 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 685, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 688, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 686, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 687, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 689, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedProduct" + }, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 690, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 688, + 686, + 687, + 689, + 690 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 691, + 661 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 661, + 691 + ] + } + ] + }, + { + "id": 60, + "name": "Regions", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries listed here are used to send requests to the [Store Region API Routes](https://docs.medusajs.com/api/store#regions_getregions).\n\nRegions are different countries or geographical regions that the commerce store serves customers in.\nCustomers can choose what region they're in, which can be used to change the prices shown based on the region and its currency.\n\nRelated Guide: [How to use regions in a storefront](https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 734, + "name": "useRegion", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 735, + "name": "useRegion", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a Region's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useRegion } from \"medusa-react\"\n\ntype Props = {\n regionId: string\n}\n\nconst Region = ({ regionId }: Props) => {\n const { region, isLoading } = useRegion(\n regionId\n )\n\n return (\n
\n {isLoading && Loading...}\n {region && {region.name}}\n
\n )\n}\n\nexport default Region\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 736, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 737, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/regions/index.d.ts", + "qualifiedName": "StoreRegionsRes" + }, + "name": "StoreRegionsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "regions" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 738, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 739, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + }, + { + "id": 740, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 739, + 740 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 741, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 742, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + }, + { + "id": 743, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 742, + 743 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 744, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 745, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + }, + { + "id": 746, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 745, + 746 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 747, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 748, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + }, + { + "id": 749, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 748, + 749 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 707, + "name": "useRegions", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 708, + "name": "useRegions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of regions. This hook is useful to show the customer all available regions to choose from." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useRegions } from \"medusa-react\"\n\nconst Regions = () => {\n const { regions, isLoading } = useRegions()\n\n return (\n
\n {isLoading && Loading...}\n {regions?.length && (\n
    \n {regions.map((region) => (\n
  • \n {region.name}\n
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default Regions\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 709, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/regions/index.d.ts", + "qualifiedName": "StoreRegionsListRes" + }, + "name": "StoreRegionsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "regions" + }, + { + "type": "literal", + "value": "list" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 710, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 713, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 711, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 712, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 714, + "name": "regions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 715, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 713, + 711, + 712, + 714, + 715 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 716, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 719, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 717, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 718, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 720, + "name": "regions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 721, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 719, + 717, + 718, + 720, + 721 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 722, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 725, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 723, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 724, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 726, + "name": "regions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 727, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 725, + 723, + 724, + 726, + 727 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 728, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 731, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 729, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 730, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 732, + "name": "regions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 733, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 731, + 729, + 730, + 732, + 733 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 734, + 707 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 707, + 734 + ] + } + ] + }, + { + "id": 61, + "name": "Return Reasons", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries listed here are used to send requests to the [Store Return Reason API Routes](https://docs.medusajs.com/api/store#return-reasons).\n\nReturn reasons are key-value pairs that are used to specify why an order return is being created." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 765, + "name": "useReturnReason", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 766, + "name": "useReturnReason", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a Return Reason's details." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useReturnReason } from \"medusa-react\"\n\ntype Props = {\n returnReasonId: string\n}\n\nconst ReturnReason = ({ returnReasonId }: Props) => {\n const { \n return_reason, \n isLoading\n } = useReturnReason(\n returnReasonId\n )\n\n return (\n
\n {isLoading && Loading...}\n {return_reason && {return_reason.label}}\n
\n )\n}\n\nexport default ReturnReason\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 767, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return reason's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 768, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/return-reasons/index.d.ts", + "qualifiedName": "StoreReturnReasonsRes" + }, + "name": "StoreReturnReasonsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "return_reasons" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 769, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 771, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 770, + "name": "return_reason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 771, + 770 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 772, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 774, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 773, + "name": "return_reason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 774, + 773 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 775, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 777, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 776, + "name": "return_reason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 777, + 776 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 778, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 780, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 779, + "name": "return_reason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 780, + 779 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 750, + "name": "useReturnReasons", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 751, + "name": "useReturnReasons", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of Return Reasons. This is useful when implementing a Create Return flow in the storefront." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useReturnReasons } from \"medusa-react\"\n\nconst ReturnReasons = () => {\n const { \n return_reasons, \n isLoading\n } = useReturnReasons()\n\n return (\n
\n {isLoading && Loading...}\n {return_reasons?.length && (\n
    \n {return_reasons.map((returnReason) => (\n
  • \n {returnReason.label}\n
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default ReturnReasons\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 752, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/return-reasons/index.d.ts", + "qualifiedName": "StoreReturnReasonsListRes" + }, + "name": "StoreReturnReasonsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "return_reasons" + }, + { + "type": "literal", + "value": "list" + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 753, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 755, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 754, + "name": "return_reasons", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 755, + 754 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 756, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 758, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 757, + "name": "return_reasons", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 758, + 757 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 759, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 761, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 760, + "name": "return_reasons", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 761, + 760 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 762, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 764, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 763, + "name": "return_reasons", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/return-reason.d.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 764, + 763 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 765, + 750 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 750, + 765 + ] + } + ] + }, + { + "id": 62, + "name": "Returns", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Mutations listed here are used to send requests to the [Store Return API Routes](https://docs.medusajs.com/api/store#returns).\n\nA return can be created by a customer to return items in an order.\n\nRelated Guide: [How to create a return in a storefront](https://docs.medusajs.com/modules/orders/storefront/create-return)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 781, + "name": "useCreateReturn", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 782, + "name": "useCreateReturn", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a return for an order. If a return shipping method is specified, the return is automatically fulfilled." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCreateReturn } from \"medusa-react\"\n\ntype CreateReturnData = {\n items: {\n item_id: string,\n quantity: number\n }[]\n return_shipping: {\n option_id: string\n }\n}\n\ntype Props = {\n orderId: string\n}\n\nconst CreateReturn = ({ orderId }: Props) => {\n const createReturn = useCreateReturn()\n // ...\n\n const handleCreate = (data: CreateReturnData) => {\n createReturn.mutate({\n ...data,\n order_id: orderId\n }, {\n onSuccess: ({ return: returnData }) => {\n console.log(returnData.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateReturn\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 783, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/returns/index.d.ts", + "qualifiedName": "StoreReturnsRes" + }, + "name": "StoreReturnsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/returns/create-return.d.ts", + "qualifiedName": "StorePostReturnsReq" + }, + "name": "StorePostReturnsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/returns/index.d.ts", + "qualifiedName": "StoreReturnsRes" + }, + "name": "StoreReturnsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/returns/create-return.d.ts", + "qualifiedName": "StorePostReturnsReq" + }, + "name": "StorePostReturnsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 781 + ] + } + ], + "categories": [ + { + "title": "Mutations", + "children": [ + 781 + ] + } + ] + }, + { + "id": 63, + "name": "Shipping Options", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries listed here are used to send requests to the [Store Shipping Option API Routes](https://docs.medusajs.com/api/store#shipping-options).\n\nA shipping option is used to define the available shipping methods during checkout or when creating a return.\n\nRelated Guide: [Shipping Option architecture](https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option)." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 802, + "name": "useCartShippingOptions", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 803, + "name": "useCartShippingOptions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of shipping options available for a cart." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCartShippingOptions } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst ShippingOptions = ({ cartId }: Props) => {\n const { shipping_options, isLoading } =\n useCartShippingOptions(cartId)\n\n return (\n
\n {isLoading && Loading...}\n {shipping_options && !shipping_options.length && (\n No shipping options\n )}\n {shipping_options && (\n
    \n {shipping_options.map(\n (shipping_option) => (\n
  • \n {shipping_option.name}\n
    • \n )\n )}\n
\n )}\n
\n )\n}\n\nexport default ShippingOptions\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 804, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 805, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/shipping-options/index.d.ts", + "qualifiedName": "StoreShippingOptionsListRes" + }, + "name": "StoreShippingOptionsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "shipping_options" + }, + { + "type": "literal", + "value": "cart" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 806, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 808, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 807, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedShippingOption" + }, + "name": "PricedShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 808, + 807 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 809, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 811, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 810, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedShippingOption" + }, + "name": "PricedShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 811, + 810 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 812, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 814, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 813, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedShippingOption" + }, + "name": "PricedShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 814, + 813 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 815, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 817, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 816, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedShippingOption" + }, + "name": "PricedShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 817, + 816 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 784, + "name": "useShippingOptions", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 785, + "name": "useShippingOptions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a list of shipping options. The shipping options can be filtered using the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " parameter." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useShippingOptions } from \"medusa-react\"\n\nconst ShippingOptions = () => {\n const { \n shipping_options, \n isLoading, \n } = useShippingOptions()\n\n return (\n
\n {isLoading && Loading...}\n {shipping_options?.length && \n shipping_options?.length > 0 && (\n
    \n {shipping_options?.map((shipping_option) => (\n
  • \n {shipping_option.id}\n
    • \n ))}\n
\n )}\n
\n )\n}\n\nexport default ShippingOptions\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 786, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filters to apply on the shipping options." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/shipping-options/list-options.d.ts", + "qualifiedName": "StoreGetShippingOptionsParams" + }, + "name": "StoreGetShippingOptionsParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 787, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/shipping-options/index.d.ts", + "qualifiedName": "StoreShippingOptionsListRes" + }, + "name": "StoreShippingOptionsListRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "shipping_options" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 788, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 789, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 789 + ] + } + ] + } + } + ] + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 790, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 792, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 791, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedShippingOption" + }, + "name": "PricedShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 792, + 791 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 793, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 795, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 794, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedShippingOption" + }, + "name": "PricedShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 795, + 794 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 796, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 798, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 797, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedShippingOption" + }, + "name": "PricedShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 798, + 797 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 799, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 801, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 800, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/pricing.d.ts", + "qualifiedName": "PricedShippingOption" + }, + "name": "PricedShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 801, + 800 + ] + } + ] + } + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 802, + 784 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 784, + 802 + ] + } + ] + }, + { + "id": 64, + "name": "Swaps", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Queries and Mutations listed here are used to send requests to the [Store Swap API Routes](https://docs.medusajs.com/api/store#swaps).\n\nA swap is created by a customer or an admin to exchange an item with a new one.\nCreating a swap implicitely includes creating a return for the item being exchanged.\n\nRelated Guide: [How to create a swap in a storefront](https://docs.medusajs.com/modules/orders/storefront/create-swap)" + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 818, + "name": "useCartSwap", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 819, + "name": "useCartSwap", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook retrieves a Swap's details by the ID of its cart." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCartSwap } from \"medusa-react\"\n\ntype Props = {\n cartId: string\n}\n\nconst Swap = ({ cartId }: Props) => {\n const { \n swap, \n isLoading, \n } = useCartSwap(cartId)\n\n return (\n
\n {isLoading && Loading...}\n {swap && {swap.id}}\n \n
\n )\n}\n\nexport default Swap\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Queries" + } + ] + } + ] + }, + "parameters": [ + { + "id": 820, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the swap's cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 821, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "UseQueryOptionsWrapper" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/swaps/index.d.ts", + "qualifiedName": "StoreSwapsRes" + }, + "name": "StoreSwapsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "swaps" + }, + { + "type": "literal", + "value": "cart" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "name": "UseQueryOptionsWrapper", + "package": "medusa-react" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 822, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 824, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 823, + "name": "swap", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/swap.d.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 824, + 823 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 825, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 827, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 826, + "name": "swap", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/swap.d.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 827, + 826 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 828, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 830, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 829, + "name": "swap", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/swap.d.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 830, + 829 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 831, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 833, + "name": "response", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "HTTPResponse" + }, + "name": "HTTPResponse", + "package": "@medusajs/medusa-js" + } + }, + { + "id": 832, + "name": "swap", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/swap.d.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 833, + 832 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 834, + "name": "useCreateSwap", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 835, + "name": "useCreateSwap", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook creates a Swap for an Order. This will also create a return and associate it with the swap. If a return shipping option is specified, the return will automatically be fulfilled.\nTo complete the swap, you must use the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useCompleteCart", + "target": 202 + }, + { + "kind": "text", + "text": " hook passing it the ID of the swap's cart.\n\nAn idempotency key will be generated if none is provided in the header " + }, + { + "kind": "code", + "text": "`Idempotency-Key`" + }, + { + "kind": "text", + "text": " and added to\nthe response. If an error occurs during swap creation or the request is interrupted for any reason, the swap creation can be retried by passing the idempotency\nkey in the " + }, + { + "kind": "code", + "text": "`Idempotency-Key`" + }, + { + "kind": "text", + "text": " header." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useCreateSwap } from \"medusa-react\"\n\ntype Props = {\n orderId: string\n}\n\ntype CreateData = {\n return_items: {\n item_id: string\n quantity: number\n }[]\n additional_items: {\n variant_id: string\n quantity: number\n }[]\n return_shipping_option: string\n}\n\nconst CreateSwap = ({\n orderId\n}: Props) => {\n const createSwap = useCreateSwap()\n // ...\n\n const handleCreate = (\n data: CreateData\n ) => {\n createSwap.mutate({\n ...data,\n order_id: orderId\n }, {\n onSuccess: ({ swap }) => {\n console.log(swap.id)\n }\n })\n }\n\n // ...\n}\n\nexport default CreateSwap\n```" + } + ] + }, + { + "tag": "@category", + "content": [ + { + "kind": "text", + "text": "Mutations" + } + ] + } + ] + }, + "parameters": [ + { + "id": 836, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/swaps/index.d.ts", + "qualifiedName": "StoreSwapsRes" + }, + "name": "StoreSwapsRes", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts", + "qualifiedName": "StorePostSwapsReq" + }, + "name": "StorePostSwapsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/swaps/index.d.ts", + "qualifiedName": "StoreSwapsRes" + }, + "name": "StoreSwapsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts", + "qualifiedName": "StorePostSwapsReq" + }, + "name": "StorePostSwapsReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 818, + 834 + ] + } + ], + "categories": [ + { + "title": "Queries", + "children": [ + 818 + ] + }, + { + "title": "Mutations", + "children": [ + 834 + ] + } + ] + } + ], + "groups": [ + { + "title": "Namespaces", + "children": [ + 48, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 49, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64 + ] + } + ] + } + ], + "groups": [ + { + "title": "Namespaces", + "children": [ + 7, + 47 + ] + } + ] + }, + { + "id": 1, + "name": "Providers", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": ":::info\n\nThis is an experimental feature.\n\n:::\n\n" + }, + { + "kind": "code", + "text": "`medusa-react`" + }, + { + "kind": "text", + "text": " exposes React Context Providers that facilitate building custom storefronts." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 2, + "name": "Cart", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 174, + "name": "CartProvider", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 175, + "name": "CartProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "code", + "text": "`CartProvider`" + }, + { + "kind": "text", + "text": " makes use of some of the hooks already exposed by " + }, + { + "kind": "code", + "text": "`medusa-react`" + }, + { + "kind": "text", + "text": " to perform cart operations on the Medusa backend. \nYou can use it to create a cart, start the checkout flow, authorize payment sessions, and so on.\n\nIt also manages one single global piece of state which represents a cart, exactly like the one created on your Medusa backend.\n\nTo use " + }, + { + "kind": "code", + "text": "`CartProvider`" + }, + { + "kind": "text", + "text": ", you first have to insert it somewhere in your component tree below the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "MedusaProvider", + "target": 77 + }, + { + "kind": "text", + "text": ". Then, in any of the child components, \nyou can use the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useCart", + "target": 169, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " hook exposed by " + }, + { + "kind": "code", + "text": "`medusa-react`" + }, + { + "kind": "text", + "text": " to get access to cart operations and data." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```tsx title=\"src/App.ts\"\nimport { CartProvider, MedusaProvider } from \"medusa-react\"\nimport Storefront from \"./Storefront\"\nimport { QueryClient } from \"@tanstack/react-query\"\nimport React from \"react\"\n\nconst queryClient = new QueryClient()\n\nfunction App() {\n return (\n \n \n \n \n \n )\n}\n\nexport default App\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 176, + "name": "param0", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Props of the provider." + } + ] + }, + "type": { + "type": "reference", + "target": 171, + "name": "CartProps", + "package": "medusa-react" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@types/react/index.d.ts", + "qualifiedName": "React.JSX.Element" + }, + "name": "Element", + "package": "@types/react", + "qualifiedName": "React.JSX.Element" + } + } + ] + }, + { + "id": 169, + "name": "useCart", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 170, + "name": "useCart", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook exposes the context of " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "CartProvider", + "target": 174, + "tsLinkText": "" + }, + { + "kind": "text", + "text": ".\n\nThe context provides helper functions and mutations for managing the cart and checkout. You can refer to the following guides for examples on how to use them:\n\n- [How to Add Cart Functionality](https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart)\n- [How to Implement Checkout Flow](https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-checkout-flow)" + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```tsx title=\"src/Cart.ts\"\nimport * as React from \"react\"\n\nimport { useCart } from \"medusa-react\"\n\nconst Cart = () => {\n const handleClick = () => {\n createCart.mutate({}) // create an empty cart\n }\n\n const { cart, createCart } = useCart()\n\n return (\n
\n {createCart.isLoading &&
Loading...
}\n {!cart?.id && (\n \n )}\n {cart?.id && (\n
Cart ID: {cart.id}
\n )}\n
\n )\n}\n\nexport default Cart\n```" + }, + { + "kind": "text", + "text": "\n\nIn the example above, you retrieve the " + }, + { + "kind": "code", + "text": "`createCart`" + }, + { + "kind": "text", + "text": " mutation and " + }, + { + "kind": "code", + "text": "`cart`" + }, + { + "kind": "text", + "text": " state object using the " + }, + { + "kind": "code", + "text": "`useCart`" + }, + { + "kind": "text", + "text": " hook. \nIf the " + }, + { + "kind": "code", + "text": "`cart`" + }, + { + "kind": "text", + "text": " is not set, a button is shown. When the button is clicked, the " + }, + { + "kind": "code", + "text": "`createCart`" + }, + { + "kind": "text", + "text": " mutation is executed, which interacts with the backend and creates a new cart.\n\nAfter the cart is created, the " + }, + { + "kind": "code", + "text": "`cart`" + }, + { + "kind": "text", + "text": " state variable is set and its ID is shown instead of the button.\n\n:::note\n\nThe example above does not store in the browser the ID of the cart created, so the cart’s data will be gone on refresh. \nYou would have to do that using the browser’s [Local Storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).\n\n:::" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": 156, + "name": "CartContext", + "package": "medusa-react" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 174, + 169 + ] + } + ] + }, + { + "id": 3, + "name": "Medusa", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 77, + "name": "MedusaProvider", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 78, + "name": "MedusaProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`MedusaProvider`" + }, + { + "kind": "text", + "text": " must be used at the highest possible point in the React component tree. Using any of " + }, + { + "kind": "code", + "text": "`medusa-react`" + }, + { + "kind": "text", + "text": "'s hooks or providers requires having " + }, + { + "kind": "code", + "text": "`MedusaProvider`" + }, + { + "kind": "text", + "text": "\nhigher in the component tree." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```tsx title=\"src/App.ts\"\nimport { MedusaProvider } from \"medusa-react\"\nimport Storefront from \"./Storefront\"\nimport { QueryClient } from \"@tanstack/react-query\"\nimport React from \"react\"\n\nconst queryClient = new QueryClient()\n\nconst App = () => {\n return (\n \n \n \n )\n}\n\nexport default App\n```" + }, + { + "kind": "text", + "text": "\n\nIn the example above, you wrap the " + }, + { + "kind": "code", + "text": "`Storefront`" + }, + { + "kind": "text", + "text": " component with the " + }, + { + "kind": "code", + "text": "`MedusaProvider`" + }, + { + "kind": "text", + "text": ". " + }, + { + "kind": "code", + "text": "`Storefront`" + }, + { + "kind": "text", + "text": " is assumed to be the top-level component of your storefront, but you can place " + }, + { + "kind": "code", + "text": "`MedusaProvider`" + }, + { + "kind": "text", + "text": " at any point in your tree. Only children of " + }, + { + "kind": "code", + "text": "`MedusaProvider`" + }, + { + "kind": "text", + "text": " can benefit from its hooks.\n\nThe " + }, + { + "kind": "code", + "text": "`Storefront`" + }, + { + "kind": "text", + "text": " component and its child components can now use hooks exposed by Medusa React." + } + ] + } + ] + }, + "parameters": [ + { + "id": 79, + "name": "param0", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Props of the provider." + } + ] + }, + "type": { + "type": "reference", + "target": 69, + "name": "MedusaProviderProps", + "package": "medusa-react" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@types/react/index.d.ts", + "qualifiedName": "React.JSX.Element" + }, + "name": "Element", + "package": "@types/react", + "qualifiedName": "React.JSX.Element" + } + } + ] + }, + { + "id": 67, + "name": "useMedusa", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 68, + "name": "useMedusa", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook gives you access to context of " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "MedusaProvider", + "target": 77, + "tsLinkText": "" + }, + { + "kind": "text", + "text": ". It's useful if you want access to the \n[Medusa JS Client](https://docs.medusajs.com/js-client/overview)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useMeCustomer, useMedusa } from \"medusa-react\"\n\nconst CustomerLogin = () => {\n const { client } = useMedusa()\n const { refetch: refetchCustomer } = useMeCustomer()\n // ...\n\n const handleLogin = (\n email: string,\n password: string\n ) => {\n client.auth.authenticate({\n email,\n password\n })\n .then(() => {\n // customer is logged-in successfully\n refetchCustomer()\n })\n .catch(() => {\n // an error occurred.\n })\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": 65, + "name": "MedusaContextState", + "package": "medusa-react" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 77, + 67 + ] + } + ] + }, + { + "id": 4, + "name": "Session Cart", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 151, + "name": "SessionCartProvider", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 152, + "name": "SessionCartProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unlike the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "CartProvider", + "target": 174 + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`SessionProvider`" + }, + { + "kind": "text", + "text": " never interacts with the Medusa backend. It can be used to implement the user experience related to managing a cart’s items. \nIts state variables are JavaScript objects living in the browser, but are in no way communicated with the backend.\n\nYou can use the " + }, + { + "kind": "code", + "text": "`SessionProvider`" + }, + { + "kind": "text", + "text": " as a lightweight client-side cart functionality. It’s not stored in any database or on the Medusa backend.\n\nTo use " + }, + { + "kind": "code", + "text": "`SessionProvider`" + }, + { + "kind": "text", + "text": ", you first have to insert it somewhere in your component tree below the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "MedusaProvider", + "target": 77 + }, + { + "kind": "text", + "text": ". Then, in any of the child components, \nyou can use the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useSessionCart", + "target": 154, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " hook to get access to client-side cart item functionalities." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```tsx title=\"src/App.ts\"\nimport { SessionProvider, MedusaProvider } from \"medusa-react\"\nimport Storefront from \"./Storefront\"\nimport { QueryClient } from \"@tanstack/react-query\"\nimport React from \"react\"\n\nconst queryClient = new QueryClient()\n\nconst App = () => {\n return (\n \n \n \n \n \n )\n}\n\nexport default App\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 153, + "name": "param0", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Props of the provider." + } + ] + }, + "type": { + "type": "reference", + "target": 148, + "name": "SessionCartProviderProps", + "package": "medusa-react" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@types/react/index.d.ts", + "qualifiedName": "React.JSX.Element" + }, + "name": "Element", + "package": "@types/react", + "qualifiedName": "React.JSX.Element" + } + } + ] + }, + { + "id": 154, + "name": "useSessionCart", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 155, + "name": "useSessionCart", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This hook exposes the context of " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "SessionCartProvider", + "target": 151, + "tsLinkText": "" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "The following example assumes that you've added " + }, + { + "kind": "code", + "text": "`SessionCartProvider`" + }, + { + "kind": "text", + "text": " previously in the React components tree:\n\n" + }, + { + "kind": "code", + "text": "```tsx title=\"src/Products.ts\"\nconst Products = () => {\n const { addItem } = useSessionCart()\n // ...\n\n function addToCart(variant: ProductVariant) {\n addItem({\n variant: variant,\n quantity: 1,\n })\n }\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": 89, + "name": "SessionCartContextState", + "package": "medusa-react" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 151, + 154 + ] + } + ] + } + ], + "groups": [ + { + "title": "Namespaces", + "children": [ + 2, + 3, + 4 + ] + } + ] + }, + { + "id": 5, + "name": "Utilities", + "variant": "declaration", + "kind": 4, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "code", + "text": "`medusa-react`" + }, + { + "kind": "text", + "text": " exposes a set of utility functions that are mainly used to retrieve or format the price of a product variant." + } + ], + "modifierTags": [ + "@packageDocumentation" + ] + }, + "children": [ + { + "id": 3389, + "name": "computeAmount", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3390, + "name": "computeAmount", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This utility function can be used to compute the price of an amount for a region and retrieve the amount without formatting. For example, " + }, + { + "kind": "code", + "text": "`20`" + }, + { + "kind": "text", + "text": ".\nThis function is used by " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "formatAmount", + "target": 3400, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " before applying the price formatting.\n\nThe main difference between this utility function and " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "computeVariantPrice", + "target": 3377, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " is that you don’t need to pass a complete variant object. This can be used with any number." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The computed amount." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```tsx title=\"src/MyComponent.ts\"\nimport React from \"react\"\nimport { computeAmount } from \"medusa-react\"\n\nconst MyComponent = () => {\n // ...\n return (\n
\n {computeAmount({\n amount,\n region, // should be retrieved earlier\n })}\n
\n )\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3391, + "name": "params0", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The options to compute the amount." + } + ] + }, + "type": { + "type": "reference", + "target": 3384, + "name": "ComputeAmountParams", + "package": "medusa-react" + } + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ] + }, + { + "id": 3377, + "name": "computeVariantPrice", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3378, + "name": "computeVariantPrice", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This utility function can be used to compute the price of a variant for a region and retrieve the amount without formatting. \nFor example, " + }, + { + "kind": "code", + "text": "`20`" + }, + { + "kind": "text", + "text": ". This method is used by " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "formatVariantPrice", + "target": 3370, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " before applying the price formatting." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The computed price of the variant." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```tsx title=\"src/Products.ts\"\nimport React from \"react\"\nimport { computeVariantPrice } from \"medusa-react\"\nimport { Product, ProductVariant } from \"@medusajs/medusa\"\n\nconst Products = () => {\n // ...\n return (\n
    \n {products?.map((product: Product) => (\n
  • \n {product.title}\n
      \n {product.variants.map((variant: ProductVariant) => (\n
    • \n {computeVariantPrice({\n variant,\n region, // should be retrieved earlier\n })}\n
      • \n ))}\n
    \n
    • \n ))}\n
\n )\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3379, + "name": "param0", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options to compute the variant's price." + } + ] + }, + "type": { + "type": "reference", + "target": 3373, + "name": "ComputeVariantPriceParams", + "package": "medusa-react" + } + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ] + }, + { + "id": 3400, + "name": "formatAmount", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3401, + "name": "formatAmount", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This utility function can be used to compute the price of an amount for a region and retrieve the formatted amount. For example, " + }, + { + "kind": "code", + "text": "`$20.00`" + }, + { + "kind": "text", + "text": ".\n\nThe main difference between this utility function and " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "formatVariantPrice", + "target": 3370, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " is that you don’t need to pass a complete variant object. This can be used with any number." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The formatted price." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { formatVariantPrice } from \"medusa-react\"\nimport { Product, ProductVariant } from \"@medusajs/medusa\"\n\nconst Products = () => {\n // ...\n return (\n
    \n {products?.map((product: Product) => (\n
  • \n {product.title}\n
      \n {product.variants.map((variant: ProductVariant) => (\n
    • \n {formatVariantPrice({\n variant,\n region, // should be retrieved earlier\n })}\n
      • \n ))}\n
    \n
    • \n ))}\n
\n )\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3402, + "name": "param0", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options to format the amount." + } + ] + }, + "type": { + "type": "reference", + "target": 3392, + "name": "FormatAmountParams", + "package": "medusa-react" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 3370, + "name": "formatVariantPrice", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3371, + "name": "formatVariantPrice", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This utility function can be used to compute the price of a variant for a region and retrieve the formatted amount. For example, " + }, + { + "kind": "code", + "text": "`$20.00`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The formatted price." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```tsx title=\"src/Products.ts\"\nimport React from \"react\"\nimport { formatVariantPrice } from \"medusa-react\"\nimport { Product, ProductVariant } from \"@medusajs/medusa\"\n\nconst Products = () => {\n // ...\n return (\n
    \n {products?.map((product: Product) => (\n
  • \n {product.title}\n
      \n {product.variants.map((variant: ProductVariant) => (\n
    • \n {formatVariantPrice({\n variant,\n region, // should be retrieved earlier\n })}\n
      • \n ))}\n
    \n
    • \n ))}\n
\n )\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3372, + "name": "param0", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options to format the variant's price." + } + ] + }, + "type": { + "type": "reference", + "target": 3363, + "name": "FormatVariantPriceParams", + "package": "medusa-react" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 3380, + "name": "getVariantPrice", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3381, + "name": "getVariantPrice", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This utility function is used to retrieve a variant's price in a region. It doesn't take into account taxes or any options, so you typically wouldn't need this function on its own.\nIt's used by the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "computeVariantPrice", + "target": 3377, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " function to retrieve the variant's price in a region before computing the correct price for the options provided." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The variant's price in a region." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```tsx title=\"src/Products.ts\"\nimport React from \"react\"\nimport { getVariantPrice } from \"medusa-react\"\nimport { Product, ProductVariant } from \"@medusajs/medusa\"\n\nconst Products = () => {\n // ...\n return (\n
    \n {products?.map((product: Product) => (\n
  • \n {product.title}\n
      \n {product.variants.map((variant: ProductVariant) => (\n
    • \n {getVariantPrice(\n variant,\n region, // should be retrieved earlier\n )}\n
      • \n ))}\n
    \n
    • \n ))}\n
\n )\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3382, + "name": "variant", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The variant's details." + } + ] + }, + "type": { + "type": "reference", + "target": 3403, + "name": "ProductVariantInfo", + "package": "medusa-react" + } + }, + { + "id": 3383, + "name": "region", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's details." + } + ] + }, + "type": { + "type": "reference", + "target": 3404, + "name": "RegionInfo", + "package": "medusa-react" + } + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 3389, + 3377, + 3400, + 3370, + 3380 + ] + } + ] + }, + { + "id": 156, + "name": "CartContext", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart context available if the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "CartProvider", + "target": 174, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " is used previously in the React components tree." + } + ] + }, + "children": [ + { + "id": 166, + "name": "addShippingMethod", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A mutation used to add a shipping method to the cart during checkout.\nUsing it is equivalent to using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useAddShippingMethodToCart", + "target": 229, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " mutation." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/add-shipping-method.d.ts", + "qualifiedName": "StorePostCartsCartShippingMethodReq" + }, + "name": "StorePostCartsCartShippingMethodReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + }, + { + "id": 168, + "name": "cart", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currently-used cart." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/cart.d.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" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "CartState.cart" + } + }, + { + "id": 164, + "name": "completeCheckout", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A mutation used to complete the cart and place the order.\nUsing it is equivalent to using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useCompleteCart", + "target": 202, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " mutation." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCompleteCartRes" + }, + "name": "StoreCompleteCartRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + }, + { + "id": 162, + "name": "createCart", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A mutation used to create a cart.\nUsing it is equivalent to using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useCreateCart", + "target": 195, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " mutation." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/create-cart.d.ts", + "qualifiedName": "StorePostCartReq" + }, + "name": "StorePostCartReq", + "package": "@medusajs/medusa" + } + ] + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + }, + { + "id": 161, + "name": "pay", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A mutation used to select a payment processor during checkout.\nUsing it is equivalent to using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useSetPaymentSession", + "target": 225, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " mutation." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/set-payment-session.d.ts", + "qualifiedName": "StorePostCartsCartPaymentSessionReq" + }, + "name": "StorePostCartsCartPaymentSessionReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + }, + { + "id": 157, + "name": "setCart", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 158, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 159, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A state function used to set the cart object." + } + ] + }, + "parameters": [ + { + "id": 160, + "name": "cart", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new value of the cart." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/cart.d.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" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 163, + "name": "startCheckout", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A mutation used to initialize payment sessions during checkout.\nUsing it is equivalent to using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useCreatePaymentSession", + "target": 206, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " mutation." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + }, + { + "id": 167, + "name": "totalItems", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items in the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 165, + "name": "updateCart", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A mutation used to update a cart’s details such as region, customer email, shipping address, and more.\nUsing it is equivalent to using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "useUpdateCart", + "target": 198, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " mutation." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "StoreCartsRes" + }, + "name": "StoreCartsRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/update-cart.d.ts", + "qualifiedName": "StorePostCartsCartReq" + }, + "name": "StorePostCartsCartReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 166, + 168, + 164, + 162, + 161, + 157, + 163, + 167, + 165 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartState" + }, + "name": "CartState", + "package": "medusa-react" + } + ] + }, + { + "id": 171, + "name": "CartProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 173, + "name": "initialState", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional initial value to be used for the cart." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/cart.d.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": [ + 173 + ] + } + ] + }, + { + "id": 3373, + "name": "ComputeVariantPriceParams", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options to format a variant's price." + } + ] + }, + "children": [ + { + "id": 3376, + "name": "includeTaxes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the computed price should include taxes or not." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\ntrue\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 3375, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A region's details." + } + ] + }, + "type": { + "type": "reference", + "target": 3404, + "name": "RegionInfo", + "package": "medusa-react" + } + }, + { + "id": 3374, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A variant's details." + } + ] + }, + "type": { + "type": "reference", + "target": 3403, + "name": "ProductVariantInfo", + "package": "medusa-react" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3376, + 3375, + 3374 + ] + } + ] + }, + { + "id": 3363, + "name": "FormatVariantPriceParams", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options to format a variant's price." + } + ] + }, + "children": [ + { + "id": 3366, + "name": "includeTaxes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the computed price should include taxes or not." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\ntrue\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 3369, + "name": "locale", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A BCP 47 language tag. The default value is " + }, + { + "kind": "code", + "text": "`en-US`" + }, + { + "kind": "text", + "text": ". This is passed as a first parameter to " + }, + { + "kind": "code", + "text": "`Intl.NumberFormat`" + }, + { + "kind": "text", + "text": " which is used within the utility method. \nYou can learn more about this method’s parameters in \n[MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters)." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3368, + "name": "maximumFractionDigits", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of fraction digits to use when formatting the price. This is passed as an option to " + }, + { + "kind": "code", + "text": "`Intl.NumberFormat`" + }, + { + "kind": "text", + "text": " which is used within the utility method.\nYou can learn more about this method’s options in \n[MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters)." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3367, + "name": "minimumFractionDigits", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum number of fraction digits to use when formatting the price. This is passed as an option to " + }, + { + "kind": "code", + "text": "`Intl.NumberFormat`" + }, + { + "kind": "text", + "text": " in the underlying layer. \nYou can learn more about this method’s options in \n[MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters)." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3365, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A region's details." + } + ] + }, + "type": { + "type": "reference", + "target": 3404, + "name": "RegionInfo", + "package": "medusa-react" + } + }, + { + "id": 3364, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A variant's details." + } + ] + }, + "type": { + "type": "reference", + "target": 3403, + "name": "ProductVariantInfo", + "package": "medusa-react" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3366, + 3369, + 3368, + 3367, + 3365, + 3364 + ] + } + ] + }, + { + "id": 80, + "name": "Item", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A session cart's item." + } + ] + }, + "children": [ + { + "id": 82, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity added in the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 83, + "name": "total", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total amount of the item in the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 81, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product variant represented by this item in the cart." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "ConvertDateToString" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/models/product-variant.d.ts", + "qualifiedName": "ProductVariant" + }, + "name": "ProductVariant", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "beforeInsert" + } + ], + "name": "Omit", + "package": "typescript" + } + ], + "name": "ConvertDateToString", + "package": "medusa-react" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 82, + 83, + 81 + ] + } + ] + }, + { + "id": 65, + "name": "MedusaContextState", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 66, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Medusa JS Client instance." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Medusa" + }, + "name": "Medusa", + "package": "@medusajs/medusa-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 66 + ] + } + ] + }, + { + "id": 69, + "name": "MedusaProviderProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 73, + "name": "apiKey", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "API key used for authenticating admin requests. Follow [this guide](https://docs.medusajs.com/api/admin#authentication) to learn how to create an API key for an admin user." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 70, + "name": "baseUrl", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL to your Medusa backend." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 76, + "name": "customHeaders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object of custom headers to pass with every request. Each key of the object is the name of the header, and its value is the header's value." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "`{}`" + } + ] + } + ] + }, + "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": 75, + "name": "maxRetries", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of times to retry a request if it fails." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n3\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 74, + "name": "publishableApiKey", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Publishable API key used for storefront requests. You can create a publishable API key either using the \n[admin APIs](https://docs.medusajs.com/development/publishable-api-keys/admin/manage-publishable-api-keys) or the \n[Medusa admin](https://docs.medusajs.com/user-guide/settings/publishable-api-keys#create-publishable-api-key)." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 71, + "name": "queryClientProviderProps", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to set the Tanstack Query client. The object requires a " + }, + { + "kind": "code", + "text": "`client`" + }, + { + "kind": "text", + "text": " property, \nwhich should be an instance of [QueryClient](https://tanstack.com/query/v4/docs/react/reference/QueryClient)." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/QueryClientProvider.d.ts", + "qualifiedName": "QueryClientProviderProps" + }, + "name": "QueryClientProviderProps", + "package": "@tanstack/react-query" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 73, + 70, + 76, + 75, + 74, + 71 + ] + } + ] + }, + { + "id": 89, + "name": "SessionCartContextState", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 94, + "name": "addItem", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 95, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 96, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This function adds an item to the session cart." + } + ] + }, + "parameters": [ + { + "id": 97, + "name": "item", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The item to add." + } + ] + }, + "type": { + "type": "reference", + "target": 80, + "name": "Item", + "package": "medusa-react" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 128, + "name": "clearItems", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 129, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 130, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Removes all items in the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 120, + "name": "decrementItemQuantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 121, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 122, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This function decrements the item's quantity in the cart." + } + ] + }, + "parameters": [ + { + "id": 123, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 124, + "name": "getItem", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 125, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 126, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This function retrieves an item's details by its ID." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The item in the cart, if found." + } + ] + } + ] + }, + "parameters": [ + { + "id": 127, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": 80, + "name": "Item", + "package": "medusa-react" + } + ] + } + } + ] + } + } + }, + { + "id": 116, + "name": "incrementItemQuantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 117, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 118, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This function increments the item's quantity in the cart." + } + ] + }, + "parameters": [ + { + "id": 119, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 132, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The items in the cart." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 80, + "name": "Item", + "package": "medusa-react" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 86, + "name": "SessionCartState.items" + } + }, + { + "id": 131, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region of the cart." + } + ] + }, + "type": { + "type": "reference", + "target": 3404, + "name": "RegionInfo", + "package": "medusa-react" + }, + "inheritedFrom": { + "type": "reference", + "target": 85, + "name": "SessionCartState.region" + } + }, + { + "id": 98, + "name": "removeItem", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 99, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 100, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This function removes an item from the session cart." + } + ] + }, + "parameters": [ + { + "id": 101, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 107, + "name": "setItems", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 108, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 109, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A state function used to set the items in the cart." + } + ] + }, + "parameters": [ + { + "id": 110, + "name": "items", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The items to set in the cart." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 80, + "name": "Item", + "package": "medusa-react" + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 90, + "name": "setRegion", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 91, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 92, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A state function used to set the region." + } + ] + }, + "parameters": [ + { + "id": 93, + "name": "region", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new value of the region." + } + ] + }, + "type": { + "type": "reference", + "target": 3404, + "name": "RegionInfo", + "package": "medusa-react" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 134, + "name": "total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total amount of the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "target": 88, + "name": "SessionCartState.total" + } + }, + { + "id": 133, + "name": "totalItems", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total items in the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "target": 87, + "name": "SessionCartState.totalItems" + } + }, + { + "id": 102, + "name": "updateItem", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 103, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 104, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This function updates an item in the session cart." + } + ] + }, + "parameters": [ + { + "id": 105, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 106, + "name": "item", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The item's data to update." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": 80, + "name": "Item", + "package": "medusa-react" + } + ], + "name": "Partial", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 111, + "name": "updateItemQuantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 112, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 113, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This function updates an item's quantity in the cart." + } + ] + }, + "parameters": [ + { + "id": 114, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 115, + "name": "quantity", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new quantity of the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 94, + 128, + 120, + 124, + 116, + 132, + 131, + 98, + 107, + 90, + 134, + 133, + 102, + 111 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 84, + "name": "SessionCartState", + "package": "medusa-react" + } + ] + }, + { + "id": 148, + "name": "SessionCartProviderProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 150, + "name": "initialState", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional initial value to be used for the session cart." + } + ] + }, + "type": { + "type": "reference", + "target": 84, + "name": "SessionCartState", + "package": "medusa-react" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 150 + ] + } + ] + }, + { + "id": 84, + "name": "SessionCartState", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 86, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The items in the cart." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 80, + "name": "Item", + "package": "medusa-react" + } + } + }, + { + "id": 85, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region of the cart." + } + ] + }, + "type": { + "type": "reference", + "target": 3404, + "name": "RegionInfo", + "package": "medusa-react" + } + }, + { + "id": 88, + "name": "total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total amount of the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 87, + "name": "totalItems", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total items in the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 86, + 85, + 88, + 87 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 89, + "name": "SessionCartContextState" + } + ] + }, + { + "id": 940, + "name": "AdminCancelClaimFulfillmentReq", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cancelation details." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 941, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 942, + "name": "claim_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 943, + "name": "fulfillment_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The fulfillment's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 942, + 943 + ] + } + ] + } + } + }, + { + "id": 3141, + "name": "AdminCancelSwapFulfillmentReq", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the swap's fulfillment to cancel." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3142, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3144, + "name": "fulfillment_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The fulfillment's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3143, + "name": "swap_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The swap's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3144, + 3143 + ] + } + ] + } + } + }, + { + "id": 3130, + "name": "AdminCreateSwapShipmentReq", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts", + "qualifiedName": "AdminPostOrdersOrderSwapsSwapShipmentsReq" + }, + "name": "AdminPostOrdersOrderSwapsSwapShipmentsReq", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 3131, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3132, + "name": "swap_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The swap's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3132 + ] + } + ] + } + } + ] + } + }, + { + "id": 1499, + "name": "AdminDraftOrderUpdateLineItemReq", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the line item." + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts", + "qualifiedName": "AdminPostDraftOrdersDraftOrderLineItemsItemReq" + }, + "name": "AdminPostDraftOrdersDraftOrderLineItemsItemReq", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1500, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1501, + "name": "item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item's ID to update." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1501 + ] + } + ] + } + } + ] + } + }, + { + "id": 3123, + "name": "AdminFulfillSwapReq", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts", + "qualifiedName": "AdminPostOrdersOrderSwapsSwapFulfillmentsReq" + }, + "name": "AdminPostOrdersOrderSwapsSwapFulfillmentsReq", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 3124, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3125, + "name": "swap_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The swap's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3125 + ] + } + ] + } + } + ] + } + }, + { + "id": 921, + "name": "AdminUpdateClaimReq", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts", + "qualifiedName": "AdminPostOrdersOrderClaimsClaimReq" + }, + "name": "AdminPostOrdersOrderClaimsClaimReq", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 922, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 923, + "name": "claim_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 923 + ] + } + ] + } + } + ] + } + }, + { + "id": 1652, + "name": "AdminUpdateLocationLevelReq", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/update-location-level.d.ts", + "qualifiedName": "AdminPostInventoryItemsItemLocationLevelsLevelReq" + }, + "name": "AdminPostInventoryItemsItemLocationLevelsLevelReq", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1653, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1654, + "name": "stockLocationId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the location level to update." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1654 + ] + } + ] + } + } + ] + } + }, + { + "id": 2415, + "name": "AdminUpdateProductOptionReq", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/update-option.d.ts", + "qualifiedName": "AdminPostProductsProductOptionsOption" + }, + "name": "AdminPostProductsProductOptionsOption", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 2416, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2417, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product option to update." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2417 + ] + } + ] + } + } + ] + } + }, + { + "id": 2400, + "name": "AdminUpdateVariantReq", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/update-variant.d.ts", + "qualifiedName": "AdminPostProductsProductVariantsVariantReq" + }, + "name": "AdminPostProductsProductVariantsVariantReq", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 2401, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2402, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product variant's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2402 + ] + } + ] + } + } + ] + } + }, + { + "id": 3384, + "name": "ComputeAmountParams", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options to compute an amount." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3385, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3386, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The original amount used for computation." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3388, + "name": "includeTaxes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the computed price should include taxes or not." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\ntrue\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 3387, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's details." + } + ] + }, + "type": { + "type": "reference", + "target": 3404, + "name": "RegionInfo", + "package": "medusa-react" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3386, + 3388, + 3387 + ] + } + ] + } + } + }, + { + "id": 194, + "name": "CreateCartReq", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the cart to create." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/create-cart.d.ts", + "qualifiedName": "StorePostCartReq" + }, + "name": "StorePostCartReq", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] + } + }, + { + "id": 233, + "name": "DeletePaymentSessionMutationData", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment session to delete." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 234, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 235, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment provider's identifier." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 235 + ] + } + ] + } + } + }, + { + "id": 3392, + "name": "FormatAmountParams", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options to format an amount." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3393, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3394, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The original amount used for computation." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3396, + "name": "includeTaxes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the computed price should include taxes or not." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\ntrue\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 3399, + "name": "locale", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A BCP 47 language tag. The default value is " + }, + { + "kind": "code", + "text": "`en-US`" + }, + { + "kind": "text", + "text": ". This is passed as a first parameter to " + }, + { + "kind": "code", + "text": "`Intl.NumberFormat`" + }, + { + "kind": "text", + "text": " which is used within the utility method. \nYou can learn more about this method’s parameters in \n[MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters)." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3398, + "name": "maximumFractionDigits", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of fraction digits to use when formatting the price. This is passed as an option to " + }, + { + "kind": "code", + "text": "`Intl.NumberFormat`" + }, + { + "kind": "text", + "text": " which is used within the utility method. \nYou can learn more about this method’s options in \n[MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters)." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3397, + "name": "minimumFractionDigits", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum number of fraction digits to use when formatting the price. This is passed as an option to " + }, + { + "kind": "code", + "text": "`Intl.NumberFormat`" + }, + { + "kind": "text", + "text": " in the underlying layer. \nYou can learn more about this method’s options in \n[MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters)." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3395, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's details." + } + ] + }, + "type": { + "type": "reference", + "target": 3404, + "name": "RegionInfo", + "package": "medusa-react" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3394, + 3396, + 3399, + 3398, + 3397, + 3395 + ] + } + ] + } + } + }, + { + "id": 3403, + "name": "ProductVariantInfo", + "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-react/src/types.ts", + "qualifiedName": "ProductVariant" + }, + "name": "ProductVariant", + "package": "medusa-react" + }, + { + "type": "literal", + "value": "prices" + } + ], + "name": "Pick", + "package": "typescript" + } + }, + { + "id": 218, + "name": "RefreshPaymentSessionMutationData", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment session to refresh." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 219, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 220, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment provider's identifier." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 220 + ] + } + ] + } + } + }, + { + "id": 3404, + "name": "RegionInfo", + "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/dist/models/region.d.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "currency_code" + }, + { + "type": "literal", + "value": "tax_code" + }, + { + "type": "literal", + "value": "tax_rate" + } + ] + } + ], + "name": "Pick", + "package": "typescript" + } + }, + { + "id": 386, + "name": "UpdateLineItemReq", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/update-line-item.d.ts", + "qualifiedName": "StorePostCartsCartLineItemsItemReq" + }, + "name": "StorePostCartsCartLineItemsItemReq", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 387, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 388, + "name": "lineId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 388 + ] + } + ] + } + } + ] + } + }, + { + "id": 359, + "name": "UpdateMeReq", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/update-customer.d.ts", + "qualifiedName": "StorePostCustomersCustomerReq" + }, + "name": "StorePostCustomersCustomerReq", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 360, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 361, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 361 + ] + } + ] + } + } + ] + } + }, + { + "id": 837, + "name": "adminAuthKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_auth" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 859, + "name": "adminBatchJobsKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_batches" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 956, + "name": "adminCollectionKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_collections" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 1026, + "name": "adminCurrenciesKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_currencies" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 1220, + "name": "adminCustomerKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_customers" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 1274, + "name": "adminDiscountKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1275, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1280, + "name": "all", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_discounts" + } + ] + } + }, + { + "id": 1293, + "name": "detail", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1294, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1295, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1296, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_discounts" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ] + } + } + }, + { + "id": 1290, + "name": "details", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1291, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1292, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_discounts" + }, + { + "type": "literal", + "value": "detail" + } + ] + } + } + ] + } + } + }, + { + "id": 1284, + "name": "list", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1285, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1286, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1287, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_discounts" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1288, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1289, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1289 + ] + } + ] + } + } + ] + } + } + ] + } + } + }, + { + "id": 1281, + "name": "lists", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1282, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1283, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_discounts" + }, + { + "type": "literal", + "value": "list" + } + ] + } + } + ] + } + } + }, + { + "id": 1276, + "name": "detailCondition", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1277, + "name": "detailCondition", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1278, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1279, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_discounts" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": "condition" + }, + { + "type": "intrinsic", + "name": "any" + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1280, + 1293, + 1290, + 1284, + 1281 + ] + }, + { + "title": "Methods", + "children": [ + 1276 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 1429, + "name": "adminDraftOrderKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_draft_orders" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 1506, + "name": "adminGiftCardKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_gift_cards" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 1564, + "name": "adminInventoryItemsKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_inventory_items" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 1667, + "name": "adminInviteKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_invites" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 1697, + "name": "adminNoteKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_notes" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 1755, + "name": "adminNotificationKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_notifications" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 1790, + "name": "adminOrderEditsKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_order_edits" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 1880, + "name": "adminOrderKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1881, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1889, + "name": "all", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_orders" + } + ] + } + }, + { + "id": 1902, + "name": "detail", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1903, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1904, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1905, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_orders" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ] + } + } + }, + { + "id": 1899, + "name": "details", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1900, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1901, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_orders" + }, + { + "type": "literal", + "value": "detail" + } + ] + } + } + ] + } + } + }, + { + "id": 1893, + "name": "list", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1894, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1895, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1896, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_orders" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 1897, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1898, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1898 + ] + } + ] + } + } + ] + } + } + ] + } + } + }, + { + "id": 1890, + "name": "lists", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1891, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1892, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_orders" + }, + { + "type": "literal", + "value": "list" + } + ] + } + } + ] + } + } + }, + { + "id": 1882, + "name": "detailOrder", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1883, + "name": "detailOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1884, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1885, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "FindParams" + }, + "name": "FindParams", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1886, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1887, + "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": 1888, + "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": "Properties", + "children": [ + 1887, + 1888 + ] + } + ] + } + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1889, + 1902, + 1899, + 1893, + 1890 + ] + }, + { + "title": "Methods", + "children": [ + 1882 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 2000, + "name": "adminPaymentCollectionQueryKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "paymentCollection" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2029, + "name": "adminPaymentQueryKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "payment" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2054, + "name": "adminPriceListKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2055, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2060, + "name": "all", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_price_lists" + } + ] + } + }, + { + "id": 2073, + "name": "detail", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2074, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2075, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2076, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_price_lists" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ] + } + } + }, + { + "id": 2070, + "name": "details", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2071, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2072, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_price_lists" + }, + { + "type": "literal", + "value": "detail" + } + ] + } + } + ] + } + } + }, + { + "id": 2064, + "name": "list", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2065, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2066, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2067, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_price_lists" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2068, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2069, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2069 + ] + } + ] + } + } + ] + } + } + ] + } + } + }, + { + "id": 2061, + "name": "lists", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2062, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2063, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_price_lists" + }, + { + "type": "literal", + "value": "list" + } + ] + } + } + ] + } + } + }, + { + "id": 2056, + "name": "detailProducts", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2057, + "name": "detailProducts", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2058, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2059, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_price_lists" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": "products" + }, + { + "type": "intrinsic", + "name": "any" + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2060, + 2073, + 2070, + 2064, + 2061 + ] + }, + { + "title": "Methods", + "children": [ + 2056 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 2185, + "name": "adminProductCategoryKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "product_categories" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2314, + "name": "adminProductKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_products" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2252, + "name": "adminProductTagKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_product_tags" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2283, + "name": "adminProductTypeKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_product_types" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2426, + "name": "adminPublishableApiKeysKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2427, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2432, + "name": "all", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_publishable_api_keys" + } + ] + } + }, + { + "id": 2445, + "name": "detail", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2446, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2447, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2448, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_publishable_api_keys" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ] + } + } + }, + { + "id": 2442, + "name": "details", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2443, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2444, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_publishable_api_keys" + }, + { + "type": "literal", + "value": "detail" + } + ] + } + } + ] + } + } + }, + { + "id": 2436, + "name": "list", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2437, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2438, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2439, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_publishable_api_keys" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 2440, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2441, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2441 + ] + } + ] + } + } + ] + } + } + ] + } + } + }, + { + "id": 2433, + "name": "lists", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2434, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2435, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_publishable_api_keys" + }, + { + "type": "literal", + "value": "list" + } + ] + } + } + ] + } + } + }, + { + "id": 2428, + "name": "detailSalesChannels", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2429, + "name": "detailSalesChannels", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2430, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2431, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "admin_publishable_api_keys" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": "sales_channels" + }, + { + "type": "intrinsic", + "name": "any" + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2432, + 2445, + 2442, + 2436, + 2433 + ] + }, + { + "title": "Methods", + "children": [ + 2428 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 2535, + "name": "adminRegionKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_regions" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2644, + "name": "adminReservationsKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_reservations" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2734, + "name": "adminReturnKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_returns" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2691, + "name": "adminReturnReasonKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_return_reasons" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2770, + "name": "adminSalesChannelsKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_sales_channels" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2854, + "name": "adminShippingOptionKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_shipping_options" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2912, + "name": "adminShippingProfileKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_shippingProfiles" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 2955, + "name": "adminStockLocationsKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_stock_locations" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 3013, + "name": "adminStoreKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_store" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 3068, + "name": "adminSwapKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_swaps" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 3155, + "name": "adminTaxRateKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_tax_rates" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 3250, + "name": "adminUserKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_users" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 3299, + "name": "adminVariantKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "admin_variants" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 177, + "name": "cartKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "carts" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 243, + "name": "collectionKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "collections" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 290, + "name": "customerKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 291, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 296, + "name": "all", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "customers" + } + ] + } + }, + { + "id": 309, + "name": "detail", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 310, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 311, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 312, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "customers" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ] + } + } + }, + { + "id": 306, + "name": "details", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 307, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 308, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "customers" + }, + { + "type": "literal", + "value": "detail" + } + ] + } + } + ] + } + } + }, + { + "id": 300, + "name": "list", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 301, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 302, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 303, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "customers" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 304, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 305, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 305 + ] + } + ] + } + } + ] + } + } + ] + } + } + }, + { + "id": 297, + "name": "lists", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 298, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 299, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "customers" + }, + { + "type": "literal", + "value": "list" + } + ] + } + } + ] + } + } + }, + { + "id": 292, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 293, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 294, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 295, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "customers" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": "orders" + } + ] + } + } + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 296, + 309, + 306, + 300, + 297, + 292 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 365, + "name": "giftCardKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "gift_cards" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 401, + "name": "orderEditQueryKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "orderEdit" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 426, + "name": "orderKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 427, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 432, + "name": "all", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "orders" + } + ] + } + }, + { + "id": 428, + "name": "cart", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 429, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 430, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 431, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "orders" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "literal", + "value": "cart" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 445, + "name": "detail", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 446, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 447, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 448, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "orders" + }, + { + "type": "literal", + "value": "detail" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ] + } + } + }, + { + "id": 442, + "name": "details", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 443, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 444, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "orders" + }, + { + "type": "literal", + "value": "detail" + } + ] + } + } + ] + } + } + }, + { + "id": 436, + "name": "list", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 437, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 438, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 439, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts", + "qualifiedName": "StoreGetOrdersParams" + }, + "name": "StoreGetOrdersParams", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "orders" + }, + { + "type": "literal", + "value": "list" + }, + { + "type": "reflection", + "declaration": { + "id": 440, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 441, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts", + "qualifiedName": "StoreGetOrdersParams" + }, + "name": "StoreGetOrdersParams", + "package": "@medusajs/medusa" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 441 + ] + } + ] + } + } + ] + } + } + ] + } + } + }, + { + "id": 433, + "name": "lists", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 434, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 435, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "orders" + }, + { + "type": "literal", + "value": "list" + } + ] + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 432, + 428, + 445, + 442, + 436, + 433 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 513, + "name": "paymentCollectionQueryKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "paymentCollection" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 660, + "name": "productKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "products" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/list-products.d.ts", + "qualifiedName": "StoreGetProductsParams" + }, + "name": "StoreGetProductsParams", + "package": "@medusajs/medusa" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 598, + "name": "productTagKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "product_tags" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 629, + "name": "productTypeKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "product_types" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 550, + "name": "storeProductCategoryKeys", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "TQueryKey" + }, + "typeArguments": [ + { + "type": "literal", + "value": "product_categories" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "TQueryKey", + "package": "medusa-react" + }, + "defaultValue": "..." + }, + { + "id": 913, + "name": "useAdminConfirmBatchJob", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 914, + "name": "useAdminConfirmBatchJob", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@reactMutationHook", + "content": [ + { + "kind": "text", + "text": "When a batch job is created, it's not executed automatically if " + }, + { + "kind": "code", + "text": "`dry_run`" + }, + { + "kind": "text", + "text": " is set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ". This hook confirms that the batch job should be executed." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport React from \"react\"\nimport { useAdminConfirmBatchJob } from \"medusa-react\"\n\ntype Props = {\n batchJobId: string\n}\n\nconst BatchJob = ({ batchJobId }: Props) => {\n const confirmBatchJob = useAdminConfirmBatchJob(batchJobId)\n // ...\n\n const handleConfirm = () => {\n confirmBatchJob.mutate(undefined, {\n onSuccess: ({ batch_job }) => {\n console.log(batch_job)\n }\n })\n }\n\n // ...\n}\n\nexport default BatchJob\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 915, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the batch job." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 916, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "AdminBatchJobRes" + }, + "name": "AdminBatchJobRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "AdminBatchJobRes" + }, + "name": "AdminBatchJobRes", + "package": "@medusajs/medusa" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + }, + { + "id": 1690, + "name": "useAdminCreateInvite", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 1691, + "name": "useAdminCreateInvite", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1692, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "AdminPostInvitesPayload" + }, + "name": "AdminPostInvitesPayload", + "package": "@medusajs/medusa-js" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationOptions", + "package": "@tanstack/react-query" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-react/node_modules/@tanstack/react-query/build/lib/types.d.ts", + "qualifiedName": "UseMutationResult" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "Response" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Response", + "package": "@medusajs/medusa-js" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "AdminPostInvitesPayload" + }, + "name": "AdminPostInvitesPayload", + "package": "@medusajs/medusa-js" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "UseMutationResult", + "package": "@tanstack/react-query" + } + } + ] + } + ], + "groups": [ + { + "title": "Namespaces", + "children": [ + 6, + 1, + 5 + ] + }, + { + "title": "Interfaces", + "children": [ + 156, + 171, + 3373, + 3363, + 80, + 65, + 69, + 89, + 148, + 84 + ] + }, + { + "title": "Type Aliases", + "children": [ + 940, + 3141, + 3130, + 1499, + 3123, + 921, + 1652, + 2415, + 2400, + 3384, + 194, + 233, + 3392, + 3403, + 218, + 3404, + 386, + 359 + ] + }, + { + "title": "Variables", + "children": [ + 837, + 859, + 956, + 1026, + 1220, + 1274, + 1429, + 1506, + 1564, + 1667, + 1697, + 1755, + 1790, + 1880, + 2000, + 2029, + 2054, + 2185, + 2314, + 2252, + 2283, + 2426, + 2535, + 2644, + 2734, + 2691, + 2770, + 2854, + 2912, + 2955, + 3013, + 3068, + 3155, + 3250, + 3299, + 177, + 243, + 290, + 365, + 401, + 426, + 513, + 660, + 598, + 629, + 550 + ] + }, + { + "title": "Functions", + "children": [ + 913, + 1690 + ] + } + ], + "packageName": "medusa-react", + "symbolIdMap": { + "0": { + "sourceFileName": "../../../packages/medusa-react/src/index.ts", + "qualifiedName": "" + }, + "65": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "MedusaContextState" + }, + "66": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "MedusaContextState.client" + }, + "67": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "useMedusa" + }, + "68": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "useMedusa" + }, + "69": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "MedusaProviderProps" + }, + "70": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "MedusaProviderProps.baseUrl" + }, + "71": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "MedusaProviderProps.queryClientProviderProps" + }, + "73": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "MedusaProviderProps.apiKey" + }, + "74": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "MedusaProviderProps.publishableApiKey" + }, + "75": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "MedusaProviderProps.maxRetries" + }, + "76": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "MedusaProviderProps.customHeaders" + }, + "77": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "MedusaProvider" + }, + "78": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "MedusaProvider" + }, + "79": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/medusa.tsx", + "qualifiedName": "__0" + }, + "80": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "Item" + }, + "81": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "Item.variant" + }, + "82": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "Item.quantity" + }, + "83": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "Item.total" + }, + "84": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartState" + }, + "85": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartState.region" + }, + "86": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartState.items" + }, + "87": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartState.totalItems" + }, + "88": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartState.total" + }, + "89": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartContextState" + }, + "90": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartContextState.setRegion" + }, + "91": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "92": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "93": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "region" + }, + "94": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartContextState.addItem" + }, + "95": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "96": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "97": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "item" + }, + "98": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartContextState.removeItem" + }, + "99": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "100": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "101": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "id" + }, + "102": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartContextState.updateItem" + }, + "103": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "104": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "105": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "id" + }, + "106": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "item" + }, + "107": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartContextState.setItems" + }, + "108": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "109": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "110": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "items" + }, + "111": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartContextState.updateItemQuantity" + }, + "112": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "113": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "114": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "id" + }, + "115": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "quantity" + }, + "116": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartContextState.incrementItemQuantity" + }, + "117": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "118": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "119": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "id" + }, + "120": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartContextState.decrementItemQuantity" + }, + "121": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "122": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "123": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "id" + }, + "124": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartContextState.getItem" + }, + "125": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "126": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "127": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "id" + }, + "128": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartContextState.clearItems" + }, + "129": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "130": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__type" + }, + "131": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartState.region" + }, + "132": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartState.items" + }, + "133": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartState.totalItems" + }, + "134": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartState.total" + }, + "148": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartProviderProps" + }, + "150": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartProviderProps.initialState" + }, + "151": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartProvider" + }, + "152": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "SessionCartProvider" + }, + "153": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "__0" + }, + "154": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "useSessionCart" + }, + "155": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/session-cart.tsx", + "qualifiedName": "useSessionCart" + }, + "156": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartContext" + }, + "157": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartContext.setCart" + }, + "158": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "__type" + }, + "159": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "__type" + }, + "160": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "cart" + }, + "161": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartContext.pay" + }, + "162": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartContext.createCart" + }, + "163": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartContext.startCheckout" + }, + "164": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartContext.completeCheckout" + }, + "165": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartContext.updateCart" + }, + "166": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartContext.addShippingMethod" + }, + "167": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartContext.totalItems" + }, + "168": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartState.cart" + }, + "169": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "useCart" + }, + "170": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "useCart" + }, + "171": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartProps" + }, + "173": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartProps.initialState" + }, + "174": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartProvider" + }, + "175": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "CartProvider" + }, + "176": { + "sourceFileName": "../../../packages/medusa-react/src/contexts/cart.tsx", + "qualifiedName": "__0" + }, + "177": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/queries.ts", + "qualifiedName": "cartKeys" + }, + "178": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/queries.ts", + "qualifiedName": "useGetCart" + }, + "179": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/queries.ts", + "qualifiedName": "useGetCart" + }, + "180": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/queries.ts", + "qualifiedName": "id" + }, + "181": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/queries.ts", + "qualifiedName": "options" + }, + "182": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/queries.ts", + "qualifiedName": "__object" + }, + "183": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "cart" + }, + "184": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "185": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/queries.ts", + "qualifiedName": "__object" + }, + "186": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "cart" + }, + "187": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "188": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/queries.ts", + "qualifiedName": "__object" + }, + "189": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "cart" + }, + "190": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "191": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/queries.ts", + "qualifiedName": "__object" + }, + "192": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/carts/index.d.ts", + "qualifiedName": "cart" + }, + "193": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "194": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "CreateCartReq" + }, + "195": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useCreateCart" + }, + "196": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useCreateCart" + }, + "197": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "options" + }, + "198": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useUpdateCart" + }, + "199": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useUpdateCart" + }, + "200": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "cartId" + }, + "201": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "options" + }, + "202": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useCompleteCart" + }, + "203": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useCompleteCart" + }, + "204": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "cartId" + }, + "205": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "options" + }, + "206": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useCreatePaymentSession" + }, + "207": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useCreatePaymentSession" + }, + "208": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "cartId" + }, + "209": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "options" + }, + "210": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useUpdatePaymentSession" + }, + "211": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useUpdatePaymentSession" + }, + "212": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "cartId" + }, + "213": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "options" + }, + "214": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "__type" + }, + "215": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "__type.provider_id" + }, + "216": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "__type" + }, + "217": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "__type.provider_id" + }, + "218": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "RefreshPaymentSessionMutationData" + }, + "219": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "__type" + }, + "220": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "__type.provider_id" + }, + "221": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useRefreshPaymentSession" + }, + "222": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useRefreshPaymentSession" + }, + "223": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "cartId" + }, + "224": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "options" + }, + "225": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useSetPaymentSession" + }, + "226": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useSetPaymentSession" + }, + "227": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "cartId" + }, + "228": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "options" + }, + "229": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useAddShippingMethodToCart" + }, + "230": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useAddShippingMethodToCart" + }, + "231": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "cartId" + }, + "232": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "options" + }, + "233": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "DeletePaymentSessionMutationData" + }, + "234": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "__type" + }, + "235": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "__type.provider_id" + }, + "236": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useDeletePaymentSession" + }, + "237": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useDeletePaymentSession" + }, + "238": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "cartId" + }, + "239": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "options" + }, + "240": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useStartCheckout" + }, + "241": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "useStartCheckout" + }, + "242": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/carts/mutations.ts", + "qualifiedName": "options" + }, + "243": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "collectionKeys" + }, + "244": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "useCollection" + }, + "245": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "useCollection" + }, + "246": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "id" + }, + "247": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "options" + }, + "248": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "__object" + }, + "249": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/collections/index.d.ts", + "qualifiedName": "collection" + }, + "250": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "251": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "__object" + }, + "252": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/collections/index.d.ts", + "qualifiedName": "collection" + }, + "253": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "254": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "__object" + }, + "255": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/collections/index.d.ts", + "qualifiedName": "collection" + }, + "256": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "257": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "__object" + }, + "258": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/collections/index.d.ts", + "qualifiedName": "collection" + }, + "259": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "260": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "useCollections" + }, + "261": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "useCollections" + }, + "262": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "query" + }, + "263": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "options" + }, + "264": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "265": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "266": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "__object" + }, + "267": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "268": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "269": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "270": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/collections/index.d.ts", + "qualifiedName": "collections" + }, + "271": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "272": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "__object" + }, + "273": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "274": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "275": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "276": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/collections/index.d.ts", + "qualifiedName": "collections" + }, + "277": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "278": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "__object" + }, + "279": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "280": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "281": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "282": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/collections/index.d.ts", + "qualifiedName": "collections" + }, + "283": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "284": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/collections/queries.ts", + "qualifiedName": "__object" + }, + "285": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "286": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "287": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "288": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/collections/index.d.ts", + "qualifiedName": "collections" + }, + "289": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "290": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "customerKeys" + }, + "291": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "__object" + }, + "292": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "__object.orders" + }, + "293": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "__function" + }, + "294": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "__function" + }, + "295": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "id" + }, + "296": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.all" + }, + "297": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.lists" + }, + "298": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "299": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "300": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.list" + }, + "301": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "302": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "303": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "query" + }, + "304": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "305": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "306": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.details" + }, + "307": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "308": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "309": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.detail" + }, + "310": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "311": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "312": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "id" + }, + "313": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "useMeCustomer" + }, + "314": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "useMeCustomer" + }, + "315": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "options" + }, + "316": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "__object" + }, + "317": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "customer" + }, + "318": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "319": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "__object" + }, + "320": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "customer" + }, + "321": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "322": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "__object" + }, + "323": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "customer" + }, + "324": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "325": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "__object" + }, + "326": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "customer" + }, + "327": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "328": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "useCustomerOrders" + }, + "329": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "useCustomerOrders" + }, + "330": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "query" + }, + "331": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "options" + }, + "332": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "__object" + }, + "333": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "334": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "335": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "336": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "orders" + }, + "337": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "338": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "__object" + }, + "339": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "340": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "341": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "342": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "orders" + }, + "343": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "344": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "__object" + }, + "345": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "346": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "347": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "348": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "orders" + }, + "349": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "350": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/queries.ts", + "qualifiedName": "__object" + }, + "351": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "352": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "353": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "354": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/customers/index.d.ts", + "qualifiedName": "orders" + }, + "355": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "356": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/mutations.ts", + "qualifiedName": "useCreateCustomer" + }, + "357": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/mutations.ts", + "qualifiedName": "useCreateCustomer" + }, + "358": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/mutations.ts", + "qualifiedName": "options" + }, + "359": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/mutations.ts", + "qualifiedName": "UpdateMeReq" + }, + "360": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/mutations.ts", + "qualifiedName": "__type" + }, + "361": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/mutations.ts", + "qualifiedName": "__type.id" + }, + "362": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/mutations.ts", + "qualifiedName": "useUpdateMe" + }, + "363": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/mutations.ts", + "qualifiedName": "useUpdateMe" + }, + "364": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/customers/mutations.ts", + "qualifiedName": "options" + }, + "365": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/gift-cards/queries.ts", + "qualifiedName": "giftCardKeys" + }, + "366": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/gift-cards/queries.ts", + "qualifiedName": "useGiftCard" + }, + "367": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/gift-cards/queries.ts", + "qualifiedName": "useGiftCard" + }, + "368": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/gift-cards/queries.ts", + "qualifiedName": "id" + }, + "369": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/gift-cards/queries.ts", + "qualifiedName": "options" + }, + "370": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/gift-cards/queries.ts", + "qualifiedName": "__object" + }, + "371": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/gift-cards/index.d.ts", + "qualifiedName": "gift_card" + }, + "372": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "373": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/gift-cards/queries.ts", + "qualifiedName": "__object" + }, + "374": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/gift-cards/index.d.ts", + "qualifiedName": "gift_card" + }, + "375": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "376": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/gift-cards/queries.ts", + "qualifiedName": "__object" + }, + "377": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/gift-cards/index.d.ts", + "qualifiedName": "gift_card" + }, + "378": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "379": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/gift-cards/queries.ts", + "qualifiedName": "__object" + }, + "380": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/gift-cards/index.d.ts", + "qualifiedName": "gift_card" + }, + "381": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "382": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "useCreateLineItem" + }, + "383": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "useCreateLineItem" + }, + "384": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "cartId" + }, + "385": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "options" + }, + "386": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "UpdateLineItemReq" + }, + "387": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "__type" + }, + "388": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "__type.lineId" + }, + "389": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "useUpdateLineItem" + }, + "390": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "useUpdateLineItem" + }, + "391": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "cartId" + }, + "392": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "options" + }, + "393": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "useDeleteLineItem" + }, + "394": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "useDeleteLineItem" + }, + "395": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "cartId" + }, + "396": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "options" + }, + "397": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "__type" + }, + "398": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "__type.lineId" + }, + "399": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "__type" + }, + "400": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/line-items/mutations.ts", + "qualifiedName": "__type.lineId" + }, + "401": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/queries.ts", + "qualifiedName": "orderEditQueryKeys" + }, + "402": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/queries.ts", + "qualifiedName": "useOrderEdit" + }, + "403": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/queries.ts", + "qualifiedName": "useOrderEdit" + }, + "404": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/queries.ts", + "qualifiedName": "id" + }, + "405": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/queries.ts", + "qualifiedName": "options" + }, + "406": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/queries.ts", + "qualifiedName": "__object" + }, + "407": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/order-edits/index.d.ts", + "qualifiedName": "order_edit" + }, + "408": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "409": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/queries.ts", + "qualifiedName": "__object" + }, + "410": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/order-edits/index.d.ts", + "qualifiedName": "order_edit" + }, + "411": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "412": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/queries.ts", + "qualifiedName": "__object" + }, + "413": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/order-edits/index.d.ts", + "qualifiedName": "order_edit" + }, + "414": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "415": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/queries.ts", + "qualifiedName": "__object" + }, + "416": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/order-edits/index.d.ts", + "qualifiedName": "order_edit" + }, + "417": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "418": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/mutations.ts", + "qualifiedName": "useDeclineOrderEdit" + }, + "419": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/mutations.ts", + "qualifiedName": "useDeclineOrderEdit" + }, + "420": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/mutations.ts", + "qualifiedName": "id" + }, + "421": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/mutations.ts", + "qualifiedName": "options" + }, + "422": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/mutations.ts", + "qualifiedName": "useCompleteOrderEdit" + }, + "423": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/mutations.ts", + "qualifiedName": "useCompleteOrderEdit" + }, + "424": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/mutations.ts", + "qualifiedName": "id" + }, + "425": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/order-edits/mutations.ts", + "qualifiedName": "options" + }, + "426": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "orderKeys" + }, + "427": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "428": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object.cart" + }, + "429": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__function" + }, + "430": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__function" + }, + "431": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "cartId" + }, + "432": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.all" + }, + "433": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.lists" + }, + "434": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "435": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "436": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.list" + }, + "437": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "438": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "439": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "query" + }, + "440": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "441": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "442": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.details" + }, + "443": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "444": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "445": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.detail" + }, + "446": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "447": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "448": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "id" + }, + "449": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "useOrder" + }, + "450": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "useOrder" + }, + "451": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "id" + }, + "452": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "options" + }, + "453": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "454": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "order" + }, + "455": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "456": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "457": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "order" + }, + "458": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "459": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "460": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "order" + }, + "461": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "462": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "463": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "order" + }, + "464": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "465": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "useCartOrder" + }, + "466": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "useCartOrder" + }, + "467": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "cartId" + }, + "468": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "options" + }, + "469": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "470": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "order" + }, + "471": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "472": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "473": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "order" + }, + "474": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "475": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "476": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "order" + }, + "477": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "478": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "479": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "order" + }, + "480": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "481": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "useOrders" + }, + "482": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "useOrders" + }, + "483": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "query" + }, + "484": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "options" + }, + "485": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "486": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "487": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "488": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "order" + }, + "489": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "490": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "491": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "order" + }, + "492": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "493": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "494": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "order" + }, + "495": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "496": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/queries.ts", + "qualifiedName": "__object" + }, + "497": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/orders/index.d.ts", + "qualifiedName": "order" + }, + "498": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "499": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/mutations.ts", + "qualifiedName": "useRequestOrderAccess" + }, + "500": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/mutations.ts", + "qualifiedName": "useRequestOrderAccess" + }, + "501": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/mutations.ts", + "qualifiedName": "options" + }, + "502": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "__type" + }, + "503": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "__type.response" + }, + "504": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "__type" + }, + "505": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "__type.response" + }, + "506": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/mutations.ts", + "qualifiedName": "useGrantOrderAccess" + }, + "507": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/mutations.ts", + "qualifiedName": "useGrantOrderAccess" + }, + "508": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/orders/mutations.ts", + "qualifiedName": "options" + }, + "509": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "__type" + }, + "510": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "__type.response" + }, + "511": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "__type" + }, + "512": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "__type.response" + }, + "513": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/queries.ts", + "qualifiedName": "paymentCollectionQueryKeys" + }, + "514": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/queries.ts", + "qualifiedName": "usePaymentCollection" + }, + "515": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/queries.ts", + "qualifiedName": "usePaymentCollection" + }, + "516": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/queries.ts", + "qualifiedName": "id" + }, + "517": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/queries.ts", + "qualifiedName": "options" + }, + "518": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/queries.ts", + "qualifiedName": "__object" + }, + "519": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "payment_collection" + }, + "520": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "521": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/queries.ts", + "qualifiedName": "__object" + }, + "522": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "payment_collection" + }, + "523": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "524": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/queries.ts", + "qualifiedName": "__object" + }, + "525": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "payment_collection" + }, + "526": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "527": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/queries.ts", + "qualifiedName": "__object" + }, + "528": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/payment-collections/index.d.ts", + "qualifiedName": "payment_collection" + }, + "529": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "530": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "useManageMultiplePaymentSessions" + }, + "531": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "useManageMultiplePaymentSessions" + }, + "532": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "id" + }, + "533": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "options" + }, + "534": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "useManagePaymentSession" + }, + "535": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "useManagePaymentSession" + }, + "536": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "id" + }, + "537": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "options" + }, + "538": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "useAuthorizePaymentSession" + }, + "539": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "useAuthorizePaymentSession" + }, + "540": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "id" + }, + "541": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "options" + }, + "542": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "useAuthorizePaymentSessionsBatch" + }, + "543": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "useAuthorizePaymentSessionsBatch" + }, + "544": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "id" + }, + "545": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "options" + }, + "546": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "usePaymentCollectionRefreshPaymentSession" + }, + "547": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "usePaymentCollectionRefreshPaymentSession" + }, + "548": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "id" + }, + "549": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/payment-collections/mutations.ts", + "qualifiedName": "options" + }, + "550": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "storeProductCategoryKeys" + }, + "551": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "useProductCategories" + }, + "552": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "useProductCategories" + }, + "553": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "query" + }, + "554": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "options" + }, + "555": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "556": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "557": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "558": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "559": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "560": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "561": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-categories/index.d.ts", + "qualifiedName": "product_categories" + }, + "562": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "563": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "564": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "565": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "566": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "567": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-categories/index.d.ts", + "qualifiedName": "product_categories" + }, + "568": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "569": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "570": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "571": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "572": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "573": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-categories/index.d.ts", + "qualifiedName": "product_categories" + }, + "574": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "575": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "576": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "577": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "578": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "579": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-categories/index.d.ts", + "qualifiedName": "product_categories" + }, + "580": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "581": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "useProductCategory" + }, + "582": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "useProductCategory" + }, + "583": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "id" + }, + "584": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "query" + }, + "585": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "options" + }, + "586": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "587": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-categories/index.d.ts", + "qualifiedName": "product_category" + }, + "588": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "589": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "590": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-categories/index.d.ts", + "qualifiedName": "product_category" + }, + "591": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "592": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "593": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-categories/index.d.ts", + "qualifiedName": "product_category" + }, + "594": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "595": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "596": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-categories/index.d.ts", + "qualifiedName": "product_category" + }, + "597": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "598": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-tags/queries.ts", + "qualifiedName": "productTagKeys" + }, + "599": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-tags/queries.ts", + "qualifiedName": "useProductTags" + }, + "600": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-tags/queries.ts", + "qualifiedName": "useProductTags" + }, + "601": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-tags/queries.ts", + "qualifiedName": "query" + }, + "602": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-tags/queries.ts", + "qualifiedName": "options" + }, + "603": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "604": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "605": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-tags/queries.ts", + "qualifiedName": "__object" + }, + "606": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "607": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "608": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "609": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-tags/index.d.ts", + "qualifiedName": "product_tags" + }, + "610": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "611": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-tags/queries.ts", + "qualifiedName": "__object" + }, + "612": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "613": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "614": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "615": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-tags/index.d.ts", + "qualifiedName": "product_tags" + }, + "616": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "617": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-tags/queries.ts", + "qualifiedName": "__object" + }, + "618": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "619": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "620": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "621": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-tags/index.d.ts", + "qualifiedName": "product_tags" + }, + "622": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "623": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-tags/queries.ts", + "qualifiedName": "__object" + }, + "624": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "625": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "626": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "627": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-tags/index.d.ts", + "qualifiedName": "product_tags" + }, + "628": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "629": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-types/queries.ts", + "qualifiedName": "productTypeKeys" + }, + "630": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-types/queries.ts", + "qualifiedName": "useProductTypes" + }, + "631": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-types/queries.ts", + "qualifiedName": "useProductTypes" + }, + "632": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-types/queries.ts", + "qualifiedName": "query" + }, + "633": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-types/queries.ts", + "qualifiedName": "options" + }, + "634": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "635": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "636": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-types/queries.ts", + "qualifiedName": "__object" + }, + "637": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "638": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "639": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "640": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-types/index.d.ts", + "qualifiedName": "product_types" + }, + "641": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "642": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-types/queries.ts", + "qualifiedName": "__object" + }, + "643": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "644": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "645": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "646": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-types/index.d.ts", + "qualifiedName": "product_types" + }, + "647": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "648": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-types/queries.ts", + "qualifiedName": "__object" + }, + "649": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "650": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "651": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "652": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-types/index.d.ts", + "qualifiedName": "product_types" + }, + "653": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "654": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/product-types/queries.ts", + "qualifiedName": "__object" + }, + "655": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "656": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "657": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "658": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/product-types/index.d.ts", + "qualifiedName": "product_types" + }, + "659": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "660": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "productKeys" + }, + "661": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "useProducts" + }, + "662": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "useProducts" + }, + "663": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "query" + }, + "664": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "options" + }, + "665": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "666": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "667": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "__object" + }, + "668": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "669": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "670": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "671": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/index.d.ts", + "qualifiedName": "products" + }, + "672": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "673": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "__object" + }, + "674": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "675": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "676": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "677": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/index.d.ts", + "qualifiedName": "products" + }, + "678": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "679": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "__object" + }, + "680": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "681": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "682": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "683": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/index.d.ts", + "qualifiedName": "products" + }, + "684": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "685": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "__object" + }, + "686": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "687": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "688": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "689": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/index.d.ts", + "qualifiedName": "products" + }, + "690": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "691": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "useProduct" + }, + "692": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "useProduct" + }, + "693": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "id" + }, + "694": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "options" + }, + "695": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "__object" + }, + "696": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/index.d.ts", + "qualifiedName": "product" + }, + "697": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "698": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "__object" + }, + "699": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/index.d.ts", + "qualifiedName": "product" + }, + "700": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "701": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "__object" + }, + "702": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/index.d.ts", + "qualifiedName": "product" + }, + "703": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "704": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/products/queries.ts", + "qualifiedName": "__object" + }, + "705": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/products/index.d.ts", + "qualifiedName": "product" + }, + "706": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "707": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "useRegions" + }, + "708": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "useRegions" + }, + "709": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "options" + }, + "710": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "__object" + }, + "711": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "limit" + }, + "712": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "offset" + }, + "713": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "count" + }, + "714": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/regions/index.d.ts", + "qualifiedName": "regions" + }, + "715": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "716": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "__object" + }, + "717": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "limit" + }, + "718": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "offset" + }, + "719": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "count" + }, + "720": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/regions/index.d.ts", + "qualifiedName": "regions" + }, + "721": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "722": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "__object" + }, + "723": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "limit" + }, + "724": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "offset" + }, + "725": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "count" + }, + "726": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/regions/index.d.ts", + "qualifiedName": "regions" + }, + "727": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "728": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "__object" + }, + "729": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "limit" + }, + "730": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "offset" + }, + "731": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "count" + }, + "732": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/regions/index.d.ts", + "qualifiedName": "regions" + }, + "733": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "734": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "useRegion" + }, + "735": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "useRegion" + }, + "736": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "id" + }, + "737": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "options" + }, + "738": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "__object" + }, + "739": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/regions/index.d.ts", + "qualifiedName": "region" + }, + "740": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "741": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "__object" + }, + "742": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/regions/index.d.ts", + "qualifiedName": "region" + }, + "743": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "744": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "__object" + }, + "745": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/regions/index.d.ts", + "qualifiedName": "region" + }, + "746": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "747": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/regions/queries.ts", + "qualifiedName": "__object" + }, + "748": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/regions/index.d.ts", + "qualifiedName": "region" + }, + "749": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "750": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "useReturnReasons" + }, + "751": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "useReturnReasons" + }, + "752": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "options" + }, + "753": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "754": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/return-reasons/index.d.ts", + "qualifiedName": "return_reasons" + }, + "755": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "756": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "757": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/return-reasons/index.d.ts", + "qualifiedName": "return_reasons" + }, + "758": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "759": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "760": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/return-reasons/index.d.ts", + "qualifiedName": "return_reasons" + }, + "761": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "762": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "763": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/return-reasons/index.d.ts", + "qualifiedName": "return_reasons" + }, + "764": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "765": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "useReturnReason" + }, + "766": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "useReturnReason" + }, + "767": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "id" + }, + "768": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "options" + }, + "769": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "770": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/return-reasons/index.d.ts", + "qualifiedName": "return_reason" + }, + "771": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "772": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "773": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/return-reasons/index.d.ts", + "qualifiedName": "return_reason" + }, + "774": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "775": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "776": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/return-reasons/index.d.ts", + "qualifiedName": "return_reason" + }, + "777": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "778": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "779": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/return-reasons/index.d.ts", + "qualifiedName": "return_reason" + }, + "780": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "781": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/returns/mutations.ts", + "qualifiedName": "useCreateReturn" + }, + "782": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/returns/mutations.ts", + "qualifiedName": "useCreateReturn" + }, + "783": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/returns/mutations.ts", + "qualifiedName": "options" + }, + "784": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "useShippingOptions" + }, + "785": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "useShippingOptions" + }, + "786": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "query" + }, + "787": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "options" + }, + "788": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "789": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "790": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "791": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/shipping-options/index.d.ts", + "qualifiedName": "shipping_options" + }, + "792": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "793": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "794": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/shipping-options/index.d.ts", + "qualifiedName": "shipping_options" + }, + "795": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "796": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "797": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/shipping-options/index.d.ts", + "qualifiedName": "shipping_options" + }, + "798": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "799": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "800": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/shipping-options/index.d.ts", + "qualifiedName": "shipping_options" + }, + "801": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "802": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "useCartShippingOptions" + }, + "803": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "useCartShippingOptions" + }, + "804": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "cartId" + }, + "805": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "options" + }, + "806": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "807": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/shipping-options/index.d.ts", + "qualifiedName": "shipping_options" + }, + "808": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "809": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "810": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/shipping-options/index.d.ts", + "qualifiedName": "shipping_options" + }, + "811": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "812": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "813": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/shipping-options/index.d.ts", + "qualifiedName": "shipping_options" + }, + "814": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "815": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "816": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/shipping-options/index.d.ts", + "qualifiedName": "shipping_options" + }, + "817": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "818": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/swaps/queries.ts", + "qualifiedName": "useCartSwap" + }, + "819": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/swaps/queries.ts", + "qualifiedName": "useCartSwap" + }, + "820": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/swaps/queries.ts", + "qualifiedName": "cartId" + }, + "821": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/swaps/queries.ts", + "qualifiedName": "options" + }, + "822": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/swaps/queries.ts", + "qualifiedName": "__object" + }, + "823": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/swaps/index.d.ts", + "qualifiedName": "swap" + }, + "824": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "825": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/swaps/queries.ts", + "qualifiedName": "__object" + }, + "826": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/swaps/index.d.ts", + "qualifiedName": "swap" + }, + "827": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "828": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/swaps/queries.ts", + "qualifiedName": "__object" + }, + "829": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/swaps/index.d.ts", + "qualifiedName": "swap" + }, + "830": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "831": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/swaps/queries.ts", + "qualifiedName": "__object" + }, + "832": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/store/swaps/index.d.ts", + "qualifiedName": "swap" + }, + "833": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "834": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/swaps/mutations.ts", + "qualifiedName": "useCreateSwap" + }, + "835": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/swaps/mutations.ts", + "qualifiedName": "useCreateSwap" + }, + "836": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/store/swaps/mutations.ts", + "qualifiedName": "options" + }, + "837": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/queries.ts", + "qualifiedName": "adminAuthKeys" + }, + "838": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/queries.ts", + "qualifiedName": "useAdminGetSession" + }, + "839": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/queries.ts", + "qualifiedName": "useAdminGetSession" + }, + "840": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/queries.ts", + "qualifiedName": "options" + }, + "841": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/queries.ts", + "qualifiedName": "__object" + }, + "842": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/auth/index.d.ts", + "qualifiedName": "user" + }, + "843": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "844": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/queries.ts", + "qualifiedName": "__object" + }, + "845": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/auth/index.d.ts", + "qualifiedName": "user" + }, + "846": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "847": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/queries.ts", + "qualifiedName": "__object" + }, + "848": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/auth/index.d.ts", + "qualifiedName": "user" + }, + "849": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "850": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/queries.ts", + "qualifiedName": "__object" + }, + "851": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/auth/index.d.ts", + "qualifiedName": "user" + }, + "852": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "853": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/mutations.ts", + "qualifiedName": "useAdminLogin" + }, + "854": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/mutations.ts", + "qualifiedName": "useAdminLogin" + }, + "855": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/mutations.ts", + "qualifiedName": "options" + }, + "856": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/mutations.ts", + "qualifiedName": "useAdminDeleteSession" + }, + "857": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/mutations.ts", + "qualifiedName": "useAdminDeleteSession" + }, + "858": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/auth/mutations.ts", + "qualifiedName": "options" + }, + "859": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "adminBatchJobsKeys" + }, + "860": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "useAdminBatchJobs" + }, + "861": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "useAdminBatchJobs" + }, + "862": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "query" + }, + "863": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "options" + }, + "864": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "865": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "866": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "__object" + }, + "867": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "868": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "869": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "870": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "batch_jobs" + }, + "871": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "872": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "__object" + }, + "873": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "874": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "875": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "876": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "batch_jobs" + }, + "877": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "878": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "__object" + }, + "879": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "880": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "881": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "882": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "batch_jobs" + }, + "883": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "884": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "__object" + }, + "885": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "886": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "887": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "888": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "batch_jobs" + }, + "889": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "890": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "useAdminBatchJob" + }, + "891": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "useAdminBatchJob" + }, + "892": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "id" + }, + "893": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "options" + }, + "894": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "__object" + }, + "895": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "batch_job" + }, + "896": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "897": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "__object" + }, + "898": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "batch_job" + }, + "899": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "900": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "__object" + }, + "901": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "batch_job" + }, + "902": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "903": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts", + "qualifiedName": "__object" + }, + "904": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/batch/index.d.ts", + "qualifiedName": "batch_job" + }, + "905": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "906": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts", + "qualifiedName": "useAdminCreateBatchJob" + }, + "907": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts", + "qualifiedName": "useAdminCreateBatchJob" + }, + "908": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts", + "qualifiedName": "options" + }, + "909": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts", + "qualifiedName": "useAdminCancelBatchJob" + }, + "910": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts", + "qualifiedName": "useAdminCancelBatchJob" + }, + "911": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts", + "qualifiedName": "id" + }, + "912": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts", + "qualifiedName": "options" + }, + "913": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts", + "qualifiedName": "useAdminConfirmBatchJob" + }, + "914": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts", + "qualifiedName": "useAdminConfirmBatchJob" + }, + "915": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts", + "qualifiedName": "id" + }, + "916": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts", + "qualifiedName": "options" + }, + "917": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "useAdminCreateClaim" + }, + "918": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "useAdminCreateClaim" + }, + "919": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "orderId" + }, + "920": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "options" + }, + "921": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "AdminUpdateClaimReq" + }, + "922": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type" + }, + "923": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type.claim_id" + }, + "924": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "useAdminUpdateClaim" + }, + "925": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "useAdminUpdateClaim" + }, + "926": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "orderId" + }, + "927": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "options" + }, + "928": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "useAdminCancelClaim" + }, + "929": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "useAdminCancelClaim" + }, + "930": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "orderId" + }, + "931": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "options" + }, + "932": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "useAdminFulfillClaim" + }, + "933": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "useAdminFulfillClaim" + }, + "934": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "orderId" + }, + "935": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "options" + }, + "936": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type" + }, + "937": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type.claim_id" + }, + "938": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type" + }, + "939": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type.claim_id" + }, + "940": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "AdminCancelClaimFulfillmentReq" + }, + "941": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type" + }, + "942": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type.claim_id" + }, + "943": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type.fulfillment_id" + }, + "944": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "useAdminCancelClaimFulfillment" + }, + "945": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "useAdminCancelClaimFulfillment" + }, + "946": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "orderId" + }, + "947": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "options" + }, + "948": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "useAdminCreateClaimShipment" + }, + "949": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "useAdminCreateClaimShipment" + }, + "950": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "orderId" + }, + "951": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "options" + }, + "952": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type" + }, + "953": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type.claim_id" + }, + "954": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type" + }, + "955": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/claims/mutations.ts", + "qualifiedName": "__type.claim_id" + }, + "956": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "adminCollectionKeys" + }, + "957": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "useAdminCollections" + }, + "958": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "useAdminCollections" + }, + "959": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "query" + }, + "960": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "options" + }, + "961": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "962": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "963": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "__object" + }, + "964": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "965": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "966": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "967": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "collections" + }, + "968": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "969": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "__object" + }, + "970": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "971": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "972": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "973": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "collections" + }, + "974": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "975": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "__object" + }, + "976": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "977": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "978": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "979": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "collections" + }, + "980": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "981": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "__object" + }, + "982": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "983": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "984": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "985": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "collections" + }, + "986": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "987": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "useAdminCollection" + }, + "988": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "useAdminCollection" + }, + "989": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "id" + }, + "990": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "options" + }, + "991": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "__object" + }, + "992": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "collection" + }, + "993": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "994": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "__object" + }, + "995": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "collection" + }, + "996": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "997": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "__object" + }, + "998": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "collection" + }, + "999": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1000": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/queries.ts", + "qualifiedName": "__object" + }, + "1001": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/collections/index.d.ts", + "qualifiedName": "collection" + }, + "1002": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1003": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "useAdminCreateCollection" + }, + "1004": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "useAdminCreateCollection" + }, + "1005": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "options" + }, + "1006": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "useAdminUpdateCollection" + }, + "1007": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "useAdminUpdateCollection" + }, + "1008": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "id" + }, + "1009": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "options" + }, + "1010": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "useAdminDeleteCollection" + }, + "1011": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "useAdminDeleteCollection" + }, + "1012": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "id" + }, + "1013": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "options" + }, + "1014": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "useAdminAddProductsToCollection" + }, + "1015": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "useAdminAddProductsToCollection" + }, + "1016": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "id" + }, + "1017": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "options" + }, + "1018": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "useAdminRemoveProductsFromCollection" + }, + "1019": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "useAdminRemoveProductsFromCollection" + }, + "1020": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "id" + }, + "1021": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/collections/mutations.ts", + "qualifiedName": "options" + }, + "1022": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/mutations.ts", + "qualifiedName": "useAdminUpdateCurrency" + }, + "1023": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/mutations.ts", + "qualifiedName": "useAdminUpdateCurrency" + }, + "1024": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/mutations.ts", + "qualifiedName": "code" + }, + "1025": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/mutations.ts", + "qualifiedName": "options" + }, + "1026": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/queries.ts", + "qualifiedName": "adminCurrenciesKeys" + }, + "1027": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/queries.ts", + "qualifiedName": "useAdminCurrencies" + }, + "1028": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/queries.ts", + "qualifiedName": "useAdminCurrencies" + }, + "1029": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/queries.ts", + "qualifiedName": "query" + }, + "1030": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/queries.ts", + "qualifiedName": "options" + }, + "1031": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1032": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1033": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/queries.ts", + "qualifiedName": "__object" + }, + "1034": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1035": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1036": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1037": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/currencies/index.d.ts", + "qualifiedName": "currencies" + }, + "1038": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1039": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/queries.ts", + "qualifiedName": "__object" + }, + "1040": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1041": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1042": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1043": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/currencies/index.d.ts", + "qualifiedName": "currencies" + }, + "1044": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1045": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/queries.ts", + "qualifiedName": "__object" + }, + "1046": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1047": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1048": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1049": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/currencies/index.d.ts", + "qualifiedName": "currencies" + }, + "1050": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1051": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/currencies/queries.ts", + "qualifiedName": "__object" + }, + "1052": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1053": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1054": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1055": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/currencies/index.d.ts", + "qualifiedName": "currencies" + }, + "1056": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1057": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "useAdminCustomDelete" + }, + "1058": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "useAdminCustomDelete" + }, + "1059": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "TResponse" + }, + "1060": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "path" + }, + "1061": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "queryKey" + }, + "1062": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "relatedDomains" + }, + "1063": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "options" + }, + "1064": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "useAdminCustomPost" + }, + "1065": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "useAdminCustomPost" + }, + "1066": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "TPayload" + }, + "1067": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "TResponse" + }, + "1068": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "path" + }, + "1069": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "queryKey" + }, + "1070": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "relatedDomains" + }, + "1071": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/mutations.ts", + "qualifiedName": "options" + }, + "1072": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "useAdminCustomQuery" + }, + "1073": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "useAdminCustomQuery" + }, + "1074": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "TQuery" + }, + "1075": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "TResponse" + }, + "1076": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "path" + }, + "1077": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "queryKey" + }, + "1078": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "query" + }, + "1079": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "options" + }, + "1080": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "__object" + }, + "1081": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "__object.data" + }, + "1082": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "__object" + }, + "1083": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "__object.data" + }, + "1084": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "__object" + }, + "1085": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "__object.data" + }, + "1086": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "__object" + }, + "1087": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/custom/queries.ts", + "qualifiedName": "__object.data" + }, + "1118": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "useAdminCustomerGroup" + }, + "1119": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "useAdminCustomerGroup" + }, + "1120": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "id" + }, + "1121": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "query" + }, + "1122": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "options" + }, + "1123": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1124": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "customer_group" + }, + "1125": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1126": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1127": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "customer_group" + }, + "1128": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1129": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1130": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "customer_group" + }, + "1131": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1132": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1133": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "customer_group" + }, + "1134": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1135": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "useAdminCustomerGroups" + }, + "1136": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "useAdminCustomerGroups" + }, + "1137": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "query" + }, + "1138": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "options" + }, + "1139": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1140": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1141": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1142": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1143": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1144": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1145": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "customer_groups" + }, + "1146": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1147": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1148": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1149": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1150": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1151": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "customer_groups" + }, + "1152": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1153": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1154": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1155": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1156": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1157": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "customer_groups" + }, + "1158": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1159": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1160": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1161": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1162": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1163": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts", + "qualifiedName": "customer_groups" + }, + "1164": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1165": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "useAdminCustomerGroupCustomers" + }, + "1166": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "useAdminCustomerGroupCustomers" + }, + "1167": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "id" + }, + "1168": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "query" + }, + "1169": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "options" + }, + "1170": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1171": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts", + "qualifiedName": "limit" + }, + "1172": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts", + "qualifiedName": "offset" + }, + "1173": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts", + "qualifiedName": "expand" + }, + "1174": { + "sourceFileName": "../../../packages/medusa/dist/types/customers.d.ts", + "qualifiedName": "q" + }, + "1175": { + "sourceFileName": "../../../packages/medusa/dist/types/customers.d.ts", + "qualifiedName": "has_account" + }, + "1176": { + "sourceFileName": "../../../packages/medusa/dist/types/customers.d.ts", + "qualifiedName": "groups" + }, + "1177": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1178": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1179": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1180": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1181": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "customers" + }, + "1182": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1183": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1184": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1185": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1186": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1187": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "customers" + }, + "1188": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1189": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1190": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1191": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1192": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1193": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "customers" + }, + "1194": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1195": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/queries.ts", + "qualifiedName": "__object" + }, + "1196": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1197": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1198": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1199": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "customers" + }, + "1200": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1201": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "useAdminCreateCustomerGroup" + }, + "1202": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "useAdminCreateCustomerGroup" + }, + "1203": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "options" + }, + "1204": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "useAdminUpdateCustomerGroup" + }, + "1205": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "useAdminUpdateCustomerGroup" + }, + "1206": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "id" + }, + "1207": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "options" + }, + "1208": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "useAdminDeleteCustomerGroup" + }, + "1209": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "useAdminDeleteCustomerGroup" + }, + "1210": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "id" + }, + "1211": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "options" + }, + "1212": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "useAdminAddCustomersToCustomerGroup" + }, + "1213": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "useAdminAddCustomersToCustomerGroup" + }, + "1214": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "id" + }, + "1215": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "options" + }, + "1216": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "useAdminRemoveCustomersFromCustomerGroup" + }, + "1217": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "useAdminRemoveCustomersFromCustomerGroup" + }, + "1218": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "id" + }, + "1219": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts", + "qualifiedName": "options" + }, + "1220": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "adminCustomerKeys" + }, + "1221": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "useAdminCustomers" + }, + "1222": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "useAdminCustomers" + }, + "1223": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "query" + }, + "1224": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "options" + }, + "1225": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1226": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1227": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "__object" + }, + "1228": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1229": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1230": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1231": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "customers" + }, + "1232": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1233": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "__object" + }, + "1234": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1235": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1236": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1237": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "customers" + }, + "1238": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1239": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "__object" + }, + "1240": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1241": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1242": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1243": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "customers" + }, + "1244": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1245": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "__object" + }, + "1246": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1247": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1248": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1249": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "customers" + }, + "1250": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1251": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "useAdminCustomer" + }, + "1252": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "useAdminCustomer" + }, + "1253": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "id" + }, + "1254": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "options" + }, + "1255": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "__object" + }, + "1256": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "customer" + }, + "1257": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1258": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "__object" + }, + "1259": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "customer" + }, + "1260": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1261": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "__object" + }, + "1262": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "customer" + }, + "1263": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1264": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/queries.ts", + "qualifiedName": "__object" + }, + "1265": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/customers/index.d.ts", + "qualifiedName": "customer" + }, + "1266": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1267": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/mutations.ts", + "qualifiedName": "useAdminCreateCustomer" + }, + "1268": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/mutations.ts", + "qualifiedName": "useAdminCreateCustomer" + }, + "1269": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/mutations.ts", + "qualifiedName": "options" + }, + "1270": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/mutations.ts", + "qualifiedName": "useAdminUpdateCustomer" + }, + "1271": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/mutations.ts", + "qualifiedName": "useAdminUpdateCustomer" + }, + "1272": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/mutations.ts", + "qualifiedName": "id" + }, + "1273": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/customers/mutations.ts", + "qualifiedName": "options" + }, + "1274": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "adminDiscountKeys" + }, + "1275": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1276": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object.detailCondition" + }, + "1277": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object.detailCondition" + }, + "1278": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "id" + }, + "1279": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "query" + }, + "1280": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.all" + }, + "1281": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.lists" + }, + "1282": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1283": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1284": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.list" + }, + "1285": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1286": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1287": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "query" + }, + "1288": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1289": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1290": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.details" + }, + "1291": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1292": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1293": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.detail" + }, + "1294": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1295": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1296": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "id" + }, + "1297": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "useAdminDiscounts" + }, + "1298": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "useAdminDiscounts" + }, + "1299": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "query" + }, + "1300": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "options" + }, + "1301": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1302": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1303": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1304": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1305": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1306": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1307": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discounts" + }, + "1308": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1309": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1310": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1311": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1312": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1313": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discounts" + }, + "1314": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1315": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1316": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1317": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1318": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1319": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discounts" + }, + "1320": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1321": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1322": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1323": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1324": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1325": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discounts" + }, + "1326": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1327": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "useAdminDiscount" + }, + "1328": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "useAdminDiscount" + }, + "1329": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "id" + }, + "1330": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "query" + }, + "1331": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "options" + }, + "1332": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1333": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discount" + }, + "1334": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1335": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1336": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discount" + }, + "1337": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1338": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1339": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discount" + }, + "1340": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1341": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1342": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discount" + }, + "1343": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1344": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "useAdminGetDiscountByCode" + }, + "1345": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "useAdminGetDiscountByCode" + }, + "1346": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "code" + }, + "1347": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "options" + }, + "1348": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1349": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discount" + }, + "1350": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1351": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1352": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discount" + }, + "1353": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1354": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1355": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discount" + }, + "1356": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1357": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1358": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discount" + }, + "1359": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1360": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "useAdminGetDiscountCondition" + }, + "1361": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "useAdminGetDiscountCondition" + }, + "1362": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "id" + }, + "1363": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "conditionId" + }, + "1364": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "query" + }, + "1365": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "options" + }, + "1366": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1367": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discount_condition" + }, + "1368": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1369": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1370": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discount_condition" + }, + "1371": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1372": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1373": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discount_condition" + }, + "1374": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1375": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/queries.ts", + "qualifiedName": "__object" + }, + "1376": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/discounts/index.d.ts", + "qualifiedName": "discount_condition" + }, + "1377": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1378": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminAddDiscountConditionResourceBatch" + }, + "1379": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminAddDiscountConditionResourceBatch" + }, + "1380": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "discountId" + }, + "1381": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "conditionId" + }, + "1382": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "query" + }, + "1383": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "options" + }, + "1384": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDeleteDiscountConditionResourceBatch" + }, + "1385": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDeleteDiscountConditionResourceBatch" + }, + "1386": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "discountId" + }, + "1387": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "conditionId" + }, + "1388": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "options" + }, + "1389": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminCreateDiscount" + }, + "1390": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminCreateDiscount" + }, + "1391": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "options" + }, + "1392": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminUpdateDiscount" + }, + "1393": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminUpdateDiscount" + }, + "1394": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "id" + }, + "1395": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "options" + }, + "1396": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDeleteDiscount" + }, + "1397": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDeleteDiscount" + }, + "1398": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "id" + }, + "1399": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "options" + }, + "1400": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDiscountAddRegion" + }, + "1401": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDiscountAddRegion" + }, + "1402": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "id" + }, + "1403": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "options" + }, + "1404": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDiscountRemoveRegion" + }, + "1405": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDiscountRemoveRegion" + }, + "1406": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "id" + }, + "1407": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "options" + }, + "1408": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminCreateDynamicDiscountCode" + }, + "1409": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminCreateDynamicDiscountCode" + }, + "1410": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "id" + }, + "1411": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "options" + }, + "1412": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDeleteDynamicDiscountCode" + }, + "1413": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDeleteDynamicDiscountCode" + }, + "1414": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "id" + }, + "1415": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "options" + }, + "1416": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDiscountCreateCondition" + }, + "1417": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDiscountCreateCondition" + }, + "1418": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "discountId" + }, + "1419": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "options" + }, + "1420": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDiscountUpdateCondition" + }, + "1421": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDiscountUpdateCondition" + }, + "1422": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "discountId" + }, + "1423": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "conditionId" + }, + "1424": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "options" + }, + "1425": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDiscountRemoveCondition" + }, + "1426": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "useAdminDiscountRemoveCondition" + }, + "1427": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "discountId" + }, + "1428": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/discounts/mutations.ts", + "qualifiedName": "options" + }, + "1429": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "adminDraftOrderKeys" + }, + "1430": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "useAdminDraftOrders" + }, + "1431": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "useAdminDraftOrders" + }, + "1432": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "query" + }, + "1433": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "options" + }, + "1434": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1435": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1436": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "__object" + }, + "1437": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1438": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1439": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1440": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "draft_orders" + }, + "1441": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1442": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "__object" + }, + "1443": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1444": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1445": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1446": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "draft_orders" + }, + "1447": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1448": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "__object" + }, + "1449": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1450": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1451": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1452": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "draft_orders" + }, + "1453": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1454": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "__object" + }, + "1455": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1456": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1457": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1458": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "draft_orders" + }, + "1459": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1460": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "useAdminDraftOrder" + }, + "1461": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "useAdminDraftOrder" + }, + "1462": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "id" + }, + "1463": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "options" + }, + "1464": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "__object" + }, + "1465": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "draft_order" + }, + "1466": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1467": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "__object" + }, + "1468": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "draft_order" + }, + "1469": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1470": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "__object" + }, + "1471": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "draft_order" + }, + "1472": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1473": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/queries.ts", + "qualifiedName": "__object" + }, + "1474": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts", + "qualifiedName": "draft_order" + }, + "1475": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1476": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminCreateDraftOrder" + }, + "1477": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminCreateDraftOrder" + }, + "1478": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "options" + }, + "1479": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminUpdateDraftOrder" + }, + "1480": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminUpdateDraftOrder" + }, + "1481": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "id" + }, + "1482": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "options" + }, + "1483": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminDeleteDraftOrder" + }, + "1484": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminDeleteDraftOrder" + }, + "1485": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "id" + }, + "1486": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "options" + }, + "1487": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminDraftOrderRegisterPayment" + }, + "1488": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminDraftOrderRegisterPayment" + }, + "1489": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "id" + }, + "1490": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "options" + }, + "1491": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminDraftOrderAddLineItem" + }, + "1492": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminDraftOrderAddLineItem" + }, + "1493": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "id" + }, + "1494": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "options" + }, + "1495": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminDraftOrderRemoveLineItem" + }, + "1496": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminDraftOrderRemoveLineItem" + }, + "1497": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "id" + }, + "1498": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "options" + }, + "1499": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "AdminDraftOrderUpdateLineItemReq" + }, + "1500": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "__type" + }, + "1501": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "__type.item_id" + }, + "1502": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminDraftOrderUpdateLineItem" + }, + "1503": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "useAdminDraftOrderUpdateLineItem" + }, + "1504": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "id" + }, + "1505": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts", + "qualifiedName": "options" + }, + "1506": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "adminGiftCardKeys" + }, + "1507": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "useAdminGiftCards" + }, + "1508": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "useAdminGiftCards" + }, + "1509": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "query" + }, + "1510": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "options" + }, + "1511": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1512": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1513": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "__object" + }, + "1514": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1515": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1516": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1517": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "gift_cards" + }, + "1518": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1519": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "__object" + }, + "1520": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1521": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1522": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1523": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "gift_cards" + }, + "1524": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1525": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "__object" + }, + "1526": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1527": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1528": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1529": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "gift_cards" + }, + "1530": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1531": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "__object" + }, + "1532": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1533": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1534": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1535": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "gift_cards" + }, + "1536": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1537": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "useAdminGiftCard" + }, + "1538": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "useAdminGiftCard" + }, + "1539": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "id" + }, + "1540": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "options" + }, + "1541": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "__object" + }, + "1542": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "gift_card" + }, + "1543": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1544": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "__object" + }, + "1545": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "gift_card" + }, + "1546": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1547": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "__object" + }, + "1548": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "gift_card" + }, + "1549": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1550": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/queries.ts", + "qualifiedName": "__object" + }, + "1551": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts", + "qualifiedName": "gift_card" + }, + "1552": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1553": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts", + "qualifiedName": "useAdminCreateGiftCard" + }, + "1554": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts", + "qualifiedName": "useAdminCreateGiftCard" + }, + "1555": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts", + "qualifiedName": "options" + }, + "1556": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts", + "qualifiedName": "useAdminUpdateGiftCard" + }, + "1557": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts", + "qualifiedName": "useAdminUpdateGiftCard" + }, + "1558": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts", + "qualifiedName": "id" + }, + "1559": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts", + "qualifiedName": "options" + }, + "1560": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts", + "qualifiedName": "useAdminDeleteGiftCard" + }, + "1561": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts", + "qualifiedName": "useAdminDeleteGiftCard" + }, + "1562": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts", + "qualifiedName": "id" + }, + "1563": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts", + "qualifiedName": "options" + }, + "1564": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "adminInventoryItemsKeys" + }, + "1565": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "useAdminInventoryItems" + }, + "1566": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "useAdminInventoryItems" + }, + "1567": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "query" + }, + "1568": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "options" + }, + "1569": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1570": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1571": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "__object" + }, + "1572": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1573": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1574": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1575": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "inventory_items" + }, + "1576": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1577": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "__object" + }, + "1578": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1579": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1580": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1581": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "inventory_items" + }, + "1582": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1583": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "__object" + }, + "1584": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1585": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1586": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1587": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "inventory_items" + }, + "1588": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1589": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "__object" + }, + "1590": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1591": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1592": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1593": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "inventory_items" + }, + "1594": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1595": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "useAdminInventoryItem" + }, + "1596": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "useAdminInventoryItem" + }, + "1597": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "inventoryItemId" + }, + "1598": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "query" + }, + "1599": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "options" + }, + "1600": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "__object" + }, + "1601": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "inventory_item" + }, + "1602": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1603": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "__object" + }, + "1604": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "inventory_item" + }, + "1605": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1606": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "__object" + }, + "1607": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "inventory_item" + }, + "1608": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1609": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "__object" + }, + "1610": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "inventory_item" + }, + "1611": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1612": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "useAdminInventoryItemLocationLevels" + }, + "1613": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "useAdminInventoryItemLocationLevels" + }, + "1614": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "inventoryItemId" + }, + "1615": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "query" + }, + "1616": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "options" + }, + "1617": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "__object" + }, + "1618": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "inventory_item" + }, + "1619": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "__type" + }, + "1620": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "__type.id" + }, + "1621": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "__type.location_levels" + }, + "1622": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1623": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "__object" + }, + "1624": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "inventory_item" + }, + "1625": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "__type" + }, + "1626": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "__type.id" + }, + "1627": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "__type.location_levels" + }, + "1628": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1629": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "__object" + }, + "1630": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "inventory_item" + }, + "1631": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "__type" + }, + "1632": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "__type.id" + }, + "1633": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "__type.location_levels" + }, + "1634": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1635": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/queries.ts", + "qualifiedName": "__object" + }, + "1636": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "inventory_item" + }, + "1637": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "__type" + }, + "1638": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "__type.id" + }, + "1639": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts", + "qualifiedName": "__type.location_levels" + }, + "1640": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1641": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "useAdminCreateInventoryItem" + }, + "1642": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "useAdminCreateInventoryItem" + }, + "1643": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "options" + }, + "1644": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "useAdminUpdateInventoryItem" + }, + "1645": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "useAdminUpdateInventoryItem" + }, + "1646": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "inventoryItemId" + }, + "1647": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "options" + }, + "1648": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "useAdminDeleteInventoryItem" + }, + "1649": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "useAdminDeleteInventoryItem" + }, + "1650": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "inventoryItemId" + }, + "1651": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "options" + }, + "1652": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "AdminUpdateLocationLevelReq" + }, + "1653": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "__type" + }, + "1654": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "__type.stockLocationId" + }, + "1655": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "useAdminUpdateLocationLevel" + }, + "1656": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "useAdminUpdateLocationLevel" + }, + "1657": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "inventoryItemId" + }, + "1658": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "options" + }, + "1659": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "useAdminDeleteLocationLevel" + }, + "1660": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "useAdminDeleteLocationLevel" + }, + "1661": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "inventoryItemId" + }, + "1662": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "options" + }, + "1663": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "useAdminCreateLocationLevel" + }, + "1664": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "useAdminCreateLocationLevel" + }, + "1665": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "inventoryItemId" + }, + "1666": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts", + "qualifiedName": "options" + }, + "1667": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/queries.ts", + "qualifiedName": "adminInviteKeys" + }, + "1668": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/queries.ts", + "qualifiedName": "useAdminInvites" + }, + "1669": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/queries.ts", + "qualifiedName": "useAdminInvites" + }, + "1670": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/queries.ts", + "qualifiedName": "options" + }, + "1671": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/queries.ts", + "qualifiedName": "__object" + }, + "1672": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/invites/index.d.ts", + "qualifiedName": "invites" + }, + "1673": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1674": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/queries.ts", + "qualifiedName": "__object" + }, + "1675": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/invites/index.d.ts", + "qualifiedName": "invites" + }, + "1676": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1677": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/queries.ts", + "qualifiedName": "__object" + }, + "1678": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/invites/index.d.ts", + "qualifiedName": "invites" + }, + "1679": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1680": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/queries.ts", + "qualifiedName": "__object" + }, + "1681": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/invites/index.d.ts", + "qualifiedName": "invites" + }, + "1682": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1683": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "useAdminAcceptInvite" + }, + "1684": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "useAdminAcceptInvite" + }, + "1685": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "options" + }, + "1686": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "useAdminResendInvite" + }, + "1687": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "useAdminResendInvite" + }, + "1688": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "id" + }, + "1689": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "options" + }, + "1690": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "useAdminCreateInvite" + }, + "1691": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "useAdminCreateInvite" + }, + "1692": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "options" + }, + "1693": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "useAdminDeleteInvite" + }, + "1694": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "useAdminDeleteInvite" + }, + "1695": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "id" + }, + "1696": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/invites/mutations.ts", + "qualifiedName": "options" + }, + "1697": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "adminNoteKeys" + }, + "1698": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "useAdminNotes" + }, + "1699": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "useAdminNotes" + }, + "1700": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "query" + }, + "1701": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "options" + }, + "1702": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1703": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1704": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "__object" + }, + "1705": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1706": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1707": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1708": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "notes" + }, + "1709": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1710": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "__object" + }, + "1711": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1712": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1713": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1714": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "notes" + }, + "1715": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1716": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "__object" + }, + "1717": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1718": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1719": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1720": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "notes" + }, + "1721": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1722": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "__object" + }, + "1723": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1724": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1725": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1726": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "notes" + }, + "1727": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1728": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "useAdminNote" + }, + "1729": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "useAdminNote" + }, + "1730": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "id" + }, + "1731": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "options" + }, + "1732": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "__object" + }, + "1733": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "note" + }, + "1734": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1735": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "__object" + }, + "1736": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "note" + }, + "1737": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1738": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "__object" + }, + "1739": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "note" + }, + "1740": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1741": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/queries.ts", + "qualifiedName": "__object" + }, + "1742": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notes/index.d.ts", + "qualifiedName": "note" + }, + "1743": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1744": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/mutations.ts", + "qualifiedName": "useAdminCreateNote" + }, + "1745": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/mutations.ts", + "qualifiedName": "useAdminCreateNote" + }, + "1746": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/mutations.ts", + "qualifiedName": "options" + }, + "1747": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/mutations.ts", + "qualifiedName": "useAdminUpdateNote" + }, + "1748": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/mutations.ts", + "qualifiedName": "useAdminUpdateNote" + }, + "1749": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/mutations.ts", + "qualifiedName": "id" + }, + "1750": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/mutations.ts", + "qualifiedName": "options" + }, + "1751": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/mutations.ts", + "qualifiedName": "useAdminDeleteNote" + }, + "1752": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/mutations.ts", + "qualifiedName": "useAdminDeleteNote" + }, + "1753": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/mutations.ts", + "qualifiedName": "id" + }, + "1754": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notes/mutations.ts", + "qualifiedName": "options" + }, + "1755": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/queries.ts", + "qualifiedName": "adminNotificationKeys" + }, + "1756": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/queries.ts", + "qualifiedName": "useAdminNotifications" + }, + "1757": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/queries.ts", + "qualifiedName": "useAdminNotifications" + }, + "1758": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/queries.ts", + "qualifiedName": "query" + }, + "1759": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/queries.ts", + "qualifiedName": "options" + }, + "1760": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1761": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1762": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/queries.ts", + "qualifiedName": "__object" + }, + "1763": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "limit" + }, + "1764": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "offset" + }, + "1765": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "count" + }, + "1766": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notifications/index.d.ts", + "qualifiedName": "notifications" + }, + "1767": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1768": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/queries.ts", + "qualifiedName": "__object" + }, + "1769": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "limit" + }, + "1770": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "offset" + }, + "1771": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "count" + }, + "1772": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notifications/index.d.ts", + "qualifiedName": "notifications" + }, + "1773": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1774": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/queries.ts", + "qualifiedName": "__object" + }, + "1775": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "limit" + }, + "1776": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "offset" + }, + "1777": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "count" + }, + "1778": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notifications/index.d.ts", + "qualifiedName": "notifications" + }, + "1779": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1780": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/queries.ts", + "qualifiedName": "__object" + }, + "1781": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "limit" + }, + "1782": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "offset" + }, + "1783": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "count" + }, + "1784": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/notifications/index.d.ts", + "qualifiedName": "notifications" + }, + "1785": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1786": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/mutations.ts", + "qualifiedName": "useAdminResendNotification" + }, + "1787": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/mutations.ts", + "qualifiedName": "useAdminResendNotification" + }, + "1788": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/mutations.ts", + "qualifiedName": "id" + }, + "1789": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/notifications/mutations.ts", + "qualifiedName": "options" + }, + "1790": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "adminOrderEditsKeys" + }, + "1791": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "useAdminOrderEdit" + }, + "1792": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "useAdminOrderEdit" + }, + "1793": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "id" + }, + "1794": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "query" + }, + "1795": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "options" + }, + "1796": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "__object" + }, + "1797": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "order_edit" + }, + "1798": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1799": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "__object" + }, + "1800": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "order_edit" + }, + "1801": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1802": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "__object" + }, + "1803": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "order_edit" + }, + "1804": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1805": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "__object" + }, + "1806": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "order_edit" + }, + "1807": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1808": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "useAdminOrderEdits" + }, + "1809": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "useAdminOrderEdits" + }, + "1810": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "query" + }, + "1811": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "options" + }, + "1812": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1813": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1814": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "__object" + }, + "1815": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1816": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1817": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1818": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "order_edits" + }, + "1819": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1820": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "__object" + }, + "1821": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1822": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1823": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1824": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "order_edits" + }, + "1825": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1826": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "__object" + }, + "1827": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1828": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1829": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1830": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "order_edits" + }, + "1831": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1832": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/queries.ts", + "qualifiedName": "__object" + }, + "1833": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1834": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1835": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1836": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/order-edits/index.d.ts", + "qualifiedName": "order_edits" + }, + "1837": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1838": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminCreateOrderEdit" + }, + "1839": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminCreateOrderEdit" + }, + "1840": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "options" + }, + "1841": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminDeleteOrderEdit" + }, + "1842": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminDeleteOrderEdit" + }, + "1843": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "id" + }, + "1844": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "options" + }, + "1845": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminDeleteOrderEditItemChange" + }, + "1846": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminDeleteOrderEditItemChange" + }, + "1847": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "orderEditId" + }, + "1848": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "itemChangeId" + }, + "1849": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "options" + }, + "1850": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminOrderEditUpdateLineItem" + }, + "1851": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminOrderEditUpdateLineItem" + }, + "1852": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "orderEditId" + }, + "1853": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "itemId" + }, + "1854": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "options" + }, + "1855": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminOrderEditDeleteLineItem" + }, + "1856": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminOrderEditDeleteLineItem" + }, + "1857": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "orderEditId" + }, + "1858": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "itemId" + }, + "1859": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "options" + }, + "1860": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminUpdateOrderEdit" + }, + "1861": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminUpdateOrderEdit" + }, + "1862": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "id" + }, + "1863": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "options" + }, + "1864": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminOrderEditAddLineItem" + }, + "1865": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminOrderEditAddLineItem" + }, + "1866": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "id" + }, + "1867": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "options" + }, + "1868": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminRequestOrderEditConfirmation" + }, + "1869": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminRequestOrderEditConfirmation" + }, + "1870": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "id" + }, + "1871": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "options" + }, + "1872": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminCancelOrderEdit" + }, + "1873": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminCancelOrderEdit" + }, + "1874": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "id" + }, + "1875": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "options" + }, + "1876": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminConfirmOrderEdit" + }, + "1877": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "useAdminConfirmOrderEdit" + }, + "1878": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "id" + }, + "1879": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/order-edits/mutations.ts", + "qualifiedName": "options" + }, + "1880": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "adminOrderKeys" + }, + "1881": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object" + }, + "1882": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object.detailOrder" + }, + "1883": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object.detailOrder" + }, + "1884": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "id" + }, + "1885": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "query" + }, + "1886": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object" + }, + "1887": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "FindParams.expand" + }, + "1888": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "FindParams.fields" + }, + "1889": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.all" + }, + "1890": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.lists" + }, + "1891": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1892": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1893": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.list" + }, + "1894": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1895": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1896": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "query" + }, + "1897": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1898": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1899": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.details" + }, + "1900": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1901": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1902": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.detail" + }, + "1903": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1904": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1905": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "id" + }, + "1906": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "useAdminOrders" + }, + "1907": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "useAdminOrders" + }, + "1908": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "query" + }, + "1909": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "options" + }, + "1910": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "1911": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "1912": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object" + }, + "1913": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1914": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1915": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1916": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "orders" + }, + "1917": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1918": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object" + }, + "1919": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1920": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1921": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1922": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "orders" + }, + "1923": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1924": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object" + }, + "1925": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1926": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1927": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1928": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "orders" + }, + "1929": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1930": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object" + }, + "1931": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "1932": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "1933": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "1934": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "orders" + }, + "1935": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1936": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "useAdminOrder" + }, + "1937": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "useAdminOrder" + }, + "1938": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "id" + }, + "1939": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "query" + }, + "1940": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "options" + }, + "1941": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object" + }, + "1942": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "FindParams.expand" + }, + "1943": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "FindParams.fields" + }, + "1944": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object" + }, + "1945": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "order" + }, + "1946": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1947": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object" + }, + "1948": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "order" + }, + "1949": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1950": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object" + }, + "1951": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "order" + }, + "1952": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1953": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/queries.ts", + "qualifiedName": "__object" + }, + "1954": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/orders/index.d.ts", + "qualifiedName": "order" + }, + "1955": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "1956": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminUpdateOrder" + }, + "1957": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminUpdateOrder" + }, + "1958": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "id" + }, + "1959": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "options" + }, + "1960": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminCancelOrder" + }, + "1961": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminCancelOrder" + }, + "1962": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "id" + }, + "1963": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "options" + }, + "1964": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminCompleteOrder" + }, + "1965": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminCompleteOrder" + }, + "1966": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "id" + }, + "1967": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "options" + }, + "1968": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminCapturePayment" + }, + "1969": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminCapturePayment" + }, + "1970": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "id" + }, + "1971": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "options" + }, + "1972": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminRefundPayment" + }, + "1973": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminRefundPayment" + }, + "1974": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "id" + }, + "1975": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "options" + }, + "1976": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminCreateFulfillment" + }, + "1977": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminCreateFulfillment" + }, + "1978": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "orderId" + }, + "1979": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "options" + }, + "1980": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminCancelFulfillment" + }, + "1981": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminCancelFulfillment" + }, + "1982": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "orderId" + }, + "1983": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "options" + }, + "1984": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminCreateShipment" + }, + "1985": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminCreateShipment" + }, + "1986": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "orderId" + }, + "1987": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "options" + }, + "1988": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminRequestReturn" + }, + "1989": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminRequestReturn" + }, + "1990": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "orderId" + }, + "1991": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "options" + }, + "1992": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminAddShippingMethod" + }, + "1993": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminAddShippingMethod" + }, + "1994": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "orderId" + }, + "1995": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "options" + }, + "1996": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminArchiveOrder" + }, + "1997": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "useAdminArchiveOrder" + }, + "1998": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "id" + }, + "1999": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/orders/mutations.ts", + "qualifiedName": "options" + }, + "2000": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/queries.ts", + "qualifiedName": "adminPaymentCollectionQueryKeys" + }, + "2001": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/queries.ts", + "qualifiedName": "useAdminPaymentCollection" + }, + "2002": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/queries.ts", + "qualifiedName": "useAdminPaymentCollection" + }, + "2003": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/queries.ts", + "qualifiedName": "id" + }, + "2004": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/queries.ts", + "qualifiedName": "options" + }, + "2005": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/queries.ts", + "qualifiedName": "__object" + }, + "2006": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts", + "qualifiedName": "payment_collection" + }, + "2007": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2008": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/queries.ts", + "qualifiedName": "__object" + }, + "2009": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts", + "qualifiedName": "payment_collection" + }, + "2010": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2011": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/queries.ts", + "qualifiedName": "__object" + }, + "2012": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts", + "qualifiedName": "payment_collection" + }, + "2013": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2014": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/queries.ts", + "qualifiedName": "__object" + }, + "2015": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts", + "qualifiedName": "payment_collection" + }, + "2016": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2017": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts", + "qualifiedName": "useAdminDeletePaymentCollection" + }, + "2018": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts", + "qualifiedName": "useAdminDeletePaymentCollection" + }, + "2019": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts", + "qualifiedName": "id" + }, + "2020": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts", + "qualifiedName": "options" + }, + "2021": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts", + "qualifiedName": "useAdminUpdatePaymentCollection" + }, + "2022": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts", + "qualifiedName": "useAdminUpdatePaymentCollection" + }, + "2023": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts", + "qualifiedName": "id" + }, + "2024": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts", + "qualifiedName": "options" + }, + "2025": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts", + "qualifiedName": "useAdminMarkPaymentCollectionAsAuthorized" + }, + "2026": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts", + "qualifiedName": "useAdminMarkPaymentCollectionAsAuthorized" + }, + "2027": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts", + "qualifiedName": "id" + }, + "2028": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts", + "qualifiedName": "options" + }, + "2029": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/queries.ts", + "qualifiedName": "adminPaymentQueryKeys" + }, + "2030": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/queries.ts", + "qualifiedName": "useAdminPayment" + }, + "2031": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/queries.ts", + "qualifiedName": "useAdminPayment" + }, + "2032": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/queries.ts", + "qualifiedName": "id" + }, + "2033": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/queries.ts", + "qualifiedName": "options" + }, + "2034": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/queries.ts", + "qualifiedName": "__object" + }, + "2035": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payments/index.d.ts", + "qualifiedName": "payment" + }, + "2036": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2037": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/queries.ts", + "qualifiedName": "__object" + }, + "2038": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payments/index.d.ts", + "qualifiedName": "payment" + }, + "2039": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2040": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/queries.ts", + "qualifiedName": "__object" + }, + "2041": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payments/index.d.ts", + "qualifiedName": "payment" + }, + "2042": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2043": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/queries.ts", + "qualifiedName": "__object" + }, + "2044": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/payments/index.d.ts", + "qualifiedName": "payment" + }, + "2045": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2046": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/mutations.ts", + "qualifiedName": "useAdminPaymentsCapturePayment" + }, + "2047": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/mutations.ts", + "qualifiedName": "useAdminPaymentsCapturePayment" + }, + "2048": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/mutations.ts", + "qualifiedName": "id" + }, + "2049": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/mutations.ts", + "qualifiedName": "options" + }, + "2050": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/mutations.ts", + "qualifiedName": "useAdminPaymentsRefundPayment" + }, + "2051": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/mutations.ts", + "qualifiedName": "useAdminPaymentsRefundPayment" + }, + "2052": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/mutations.ts", + "qualifiedName": "id" + }, + "2053": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/payments/mutations.ts", + "qualifiedName": "options" + }, + "2054": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "adminPriceListKeys" + }, + "2055": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2056": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object.detailProducts" + }, + "2057": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object.detailProducts" + }, + "2058": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "id" + }, + "2059": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "query" + }, + "2060": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.all" + }, + "2061": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.lists" + }, + "2062": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2063": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2064": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.list" + }, + "2065": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2066": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2067": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "query" + }, + "2068": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2069": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2070": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.details" + }, + "2071": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2072": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2073": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.detail" + }, + "2074": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2075": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2076": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "id" + }, + "2077": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "useAdminPriceLists" + }, + "2078": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "useAdminPriceLists" + }, + "2079": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "query" + }, + "2080": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "options" + }, + "2081": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2082": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2083": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2084": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2085": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2086": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2087": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "price_lists" + }, + "2088": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2089": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2090": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2091": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2092": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2093": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "price_lists" + }, + "2094": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2095": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2096": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2097": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2098": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2099": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "price_lists" + }, + "2100": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2101": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2102": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2103": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2104": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2105": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "price_lists" + }, + "2106": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2107": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "useAdminPriceListProducts" + }, + "2108": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "useAdminPriceListProducts" + }, + "2109": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "id" + }, + "2110": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "query" + }, + "2111": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "options" + }, + "2112": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2113": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2114": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2115": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2116": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "products" + }, + "2117": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2118": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2119": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2120": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2121": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2122": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "products" + }, + "2123": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2124": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2125": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2126": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2127": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2128": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "products" + }, + "2129": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2130": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2131": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2132": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2133": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2134": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "products" + }, + "2135": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2136": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "useAdminPriceList" + }, + "2137": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "useAdminPriceList" + }, + "2138": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "id" + }, + "2139": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "options" + }, + "2140": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2141": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "price_list" + }, + "2142": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2143": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2144": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "price_list" + }, + "2145": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2146": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2147": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "price_list" + }, + "2148": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2149": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/queries.ts", + "qualifiedName": "__object" + }, + "2150": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/price-lists/index.d.ts", + "qualifiedName": "price_list" + }, + "2151": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2152": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminCreatePriceList" + }, + "2153": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminCreatePriceList" + }, + "2154": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "options" + }, + "2155": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminUpdatePriceList" + }, + "2156": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminUpdatePriceList" + }, + "2157": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "id" + }, + "2158": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "options" + }, + "2159": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminDeletePriceList" + }, + "2160": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminDeletePriceList" + }, + "2161": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "id" + }, + "2162": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "options" + }, + "2163": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminCreatePriceListPrices" + }, + "2164": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminCreatePriceListPrices" + }, + "2165": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "id" + }, + "2166": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "options" + }, + "2167": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminDeletePriceListPrices" + }, + "2168": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminDeletePriceListPrices" + }, + "2169": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "id" + }, + "2170": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "options" + }, + "2171": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminDeletePriceListProductsPrices" + }, + "2172": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminDeletePriceListProductsPrices" + }, + "2173": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "id" + }, + "2174": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "options" + }, + "2175": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminDeletePriceListProductPrices" + }, + "2176": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminDeletePriceListProductPrices" + }, + "2177": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "id" + }, + "2178": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "productId" + }, + "2179": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "options" + }, + "2180": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminDeletePriceListVariantPrices" + }, + "2181": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "useAdminDeletePriceListVariantPrices" + }, + "2182": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "id" + }, + "2183": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "variantId" + }, + "2184": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/price-lists/mutations.ts", + "qualifiedName": "options" + }, + "2185": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "adminProductCategoryKeys" + }, + "2186": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "useAdminProductCategories" + }, + "2187": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "useAdminProductCategories" + }, + "2188": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "query" + }, + "2189": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "options" + }, + "2190": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2191": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2192": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "2193": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2194": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2195": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2196": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "product_categories" + }, + "2197": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2198": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "2199": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2200": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2201": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2202": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "product_categories" + }, + "2203": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2204": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "2205": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2206": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2207": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2208": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "product_categories" + }, + "2209": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2210": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "2211": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2212": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2213": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2214": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "product_categories" + }, + "2215": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2216": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "useAdminProductCategory" + }, + "2217": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "useAdminProductCategory" + }, + "2218": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "id" + }, + "2219": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "query" + }, + "2220": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "options" + }, + "2221": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "2222": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "product_category" + }, + "2223": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2224": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "2225": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "product_category" + }, + "2226": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2227": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "2228": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "product_category" + }, + "2229": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2230": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/queries.ts", + "qualifiedName": "__object" + }, + "2231": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-categories/index.d.ts", + "qualifiedName": "product_category" + }, + "2232": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2233": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "useAdminCreateProductCategory" + }, + "2234": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "useAdminCreateProductCategory" + }, + "2235": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "options" + }, + "2236": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "useAdminUpdateProductCategory" + }, + "2237": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "useAdminUpdateProductCategory" + }, + "2238": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "id" + }, + "2239": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "options" + }, + "2240": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "useAdminDeleteProductCategory" + }, + "2241": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "useAdminDeleteProductCategory" + }, + "2242": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "id" + }, + "2243": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "options" + }, + "2244": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "useAdminAddProductsToCategory" + }, + "2245": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "useAdminAddProductsToCategory" + }, + "2246": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "id" + }, + "2247": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "options" + }, + "2248": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "useAdminDeleteProductsFromCategory" + }, + "2249": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "useAdminDeleteProductsFromCategory" + }, + "2250": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "id" + }, + "2251": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-categories/mutations.ts", + "qualifiedName": "options" + }, + "2252": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-tags/queries.ts", + "qualifiedName": "adminProductTagKeys" + }, + "2253": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-tags/queries.ts", + "qualifiedName": "useAdminProductTags" + }, + "2254": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-tags/queries.ts", + "qualifiedName": "useAdminProductTags" + }, + "2255": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-tags/queries.ts", + "qualifiedName": "query" + }, + "2256": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-tags/queries.ts", + "qualifiedName": "options" + }, + "2257": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2258": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2259": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-tags/queries.ts", + "qualifiedName": "__object" + }, + "2260": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2261": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2262": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2263": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-tags/index.d.ts", + "qualifiedName": "product_tags" + }, + "2264": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2265": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-tags/queries.ts", + "qualifiedName": "__object" + }, + "2266": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2267": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2268": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2269": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-tags/index.d.ts", + "qualifiedName": "product_tags" + }, + "2270": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2271": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-tags/queries.ts", + "qualifiedName": "__object" + }, + "2272": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2273": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2274": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2275": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-tags/index.d.ts", + "qualifiedName": "product_tags" + }, + "2276": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2277": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-tags/queries.ts", + "qualifiedName": "__object" + }, + "2278": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2279": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2280": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2281": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-tags/index.d.ts", + "qualifiedName": "product_tags" + }, + "2282": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2283": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-types/queries.ts", + "qualifiedName": "adminProductTypeKeys" + }, + "2284": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-types/queries.ts", + "qualifiedName": "useAdminProductTypes" + }, + "2285": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-types/queries.ts", + "qualifiedName": "useAdminProductTypes" + }, + "2286": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-types/queries.ts", + "qualifiedName": "query" + }, + "2287": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-types/queries.ts", + "qualifiedName": "options" + }, + "2288": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2289": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2290": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-types/queries.ts", + "qualifiedName": "__object" + }, + "2291": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2292": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2293": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2294": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-types/index.d.ts", + "qualifiedName": "product_types" + }, + "2295": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2296": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-types/queries.ts", + "qualifiedName": "__object" + }, + "2297": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2298": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2299": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2300": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-types/index.d.ts", + "qualifiedName": "product_types" + }, + "2301": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2302": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-types/queries.ts", + "qualifiedName": "__object" + }, + "2303": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2304": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2305": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2306": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-types/index.d.ts", + "qualifiedName": "product_types" + }, + "2307": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2308": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/product-types/queries.ts", + "qualifiedName": "__object" + }, + "2309": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2310": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2311": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2312": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/product-types/index.d.ts", + "qualifiedName": "product_types" + }, + "2313": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2314": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "adminProductKeys" + }, + "2315": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "useAdminProducts" + }, + "2316": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "useAdminProducts" + }, + "2317": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "query" + }, + "2318": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "options" + }, + "2319": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2320": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2321": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "__object" + }, + "2322": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2323": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2324": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2325": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "products" + }, + "2326": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2327": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "__object" + }, + "2328": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2329": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2330": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2331": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "products" + }, + "2332": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2333": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "__object" + }, + "2334": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2335": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2336": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2337": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "products" + }, + "2338": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2339": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "__object" + }, + "2340": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2341": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2342": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2343": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "products" + }, + "2344": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2345": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "useAdminProduct" + }, + "2346": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "useAdminProduct" + }, + "2347": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "id" + }, + "2348": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "query" + }, + "2349": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "options" + }, + "2350": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "__object" + }, + "2351": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "product" + }, + "2352": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2353": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "__object" + }, + "2354": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "product" + }, + "2355": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2356": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "__object" + }, + "2357": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "product" + }, + "2358": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2359": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "__object" + }, + "2360": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "product" + }, + "2361": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2362": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "useAdminProductTagUsage" + }, + "2363": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "useAdminProductTagUsage" + }, + "2364": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "options" + }, + "2365": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "__object" + }, + "2366": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "tags" + }, + "2367": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "__type" + }, + "2368": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "__type.usage_count" + }, + "2369": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2370": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "__object" + }, + "2371": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "tags" + }, + "2372": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "__type" + }, + "2373": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "__type.usage_count" + }, + "2374": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2375": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "__object" + }, + "2376": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "tags" + }, + "2377": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "__type" + }, + "2378": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "__type.usage_count" + }, + "2379": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2380": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/queries.ts", + "qualifiedName": "__object" + }, + "2381": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "tags" + }, + "2382": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "__type" + }, + "2383": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/products/index.d.ts", + "qualifiedName": "__type.usage_count" + }, + "2384": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2385": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminCreateProduct" + }, + "2386": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminCreateProduct" + }, + "2387": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "options" + }, + "2388": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminUpdateProduct" + }, + "2389": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminUpdateProduct" + }, + "2390": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "id" + }, + "2391": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "options" + }, + "2392": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminDeleteProduct" + }, + "2393": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminDeleteProduct" + }, + "2394": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "id" + }, + "2395": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "options" + }, + "2396": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminCreateVariant" + }, + "2397": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminCreateVariant" + }, + "2398": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "productId" + }, + "2399": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "options" + }, + "2400": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "AdminUpdateVariantReq" + }, + "2401": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "__type" + }, + "2402": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "__type.variant_id" + }, + "2403": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminUpdateVariant" + }, + "2404": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminUpdateVariant" + }, + "2405": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "productId" + }, + "2406": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "options" + }, + "2407": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminDeleteVariant" + }, + "2408": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminDeleteVariant" + }, + "2409": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "productId" + }, + "2410": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "options" + }, + "2411": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminCreateProductOption" + }, + "2412": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminCreateProductOption" + }, + "2413": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "productId" + }, + "2414": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "options" + }, + "2415": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "AdminUpdateProductOptionReq" + }, + "2416": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "__type" + }, + "2417": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "__type.option_id" + }, + "2418": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminUpdateProductOption" + }, + "2419": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminUpdateProductOption" + }, + "2420": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "productId" + }, + "2421": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "options" + }, + "2422": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminDeleteProductOption" + }, + "2423": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "useAdminDeleteProductOption" + }, + "2424": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "productId" + }, + "2425": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/products/mutations.ts", + "qualifiedName": "options" + }, + "2426": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "adminPublishableApiKeysKeys" + }, + "2427": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2428": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object.detailSalesChannels" + }, + "2429": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object.detailSalesChannels" + }, + "2430": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "id" + }, + "2431": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "query" + }, + "2432": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.all" + }, + "2433": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.lists" + }, + "2434": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2435": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2436": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.list" + }, + "2437": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2438": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2439": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "query" + }, + "2440": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2441": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2442": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.details" + }, + "2443": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2444": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2445": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.detail" + }, + "2446": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2447": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2448": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "id" + }, + "2449": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "useAdminPublishableApiKey" + }, + "2450": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "useAdminPublishableApiKey" + }, + "2451": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "id" + }, + "2452": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "options" + }, + "2453": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2454": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "publishable_api_key" + }, + "2455": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2456": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2457": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "publishable_api_key" + }, + "2458": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2459": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2460": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "publishable_api_key" + }, + "2461": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2462": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2463": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "publishable_api_key" + }, + "2464": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2465": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "useAdminPublishableApiKeys" + }, + "2466": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "useAdminPublishableApiKeys" + }, + "2467": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "query" + }, + "2468": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "options" + }, + "2469": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2470": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2471": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2472": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2473": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2474": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2475": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "publishable_api_keys" + }, + "2476": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2477": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2478": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2479": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2480": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2481": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "publishable_api_keys" + }, + "2482": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2483": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2484": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2485": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2486": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2487": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "publishable_api_keys" + }, + "2488": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2489": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2490": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2491": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2492": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2493": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "publishable_api_keys" + }, + "2494": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2495": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "useAdminPublishableApiKeySalesChannels" + }, + "2496": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "useAdminPublishableApiKeySalesChannels" + }, + "2497": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "id" + }, + "2498": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "query" + }, + "2499": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "options" + }, + "2500": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2501": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "sales_channels" + }, + "2502": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2503": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2504": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "sales_channels" + }, + "2505": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2506": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2507": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "sales_channels" + }, + "2508": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2509": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts", + "qualifiedName": "__object" + }, + "2510": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts", + "qualifiedName": "sales_channels" + }, + "2511": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2512": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "useAdminCreatePublishableApiKey" + }, + "2513": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "useAdminCreatePublishableApiKey" + }, + "2514": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "options" + }, + "2515": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "useAdminUpdatePublishableApiKey" + }, + "2516": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "useAdminUpdatePublishableApiKey" + }, + "2517": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "id" + }, + "2518": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "options" + }, + "2519": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "useAdminDeletePublishableApiKey" + }, + "2520": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "useAdminDeletePublishableApiKey" + }, + "2521": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "id" + }, + "2522": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "options" + }, + "2523": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "useAdminRevokePublishableApiKey" + }, + "2524": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "useAdminRevokePublishableApiKey" + }, + "2525": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "id" + }, + "2526": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "options" + }, + "2527": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "useAdminAddPublishableKeySalesChannelsBatch" + }, + "2528": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "useAdminAddPublishableKeySalesChannelsBatch" + }, + "2529": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "id" + }, + "2530": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "options" + }, + "2531": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "useAdminRemovePublishableKeySalesChannelsBatch" + }, + "2532": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "useAdminRemovePublishableKeySalesChannelsBatch" + }, + "2533": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "id" + }, + "2534": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts", + "qualifiedName": "options" + }, + "2535": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "adminRegionKeys" + }, + "2536": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "useAdminRegions" + }, + "2537": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "useAdminRegions" + }, + "2538": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "query" + }, + "2539": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "options" + }, + "2540": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2541": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2542": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "__object" + }, + "2543": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2544": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2545": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2546": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "regions" + }, + "2547": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2548": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "__object" + }, + "2549": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2550": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2551": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2552": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "regions" + }, + "2553": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2554": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "__object" + }, + "2555": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2556": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2557": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2558": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "regions" + }, + "2559": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2560": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "__object" + }, + "2561": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2562": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2563": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2564": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "regions" + }, + "2565": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2566": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "useAdminRegion" + }, + "2567": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "useAdminRegion" + }, + "2568": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "id" + }, + "2569": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "options" + }, + "2570": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "__object" + }, + "2571": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "region" + }, + "2572": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2573": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "__object" + }, + "2574": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "region" + }, + "2575": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2576": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "__object" + }, + "2577": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "region" + }, + "2578": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2579": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "__object" + }, + "2580": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "region" + }, + "2581": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2582": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "useAdminRegionFulfillmentOptions" + }, + "2583": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "useAdminRegionFulfillmentOptions" + }, + "2584": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "regionId" + }, + "2585": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "options" + }, + "2586": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "__object" + }, + "2587": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "fulfillment_options" + }, + "2588": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2589": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "__object" + }, + "2590": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "fulfillment_options" + }, + "2591": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2592": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "__object" + }, + "2593": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "fulfillment_options" + }, + "2594": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2595": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/queries.ts", + "qualifiedName": "__object" + }, + "2596": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/regions/index.d.ts", + "qualifiedName": "fulfillment_options" + }, + "2597": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2598": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminCreateRegion" + }, + "2599": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminCreateRegion" + }, + "2600": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "options" + }, + "2601": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminUpdateRegion" + }, + "2602": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminUpdateRegion" + }, + "2603": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "id" + }, + "2604": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "options" + }, + "2605": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminDeleteRegion" + }, + "2606": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminDeleteRegion" + }, + "2607": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "id" + }, + "2608": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "options" + }, + "2609": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminRegionAddCountry" + }, + "2610": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminRegionAddCountry" + }, + "2611": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "id" + }, + "2612": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "options" + }, + "2613": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminRegionRemoveCountry" + }, + "2614": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminRegionRemoveCountry" + }, + "2615": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "id" + }, + "2616": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "options" + }, + "2617": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminRegionAddFulfillmentProvider" + }, + "2618": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminRegionAddFulfillmentProvider" + }, + "2619": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "id" + }, + "2620": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "options" + }, + "2621": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminRegionDeleteFulfillmentProvider" + }, + "2622": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminRegionDeleteFulfillmentProvider" + }, + "2623": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "id" + }, + "2624": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "options" + }, + "2625": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminRegionAddPaymentProvider" + }, + "2626": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminRegionAddPaymentProvider" + }, + "2627": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "id" + }, + "2628": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "options" + }, + "2629": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminRegionDeletePaymentProvider" + }, + "2630": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "useAdminRegionDeletePaymentProvider" + }, + "2631": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "id" + }, + "2632": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/regions/mutations.ts", + "qualifiedName": "options" + }, + "2633": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/mutations.ts", + "qualifiedName": "useAdminCreateReservation" + }, + "2634": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/mutations.ts", + "qualifiedName": "useAdminCreateReservation" + }, + "2635": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/mutations.ts", + "qualifiedName": "options" + }, + "2636": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/mutations.ts", + "qualifiedName": "useAdminUpdateReservation" + }, + "2637": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/mutations.ts", + "qualifiedName": "useAdminUpdateReservation" + }, + "2638": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/mutations.ts", + "qualifiedName": "id" + }, + "2639": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/mutations.ts", + "qualifiedName": "options" + }, + "2640": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/mutations.ts", + "qualifiedName": "useAdminDeleteReservation" + }, + "2641": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/mutations.ts", + "qualifiedName": "useAdminDeleteReservation" + }, + "2642": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/mutations.ts", + "qualifiedName": "id" + }, + "2643": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/mutations.ts", + "qualifiedName": "options" + }, + "2644": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "adminReservationsKeys" + }, + "2645": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "useAdminReservations" + }, + "2646": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "useAdminReservations" + }, + "2647": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "query" + }, + "2648": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "options" + }, + "2649": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2650": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2651": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "__object" + }, + "2652": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2653": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2654": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2655": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "reservations" + }, + "2656": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2657": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "__object" + }, + "2658": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2659": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2660": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2661": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "reservations" + }, + "2662": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2663": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "__object" + }, + "2664": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2665": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2666": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2667": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "reservations" + }, + "2668": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2669": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "__object" + }, + "2670": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2671": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2672": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2673": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "reservations" + }, + "2674": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2675": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "useAdminReservation" + }, + "2676": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "useAdminReservation" + }, + "2677": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "id" + }, + "2678": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "options" + }, + "2679": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "__object" + }, + "2680": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "reservation" + }, + "2681": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2682": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "__object" + }, + "2683": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "reservation" + }, + "2684": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2685": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "__object" + }, + "2686": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "reservation" + }, + "2687": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2688": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/reservations/queries.ts", + "qualifiedName": "__object" + }, + "2689": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/reservations/index.d.ts", + "qualifiedName": "reservation" + }, + "2690": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2691": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "adminReturnReasonKeys" + }, + "2692": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "useAdminReturnReasons" + }, + "2693": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "useAdminReturnReasons" + }, + "2694": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "options" + }, + "2695": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "2696": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "return_reasons" + }, + "2697": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2698": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "2699": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "return_reasons" + }, + "2700": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2701": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "2702": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "return_reasons" + }, + "2703": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2704": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "2705": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "return_reasons" + }, + "2706": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2707": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "useAdminReturnReason" + }, + "2708": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "useAdminReturnReason" + }, + "2709": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "id" + }, + "2710": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "options" + }, + "2711": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "2712": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "return_reason" + }, + "2713": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2714": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "2715": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "return_reason" + }, + "2716": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2717": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "2718": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "return_reason" + }, + "2719": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2720": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/queries.ts", + "qualifiedName": "__object" + }, + "2721": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts", + "qualifiedName": "return_reason" + }, + "2722": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2723": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts", + "qualifiedName": "useAdminCreateReturnReason" + }, + "2724": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts", + "qualifiedName": "useAdminCreateReturnReason" + }, + "2725": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts", + "qualifiedName": "options" + }, + "2726": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts", + "qualifiedName": "useAdminUpdateReturnReason" + }, + "2727": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts", + "qualifiedName": "useAdminUpdateReturnReason" + }, + "2728": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts", + "qualifiedName": "id" + }, + "2729": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts", + "qualifiedName": "options" + }, + "2730": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts", + "qualifiedName": "useAdminDeleteReturnReason" + }, + "2731": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts", + "qualifiedName": "useAdminDeleteReturnReason" + }, + "2732": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts", + "qualifiedName": "id" + }, + "2733": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts", + "qualifiedName": "options" + }, + "2734": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/queries.ts", + "qualifiedName": "adminReturnKeys" + }, + "2735": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/queries.ts", + "qualifiedName": "useAdminReturns" + }, + "2736": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/queries.ts", + "qualifiedName": "useAdminReturns" + }, + "2737": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/queries.ts", + "qualifiedName": "options" + }, + "2738": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/queries.ts", + "qualifiedName": "__object" + }, + "2739": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2740": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2741": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2742": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/returns/index.d.ts", + "qualifiedName": "returns" + }, + "2743": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2744": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/queries.ts", + "qualifiedName": "__object" + }, + "2745": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2746": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2747": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2748": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/returns/index.d.ts", + "qualifiedName": "returns" + }, + "2749": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2750": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/queries.ts", + "qualifiedName": "__object" + }, + "2751": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2752": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2753": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2754": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/returns/index.d.ts", + "qualifiedName": "returns" + }, + "2755": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2756": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/queries.ts", + "qualifiedName": "__object" + }, + "2757": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2758": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2759": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2760": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/returns/index.d.ts", + "qualifiedName": "returns" + }, + "2761": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2762": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/mutations.ts", + "qualifiedName": "useAdminReceiveReturn" + }, + "2763": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/mutations.ts", + "qualifiedName": "useAdminReceiveReturn" + }, + "2764": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/mutations.ts", + "qualifiedName": "id" + }, + "2765": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/mutations.ts", + "qualifiedName": "options" + }, + "2766": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/mutations.ts", + "qualifiedName": "useAdminCancelReturn" + }, + "2767": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/mutations.ts", + "qualifiedName": "useAdminCancelReturn" + }, + "2768": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/mutations.ts", + "qualifiedName": "id" + }, + "2769": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/returns/mutations.ts", + "qualifiedName": "options" + }, + "2770": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "adminSalesChannelsKeys" + }, + "2771": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "useAdminSalesChannel" + }, + "2772": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "useAdminSalesChannel" + }, + "2773": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "id" + }, + "2774": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "options" + }, + "2775": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "__object" + }, + "2776": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "sales_channel" + }, + "2777": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2778": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "__object" + }, + "2779": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "sales_channel" + }, + "2780": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2781": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "__object" + }, + "2782": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "sales_channel" + }, + "2783": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2784": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "__object" + }, + "2785": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "sales_channel" + }, + "2786": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2787": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "useAdminSalesChannels" + }, + "2788": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "useAdminSalesChannels" + }, + "2789": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "query" + }, + "2790": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "options" + }, + "2791": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2792": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2793": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "__object" + }, + "2794": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2795": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2796": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2797": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "sales_channels" + }, + "2798": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2799": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "__object" + }, + "2800": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2801": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2802": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2803": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "sales_channels" + }, + "2804": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2805": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "__object" + }, + "2806": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2807": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2808": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2809": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "sales_channels" + }, + "2810": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2811": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/queries.ts", + "qualifiedName": "__object" + }, + "2812": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2813": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2814": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2815": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts", + "qualifiedName": "sales_channels" + }, + "2816": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2817": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminCreateSalesChannel" + }, + "2818": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminCreateSalesChannel" + }, + "2819": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "options" + }, + "2820": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminUpdateSalesChannel" + }, + "2821": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminUpdateSalesChannel" + }, + "2822": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "id" + }, + "2823": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "options" + }, + "2824": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminDeleteSalesChannel" + }, + "2825": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminDeleteSalesChannel" + }, + "2826": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "id" + }, + "2827": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "options" + }, + "2828": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminDeleteProductsFromSalesChannel" + }, + "2829": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminDeleteProductsFromSalesChannel" + }, + "2830": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "id" + }, + "2831": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "options" + }, + "2832": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminAddProductsToSalesChannel" + }, + "2833": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminAddProductsToSalesChannel" + }, + "2834": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "id" + }, + "2835": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "options" + }, + "2836": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminAddLocationToSalesChannel" + }, + "2837": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminAddLocationToSalesChannel" + }, + "2838": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "options" + }, + "2839": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "__type" + }, + "2840": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "__type.sales_channel_id" + }, + "2841": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "__type.location_id" + }, + "2842": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "__type" + }, + "2843": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "__type.sales_channel_id" + }, + "2844": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "__type.location_id" + }, + "2845": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminRemoveLocationFromSalesChannel" + }, + "2846": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "useAdminRemoveLocationFromSalesChannel" + }, + "2847": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "options" + }, + "2848": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "__type" + }, + "2849": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "__type.sales_channel_id" + }, + "2850": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "__type.location_id" + }, + "2851": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "__type" + }, + "2852": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "__type.sales_channel_id" + }, + "2853": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts", + "qualifiedName": "__type.location_id" + }, + "2854": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "adminShippingOptionKeys" + }, + "2855": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "useAdminShippingOptions" + }, + "2856": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "useAdminShippingOptions" + }, + "2857": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "query" + }, + "2858": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "options" + }, + "2859": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2860": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2861": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "2862": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2863": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2864": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2865": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "shipping_options" + }, + "2866": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2867": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "2868": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2869": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2870": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2871": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "shipping_options" + }, + "2872": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2873": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "2874": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2875": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2876": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2877": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "shipping_options" + }, + "2878": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2879": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "2880": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "2881": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "2882": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "2883": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "shipping_options" + }, + "2884": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2885": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "useAdminShippingOption" + }, + "2886": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "useAdminShippingOption" + }, + "2887": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "id" + }, + "2888": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "options" + }, + "2889": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "2890": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "shipping_option" + }, + "2891": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2892": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "2893": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "shipping_option" + }, + "2894": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2895": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "2896": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "shipping_option" + }, + "2897": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2898": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/queries.ts", + "qualifiedName": "__object" + }, + "2899": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts", + "qualifiedName": "shipping_option" + }, + "2900": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2901": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts", + "qualifiedName": "useAdminCreateShippingOption" + }, + "2902": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts", + "qualifiedName": "useAdminCreateShippingOption" + }, + "2903": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts", + "qualifiedName": "options" + }, + "2904": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts", + "qualifiedName": "useAdminUpdateShippingOption" + }, + "2905": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts", + "qualifiedName": "useAdminUpdateShippingOption" + }, + "2906": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts", + "qualifiedName": "id" + }, + "2907": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts", + "qualifiedName": "options" + }, + "2908": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts", + "qualifiedName": "useAdminDeleteShippingOption" + }, + "2909": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts", + "qualifiedName": "useAdminDeleteShippingOption" + }, + "2910": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts", + "qualifiedName": "id" + }, + "2911": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts", + "qualifiedName": "options" + }, + "2912": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "adminShippingProfileKeys" + }, + "2913": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "useAdminShippingProfiles" + }, + "2914": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "useAdminShippingProfiles" + }, + "2915": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "options" + }, + "2916": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "__object" + }, + "2917": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "shipping_profiles" + }, + "2918": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2919": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "__object" + }, + "2920": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "shipping_profiles" + }, + "2921": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2922": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "__object" + }, + "2923": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "shipping_profiles" + }, + "2924": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2925": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "__object" + }, + "2926": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "shipping_profiles" + }, + "2927": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2928": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "useAdminShippingProfile" + }, + "2929": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "useAdminShippingProfile" + }, + "2930": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "id" + }, + "2931": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "options" + }, + "2932": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "__object" + }, + "2933": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "shipping_profile" + }, + "2934": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2935": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "__object" + }, + "2936": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "shipping_profile" + }, + "2937": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2938": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "__object" + }, + "2939": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "shipping_profile" + }, + "2940": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2941": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts", + "qualifiedName": "__object" + }, + "2942": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts", + "qualifiedName": "shipping_profile" + }, + "2943": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2944": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts", + "qualifiedName": "useAdminCreateShippingProfile" + }, + "2945": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts", + "qualifiedName": "useAdminCreateShippingProfile" + }, + "2946": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts", + "qualifiedName": "options" + }, + "2947": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts", + "qualifiedName": "useAdminUpdateShippingProfile" + }, + "2948": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts", + "qualifiedName": "useAdminUpdateShippingProfile" + }, + "2949": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts", + "qualifiedName": "id" + }, + "2950": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts", + "qualifiedName": "options" + }, + "2951": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts", + "qualifiedName": "useAdminDeleteShippingProfile" + }, + "2952": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts", + "qualifiedName": "useAdminDeleteShippingProfile" + }, + "2953": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts", + "qualifiedName": "id" + }, + "2954": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts", + "qualifiedName": "options" + }, + "2955": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "adminStockLocationsKeys" + }, + "2956": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "useAdminStockLocations" + }, + "2957": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "useAdminStockLocations" + }, + "2958": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "query" + }, + "2959": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "options" + }, + "2960": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "2961": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "2962": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "__object" + }, + "2963": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "limit" + }, + "2964": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "offset" + }, + "2965": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "count" + }, + "2966": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "stock_locations" + }, + "2967": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2968": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "__object" + }, + "2969": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "limit" + }, + "2970": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "offset" + }, + "2971": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "count" + }, + "2972": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "stock_locations" + }, + "2973": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2974": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "__object" + }, + "2975": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "limit" + }, + "2976": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "offset" + }, + "2977": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "count" + }, + "2978": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "stock_locations" + }, + "2979": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2980": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "__object" + }, + "2981": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "limit" + }, + "2982": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "offset" + }, + "2983": { + "sourceFileName": "../../../packages/types/dist/common/common.d.ts", + "qualifiedName": "count" + }, + "2984": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "stock_locations" + }, + "2985": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2986": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "useAdminStockLocation" + }, + "2987": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "useAdminStockLocation" + }, + "2988": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "id" + }, + "2989": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "options" + }, + "2990": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "__object" + }, + "2991": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "stock_location" + }, + "2992": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2993": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "__object" + }, + "2994": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "stock_location" + }, + "2995": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2996": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "__object" + }, + "2997": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "stock_location" + }, + "2998": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "2999": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/queries.ts", + "qualifiedName": "__object" + }, + "3000": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts", + "qualifiedName": "stock_location" + }, + "3001": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3002": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts", + "qualifiedName": "useAdminCreateStockLocation" + }, + "3003": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts", + "qualifiedName": "useAdminCreateStockLocation" + }, + "3004": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts", + "qualifiedName": "options" + }, + "3005": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts", + "qualifiedName": "useAdminUpdateStockLocation" + }, + "3006": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts", + "qualifiedName": "useAdminUpdateStockLocation" + }, + "3007": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts", + "qualifiedName": "id" + }, + "3008": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts", + "qualifiedName": "options" + }, + "3009": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts", + "qualifiedName": "useAdminDeleteStockLocation" + }, + "3010": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts", + "qualifiedName": "useAdminDeleteStockLocation" + }, + "3011": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts", + "qualifiedName": "id" + }, + "3012": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts", + "qualifiedName": "options" + }, + "3013": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "adminStoreKeys" + }, + "3014": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "useAdminStorePaymentProviders" + }, + "3015": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "useAdminStorePaymentProviders" + }, + "3016": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "options" + }, + "3017": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "__object" + }, + "3018": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "payment_providers" + }, + "3019": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3020": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "__object" + }, + "3021": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "payment_providers" + }, + "3022": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3023": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "__object" + }, + "3024": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "payment_providers" + }, + "3025": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3026": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "__object" + }, + "3027": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "payment_providers" + }, + "3028": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3029": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "useAdminStoreTaxProviders" + }, + "3030": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "useAdminStoreTaxProviders" + }, + "3031": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "options" + }, + "3032": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "__object" + }, + "3033": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "tax_providers" + }, + "3034": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3035": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "__object" + }, + "3036": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "tax_providers" + }, + "3037": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3038": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "__object" + }, + "3039": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "tax_providers" + }, + "3040": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3041": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "__object" + }, + "3042": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "tax_providers" + }, + "3043": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3044": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "useAdminStore" + }, + "3045": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "useAdminStore" + }, + "3046": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "options" + }, + "3047": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "__object" + }, + "3048": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "store" + }, + "3049": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3050": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "__object" + }, + "3051": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "store" + }, + "3052": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3053": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "__object" + }, + "3054": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "store" + }, + "3055": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3056": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/queries.ts", + "qualifiedName": "__object" + }, + "3057": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/store/index.d.ts", + "qualifiedName": "store" + }, + "3058": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3059": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/mutations.ts", + "qualifiedName": "useAdminUpdateStore" + }, + "3060": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/mutations.ts", + "qualifiedName": "useAdminUpdateStore" + }, + "3061": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/mutations.ts", + "qualifiedName": "options" + }, + "3062": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/mutations.ts", + "qualifiedName": "useAdminAddStoreCurrency" + }, + "3063": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/mutations.ts", + "qualifiedName": "useAdminAddStoreCurrency" + }, + "3064": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/mutations.ts", + "qualifiedName": "options" + }, + "3065": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/mutations.ts", + "qualifiedName": "useAdminDeleteStoreCurrency" + }, + "3066": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/mutations.ts", + "qualifiedName": "useAdminDeleteStoreCurrency" + }, + "3067": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/store/mutations.ts", + "qualifiedName": "options" + }, + "3068": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "adminSwapKeys" + }, + "3069": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "useAdminSwaps" + }, + "3070": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "useAdminSwaps" + }, + "3071": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "query" + }, + "3072": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "options" + }, + "3073": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "3074": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "3075": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "__object" + }, + "3076": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "3077": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "3078": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "3079": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/swaps/index.d.ts", + "qualifiedName": "swaps" + }, + "3080": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3081": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "__object" + }, + "3082": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "3083": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "3084": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "3085": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/swaps/index.d.ts", + "qualifiedName": "swaps" + }, + "3086": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3087": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "__object" + }, + "3088": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "3089": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "3090": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "3091": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/swaps/index.d.ts", + "qualifiedName": "swaps" + }, + "3092": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3093": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "__object" + }, + "3094": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "3095": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "3096": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "3097": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/swaps/index.d.ts", + "qualifiedName": "swaps" + }, + "3098": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3099": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "useAdminSwap" + }, + "3100": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "useAdminSwap" + }, + "3101": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "id" + }, + "3102": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "options" + }, + "3103": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "__object" + }, + "3104": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/swaps/index.d.ts", + "qualifiedName": "swap" + }, + "3105": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3106": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "__object" + }, + "3107": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/swaps/index.d.ts", + "qualifiedName": "swap" + }, + "3108": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3109": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "__object" + }, + "3110": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/swaps/index.d.ts", + "qualifiedName": "swap" + }, + "3111": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3112": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/queries.ts", + "qualifiedName": "__object" + }, + "3113": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/swaps/index.d.ts", + "qualifiedName": "swap" + }, + "3114": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3115": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "useAdminCreateSwap" + }, + "3116": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "useAdminCreateSwap" + }, + "3117": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "orderId" + }, + "3118": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "options" + }, + "3119": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "useAdminCancelSwap" + }, + "3120": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "useAdminCancelSwap" + }, + "3121": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "orderId" + }, + "3122": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "options" + }, + "3123": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "AdminFulfillSwapReq" + }, + "3124": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type" + }, + "3125": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type.swap_id" + }, + "3126": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "useAdminFulfillSwap" + }, + "3127": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "useAdminFulfillSwap" + }, + "3128": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "orderId" + }, + "3129": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "options" + }, + "3130": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "AdminCreateSwapShipmentReq" + }, + "3131": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type" + }, + "3132": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type.swap_id" + }, + "3133": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "useAdminCreateSwapShipment" + }, + "3134": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "useAdminCreateSwapShipment" + }, + "3135": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "orderId" + }, + "3136": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "options" + }, + "3137": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "useAdminProcessSwapPayment" + }, + "3138": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "useAdminProcessSwapPayment" + }, + "3139": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "orderId" + }, + "3140": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "options" + }, + "3141": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "AdminCancelSwapFulfillmentReq" + }, + "3142": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type" + }, + "3143": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type.swap_id" + }, + "3144": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type.fulfillment_id" + }, + "3145": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "useAdminCancelSwapFulfillment" + }, + "3146": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "useAdminCancelSwapFulfillment" + }, + "3147": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "orderId" + }, + "3148": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "options" + }, + "3149": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type" + }, + "3150": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type.swap_id" + }, + "3151": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type.fulfillment_id" + }, + "3152": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type" + }, + "3153": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type.swap_id" + }, + "3154": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/swaps/mutations.ts", + "qualifiedName": "__type.fulfillment_id" + }, + "3155": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "adminTaxRateKeys" + }, + "3156": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "useAdminTaxRates" + }, + "3157": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "useAdminTaxRates" + }, + "3158": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "query" + }, + "3159": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "options" + }, + "3160": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "3161": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "3162": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "__object" + }, + "3163": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "3164": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "3165": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "3166": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "tax_rates" + }, + "3167": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3168": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "__object" + }, + "3169": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "3170": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "3171": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "3172": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "tax_rates" + }, + "3173": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3174": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "__object" + }, + "3175": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "3176": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "3177": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "3178": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "tax_rates" + }, + "3179": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3180": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "__object" + }, + "3181": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "3182": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "3183": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "3184": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "tax_rates" + }, + "3185": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3186": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "useAdminTaxRate" + }, + "3187": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "useAdminTaxRate" + }, + "3188": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "id" + }, + "3189": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "query" + }, + "3190": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "options" + }, + "3191": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "__object" + }, + "3192": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "tax_rate" + }, + "3193": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3194": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "__object" + }, + "3195": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "tax_rate" + }, + "3196": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3197": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "__object" + }, + "3198": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "tax_rate" + }, + "3199": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3200": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/queries.ts", + "qualifiedName": "__object" + }, + "3201": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts", + "qualifiedName": "tax_rate" + }, + "3202": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3203": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminCreateTaxRate" + }, + "3204": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminCreateTaxRate" + }, + "3205": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "options" + }, + "3206": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminUpdateTaxRate" + }, + "3207": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminUpdateTaxRate" + }, + "3208": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "id" + }, + "3209": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "options" + }, + "3210": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminDeleteTaxRate" + }, + "3211": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminDeleteTaxRate" + }, + "3212": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "id" + }, + "3213": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "options" + }, + "3214": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminCreateProductTaxRates" + }, + "3215": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminCreateProductTaxRates" + }, + "3216": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "id" + }, + "3217": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "options" + }, + "3218": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminDeleteProductTaxRates" + }, + "3219": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminDeleteProductTaxRates" + }, + "3220": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "id" + }, + "3221": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "options" + }, + "3222": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminCreateProductTypeTaxRates" + }, + "3223": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminCreateProductTypeTaxRates" + }, + "3224": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "id" + }, + "3225": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "options" + }, + "3226": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminDeleteProductTypeTaxRates" + }, + "3227": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminDeleteProductTypeTaxRates" + }, + "3228": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "id" + }, + "3229": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "options" + }, + "3230": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminCreateShippingTaxRates" + }, + "3231": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminCreateShippingTaxRates" + }, + "3232": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "id" + }, + "3233": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "options" + }, + "3234": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminDeleteShippingTaxRates" + }, + "3235": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "useAdminDeleteShippingTaxRates" + }, + "3236": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "id" + }, + "3237": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts", + "qualifiedName": "options" + }, + "3238": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/uploads/mutations.ts", + "qualifiedName": "useAdminUploadFile" + }, + "3239": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/uploads/mutations.ts", + "qualifiedName": "useAdminUploadFile" + }, + "3240": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/uploads/mutations.ts", + "qualifiedName": "options" + }, + "3241": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/uploads/mutations.ts", + "qualifiedName": "useAdminUploadProtectedFile" + }, + "3242": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/uploads/mutations.ts", + "qualifiedName": "useAdminUploadProtectedFile" + }, + "3243": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/uploads/mutations.ts", + "qualifiedName": "options" + }, + "3244": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/uploads/mutations.ts", + "qualifiedName": "useAdminCreatePresignedDownloadUrl" + }, + "3245": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/uploads/mutations.ts", + "qualifiedName": "useAdminCreatePresignedDownloadUrl" + }, + "3246": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/uploads/mutations.ts", + "qualifiedName": "options" + }, + "3247": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/uploads/mutations.ts", + "qualifiedName": "useAdminDeleteFile" + }, + "3248": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/uploads/mutations.ts", + "qualifiedName": "useAdminDeleteFile" + }, + "3249": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/uploads/mutations.ts", + "qualifiedName": "options" + }, + "3250": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "adminUserKeys" + }, + "3251": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "useAdminUsers" + }, + "3252": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "useAdminUsers" + }, + "3253": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "options" + }, + "3254": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "__object" + }, + "3255": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "users" + }, + "3256": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3257": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "__object" + }, + "3258": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "users" + }, + "3259": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3260": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "__object" + }, + "3261": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "users" + }, + "3262": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3263": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "__object" + }, + "3264": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "users" + }, + "3265": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3266": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "useAdminUser" + }, + "3267": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "useAdminUser" + }, + "3268": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "id" + }, + "3269": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "options" + }, + "3270": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "__object" + }, + "3271": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "user" + }, + "3272": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3273": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "__object" + }, + "3274": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "user" + }, + "3275": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3276": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "__object" + }, + "3277": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "user" + }, + "3278": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3279": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/queries.ts", + "qualifiedName": "__object" + }, + "3280": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/users/index.d.ts", + "qualifiedName": "user" + }, + "3281": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3282": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "useAdminCreateUser" + }, + "3283": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "useAdminCreateUser" + }, + "3284": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "options" + }, + "3285": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "useAdminUpdateUser" + }, + "3286": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "useAdminUpdateUser" + }, + "3287": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "id" + }, + "3288": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "options" + }, + "3289": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "useAdminDeleteUser" + }, + "3290": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "useAdminDeleteUser" + }, + "3291": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "id" + }, + "3292": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "options" + }, + "3293": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "useAdminResetPassword" + }, + "3294": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "useAdminResetPassword" + }, + "3295": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "options" + }, + "3296": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "useAdminSendResetPasswordToken" + }, + "3297": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "useAdminSendResetPasswordToken" + }, + "3298": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/users/mutations.ts", + "qualifiedName": "options" + }, + "3299": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "adminVariantKeys" + }, + "3300": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "useAdminVariants" + }, + "3301": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "useAdminVariants" + }, + "3302": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "query" + }, + "3303": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "options" + }, + "3304": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type" + }, + "3305": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "__type.query" + }, + "3306": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "__object" + }, + "3307": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "3308": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "3309": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "3310": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/index.d.ts", + "qualifiedName": "variants" + }, + "3311": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3312": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "__object" + }, + "3313": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "3314": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "3315": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "3316": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/index.d.ts", + "qualifiedName": "variants" + }, + "3317": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3318": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "__object" + }, + "3319": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "3320": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "3321": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "3322": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/index.d.ts", + "qualifiedName": "variants" + }, + "3323": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3324": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "__object" + }, + "3325": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "limit" + }, + "3326": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "offset" + }, + "3327": { + "sourceFileName": "../../../packages/medusa/dist/types/common.d.ts", + "qualifiedName": "count" + }, + "3328": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/index.d.ts", + "qualifiedName": "variants" + }, + "3329": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3330": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "useAdminVariant" + }, + "3331": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "useAdminVariant" + }, + "3332": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "id" + }, + "3333": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "query" + }, + "3334": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "options" + }, + "3335": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "__object" + }, + "3336": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/index.d.ts", + "qualifiedName": "variant" + }, + "3337": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3338": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "__object" + }, + "3339": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/index.d.ts", + "qualifiedName": "variant" + }, + "3340": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3341": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "__object" + }, + "3342": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/index.d.ts", + "qualifiedName": "variant" + }, + "3343": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3344": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "__object" + }, + "3345": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/index.d.ts", + "qualifiedName": "variant" + }, + "3346": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3347": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "useAdminVariantsInventory" + }, + "3348": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "useAdminVariantsInventory" + }, + "3349": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "id" + }, + "3350": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "options" + }, + "3351": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "__object" + }, + "3352": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts", + "qualifiedName": "variant" + }, + "3353": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3354": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "__object" + }, + "3355": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts", + "qualifiedName": "variant" + }, + "3356": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3357": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "__object" + }, + "3358": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts", + "qualifiedName": "variant" + }, + "3359": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3360": { + "sourceFileName": "../../../packages/medusa-react/src/hooks/admin/variants/queries.ts", + "qualifiedName": "__object" + }, + "3361": { + "sourceFileName": "../../../packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts", + "qualifiedName": "variant" + }, + "3362": { + "sourceFileName": "../../../packages/medusa-js/dist/index.d.ts", + "qualifiedName": "response" + }, + "3363": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "FormatVariantPriceParams" + }, + "3364": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.variant" + }, + "3365": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.region" + }, + "3366": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.includeTaxes" + }, + "3367": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.minimumFractionDigits" + }, + "3368": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.maximumFractionDigits" + }, + "3369": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.locale" + }, + "3370": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "formatVariantPrice" + }, + "3371": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "formatVariantPrice" + }, + "3372": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__0" + }, + "3373": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "ComputeVariantPriceParams" + }, + "3374": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.variant" + }, + "3375": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.region" + }, + "3376": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.includeTaxes" + }, + "3377": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "computeVariantPrice" + }, + "3378": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "computeVariantPrice" + }, + "3379": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__0" + }, + "3380": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "getVariantPrice" + }, + "3381": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "getVariantPrice" + }, + "3382": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "variant" + }, + "3383": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "region" + }, + "3384": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "ComputeAmountParams" + }, + "3385": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type" + }, + "3386": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.amount" + }, + "3387": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.region" + }, + "3388": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.includeTaxes" + }, + "3389": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "computeAmount" + }, + "3390": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "computeAmount" + }, + "3391": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__0" + }, + "3392": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "FormatAmountParams" + }, + "3393": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type" + }, + "3394": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.amount" + }, + "3395": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.region" + }, + "3396": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.includeTaxes" + }, + "3397": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.minimumFractionDigits" + }, + "3398": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.maximumFractionDigits" + }, + "3399": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__type.locale" + }, + "3400": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "formatAmount" + }, + "3401": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "formatAmount" + }, + "3402": { + "sourceFileName": "../../../packages/medusa-react/src/helpers/index.ts", + "qualifiedName": "__0" + }, + "3403": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "ProductVariantInfo" + }, + "3404": { + "sourceFileName": "../../../packages/medusa-react/src/types.ts", + "qualifiedName": "RegionInfo" + } + } +} \ No newline at end of file diff --git a/docs-util/typedoc-json-output/pricing.json b/docs-util/typedoc-json-output/pricing.json index 0436fab6b6b89..f4d6857c67355 100644 --- a/docs-util/typedoc-json-output/pricing.json +++ b/docs-util/typedoc-json-output/pricing.json @@ -6,7 +6,7 @@ "flags": {}, "children": [ { - "id": 599, + "id": 601, "name": "PriceListStatus", "variant": "declaration", "kind": 8, @@ -21,7 +21,7 @@ }, "children": [ { - "id": 600, + "id": 602, "name": "ACTIVE", "variant": "declaration", "kind": 16, @@ -40,7 +40,7 @@ } }, { - "id": 601, + "id": 603, "name": "DRAFT", "variant": "declaration", "kind": 16, @@ -63,14 +63,14 @@ { "title": "Enumeration Members", "children": [ - 600, - 601 + 602, + 603 ] } ] }, { - "id": 602, + "id": 604, "name": "PriceListType", "variant": "declaration", "kind": 8, @@ -85,7 +85,7 @@ }, "children": [ { - "id": 604, + "id": 606, "name": "OVERRIDE", "variant": "declaration", "kind": 16, @@ -104,7 +104,7 @@ } }, { - "id": 603, + "id": 605, "name": "SALE", "variant": "declaration", "kind": 16, @@ -127,14 +127,14 @@ { "title": "Enumeration Members", "children": [ - 604, - 603 + 606, + 605 ] } ] }, { - "id": 560, + "id": 562, "name": "AddPriceListPricesDTO", "variant": "declaration", "kind": 256, @@ -149,7 +149,7 @@ }, "children": [ { - "id": 561, + "id": 563, "name": "priceListId", "variant": "declaration", "kind": 1024, @@ -168,7 +168,7 @@ } }, { - "id": 562, + "id": 564, "name": "prices", "variant": "declaration", "kind": 1024, @@ -185,7 +185,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 606, + "target": 608, "name": "PriceListPriceDTO", "package": "@medusajs/types" } @@ -196,8 +196,8 @@ { "title": "Properties", "children": [ - 561, - 562 + 563, + 564 ] } ] @@ -254,7 +254,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 591, + "target": 593, "name": "CreatePricesDTO", "package": "@medusajs/types" } @@ -382,7 +382,7 @@ ] }, { - "id": 587, + "id": 589, "name": "BaseFilterable", "variant": "declaration", "kind": 256, @@ -397,7 +397,7 @@ }, "children": [ { - "id": 588, + "id": 590, "name": "$and", "variant": "declaration", "kind": 1024, @@ -425,7 +425,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -442,7 +442,7 @@ } }, { - "id": 589, + "id": 591, "name": "$or", "variant": "declaration", "kind": 1024, @@ -470,7 +470,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -491,14 +491,14 @@ { "title": "Properties", "children": [ - 588, - 589 + 590, + 591 ] } ], "typeParameters": [ { - "id": 590, + "id": 592, "name": "T", "variant": "typeParam", "kind": 131072, @@ -543,12 +543,12 @@ }, { "type": "reference", - "target": 510, + "target": 512, "name": "FilterablePriceListProps" }, { "type": "reference", - "target": 542, + "target": 544, "name": "FilterablePriceListRuleProps" } ] @@ -860,7 +860,7 @@ "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 " + "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", @@ -889,7 +889,7 @@ "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 " + "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", @@ -1649,18 +1649,18 @@ "extendedBy": [ { "type": "reference", - "target": 591, + "target": 593, "name": "CreatePricesDTO" }, { "type": "reference", - "target": 606, + "target": 608, "name": "PriceListPriceDTO" } ] }, { - "id": 518, + "id": 520, "name": "CreatePriceListDTO", "variant": "declaration", "kind": 256, @@ -1675,7 +1675,7 @@ }, "children": [ { - "id": 520, + "id": 522, "name": "description", "variant": "declaration", "kind": 1024, @@ -1694,7 +1694,7 @@ } }, { - "id": 522, + "id": 524, "name": "ends_at", "variant": "declaration", "kind": 1024, @@ -1715,8 +1715,8 @@ } }, { - "id": 525, - "name": "number_rules", + "id": 529, + "name": "prices", "variant": "declaration", "kind": 1024, "flags": { @@ -1726,18 +1726,23 @@ "summary": [ { "kind": "text", - "text": "The number of rules associated with the price list." + "text": "The prices associated with the price list." } ] }, "type": { - "type": "intrinsic", - "name": "number" + "type": "array", + "elementType": { + "type": "reference", + "target": 608, + "name": "PriceListPriceDTO", + "package": "@medusajs/types" + } } }, { - "id": 527, - "name": "prices", + "id": 528, + "name": "rules", "variant": "declaration", "kind": 1024, "flags": { @@ -1747,23 +1752,20 @@ "summary": [ { "kind": "text", - "text": "The prices associated with the price list." + "text": "The rules to be created and associated with the price list." } ] }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 606, - "name": "PriceListPriceDTO", - "package": "@medusajs/types" - } + "type": "reference", + "target": 607, + "name": "CreatePriceListRules", + "package": "@medusajs/types" } }, { - "id": 526, - "name": "rules", + "id": 527, + "name": "rules_count", "variant": "declaration", "kind": 1024, "flags": { @@ -1773,19 +1775,17 @@ "summary": [ { "kind": "text", - "text": "The rules to be created and associated with the price list." + "text": "The number of rules associated with the price list." } ] }, "type": { - "type": "reference", - "target": 605, - "name": "CreatePriceListRules", - "package": "@medusajs/types" + "type": "intrinsic", + "name": "number" } }, { - "id": 521, + "id": 523, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -1806,7 +1806,7 @@ } }, { - "id": 523, + "id": 525, "name": "status", "variant": "declaration", "kind": 1024, @@ -1823,13 +1823,13 @@ }, "type": { "type": "reference", - "target": 599, + "target": 601, "name": "PriceListStatus", "package": "@medusajs/types" } }, { - "id": 519, + "id": 521, "name": "title", "variant": "declaration", "kind": 1024, @@ -1848,7 +1848,7 @@ } }, { - "id": 524, + "id": 526, "name": "type", "variant": "declaration", "kind": 1024, @@ -1865,7 +1865,7 @@ }, "type": { "type": "reference", - "target": 602, + "target": 604, "name": "PriceListType", "package": "@medusajs/types" } @@ -1875,21 +1875,21 @@ { "title": "Properties", "children": [ - 520, 522, - 525, + 524, + 529, + 528, 527, - 526, - 521, 523, - 519, - 524 + 525, + 521, + 526 ] } ] }, { - "id": 549, + "id": 551, "name": "CreatePriceListRuleDTO", "variant": "declaration", "kind": 256, @@ -1904,7 +1904,7 @@ }, "children": [ { - "id": 553, + "id": 555, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -1928,7 +1928,7 @@ }, { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -1936,7 +1936,7 @@ } }, { - "id": 552, + "id": 554, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -1957,7 +1957,7 @@ } }, { - "id": 551, + "id": 553, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -1989,7 +1989,7 @@ } }, { - "id": 550, + "id": 552, "name": "rule_type_id", "variant": "declaration", "kind": 1024, @@ -2014,16 +2014,16 @@ { "title": "Properties", "children": [ + 555, + 554, 553, - 552, - 551, - 550 + 552 ] } ] }, { - "id": 605, + "id": 607, "name": "CreatePriceListRules", "variant": "declaration", "kind": 256, @@ -2085,30 +2085,45 @@ }, "children": [ { - "id": 484, - "name": "id", + "id": 485, + "name": "price_set", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { "kind": "text", - "text": "The ID of the price rule." + "text": "The ID or object of the associated price set." } ] }, "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 338, + "name": "PriceSetDTO", + "package": "@medusajs/types" + } + ] } }, { - "id": 485, + "id": 484, "name": "price_set_id", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { @@ -2123,35 +2138,119 @@ } }, { - "id": 489, + "id": 491, + "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": 449, + "name": "PriceSetMoneyAmountDTO", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 490, "name": "price_set_money_amount_id", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price set money amount." + } + ] + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 488, + "id": 489, "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": 487, + "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": 410, + "name": "RuleTypeDTO", + "package": "@medusajs/types" + } + ] + } + }, { "id": 486, "name": "rule_type_id", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { @@ -2166,7 +2265,7 @@ } }, { - "id": 487, + "id": 488, "name": "value", "variant": "declaration", "kind": 1024, @@ -2189,12 +2288,14 @@ { "title": "Properties", "children": [ - 484, 485, + 484, + 491, + 490, 489, - 488, + 487, 486, - 487 + 488 ] } ] @@ -2234,7 +2335,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 591, + "target": 593, "name": "CreatePricesDTO", "package": "@medusajs/types" } @@ -2403,7 +2504,51 @@ ] }, { - "id": 591, + "id": 634, + "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": 593, "name": "CreatePricesDTO", "variant": "declaration", "kind": 256, @@ -2418,7 +2563,7 @@ }, "children": [ { - "id": 596, + "id": 598, "name": "amount", "variant": "declaration", "kind": 1024, @@ -2442,7 +2587,7 @@ } }, { - "id": 595, + "id": 597, "name": "currency", "variant": "declaration", "kind": 1024, @@ -2470,7 +2615,7 @@ } }, { - "id": 594, + "id": 596, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -2494,7 +2639,7 @@ } }, { - "id": 593, + "id": 595, "name": "id", "variant": "declaration", "kind": 1024, @@ -2520,7 +2665,7 @@ } }, { - "id": 598, + "id": 600, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -2555,7 +2700,7 @@ } }, { - "id": 597, + "id": 599, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -2590,11 +2735,13 @@ } }, { - "id": 592, + "id": 594, "name": "rules", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { @@ -2613,22 +2760,9 @@ }, "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" + "target": 634, + "name": "CreatePriceSetPriceRules", + "package": "@medusajs/types" } } ], @@ -2636,13 +2770,13 @@ { "title": "Properties", "children": [ - 596, - 595, - 594, - 593, 598, 597, - 592 + 596, + 595, + 600, + 599, + 594 ] } ], @@ -2933,7 +3067,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -2950,7 +3084,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 588, + "target": 590, "name": "BaseFilterable.$and" } }, @@ -2983,7 +3117,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -3000,7 +3134,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 589, + "target": 591, "name": "BaseFilterable.$or" } }, @@ -3042,7 +3176,7 @@ "extendedTypes": [ { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -3100,7 +3234,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -3117,7 +3251,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 588, + "target": 590, "name": "BaseFilterable.$and" } }, @@ -3150,7 +3284,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -3167,7 +3301,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 589, + "target": 591, "name": "BaseFilterable.$or" } }, @@ -3243,7 +3377,7 @@ "extendedTypes": [ { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -3258,7 +3392,7 @@ ] }, { - "id": 510, + "id": 512, "name": "FilterablePriceListProps", "variant": "declaration", "kind": 256, @@ -3273,7 +3407,7 @@ }, "children": [ { - "id": 516, + "id": 518, "name": "$and", "variant": "declaration", "kind": 1024, @@ -3295,17 +3429,17 @@ "types": [ { "type": "reference", - "target": 510, + "target": 512, "name": "FilterablePriceListProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", - "target": 510, + "target": 512, "name": "FilterablePriceListProps", "package": "@medusajs/types" } @@ -3318,12 +3452,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 588, + "target": 590, "name": "BaseFilterable.$and" } }, { - "id": 517, + "id": 519, "name": "$or", "variant": "declaration", "kind": 1024, @@ -3345,17 +3479,17 @@ "types": [ { "type": "reference", - "target": 510, + "target": 512, "name": "FilterablePriceListProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", - "target": 510, + "target": 512, "name": "FilterablePriceListProps", "package": "@medusajs/types" } @@ -3368,12 +3502,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 589, + "target": 591, "name": "BaseFilterable.$or" } }, { - "id": 513, + "id": 515, "name": "ends_at", "variant": "declaration", "kind": 1024, @@ -3397,7 +3531,7 @@ } }, { - "id": 511, + "id": 513, "name": "id", "variant": "declaration", "kind": 1024, @@ -3421,8 +3555,8 @@ } }, { - "id": 515, - "name": "number_rules", + "id": 517, + "name": "rules_count", "variant": "declaration", "kind": 1024, "flags": { @@ -3445,7 +3579,7 @@ } }, { - "id": 512, + "id": 514, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -3469,7 +3603,7 @@ } }, { - "id": 514, + "id": 516, "name": "status", "variant": "declaration", "kind": 1024, @@ -3488,7 +3622,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 599, + "target": 601, "name": "PriceListStatus", "package": "@medusajs/types" } @@ -3499,24 +3633,24 @@ { "title": "Properties", "children": [ - 516, - 517, - 513, - 511, + 518, + 519, 515, - 512, - 514 + 513, + 517, + 514, + 516 ] } ], "extendedTypes": [ { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", - "target": 510, + "target": 512, "name": "FilterablePriceListProps", "package": "@medusajs/types" } @@ -3527,7 +3661,7 @@ ] }, { - "id": 542, + "id": 544, "name": "FilterablePriceListRuleProps", "variant": "declaration", "kind": 256, @@ -3542,7 +3676,7 @@ }, "children": [ { - "id": 547, + "id": 549, "name": "$and", "variant": "declaration", "kind": 1024, @@ -3564,17 +3698,17 @@ "types": [ { "type": "reference", - "target": 542, + "target": 544, "name": "FilterablePriceListRuleProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", - "target": 542, + "target": 544, "name": "FilterablePriceListRuleProps", "package": "@medusajs/types" } @@ -3587,12 +3721,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 588, + "target": 590, "name": "BaseFilterable.$and" } }, { - "id": 548, + "id": 550, "name": "$or", "variant": "declaration", "kind": 1024, @@ -3614,17 +3748,17 @@ "types": [ { "type": "reference", - "target": 542, + "target": 544, "name": "FilterablePriceListRuleProps", "package": "@medusajs/types" }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", - "target": 542, + "target": 544, "name": "FilterablePriceListRuleProps", "package": "@medusajs/types" } @@ -3637,12 +3771,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 589, + "target": 591, "name": "BaseFilterable.$or" } }, { - "id": 543, + "id": 545, "name": "id", "variant": "declaration", "kind": 1024, @@ -3666,7 +3800,7 @@ } }, { - "id": 546, + "id": 548, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -3690,7 +3824,7 @@ } }, { - "id": 545, + "id": 547, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -3714,7 +3848,7 @@ } }, { - "id": 544, + "id": 546, "name": "value", "variant": "declaration", "kind": 1024, @@ -3742,23 +3876,23 @@ { "title": "Properties", "children": [ - 547, - 548, - 543, - 546, + 549, + 550, 545, - 544 + 548, + 547, + 546 ] } ], "extendedTypes": [ { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", - "target": 542, + "target": 544, "name": "FilterablePriceListRuleProps", "package": "@medusajs/types" } @@ -3812,7 +3946,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -3829,7 +3963,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 588, + "target": 590, "name": "BaseFilterable.$and" } }, @@ -3862,7 +3996,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -3879,7 +4013,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 589, + "target": 591, "name": "BaseFilterable.$or" } }, @@ -3996,7 +4130,7 @@ "extendedTypes": [ { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -4054,7 +4188,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -4071,7 +4205,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 588, + "target": 590, "name": "BaseFilterable.$and" } }, @@ -4104,7 +4238,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -4121,7 +4255,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 589, + "target": 591, "name": "BaseFilterable.$or" } }, @@ -4213,7 +4347,7 @@ "extendedTypes": [ { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -4271,7 +4405,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -4288,7 +4422,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 588, + "target": 590, "name": "BaseFilterable.$and" } }, @@ -4321,7 +4455,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -4338,7 +4472,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 589, + "target": 591, "name": "BaseFilterable.$or" } }, @@ -4455,7 +4589,7 @@ "extendedTypes": [ { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -4513,7 +4647,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -4530,7 +4664,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 588, + "target": 590, "name": "BaseFilterable.$and" } }, @@ -4563,7 +4697,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -4580,7 +4714,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 589, + "target": 591, "name": "BaseFilterable.$or" } }, @@ -4646,7 +4780,7 @@ "extendedTypes": [ { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -4704,7 +4838,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -4721,7 +4855,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 588, + "target": 590, "name": "BaseFilterable.$and" } }, @@ -4754,7 +4888,7 @@ }, { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -4771,7 +4905,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 589, + "target": 591, "name": "BaseFilterable.$or" } }, @@ -4863,7 +4997,7 @@ "extendedTypes": [ { "type": "reference", - "target": 587, + "target": 589, "typeArguments": [ { "type": "reference", @@ -5219,7 +5353,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 560, + "target": 562, "name": "AddPriceListPricesDTO", "package": "@medusajs/types" } @@ -5260,7 +5394,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -6416,7 +6550,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 549, + "target": 551, "name": "CreatePriceListRuleDTO", "package": "@medusajs/types" } @@ -6457,7 +6591,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 536, + "target": 538, "name": "PriceListRuleDTO", "package": "@medusajs/types" } @@ -6529,7 +6663,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 518, + "target": 520, "name": "CreatePriceListDTO", "package": "@medusajs/types" } @@ -6570,7 +6704,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -8880,7 +9014,7 @@ }, "type": { "type": "reference", - "target": 542, + "target": 544, "name": "FilterablePriceListRuleProps", "package": "@medusajs/types" } @@ -8923,7 +9057,7 @@ "typeArguments": [ { "type": "reference", - "target": 536, + "target": 538, "name": "PriceListRuleDTO", "package": "@medusajs/types" } @@ -8970,7 +9104,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 536, + "target": 538, "name": "PriceListRuleDTO", "package": "@medusajs/types" } @@ -9132,7 +9266,7 @@ }, "type": { "type": "reference", - "target": 510, + "target": 512, "name": "FilterablePriceListProps", "package": "@medusajs/types" } @@ -9175,7 +9309,7 @@ "typeArguments": [ { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -9222,7 +9356,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -10846,7 +10980,7 @@ }, "type": { "type": "reference", - "target": 542, + "target": 544, "name": "FilterablePriceListRuleProps", "package": "@medusajs/types" } @@ -10889,7 +11023,7 @@ "typeArguments": [ { "type": "reference", - "target": 536, + "target": 538, "name": "PriceListRuleDTO", "package": "@medusajs/types" } @@ -10933,7 +11067,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 536, + "target": 538, "name": "PriceListRuleDTO", "package": "@medusajs/types" } @@ -11089,7 +11223,7 @@ }, "type": { "type": "reference", - "target": 510, + "target": 512, "name": "FilterablePriceListProps", "package": "@medusajs/types" } @@ -11132,7 +11266,7 @@ "typeArguments": [ { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -11176,7 +11310,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -12218,7 +12352,7 @@ }, "type": { "type": "reference", - "target": 566, + "target": 568, "name": "RemovePriceListRulesDTO", "package": "@medusajs/types" } @@ -12256,7 +12390,7 @@ "typeArguments": [ { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -12978,7 +13112,7 @@ "typeArguments": [ { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -13020,7 +13154,7 @@ "typeArguments": [ { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -13142,7 +13276,7 @@ "typeArguments": [ { "type": "reference", - "target": 536, + "target": 538, "name": "PriceListRuleDTO", "package": "@medusajs/types" } @@ -13184,7 +13318,7 @@ "typeArguments": [ { "type": "reference", - "target": 536, + "target": 538, "name": "PriceListRuleDTO", "package": "@medusajs/types" } @@ -13745,7 +13879,7 @@ }, "type": { "type": "reference", - "target": 563, + "target": 565, "name": "SetPriceListRulesDTO", "package": "@medusajs/types" } @@ -13783,7 +13917,7 @@ "typeArguments": [ { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -14080,7 +14214,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 554, + "target": 556, "name": "UpdatePriceListRuleDTO", "package": "@medusajs/types" } @@ -14121,7 +14255,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 536, + "target": 538, "name": "PriceListRuleDTO", "package": "@medusajs/types" } @@ -14193,7 +14327,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 528, + "target": 530, "name": "UpdatePriceListDTO", "package": "@medusajs/types" } @@ -14234,7 +14368,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -14306,7 +14440,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 490, + "target": 492, "name": "UpdatePriceRuleDTO", "package": "@medusajs/types" } @@ -14651,14 +14785,14 @@ ] }, { - "id": 569, + "id": 571, "name": "JoinerServiceConfig", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 571, + "id": 573, "name": "alias", "variant": "declaration", "kind": 1024, @@ -14678,7 +14812,7 @@ "types": [ { "type": "reference", - "target": 618, + "target": 621, "name": "JoinerServiceConfigAlias", "package": "@medusajs/types" }, @@ -14686,7 +14820,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 618, + "target": 621, "name": "JoinerServiceConfigAlias", "package": "@medusajs/types" } @@ -14695,7 +14829,7 @@ } }, { - "id": 582, + "id": 584, "name": "args", "variant": "declaration", "kind": 1024, @@ -14731,7 +14865,7 @@ } }, { - "id": 578, + "id": 580, "name": "extends", "variant": "declaration", "kind": 1024, @@ -14743,27 +14877,27 @@ "elementType": { "type": "reflection", "declaration": { - "id": 579, + "id": 581, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 581, + "id": 583, "name": "relationship", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 621, + "target": 624, "name": "JoinerRelationship", "package": "@medusajs/types" } }, { - "id": 580, + "id": 582, "name": "serviceName", "variant": "declaration", "kind": 1024, @@ -14778,8 +14912,8 @@ { "title": "Properties", "children": [ - 581, - 580 + 583, + 582 ] } ] @@ -14788,7 +14922,7 @@ } }, { - "id": 572, + "id": 574, "name": "fieldAlias", "variant": "declaration", "kind": 1024, @@ -14824,14 +14958,14 @@ { "type": "reflection", "declaration": { - "id": 573, + "id": 575, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 575, + "id": 577, "name": "forwardArgumentsOnPath", "variant": "declaration", "kind": 1024, @@ -14845,7 +14979,7 @@ } }, { - "id": 574, + "id": 576, "name": "path", "variant": "declaration", "kind": 1024, @@ -14860,8 +14994,8 @@ { "title": "Properties", "children": [ - 575, - 574 + 577, + 576 ] } ] @@ -14875,7 +15009,7 @@ } }, { - "id": 576, + "id": 578, "name": "primaryKeys", "variant": "declaration", "kind": 1024, @@ -14889,7 +15023,7 @@ } }, { - "id": 577, + "id": 579, "name": "relationships", "variant": "declaration", "kind": 1024, @@ -14900,14 +15034,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 621, + "target": 624, "name": "JoinerRelationship", "package": "@medusajs/types" } } }, { - "id": 570, + "id": 572, "name": "serviceName", "variant": "declaration", "kind": 1024, @@ -14922,26 +15056,26 @@ { "title": "Properties", "children": [ - 571, - 582, + 573, + 584, + 580, + 574, 578, - 572, - 576, - 577, - 570 + 579, + 572 ] } ] }, { - "id": 618, + "id": 621, "name": "JoinerServiceConfigAlias", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 620, + "id": 623, "name": "args", "variant": "declaration", "kind": 1024, @@ -14977,7 +15111,7 @@ } }, { - "id": 619, + "id": 622, "name": "name", "variant": "declaration", "kind": 1024, @@ -15004,8 +15138,8 @@ { "title": "Properties", "children": [ - 620, - 619 + 623, + 622 ] } ] @@ -15194,7 +15328,7 @@ ] }, { - "id": 498, + "id": 500, "name": "PriceListDTO", "variant": "declaration", "kind": 256, @@ -15209,7 +15343,7 @@ }, "children": [ { - "id": 503, + "id": 505, "name": "ends_at", "variant": "declaration", "kind": 1024, @@ -15239,7 +15373,7 @@ } }, { - "id": 499, + "id": 501, "name": "id", "variant": "declaration", "kind": 1024, @@ -15258,7 +15392,7 @@ } }, { - "id": 506, + "id": 508, "name": "money_amounts", "variant": "declaration", "kind": 1024, @@ -15287,28 +15421,7 @@ } }, { - "id": 504, - "name": "number_rules", - "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": 509, + "id": 511, "name": "price_list_rules", "variant": "declaration", "kind": 1024, @@ -15330,14 +15443,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 536, + "target": 538, "name": "PriceListRuleDTO", "package": "@medusajs/types" } } }, { - "id": 505, + "id": 507, "name": "price_set_money_amounts", "variant": "declaration", "kind": 1024, @@ -15366,7 +15479,7 @@ } }, { - "id": 507, + "id": 509, "name": "rule_types", "variant": "declaration", "kind": 1024, @@ -15395,7 +15508,7 @@ } }, { - "id": 508, + "id": 510, "name": "rules", "variant": "declaration", "kind": 1024, @@ -15417,14 +15530,35 @@ "type": "array", "elementType": { "type": "reference", - "target": 536, + "target": 538, "name": "PriceListRuleDTO", "package": "@medusajs/types" } } }, { - "id": 501, + "id": 506, + "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": 503, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -15454,7 +15588,7 @@ } }, { - "id": 502, + "id": 504, "name": "status", "variant": "declaration", "kind": 1024, @@ -15471,13 +15605,13 @@ }, "type": { "type": "reference", - "target": 599, + "target": 601, "name": "PriceListStatus", "package": "@medusajs/types" } }, { - "id": 500, + "id": 502, "name": "title", "variant": "declaration", "kind": 1024, @@ -15502,23 +15636,23 @@ { "title": "Properties", "children": [ - 503, - 499, - 506, - 504, - 509, 505, - 507, - 508, 501, - 502, - 500 + 508, + 511, + 507, + 509, + 510, + 506, + 503, + 504, + 502 ] } ] }, { - "id": 606, + "id": 608, "name": "PriceListPriceDTO", "variant": "declaration", "kind": 256, @@ -15533,7 +15667,7 @@ }, "children": [ { - "id": 611, + "id": 614, "name": "amount", "variant": "declaration", "kind": 1024, @@ -15557,7 +15691,7 @@ } }, { - "id": 610, + "id": 613, "name": "currency", "variant": "declaration", "kind": 1024, @@ -15585,7 +15719,7 @@ } }, { - "id": 609, + "id": 612, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -15609,7 +15743,7 @@ } }, { - "id": 608, + "id": 611, "name": "id", "variant": "declaration", "kind": 1024, @@ -15635,7 +15769,7 @@ } }, { - "id": 613, + "id": 616, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -15670,7 +15804,7 @@ } }, { - "id": 612, + "id": 615, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -15705,7 +15839,7 @@ } }, { - "id": 607, + "id": 609, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -15722,19 +15856,51 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 610, + "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": 634, + "name": "CreatePriceSetPriceRules", + "package": "@medusajs/types" + } } ], "groups": [ { "title": "Properties", "children": [ - 611, - 610, - 609, - 608, + 614, 613, 612, - 607 + 611, + 616, + 615, + 609, + 610 ] } ], @@ -15748,7 +15914,7 @@ ] }, { - "id": 536, + "id": 538, "name": "PriceListRuleDTO", "variant": "declaration", "kind": 256, @@ -15763,7 +15929,7 @@ }, "children": [ { - "id": 537, + "id": 539, "name": "id", "variant": "declaration", "kind": 1024, @@ -15782,7 +15948,7 @@ } }, { - "id": 540, + "id": 542, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -15800,13 +15966,13 @@ }, "type": { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } }, { - "id": 541, + "id": 543, "name": "price_list_rule_values", "variant": "declaration", "kind": 1024, @@ -15828,14 +15994,14 @@ "type": "array", "elementType": { "type": "reference", - "target": 614, + "target": 617, "name": "PriceListRuleValueDTO", "package": "@medusajs/types" } } }, { - "id": 539, + "id": 541, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -15859,7 +16025,7 @@ } }, { - "id": 538, + "id": 540, "name": "value", "variant": "declaration", "kind": 1024, @@ -15882,17 +16048,17 @@ { "title": "Properties", "children": [ - 537, - 540, - 541, 539, - 538 + 542, + 543, + 541, + 540 ] } ] }, { - "id": 614, + "id": 617, "name": "PriceListRuleValueDTO", "variant": "declaration", "kind": 256, @@ -15907,7 +16073,7 @@ }, "children": [ { - "id": 615, + "id": 618, "name": "id", "variant": "declaration", "kind": 1024, @@ -15926,7 +16092,7 @@ } }, { - "id": 617, + "id": 620, "name": "price_list_rule", "variant": "declaration", "kind": 1024, @@ -15944,13 +16110,13 @@ }, "type": { "type": "reference", - "target": 536, + "target": 538, "name": "PriceListRuleDTO", "package": "@medusajs/types" } }, { - "id": 616, + "id": 619, "name": "value", "variant": "declaration", "kind": 1024, @@ -15973,9 +16139,9 @@ { "title": "Properties", "children": [ - 615, - 617, - 616 + 618, + 620, + 619 ] } ] @@ -16373,7 +16539,7 @@ }, "type": { "type": "reference", - "target": 498, + "target": 500, "name": "PriceListDTO", "package": "@medusajs/types" } @@ -16755,7 +16921,7 @@ ] }, { - "id": 566, + "id": 568, "name": "RemovePriceListRulesDTO", "variant": "declaration", "kind": 256, @@ -16770,7 +16936,7 @@ }, "children": [ { - "id": 567, + "id": 569, "name": "priceListId", "variant": "declaration", "kind": 1024, @@ -16789,7 +16955,7 @@ } }, { - "id": 568, + "id": 570, "name": "rules", "variant": "declaration", "kind": 1024, @@ -16823,8 +16989,8 @@ { "title": "Properties", "children": [ - 567, - 568 + 569, + 570 ] } ] @@ -17025,7 +17191,7 @@ ] }, { - "id": 563, + "id": 565, "name": "SetPriceListRulesDTO", "variant": "declaration", "kind": 256, @@ -17040,7 +17206,7 @@ }, "children": [ { - "id": 564, + "id": 566, "name": "priceListId", "variant": "declaration", "kind": 1024, @@ -17059,7 +17225,7 @@ } }, { - "id": 565, + "id": 567, "name": "rules", "variant": "declaration", "kind": 1024, @@ -17117,8 +17283,8 @@ { "title": "Properties", "children": [ - 564, - 565 + 566, + 567 ] } ] @@ -17382,7 +17548,7 @@ ] }, { - "id": 528, + "id": 530, "name": "UpdatePriceListDTO", "variant": "declaration", "kind": 256, @@ -17397,7 +17563,7 @@ }, "children": [ { - "id": 532, + "id": 534, "name": "ends_at", "variant": "declaration", "kind": 1024, @@ -17427,7 +17593,7 @@ } }, { - "id": 529, + "id": 531, "name": "id", "variant": "declaration", "kind": 1024, @@ -17446,8 +17612,8 @@ } }, { - "id": 534, - "name": "number_rules", + "id": 537, + "name": "rules", "variant": "declaration", "kind": 1024, "flags": { @@ -17457,18 +17623,20 @@ "summary": [ { "kind": "text", - "text": "The number of rules associated with the price list." + "text": "The rules to be created and associated with the price list." } ] }, "type": { - "type": "intrinsic", - "name": "number" + "type": "reference", + "target": 607, + "name": "CreatePriceListRules", + "package": "@medusajs/types" } }, { - "id": 535, - "name": "rules", + "id": 536, + "name": "rules_count", "variant": "declaration", "kind": 1024, "flags": { @@ -17478,19 +17646,17 @@ "summary": [ { "kind": "text", - "text": "The rules to be created and associated with the price list." + "text": "The number of rules associated with the price list." } ] }, "type": { - "type": "reference", - "target": 605, - "name": "CreatePriceListRules", - "package": "@medusajs/types" + "type": "intrinsic", + "name": "number" } }, { - "id": 531, + "id": 533, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -17520,7 +17686,7 @@ } }, { - "id": 533, + "id": 535, "name": "status", "variant": "declaration", "kind": 1024, @@ -17537,13 +17703,13 @@ }, "type": { "type": "reference", - "target": 599, + "target": 601, "name": "PriceListStatus", "package": "@medusajs/types" } }, { - "id": 530, + "id": 532, "name": "title", "variant": "declaration", "kind": 1024, @@ -17568,19 +17734,19 @@ { "title": "Properties", "children": [ - 532, - 529, 534, - 535, 531, + 537, + 536, 533, - 530 + 535, + 532 ] } ] }, { - "id": 554, + "id": 556, "name": "UpdatePriceListRuleDTO", "variant": "declaration", "kind": 256, @@ -17595,7 +17761,7 @@ }, "children": [ { - "id": 555, + "id": 557, "name": "id", "variant": "declaration", "kind": 1024, @@ -17614,7 +17780,7 @@ } }, { - "id": 558, + "id": 560, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -17635,7 +17801,7 @@ } }, { - "id": 556, + "id": 558, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -17656,7 +17822,7 @@ } }, { - "id": 559, + "id": 561, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -17677,7 +17843,7 @@ } }, { - "id": 557, + "id": 559, "name": "rule_type_id", "variant": "declaration", "kind": 1024, @@ -17702,17 +17868,17 @@ { "title": "Properties", "children": [ - 555, + 557, + 560, 558, - 556, - 559, - 557 + 561, + 559 ] } ] }, { - "id": 490, + "id": 492, "name": "UpdatePriceRuleDTO", "variant": "declaration", "kind": 256, @@ -17735,7 +17901,7 @@ }, "children": [ { - "id": 491, + "id": 493, "name": "id", "variant": "declaration", "kind": 1024, @@ -17746,7 +17912,7 @@ } }, { - "id": 497, + "id": 499, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -17767,7 +17933,7 @@ } }, { - "id": 492, + "id": 494, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -17780,7 +17946,7 @@ } }, { - "id": 496, + "id": 498, "name": "price_set_money_amount_id", "variant": "declaration", "kind": 1024, @@ -17801,7 +17967,7 @@ } }, { - "id": 495, + "id": 497, "name": "priority", "variant": "declaration", "kind": 1024, @@ -17822,7 +17988,7 @@ } }, { - "id": 493, + "id": 495, "name": "rule_type_id", "variant": "declaration", "kind": 1024, @@ -17835,7 +18001,7 @@ } }, { - "id": 494, + "id": 496, "name": "value", "variant": "declaration", "kind": 1024, @@ -17860,13 +18026,13 @@ { "title": "Properties", "children": [ - 491, + 493, + 499, + 494, + 498, 497, - 492, - 496, 495, - 493, - 494 + 496 ] } ] @@ -18176,7 +18342,7 @@ ] }, { - "id": 621, + "id": 624, "name": "JoinerRelationship", "variant": "declaration", "kind": 2097152, @@ -18184,14 +18350,14 @@ "type": { "type": "reflection", "declaration": { - "id": 622, + "id": 625, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 623, + "id": 626, "name": "alias", "variant": "declaration", "kind": 1024, @@ -18202,7 +18368,7 @@ } }, { - "id": 630, + "id": 633, "name": "args", "variant": "declaration", "kind": 1024, @@ -18238,7 +18404,7 @@ } }, { - "id": 624, + "id": 627, "name": "foreignKey", "variant": "declaration", "kind": 1024, @@ -18249,7 +18415,7 @@ } }, { - "id": 628, + "id": 631, "name": "inverse", "variant": "declaration", "kind": 1024, @@ -18270,7 +18436,7 @@ } }, { - "id": 627, + "id": 630, "name": "isInternalService", "variant": "declaration", "kind": 1024, @@ -18291,7 +18457,7 @@ } }, { - "id": 629, + "id": 632, "name": "isList", "variant": "declaration", "kind": 1024, @@ -18312,7 +18478,7 @@ } }, { - "id": 625, + "id": 628, "name": "primaryKey", "variant": "declaration", "kind": 1024, @@ -18323,7 +18489,7 @@ } }, { - "id": 626, + "id": 629, "name": "serviceName", "variant": "declaration", "kind": 1024, @@ -18338,14 +18504,14 @@ { "title": "Properties", "children": [ - 623, + 626, + 633, + 627, + 631, 630, - 624, + 632, 628, - 627, - 629, - 625, - 626 + 629 ] } ] @@ -18370,7 +18536,7 @@ "typeArguments": [ { "type": "reference", - "target": 569, + "target": 571, "name": "JoinerServiceConfig", "package": "@medusajs/types" }, @@ -18792,7 +18958,7 @@ "flags": {}, "type": { "type": "reference", - "target": 583, + "target": 585, "name": "ModuleJoinerRelationship", "package": "@medusajs/types" } @@ -18929,7 +19095,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 583, + "target": 585, "name": "ModuleJoinerRelationship", "package": "@medusajs/types" } @@ -18992,7 +19158,7 @@ } }, { - "id": 583, + "id": 585, "name": "ModuleJoinerRelationship", "variant": "declaration", "kind": 2097152, @@ -19002,21 +19168,21 @@ "types": [ { "type": "reference", - "target": 621, + "target": 624, "name": "JoinerRelationship", "package": "@medusajs/types" }, { "type": "reflection", "declaration": { - "id": 584, + "id": 586, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 586, + "id": 588, "name": "deleteCascade", "variant": "declaration", "kind": 1024, @@ -19037,7 +19203,7 @@ } }, { - "id": 585, + "id": 587, "name": "isInternalService", "variant": "declaration", "kind": 1024, @@ -19062,8 +19228,8 @@ { "title": "Properties", "children": [ - 586, - 585 + 588, + 587 ] } ] @@ -19077,34 +19243,35 @@ { "title": "Enumerations", "children": [ - 599, - 602 + 601, + 604 ] }, { "title": "Interfaces", "children": [ - 560, + 562, 357, 360, - 587, + 589, 306, 299, 400, 378, - 518, - 549, - 605, + 520, + 551, + 607, 483, 347, 457, - 591, + 634, + 593, 421, 391, 396, 373, - 510, - 542, + 512, + 544, 476, 443, 436, @@ -19112,28 +19279,28 @@ 415, 327, 1, - 569, - 618, + 571, + 621, 365, - 498, - 606, - 536, - 614, + 500, + 608, + 538, + 617, 466, 338, 449, 431, 297, 295, - 566, + 568, 354, 410, - 563, + 565, 405, 385, - 528, - 554, - 490, + 530, + 556, + 492, 352, 461, 426 @@ -19142,9 +19309,9 @@ { "title": "Type Aliases", "children": [ - 621, + 624, 268, - 583 + 585 ] } ], @@ -21060,11 +21227,11 @@ }, "484": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.id" + "qualifiedName": "CreatePriceRuleDTO.price_set_id" }, "485": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.price_set_id" + "qualifiedName": "CreatePriceRuleDTO.price_set" }, "486": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", @@ -21072,579 +21239,595 @@ }, "487": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.value" + "qualifiedName": "CreatePriceRuleDTO.rule_type" }, "488": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.priority" + "qualifiedName": "CreatePriceRuleDTO.value" }, "489": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.price_set_money_amount_id" + "qualifiedName": "CreatePriceRuleDTO.priority" }, "490": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO" + "qualifiedName": "CreatePriceRuleDTO.price_set_money_amount_id" }, "491": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.id" + "qualifiedName": "CreatePriceRuleDTO.price_set_money_amount" }, "492": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.price_set_id" + "qualifiedName": "UpdatePriceRuleDTO" }, "493": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.rule_type_id" + "qualifiedName": "UpdatePriceRuleDTO.id" }, "494": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.value" + "qualifiedName": "UpdatePriceRuleDTO.price_set_id" }, "495": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.priority" + "qualifiedName": "UpdatePriceRuleDTO.rule_type_id" }, "496": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.price_set_money_amount_id" + "qualifiedName": "UpdatePriceRuleDTO.value" }, "497": { "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.price_list_id" + "qualifiedName": "UpdatePriceRuleDTO.priority" }, "498": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO" + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "UpdatePriceRuleDTO.price_set_money_amount_id" }, "499": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.id" + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "UpdatePriceRuleDTO.price_list_id" }, "500": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.title" + "qualifiedName": "PriceListDTO" }, "501": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.starts_at" + "qualifiedName": "PriceListDTO.id" }, "502": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.status" + "qualifiedName": "PriceListDTO.title" }, "503": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.ends_at" + "qualifiedName": "PriceListDTO.starts_at" }, "504": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.number_rules" + "qualifiedName": "PriceListDTO.status" }, "505": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.price_set_money_amounts" + "qualifiedName": "PriceListDTO.ends_at" }, "506": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.money_amounts" + "qualifiedName": "PriceListDTO.rules_count" }, "507": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.rule_types" + "qualifiedName": "PriceListDTO.price_set_money_amounts" }, "508": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.rules" + "qualifiedName": "PriceListDTO.money_amounts" }, "509": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.price_list_rules" + "qualifiedName": "PriceListDTO.rule_types" }, "510": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps" + "qualifiedName": "PriceListDTO.rules" }, "511": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps.id" + "qualifiedName": "PriceListDTO.price_list_rules" }, "512": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps.starts_at" + "qualifiedName": "FilterablePriceListProps" }, "513": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps.ends_at" + "qualifiedName": "FilterablePriceListProps.id" }, "514": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps.status" + "qualifiedName": "FilterablePriceListProps.starts_at" }, "515": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps.number_rules" + "qualifiedName": "FilterablePriceListProps.ends_at" }, "516": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListProps.status" + }, + "517": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListProps.rules_count" + }, + "518": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "517": { + "519": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "518": { + "520": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO" }, - "519": { + "521": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.title" }, - "520": { + "522": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.description" }, - "521": { + "523": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.starts_at" }, - "522": { + "524": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.ends_at" }, - "523": { + "525": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.status" }, - "524": { + "526": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.type" }, - "525": { + "527": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListDTO.number_rules" + "qualifiedName": "CreatePriceListDTO.rules_count" }, - "526": { + "528": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.rules" }, - "527": { + "529": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListDTO.prices" }, - "528": { + "530": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO" }, - "529": { + "531": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO.id" }, - "530": { + "532": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO.title" }, - "531": { + "533": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO.starts_at" }, - "532": { + "534": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO.ends_at" }, - "533": { + "535": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO.status" }, - "534": { + "536": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListDTO.number_rules" + "qualifiedName": "UpdatePriceListDTO.rules_count" }, - "535": { + "537": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListDTO.rules" }, - "536": { + "538": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleDTO" }, - "537": { + "539": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleDTO.id" }, - "538": { + "540": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleDTO.value" }, - "539": { + "541": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleDTO.rule_type" }, - "540": { + "542": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleDTO.price_list" }, - "541": { + "543": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleDTO.price_list_rule_values" }, - "542": { + "544": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleProps" }, - "543": { + "545": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleProps.id" }, - "544": { + "546": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleProps.value" }, - "545": { + "547": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleProps.rule_type" }, - "546": { + "548": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "FilterablePriceListRuleProps.price_list_id" }, - "547": { + "549": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "548": { + "550": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "549": { + "551": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleDTO" }, - "550": { + "552": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleDTO.rule_type_id" }, - "551": { + "553": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleDTO.rule_type" }, - "552": { + "554": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleDTO.price_list_id" }, - "553": { + "555": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRuleDTO.price_list" }, - "554": { + "556": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleDTO" }, - "555": { + "557": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleDTO.id" }, - "556": { + "558": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleDTO.price_list_id" }, - "557": { + "559": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleDTO.rule_type_id" }, - "558": { + "560": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleDTO.price_list" }, - "559": { + "561": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "UpdatePriceListRuleDTO.rule_type" }, - "560": { + "562": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "AddPriceListPricesDTO" }, - "561": { + "563": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "AddPriceListPricesDTO.priceListId" }, - "562": { + "564": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "AddPriceListPricesDTO.prices" }, - "563": { + "565": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "SetPriceListRulesDTO" }, - "564": { + "566": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "SetPriceListRulesDTO.priceListId" }, - "565": { + "567": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "SetPriceListRulesDTO.rules" }, - "566": { + "568": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "RemovePriceListRulesDTO" }, - "567": { + "569": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "RemovePriceListRulesDTO.priceListId" }, - "568": { + "570": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "RemovePriceListRulesDTO.rules" }, - "569": { + "571": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig" }, - "570": { + "572": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.serviceName" }, - "571": { + "573": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.alias" }, - "572": { + "574": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.fieldAlias" }, - "573": { + "575": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "574": { + "576": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.path" }, - "575": { + "577": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.forwardArgumentsOnPath" }, - "576": { + "578": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.primaryKeys" }, - "577": { + "579": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.relationships" }, - "578": { + "580": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.extends" }, - "579": { + "581": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "580": { + "582": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.serviceName" }, - "581": { + "583": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.relationship" }, - "582": { + "584": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.args" }, - "583": { + "585": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleJoinerRelationship" }, - "584": { + "586": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "585": { + "587": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isInternalService" }, - "586": { + "588": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.deleteCascade" }, - "587": { + "589": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable" }, - "588": { + "590": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$and" }, - "589": { + "591": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.$or" }, - "590": { + "592": { "sourceFileName": "../../../packages/types/src/dal/index.ts", "qualifiedName": "BaseFilterable.T" }, - "591": { + "593": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CreatePricesDTO" }, - "592": { + "594": { "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", "qualifiedName": "CreatePricesDTO.rules" }, - "593": { + "595": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.id" }, - "594": { + "596": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.currency_code" }, - "595": { + "597": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.currency" }, - "596": { + "598": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.amount" }, - "597": { + "599": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.min_quantity" }, - "598": { + "600": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.max_quantity" }, - "599": { + "601": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListStatus" }, - "600": { + "602": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListStatus.ACTIVE" }, - "601": { + "603": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListStatus.DRAFT" }, - "602": { + "604": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListType" }, - "603": { + "605": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListType.SALE" }, - "604": { + "606": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListType.OVERRIDE" }, - "605": { + "607": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "CreatePriceListRules" }, - "606": { + "608": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListPriceDTO" }, - "607": { + "609": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListPriceDTO.price_set_id" }, - "608": { + "610": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListPriceDTO.rules" + }, + "611": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.id" }, - "609": { + "612": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.currency_code" }, - "610": { + "613": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.currency" }, - "611": { + "614": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.amount" }, - "612": { + "615": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.min_quantity" }, - "613": { + "616": { "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", "qualifiedName": "CreateMoneyAmountDTO.max_quantity" }, - "614": { + "617": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleValueDTO" }, - "615": { + "618": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleValueDTO.id" }, - "616": { + "619": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleValueDTO.value" }, - "617": { + "620": { "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", "qualifiedName": "PriceListRuleValueDTO.price_list_rule" }, - "618": { + "621": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfigAlias" }, - "619": { + "622": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfigAlias.name" }, - "620": { + "623": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfigAlias.args" }, - "621": { + "624": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerRelationship" }, - "622": { + "625": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "623": { + "626": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.alias" }, - "624": { + "627": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.foreignKey" }, - "625": { + "628": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.primaryKey" }, - "626": { + "629": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.serviceName" }, - "627": { + "630": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.isInternalService" }, - "628": { + "631": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.inverse" }, - "629": { + "632": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.isList" }, - "630": { + "633": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.args" + }, + "634": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceSetPriceRules" } } } \ No newline at end of file diff --git a/docs-util/typedoc-json-output/services.json b/docs-util/typedoc-json-output/services.json index ee59c323d0642..d6dc37522b417 100644 --- a/docs-util/typedoc-json-output/services.json +++ b/docs-util/typedoc-json-output/services.json @@ -247,7 +247,7 @@ }, "type": { "type": "reference", - "target": 6107, + "target": 6224, "name": "UserService", "package": "@medusajs/medusa" } @@ -1118,7 +1118,7 @@ } }, { - "id": 78, + "id": 79, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -1153,7 +1153,7 @@ } }, { - "id": 77, + "id": 78, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -1172,7 +1172,7 @@ } }, { - "id": 79, + "id": 80, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -1217,13 +1217,32 @@ }, "type": { "type": "reference", - "target": 738, + "target": 745, "name": "CustomerService", "package": "@medusajs/medusa" } }, { - "id": 73, + "id": 58, + "name": "logger_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/logger/index.d.ts", + "qualifiedName": "Logger" + }, + "name": "Logger", + "package": "@medusajs/types" + } + }, + { + "id": 74, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -1246,7 +1265,7 @@ } }, { - "id": 74, + "id": 75, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -1288,13 +1307,13 @@ }, "type": { "type": "reference", - "target": 6107, + "target": 6224, "name": "UserService", "package": "@medusajs/medusa" } }, { - "id": 75, + "id": 76, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -1302,7 +1321,7 @@ "isProtected": true }, "getSignature": { - "id": 76, + "id": 77, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -1329,7 +1348,7 @@ } }, { - "id": 88, + "id": 89, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -1338,7 +1357,7 @@ }, "signatures": [ { - "id": 89, + "id": 90, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -1364,14 +1383,14 @@ }, "typeParameter": [ { - "id": 90, + "id": 91, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 91, + "id": 92, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -1380,7 +1399,7 @@ ], "parameters": [ { - "id": 92, + "id": 93, "name": "work", "variant": "param", "kind": 32768, @@ -1396,21 +1415,21 @@ "type": { "type": "reflection", "declaration": { - "id": 93, + "id": 94, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 94, + "id": 95, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 95, + "id": 96, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -1449,7 +1468,7 @@ } }, { - "id": 96, + "id": 97, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -1479,21 +1498,21 @@ { "type": "reflection", "declaration": { - "id": 97, + "id": 98, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 98, + "id": 99, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 99, + "id": 100, "name": "error", "variant": "param", "kind": 32768, @@ -1540,7 +1559,7 @@ } }, { - "id": 100, + "id": 101, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -1558,21 +1577,21 @@ "type": { "type": "reflection", "declaration": { - "id": 101, + "id": 102, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 102, + "id": 103, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 103, + "id": 104, "name": "error", "variant": "param", "kind": 32768, @@ -1648,14 +1667,14 @@ } }, { - "id": 65, + "id": 66, "name": "authenticate", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 66, + "id": 67, "name": "authenticate", "variant": "signature", "kind": 4096, @@ -1681,7 +1700,7 @@ }, "parameters": [ { - "id": 67, + "id": 68, "name": "email", "variant": "param", "kind": 32768, @@ -1700,7 +1719,7 @@ } }, { - "id": 68, + "id": 69, "name": "password", "variant": "param", "kind": 32768, @@ -1743,14 +1762,14 @@ ] }, { - "id": 62, + "id": 63, "name": "authenticateAPIToken", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 63, + "id": 64, "name": "authenticateAPIToken", "variant": "signature", "kind": 4096, @@ -1776,7 +1795,7 @@ }, "parameters": [ { - "id": 64, + "id": 65, "name": "token", "variant": "param", "kind": 32768, @@ -1819,14 +1838,14 @@ ] }, { - "id": 69, + "id": 70, "name": "authenticateCustomer", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 70, + "id": 71, "name": "authenticateCustomer", "variant": "signature", "kind": 4096, @@ -1852,7 +1871,7 @@ }, "parameters": [ { - "id": 71, + "id": 72, "name": "email", "variant": "param", "kind": 32768, @@ -1871,7 +1890,7 @@ } }, { - "id": 72, + "id": 73, "name": "password", "variant": "param", "kind": 32768, @@ -1914,7 +1933,7 @@ ] }, { - "id": 58, + "id": 59, "name": "comparePassword_", "variant": "declaration", "kind": 2048, @@ -1923,7 +1942,7 @@ }, "signatures": [ { - "id": 59, + "id": 60, "name": "comparePassword_", "variant": "signature", "kind": 4096, @@ -1949,7 +1968,7 @@ }, "parameters": [ { - "id": 60, + "id": 61, "name": "password", "variant": "param", "kind": 32768, @@ -1968,7 +1987,7 @@ } }, { - "id": 61, + "id": 62, "name": "hash", "variant": "param", "kind": 32768, @@ -2006,7 +2025,7 @@ ] }, { - "id": 83, + "id": 84, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -2015,14 +2034,14 @@ }, "signatures": [ { - "id": 84, + "id": 85, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 85, + "id": 86, "name": "err", "variant": "param", "kind": 32768, @@ -2052,14 +2071,14 @@ { "type": "reflection", "declaration": { - "id": 86, + "id": 87, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 87, + "id": 88, "name": "code", "variant": "declaration", "kind": 1024, @@ -2074,7 +2093,7 @@ { "title": "Properties", "children": [ - 87 + 88 ] } ] @@ -2102,21 +2121,21 @@ } }, { - "id": 80, + "id": 81, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 81, + "id": 82, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 82, + "id": 83, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -2164,31 +2183,32 @@ { "title": "Properties", "children": [ - 78, - 77, 79, + 78, + 80, 57, - 73, + 58, 74, + 75, 56 ] }, { "title": "Accessors", "children": [ - 75 + 76 ] }, { "title": "Methods", "children": [ - 88, - 65, - 62, - 69, - 58, - 83, - 80 + 89, + 66, + 63, + 70, + 59, + 84, + 81 ] } ], @@ -2205,28 +2225,28 @@ ] }, { - "id": 104, + "id": 105, "name": "BatchJobService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 115, + "id": 116, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 116, + "id": 117, "name": "new BatchJobService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 117, + "id": 118, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -2244,7 +2264,7 @@ ], "type": { "type": "reference", - "target": 104, + "target": 105, "name": "BatchJobService", "package": "@medusajs/medusa" }, @@ -2262,7 +2282,7 @@ } }, { - "id": 172, + "id": 173, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -2297,7 +2317,7 @@ } }, { - "id": 171, + "id": 172, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -2316,7 +2336,7 @@ } }, { - "id": 173, + "id": 174, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -2351,7 +2371,7 @@ } }, { - "id": 118, + "id": 119, "name": "batchJobRepository_", "variant": "declaration", "kind": 1024, @@ -2381,7 +2401,7 @@ } }, { - "id": 121, + "id": 122, "name": "batchJobStatusMapToProps", "variant": "declaration", "kind": 1024, @@ -2407,14 +2427,14 @@ { "type": "reflection", "declaration": { - "id": 122, + "id": 123, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 123, + "id": 124, "name": "entityColumnName", "variant": "declaration", "kind": 1024, @@ -2425,7 +2445,7 @@ } }, { - "id": 124, + "id": 125, "name": "eventType", "variant": "declaration", "kind": 1024, @@ -2440,8 +2460,8 @@ { "title": "Properties", "children": [ - 123, - 124 + 124, + 125 ] } ] @@ -2454,7 +2474,7 @@ "defaultValue": "..." }, { - "id": 119, + "id": 120, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -2464,13 +2484,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 167, + "id": 168, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -2493,7 +2513,7 @@ } }, { - "id": 120, + "id": 121, "name": "strategyResolver_", "variant": "declaration", "kind": 1024, @@ -2503,13 +2523,13 @@ }, "type": { "type": "reference", - "target": 5447, + "target": 5559, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 168, + "id": 169, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -2541,7 +2561,7 @@ } }, { - "id": 105, + "id": 106, "name": "Events", "variant": "declaration", "kind": 1024, @@ -2552,14 +2572,14 @@ "type": { "type": "reflection", "declaration": { - "id": 106, + "id": 107, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 113, + "id": 114, "name": "CANCELED", "variant": "declaration", "kind": 1024, @@ -2571,7 +2591,7 @@ "defaultValue": "\"batch.canceled\"" }, { - "id": 112, + "id": 113, "name": "COMPLETED", "variant": "declaration", "kind": 1024, @@ -2583,7 +2603,7 @@ "defaultValue": "\"batch.completed\"" }, { - "id": 110, + "id": 111, "name": "CONFIRMED", "variant": "declaration", "kind": 1024, @@ -2595,7 +2615,7 @@ "defaultValue": "\"batch.confirmed\"" }, { - "id": 107, + "id": 108, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -2607,7 +2627,7 @@ "defaultValue": "\"batch.created\"" }, { - "id": 114, + "id": 115, "name": "FAILED", "variant": "declaration", "kind": 1024, @@ -2619,7 +2639,7 @@ "defaultValue": "\"batch.failed\"" }, { - "id": 109, + "id": 110, "name": "PRE_PROCESSED", "variant": "declaration", "kind": 1024, @@ -2631,7 +2651,7 @@ "defaultValue": "\"batch.pre_processed\"" }, { - "id": 111, + "id": 112, "name": "PROCESSING", "variant": "declaration", "kind": 1024, @@ -2643,7 +2663,7 @@ "defaultValue": "\"batch.processing\"" }, { - "id": 108, + "id": 109, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -2659,14 +2679,14 @@ { "title": "Properties", "children": [ - 113, - 112, - 110, - 107, 114, - 109, + 113, 111, - 108 + 108, + 115, + 110, + 112, + 109 ] } ] @@ -2675,7 +2695,7 @@ "defaultValue": "..." }, { - "id": 169, + "id": 170, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -2683,7 +2703,7 @@ "isProtected": true }, "getSignature": { - "id": 170, + "id": 171, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -2710,7 +2730,7 @@ } }, { - "id": 182, + "id": 183, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -2719,7 +2739,7 @@ }, "signatures": [ { - "id": 183, + "id": 184, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -2745,14 +2765,14 @@ }, "typeParameter": [ { - "id": 184, + "id": 185, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 185, + "id": 186, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -2761,7 +2781,7 @@ ], "parameters": [ { - "id": 186, + "id": 187, "name": "work", "variant": "param", "kind": 32768, @@ -2777,21 +2797,21 @@ "type": { "type": "reflection", "declaration": { - "id": 187, + "id": 188, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 188, + "id": 189, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 189, + "id": 190, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -2830,7 +2850,7 @@ } }, { - "id": 190, + "id": 191, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -2860,21 +2880,21 @@ { "type": "reflection", "declaration": { - "id": 191, + "id": 192, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 192, + "id": 193, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 193, + "id": 194, "name": "error", "variant": "param", "kind": 32768, @@ -2921,7 +2941,7 @@ } }, { - "id": 194, + "id": 195, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -2939,21 +2959,21 @@ "type": { "type": "reflection", "declaration": { - "id": 195, + "id": 196, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 196, + "id": 197, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 197, + "id": 198, "name": "error", "variant": "param", "kind": 32768, @@ -3029,21 +3049,21 @@ } }, { - "id": 146, + "id": 147, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 147, + "id": 148, "name": "cancel", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 148, + "id": 149, "name": "batchJobOrId", "variant": "param", "kind": 32768, @@ -3092,21 +3112,21 @@ ] }, { - "id": 143, + "id": 144, "name": "complete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 144, + "id": 145, "name": "complete", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 145, + "id": 146, "name": "batchJobOrId", "variant": "param", "kind": 32768, @@ -3155,21 +3175,21 @@ ] }, { - "id": 140, + "id": 141, "name": "confirm", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 141, + "id": 142, "name": "confirm", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 142, + "id": 143, "name": "batchJobOrId", "variant": "param", "kind": 32768, @@ -3218,21 +3238,21 @@ ] }, { - "id": 133, + "id": 134, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 134, + "id": 135, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 135, + "id": 136, "name": "data", "variant": "param", "kind": 32768, @@ -3272,21 +3292,21 @@ ] }, { - "id": 129, + "id": 130, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 130, + "id": 131, "name": "listAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 131, + "id": 132, "name": "selector", "variant": "param", "kind": 32768, @@ -3303,7 +3323,7 @@ "defaultValue": "{}" }, { - "id": 132, + "id": 133, "name": "config", "variant": "param", "kind": 32768, @@ -3367,21 +3387,21 @@ ] }, { - "id": 159, + "id": 160, "name": "prepareBatchJobForProcessing", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 160, + "id": 161, "name": "prepareBatchJobForProcessing", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 161, + "id": 162, "name": "data", "variant": "param", "kind": 32768, @@ -3397,7 +3417,7 @@ } }, { - "id": 162, + "id": 163, "name": "req", "variant": "param", "kind": 32768, @@ -3486,21 +3506,21 @@ ] }, { - "id": 125, + "id": 126, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 126, + "id": 127, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 127, + "id": 128, "name": "batchJobId", "variant": "param", "kind": 32768, @@ -3511,7 +3531,7 @@ } }, { - "id": 128, + "id": 129, "name": "config", "variant": "param", "kind": 32768, @@ -3563,21 +3583,21 @@ ] }, { - "id": 155, + "id": 156, "name": "setFailed", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 156, + "id": 157, "name": "setFailed", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 157, + "id": 158, "name": "batchJobOrId", "variant": "param", "kind": 32768, @@ -3602,7 +3622,7 @@ } }, { - "id": 158, + "id": 159, "name": "error", "variant": "param", "kind": 32768, @@ -3653,21 +3673,21 @@ ] }, { - "id": 149, + "id": 150, "name": "setPreProcessingDone", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 150, + "id": 151, "name": "setPreProcessingDone", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 151, + "id": 152, "name": "batchJobOrId", "variant": "param", "kind": 32768, @@ -3716,21 +3736,21 @@ ] }, { - "id": 152, + "id": 153, "name": "setProcessing", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 153, + "id": 154, "name": "setProcessing", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 154, + "id": 155, "name": "batchJobOrId", "variant": "param", "kind": 32768, @@ -3779,7 +3799,7 @@ ] }, { - "id": 177, + "id": 178, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -3788,14 +3808,14 @@ }, "signatures": [ { - "id": 178, + "id": 179, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 179, + "id": 180, "name": "err", "variant": "param", "kind": 32768, @@ -3825,14 +3845,14 @@ { "type": "reflection", "declaration": { - "id": 180, + "id": 181, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 181, + "id": 182, "name": "code", "variant": "declaration", "kind": 1024, @@ -3847,7 +3867,7 @@ { "title": "Properties", "children": [ - 181 + 182 ] } ] @@ -3875,21 +3895,21 @@ } }, { - "id": 136, + "id": 137, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 137, + "id": 138, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 138, + "id": 139, "name": "batchJobOrId", "variant": "param", "kind": 32768, @@ -3914,7 +3934,7 @@ } }, { - "id": 139, + "id": 140, "name": "data", "variant": "param", "kind": 32768, @@ -3989,7 +4009,7 @@ ] }, { - "id": 163, + "id": 164, "name": "updateStatus", "variant": "declaration", "kind": 2048, @@ -3998,14 +4018,14 @@ }, "signatures": [ { - "id": 164, + "id": 165, "name": "updateStatus", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 165, + "id": 166, "name": "batchJobOrId", "variant": "param", "kind": 32768, @@ -4030,7 +4050,7 @@ } }, { - "id": 166, + "id": 167, "name": "status", "variant": "param", "kind": 32768, @@ -4070,21 +4090,21 @@ ] }, { - "id": 174, + "id": 175, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 175, + "id": 176, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 176, + "id": 177, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -4104,7 +4124,7 @@ ], "type": { "type": "reference", - "target": 104, + "target": 105, "name": "BatchJobService", "package": "@medusajs/medusa" }, @@ -4126,48 +4146,48 @@ { "title": "Constructors", "children": [ - 115 + 116 ] }, { "title": "Properties", "children": [ - 172, - 171, 173, - 118, - 121, + 172, + 174, 119, - 167, + 122, 120, 168, - 105 + 121, + 169, + 106 ] }, { "title": "Accessors", "children": [ - 169 + 170 ] }, { "title": "Methods", "children": [ - 182, - 146, - 143, - 140, - 133, - 129, - 159, - 125, - 155, - 149, - 152, - 177, - 136, - 163, - 174 + 183, + 147, + 144, + 141, + 134, + 130, + 160, + 126, + 156, + 150, + 153, + 178, + 137, + 164, + 175 ] } ], @@ -4184,28 +4204,28 @@ ] }, { - "id": 198, + "id": 199, "name": "CartService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 204, + "id": 205, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 205, + "id": 206, "name": "new CartService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 206, + "id": 207, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -4223,7 +4243,7 @@ ], "type": { "type": "reference", - "target": 198, + "target": 199, "name": "CartService", "package": "@medusajs/medusa" }, @@ -4241,7 +4261,7 @@ } }, { - "id": 435, + "id": 436, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -4276,7 +4296,7 @@ } }, { - "id": 434, + "id": 435, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -4295,7 +4315,7 @@ } }, { - "id": 436, + "id": 437, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -4330,7 +4350,7 @@ } }, { - "id": 218, + "id": 219, "name": "addressRepository_", "variant": "declaration", "kind": 1024, @@ -4360,7 +4380,7 @@ } }, { - "id": 208, + "id": 209, "name": "cartRepository_", "variant": "declaration", "kind": 1024, @@ -4394,28 +4414,28 @@ { "type": "reflection", "declaration": { - "id": 209, + "id": 210, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 214, + "id": 215, "name": "findOneWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 215, + "id": 216, "name": "findOneWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 216, + "id": 217, "name": "relations", "variant": "param", "kind": 32768, @@ -4443,7 +4463,7 @@ "defaultValue": "{}" }, { - "id": 217, + "id": 218, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -4510,21 +4530,21 @@ ] }, { - "id": 210, + "id": 211, "name": "findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 211, + "id": 212, "name": "findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 212, + "id": 213, "name": "relations", "variant": "param", "kind": 32768, @@ -4552,7 +4572,7 @@ "defaultValue": "{}" }, { - "id": 213, + "id": 214, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -4626,8 +4646,8 @@ { "title": "Methods", "children": [ - 214, - 210 + 215, + 211 ] } ] @@ -4637,7 +4657,7 @@ } }, { - "id": 243, + "id": 244, "name": "customShippingOptionService_", "variant": "declaration", "kind": 1024, @@ -4647,13 +4667,13 @@ }, "type": { "type": "reference", - "target": 689, + "target": 696, "name": "CustomShippingOptionService", "package": "@medusajs/medusa" } }, { - "id": 235, + "id": 236, "name": "customerService_", "variant": "declaration", "kind": 1024, @@ -4663,13 +4683,13 @@ }, "type": { "type": "reference", - "target": 738, + "target": 745, "name": "CustomerService", "package": "@medusajs/medusa" } }, { - "id": 238, + "id": 239, "name": "discountService_", "variant": "declaration", "kind": 1024, @@ -4679,13 +4699,13 @@ }, "type": { "type": "reference", - "target": 955, + "target": 985, "name": "DiscountService", "package": "@medusajs/medusa" } }, { - "id": 227, + "id": 228, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -4695,13 +4715,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 246, + "id": 247, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -4720,7 +4740,7 @@ } }, { - "id": 239, + "id": 240, "name": "giftCardService_", "variant": "declaration", "kind": 1024, @@ -4730,13 +4750,13 @@ }, "type": { "type": "reference", - "target": 1565, + "target": 1619, "name": "GiftCardService", "package": "@medusajs/medusa" } }, { - "id": 245, + "id": 246, "name": "lineItemAdjustmentService_", "variant": "declaration", "kind": 1024, @@ -4746,13 +4766,13 @@ }, "type": { "type": "reference", - "target": 1850, + "target": 1904, "name": "LineItemAdjustmentService", "package": "@medusajs/medusa" } }, { - "id": 220, + "id": 221, "name": "lineItemRepository_", "variant": "declaration", "kind": 1024, @@ -4786,21 +4806,21 @@ { "type": "reflection", "declaration": { - "id": 221, + "id": 222, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 222, + "id": 223, "name": "findByReturn", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 223, + "id": 224, "name": "findByReturn", "variant": "signature", "kind": 4096, @@ -4842,7 +4862,7 @@ }, "parameters": [ { - "id": 224, + "id": 225, "name": "returnId", "variant": "param", "kind": 32768, @@ -4885,14 +4905,14 @@ { "type": "reflection", "declaration": { - "id": 225, + "id": 226, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 226, + "id": 227, "name": "return_item", "variant": "declaration", "kind": 1024, @@ -4912,7 +4932,7 @@ { "title": "Properties", "children": [ - 226 + 227 ] } ] @@ -4933,7 +4953,7 @@ { "title": "Methods", "children": [ - 222 + 223 ] } ] @@ -4943,7 +4963,7 @@ } }, { - "id": 233, + "id": 234, "name": "lineItemService_", "variant": "declaration", "kind": 1024, @@ -4953,13 +4973,13 @@ }, "type": { "type": "reference", - "target": 1713, + "target": 1767, "name": "LineItemService", "package": "@medusajs/medusa" } }, { - "id": 430, + "id": 431, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -4982,7 +5002,7 @@ } }, { - "id": 242, + "id": 243, "name": "newTotalsService_", "variant": "declaration", "kind": 1024, @@ -4992,13 +5012,13 @@ }, "type": { "type": "reference", - "target": 1956, + "target": 2010, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 234, + "id": 235, "name": "paymentProviderService_", "variant": "declaration", "kind": 1024, @@ -5008,13 +5028,13 @@ }, "type": { "type": "reference", - "target": 2919, + "target": 2973, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 219, + "id": 220, "name": "paymentSessionRepository_", "variant": "declaration", "kind": 1024, @@ -5044,7 +5064,7 @@ } }, { - "id": 244, + "id": 245, "name": "priceSelectionStrategy_", "variant": "declaration", "kind": 1024, @@ -5063,7 +5083,7 @@ } }, { - "id": 248, + "id": 249, "name": "pricingService_", "variant": "declaration", "kind": 1024, @@ -5073,13 +5093,13 @@ }, "type": { "type": "reference", - "target": 3316, + "target": 3370, "name": "PricingService", "package": "@medusajs/medusa" } }, { - "id": 229, + "id": 230, "name": "productService_", "variant": "declaration", "kind": 1024, @@ -5089,13 +5109,13 @@ }, "type": { "type": "reference", - "target": 3441, + "target": 3495, "name": "ProductService", "package": "@medusajs/medusa" } }, { - "id": 247, + "id": 248, "name": "productVariantInventoryService_", "variant": "declaration", "kind": 1024, @@ -5105,13 +5125,13 @@ }, "type": { "type": "reference", - "target": 4409, + "target": 4497, "name": "ProductVariantInventoryService", "package": "@medusajs/medusa" } }, { - "id": 228, + "id": 229, "name": "productVariantService_", "variant": "declaration", "kind": 1024, @@ -5121,13 +5141,13 @@ }, "type": { "type": "reference", - "target": 4076, + "target": 4150, "name": "ProductVariantService", "package": "@medusajs/medusa" } }, { - "id": 232, + "id": 233, "name": "regionService_", "variant": "declaration", "kind": 1024, @@ -5137,13 +5157,13 @@ }, "type": { "type": "reference", - "target": 4533, + "target": 4621, "name": "RegionService", "package": "@medusajs/medusa" } }, { - "id": 231, + "id": 232, "name": "salesChannelService_", "variant": "declaration", "kind": 1024, @@ -5153,13 +5173,13 @@ }, "type": { "type": "reference", - "target": 4809, + "target": 4897, "name": "SalesChannelService", "package": "@medusajs/medusa" } }, { - "id": 207, + "id": 208, "name": "shippingMethodRepository_", "variant": "declaration", "kind": 1024, @@ -5189,7 +5209,7 @@ } }, { - "id": 236, + "id": 237, "name": "shippingOptionService_", "variant": "declaration", "kind": 1024, @@ -5199,13 +5219,13 @@ }, "type": { "type": "reference", - "target": 5056, + "target": 5163, "name": "ShippingOptionService", "package": "@medusajs/medusa" } }, { - "id": 237, + "id": 238, "name": "shippingProfileService_", "variant": "declaration", "kind": 1024, @@ -5215,13 +5235,13 @@ }, "type": { "type": "reference", - "target": 5168, + "target": 5275, "name": "ShippingProfileService", "package": "@medusajs/medusa" } }, { - "id": 230, + "id": 231, "name": "storeService_", "variant": "declaration", "kind": 1024, @@ -5231,13 +5251,13 @@ }, "type": { "type": "reference", - "target": 5392, + "target": 5504, "name": "StoreService", "package": "@medusajs/medusa" } }, { - "id": 240, + "id": 241, "name": "taxProviderService_", "variant": "declaration", "kind": 1024, @@ -5247,13 +5267,13 @@ }, "type": { "type": "reference", - "target": 5702, + "target": 5814, "name": "TaxProviderService", "package": "@medusajs/medusa" } }, { - "id": 241, + "id": 242, "name": "totalsService_", "variant": "declaration", "kind": 1024, @@ -5263,13 +5283,13 @@ }, "type": { "type": "reference", - "target": 5964, + "target": 6081, "name": "TotalsService", "package": "@medusajs/medusa" } }, { - "id": 431, + "id": 432, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -5301,7 +5321,7 @@ } }, { - "id": 199, + "id": 200, "name": "Events", "variant": "declaration", "kind": 1024, @@ -5312,14 +5332,14 @@ "type": { "type": "reflection", "declaration": { - "id": 200, + "id": 201, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 202, + "id": 203, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -5331,7 +5351,7 @@ "defaultValue": "\"cart.created\"" }, { - "id": 201, + "id": 202, "name": "CUSTOMER_UPDATED", "variant": "declaration", "kind": 1024, @@ -5343,7 +5363,7 @@ "defaultValue": "\"cart.customer_updated\"" }, { - "id": 203, + "id": 204, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -5359,9 +5379,9 @@ { "title": "Properties", "children": [ + 203, 202, - 201, - 203 + 204 ] } ] @@ -5370,7 +5390,7 @@ "defaultValue": "..." }, { - "id": 432, + "id": 433, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -5378,7 +5398,7 @@ "isProtected": true }, "getSignature": { - "id": 433, + "id": 434, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -5405,14 +5425,14 @@ } }, { - "id": 288, + "id": 289, "name": "addLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 289, + "id": 290, "name": "addLineItem", "variant": "signature", "kind": 4096, @@ -5445,7 +5465,7 @@ "kind": "inline-tag", "tag": "@link", "text": "addOrUpdateLineItems", - "target": 295, + "target": 296, "tsLinkText": "" }, { @@ -5458,7 +5478,7 @@ }, "parameters": [ { - "id": 290, + "id": 291, "name": "cartId", "variant": "param", "kind": 32768, @@ -5477,7 +5497,7 @@ } }, { - "id": 291, + "id": 292, "name": "lineItem", "variant": "param", "kind": 32768, @@ -5501,7 +5521,7 @@ } }, { - "id": 292, + "id": 293, "name": "config", "variant": "param", "kind": 32768, @@ -5517,14 +5537,14 @@ "type": { "type": "reflection", "declaration": { - "id": 293, + "id": 294, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 294, + "id": 295, "name": "validateSalesChannels", "variant": "declaration", "kind": 1024, @@ -5540,7 +5560,7 @@ { "title": "Properties", "children": [ - 294 + 295 ] } ] @@ -5568,14 +5588,14 @@ ] }, { - "id": 295, + "id": 296, "name": "addOrUpdateLineItems", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 296, + "id": 297, "name": "addOrUpdateLineItems", "variant": "signature", "kind": 4096, @@ -5601,7 +5621,7 @@ }, "parameters": [ { - "id": 297, + "id": 298, "name": "cartId", "variant": "param", "kind": 32768, @@ -5620,7 +5640,7 @@ } }, { - "id": 298, + "id": 299, "name": "lineItems", "variant": "param", "kind": 32768, @@ -5661,7 +5681,7 @@ } }, { - "id": 299, + "id": 300, "name": "config", "variant": "param", "kind": 32768, @@ -5677,14 +5697,14 @@ "type": { "type": "reflection", "declaration": { - "id": 300, + "id": 301, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 301, + "id": 302, "name": "validateSalesChannels", "variant": "declaration", "kind": 1024, @@ -5700,7 +5720,7 @@ { "title": "Properties", "children": [ - 301 + 302 ] } ] @@ -5728,14 +5748,14 @@ ] }, { - "id": 377, + "id": 378, "name": "addShippingMethod", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 378, + "id": 379, "name": "addShippingMethod", "variant": "signature", "kind": 4096, @@ -5761,7 +5781,7 @@ }, "parameters": [ { - "id": 379, + "id": 380, "name": "cartOrId", "variant": "param", "kind": 32768, @@ -5794,7 +5814,7 @@ } }, { - "id": 380, + "id": 381, "name": "optionId", "variant": "param", "kind": 32768, @@ -5813,7 +5833,7 @@ } }, { - "id": 381, + "id": 382, "name": "data", "variant": "param", "kind": 32768, @@ -5872,7 +5892,7 @@ ] }, { - "id": 307, + "id": 308, "name": "adjustFreeShipping_", "variant": "declaration", "kind": 2048, @@ -5881,7 +5901,7 @@ }, "signatures": [ { - "id": 308, + "id": 309, "name": "adjustFreeShipping_", "variant": "signature", "kind": 4096, @@ -5907,7 +5927,7 @@ }, "parameters": [ { - "id": 309, + "id": 310, "name": "cart", "variant": "param", "kind": 32768, @@ -5931,7 +5951,7 @@ } }, { - "id": 310, + "id": 311, "name": "shouldAdd", "variant": "param", "kind": 32768, @@ -5969,14 +5989,14 @@ ] }, { - "id": 340, + "id": 341, "name": "applyDiscount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 341, + "id": 342, "name": "applyDiscount", "variant": "signature", "kind": 4096, @@ -5991,7 +6011,7 @@ }, "parameters": [ { - "id": 342, + "id": 343, "name": "cart", "variant": "param", "kind": 32768, @@ -6015,7 +6035,7 @@ } }, { - "id": 343, + "id": 344, "name": "discountCode", "variant": "param", "kind": 32768, @@ -6053,14 +6073,14 @@ ] }, { - "id": 344, + "id": 345, "name": "applyDiscounts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 345, + "id": 346, "name": "applyDiscounts", "variant": "signature", "kind": 4096, @@ -6075,7 +6095,7 @@ }, "parameters": [ { - "id": 346, + "id": 347, "name": "cart", "variant": "param", "kind": 32768, @@ -6099,7 +6119,7 @@ } }, { - "id": 347, + "id": 348, "name": "discountCodes", "variant": "param", "kind": 32768, @@ -6140,7 +6160,7 @@ ] }, { - "id": 336, + "id": 337, "name": "applyGiftCard_", "variant": "declaration", "kind": 2048, @@ -6149,14 +6169,14 @@ }, "signatures": [ { - "id": 337, + "id": 338, "name": "applyGiftCard_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 338, + "id": 339, "name": "cart", "variant": "param", "kind": 32768, @@ -6172,7 +6192,7 @@ } }, { - "id": 339, + "id": 340, "name": "code", "variant": "param", "kind": 32768, @@ -6202,7 +6222,7 @@ ] }, { - "id": 445, + "id": 446, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -6211,7 +6231,7 @@ }, "signatures": [ { - "id": 446, + "id": 447, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -6237,14 +6257,14 @@ }, "typeParameter": [ { - "id": 447, + "id": 448, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 448, + "id": 449, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -6253,7 +6273,7 @@ ], "parameters": [ { - "id": 449, + "id": 450, "name": "work", "variant": "param", "kind": 32768, @@ -6269,21 +6289,21 @@ "type": { "type": "reflection", "declaration": { - "id": 450, + "id": 451, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 451, + "id": 452, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 452, + "id": 453, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -6322,7 +6342,7 @@ } }, { - "id": 453, + "id": 454, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -6352,21 +6372,21 @@ { "type": "reflection", "declaration": { - "id": 454, + "id": 455, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 455, + "id": 456, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 456, + "id": 457, "name": "error", "variant": "param", "kind": 32768, @@ -6413,7 +6433,7 @@ } }, { - "id": 457, + "id": 458, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -6431,21 +6451,21 @@ "type": { "type": "reflection", "declaration": { - "id": 458, + "id": 459, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 459, + "id": 460, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 460, + "id": 461, "name": "error", "variant": "param", "kind": 32768, @@ -6521,14 +6541,14 @@ } }, { - "id": 356, + "id": 357, "name": "authorizePayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 357, + "id": 358, "name": "authorizePayment", "variant": "signature", "kind": 4096, @@ -6554,7 +6574,7 @@ }, "parameters": [ { - "id": 358, + "id": 359, "name": "cartId", "variant": "param", "kind": 32768, @@ -6573,7 +6593,7 @@ } }, { - "id": 359, + "id": 360, "name": "context", "variant": "param", "kind": 32768, @@ -6611,14 +6631,14 @@ { "type": "reflection", "declaration": { - "id": 360, + "id": 361, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 361, + "id": 362, "name": "cart_id", "variant": "declaration", "kind": 1024, @@ -6633,7 +6653,7 @@ { "title": "Properties", "children": [ - 361 + 362 ] } ] @@ -6668,14 +6688,14 @@ ] }, { - "id": 268, + "id": 269, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 269, + "id": 270, "name": "create", "variant": "signature", "kind": 4096, @@ -6701,7 +6721,7 @@ }, "parameters": [ { - "id": 270, + "id": 271, "name": "data", "variant": "param", "kind": 32768, @@ -6749,7 +6769,7 @@ ] }, { - "id": 323, + "id": 324, "name": "createOrFetchGuestCustomerFromEmail_", "variant": "declaration", "kind": 2048, @@ -6758,7 +6778,7 @@ }, "signatures": [ { - "id": 324, + "id": 325, "name": "createOrFetchGuestCustomerFromEmail_", "variant": "signature", "kind": 4096, @@ -6784,7 +6804,7 @@ }, "parameters": [ { - "id": 325, + "id": 326, "name": "email", "variant": "param", "kind": 32768, @@ -6827,21 +6847,21 @@ ] }, { - "id": 404, + "id": 405, "name": "createTaxLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 405, + "id": 406, "name": "createTaxLines", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 406, + "id": 407, "name": "cartOrId", "variant": "param", "kind": 32768, @@ -6885,21 +6905,21 @@ ] }, { - "id": 410, + "id": 411, "name": "decorateTotals", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 411, + "id": 412, "name": "decorateTotals", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 412, + "id": 413, "name": "cart", "variant": "param", "kind": 32768, @@ -6915,7 +6935,7 @@ } }, { - "id": 413, + "id": 414, "name": "totalsConfig", "variant": "param", "kind": 32768, @@ -6971,7 +6991,7 @@ ] }, { - "id": 422, + "id": 423, "name": "decorateTotals_", "variant": "declaration", "kind": 2048, @@ -6980,7 +7000,7 @@ }, "signatures": [ { - "id": 423, + "id": 424, "name": "decorateTotals_", "variant": "signature", "kind": 4096, @@ -7003,7 +7023,7 @@ }, "parameters": [ { - "id": 424, + "id": 425, "name": "cart", "variant": "param", "kind": 32768, @@ -7019,7 +7039,7 @@ } }, { - "id": 425, + "id": 426, "name": "totalsToSelect", "variant": "param", "kind": 32768, @@ -7038,7 +7058,7 @@ } }, { - "id": 426, + "id": 427, "name": "options", "variant": "param", "kind": 32768, @@ -7079,14 +7099,14 @@ ] }, { - "id": 396, + "id": 397, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 397, + "id": 398, "name": "delete", "variant": "signature", "kind": 4096, @@ -7112,7 +7132,7 @@ }, "parameters": [ { - "id": 398, + "id": 399, "name": "cartId", "variant": "param", "kind": 32768, @@ -7155,14 +7175,14 @@ ] }, { - "id": 369, + "id": 370, "name": "deletePaymentSession", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 370, + "id": 371, "name": "deletePaymentSession", "variant": "signature", "kind": 4096, @@ -7188,7 +7208,7 @@ }, "parameters": [ { - "id": 371, + "id": 372, "name": "cartId", "variant": "param", "kind": 32768, @@ -7207,7 +7227,7 @@ } }, { - "id": 372, + "id": 373, "name": "providerId", "variant": "param", "kind": 32768, @@ -7245,21 +7265,21 @@ ] }, { - "id": 407, + "id": 408, "name": "deleteTaxLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 408, + "id": 409, "name": "deleteTaxLines", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 409, + "id": 410, "name": "id", "variant": "param", "kind": 32768, @@ -7289,14 +7309,14 @@ ] }, { - "id": 382, + "id": 383, "name": "findCustomShippingOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 383, + "id": 384, "name": "findCustomShippingOption", "variant": "signature", "kind": 4096, @@ -7322,7 +7342,7 @@ }, "parameters": [ { - "id": 384, + "id": 385, "name": "cartCustomShippingOptions", "variant": "param", "kind": 32768, @@ -7349,7 +7369,7 @@ } }, { - "id": 385, + "id": 386, "name": "optionId", "variant": "param", "kind": 32768, @@ -7390,7 +7410,7 @@ ] }, { - "id": 427, + "id": 428, "name": "getTotalsRelations", "variant": "declaration", "kind": 2048, @@ -7399,14 +7419,14 @@ }, "signatures": [ { - "id": 428, + "id": 429, "name": "getTotalsRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 429, + "id": 430, "name": "config", "variant": "param", "kind": 32768, @@ -7444,7 +7464,7 @@ ] }, { - "id": 271, + "id": 272, "name": "getValidatedSalesChannel", "variant": "declaration", "kind": 2048, @@ -7453,14 +7473,14 @@ }, "signatures": [ { - "id": 272, + "id": 273, "name": "getValidatedSalesChannel", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 273, + "id": 274, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -7497,14 +7517,14 @@ ] }, { - "id": 249, + "id": 250, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 250, + "id": 251, "name": "list", "variant": "signature", "kind": 4096, @@ -7525,7 +7545,7 @@ }, "parameters": [ { - "id": 251, + "id": 252, "name": "selector", "variant": "param", "kind": 32768, @@ -7549,7 +7569,7 @@ } }, { - "id": 252, + "id": 253, "name": "config", "variant": "param", "kind": 32768, @@ -7612,7 +7632,7 @@ ] }, { - "id": 315, + "id": 316, "name": "onSalesChannelChange", "variant": "declaration", "kind": 2048, @@ -7621,7 +7641,7 @@ }, "signatures": [ { - "id": 316, + "id": 317, "name": "onSalesChannelChange", "variant": "signature", "kind": 4096, @@ -7649,7 +7669,7 @@ }, "parameters": [ { - "id": 317, + "id": 318, "name": "cart", "variant": "param", "kind": 32768, @@ -7673,7 +7693,7 @@ } }, { - "id": 318, + "id": 319, "name": "newSalesChannelId", "variant": "param", "kind": 32768, @@ -7711,7 +7731,7 @@ ] }, { - "id": 414, + "id": 415, "name": "refreshAdjustments_", "variant": "declaration", "kind": 2048, @@ -7720,14 +7740,14 @@ }, "signatures": [ { - "id": 415, + "id": 416, "name": "refreshAdjustments_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 416, + "id": 417, "name": "cart", "variant": "param", "kind": 32768, @@ -7762,14 +7782,14 @@ ] }, { - "id": 373, + "id": 374, "name": "refreshPaymentSession", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 374, + "id": 375, "name": "refreshPaymentSession", "variant": "signature", "kind": 4096, @@ -7795,7 +7815,7 @@ }, "parameters": [ { - "id": 375, + "id": 376, "name": "cartId", "variant": "param", "kind": 32768, @@ -7814,7 +7834,7 @@ } }, { - "id": 376, + "id": 377, "name": "providerId", "variant": "param", "kind": 32768, @@ -7852,14 +7872,14 @@ ] }, { - "id": 348, + "id": 349, "name": "removeDiscount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 349, + "id": 350, "name": "removeDiscount", "variant": "signature", "kind": 4096, @@ -7885,7 +7905,7 @@ }, "parameters": [ { - "id": 350, + "id": 351, "name": "cartId", "variant": "param", "kind": 32768, @@ -7904,7 +7924,7 @@ } }, { - "id": 351, + "id": 352, "name": "discountCode", "variant": "param", "kind": 32768, @@ -7947,14 +7967,14 @@ ] }, { - "id": 274, + "id": 275, "name": "removeLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 275, + "id": 276, "name": "removeLineItem", "variant": "signature", "kind": 4096, @@ -7980,7 +8000,7 @@ }, "parameters": [ { - "id": 276, + "id": 277, "name": "cartId", "variant": "param", "kind": 32768, @@ -7999,7 +8019,7 @@ } }, { - "id": 277, + "id": 278, "name": "lineItemId", "variant": "param", "kind": 32768, @@ -8042,14 +8062,14 @@ ] }, { - "id": 253, + "id": 254, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 254, + "id": 255, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -8075,7 +8095,7 @@ }, "parameters": [ { - "id": 255, + "id": 256, "name": "cartId", "variant": "param", "kind": 32768, @@ -8094,7 +8114,7 @@ } }, { - "id": 256, + "id": 257, "name": "options", "variant": "param", "kind": 32768, @@ -8130,7 +8150,7 @@ "defaultValue": "{}" }, { - "id": 257, + "id": 258, "name": "totalsConfig", "variant": "param", "kind": 32768, @@ -8171,7 +8191,7 @@ ] }, { - "id": 258, + "id": 259, "name": "retrieveLegacy", "variant": "declaration", "kind": 2048, @@ -8180,7 +8200,7 @@ }, "signatures": [ { - "id": 259, + "id": 260, "name": "retrieveLegacy", "variant": "signature", "kind": 4096, @@ -8198,7 +8218,7 @@ }, "parameters": [ { - "id": 260, + "id": 261, "name": "cartId", "variant": "param", "kind": 32768, @@ -8209,7 +8229,7 @@ } }, { - "id": 261, + "id": 262, "name": "options", "variant": "param", "kind": 32768, @@ -8237,7 +8257,7 @@ "defaultValue": "{}" }, { - "id": 262, + "id": 263, "name": "totalsConfig", "variant": "param", "kind": 32768, @@ -8278,21 +8298,21 @@ ] }, { - "id": 263, + "id": 264, "name": "retrieveWithTotals", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 264, + "id": 265, "name": "retrieveWithTotals", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 265, + "id": 266, "name": "cartId", "variant": "param", "kind": 32768, @@ -8303,7 +8323,7 @@ } }, { - "id": 266, + "id": 267, "name": "options", "variant": "param", "kind": 32768, @@ -8331,7 +8351,7 @@ "defaultValue": "{}" }, { - "id": 267, + "id": 268, "name": "totalsConfig", "variant": "param", "kind": 32768, @@ -8387,14 +8407,14 @@ ] }, { - "id": 399, + "id": 400, "name": "setMetadata", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 400, + "id": 401, "name": "setMetadata", "variant": "signature", "kind": 4096, @@ -8420,7 +8440,7 @@ }, "parameters": [ { - "id": 401, + "id": 402, "name": "cartId", "variant": "param", "kind": 32768, @@ -8439,7 +8459,7 @@ } }, { - "id": 402, + "id": 403, "name": "key", "variant": "param", "kind": 32768, @@ -8458,7 +8478,7 @@ } }, { - "id": 403, + "id": 404, "name": "value", "variant": "param", "kind": 32768, @@ -8510,14 +8530,14 @@ ] }, { - "id": 362, + "id": 363, "name": "setPaymentSession", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 363, + "id": 364, "name": "setPaymentSession", "variant": "signature", "kind": 4096, @@ -8532,7 +8552,7 @@ }, "parameters": [ { - "id": 364, + "id": 365, "name": "cartId", "variant": "param", "kind": 32768, @@ -8551,7 +8571,7 @@ } }, { - "id": 365, + "id": 366, "name": "providerId", "variant": "param", "kind": 32768, @@ -8589,14 +8609,14 @@ ] }, { - "id": 366, + "id": 367, "name": "setPaymentSessions", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 367, + "id": 368, "name": "setPaymentSessions", "variant": "signature", "kind": 4096, @@ -8622,7 +8642,7 @@ }, "parameters": [ { - "id": 368, + "id": 369, "name": "cartOrCartId", "variant": "param", "kind": 32768, @@ -8674,7 +8694,7 @@ ] }, { - "id": 391, + "id": 392, "name": "setRegion_", "variant": "declaration", "kind": 2048, @@ -8683,7 +8703,7 @@ }, "signatures": [ { - "id": 392, + "id": 393, "name": "setRegion_", "variant": "signature", "kind": 4096, @@ -8709,7 +8729,7 @@ }, "parameters": [ { - "id": 393, + "id": 394, "name": "cart", "variant": "param", "kind": 32768, @@ -8733,7 +8753,7 @@ } }, { - "id": 394, + "id": 395, "name": "regionId", "variant": "param", "kind": 32768, @@ -8752,7 +8772,7 @@ } }, { - "id": 395, + "id": 396, "name": "countryCode", "variant": "param", "kind": 32768, @@ -8799,7 +8819,7 @@ ] }, { - "id": 440, + "id": 441, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -8808,14 +8828,14 @@ }, "signatures": [ { - "id": 441, + "id": 442, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 442, + "id": 443, "name": "err", "variant": "param", "kind": 32768, @@ -8845,14 +8865,14 @@ { "type": "reflection", "declaration": { - "id": 443, + "id": 444, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 444, + "id": 445, "name": "code", "variant": "declaration", "kind": 1024, @@ -8867,7 +8887,7 @@ { "title": "Properties", "children": [ - 444 + 445 ] } ] @@ -8895,7 +8915,7 @@ } }, { - "id": 417, + "id": 418, "name": "transformQueryForTotals_", "variant": "declaration", "kind": 2048, @@ -8904,14 +8924,14 @@ }, "signatures": [ { - "id": 418, + "id": 419, "name": "transformQueryForTotals_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 419, + "id": 420, "name": "config", "variant": "param", "kind": 32768, @@ -8964,14 +8984,14 @@ { "type": "reflection", "declaration": { - "id": 420, + "id": 421, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 421, + "id": 422, "name": "totalsToSelect", "variant": "declaration", "kind": 1024, @@ -8994,7 +9014,7 @@ { "title": "Properties", "children": [ - 421 + 422 ] } ] @@ -9006,21 +9026,21 @@ ] }, { - "id": 311, + "id": 312, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 312, + "id": 313, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 313, + "id": 314, "name": "cartOrId", "variant": "param", "kind": 32768, @@ -9045,7 +9065,7 @@ } }, { - "id": 314, + "id": 315, "name": "data", "variant": "param", "kind": 32768, @@ -9085,7 +9105,7 @@ ] }, { - "id": 326, + "id": 327, "name": "updateBillingAddress_", "variant": "declaration", "kind": 2048, @@ -9094,7 +9114,7 @@ }, "signatures": [ { - "id": 327, + "id": 328, "name": "updateBillingAddress_", "variant": "signature", "kind": 4096, @@ -9120,7 +9140,7 @@ }, "parameters": [ { - "id": 328, + "id": 329, "name": "cart", "variant": "param", "kind": 32768, @@ -9144,7 +9164,7 @@ } }, { - "id": 329, + "id": 330, "name": "addressOrId", "variant": "param", "kind": 32768, @@ -9197,7 +9217,7 @@ } }, { - "id": 330, + "id": 331, "name": "addrRepo", "variant": "param", "kind": 32768, @@ -9251,7 +9271,7 @@ ] }, { - "id": 319, + "id": 320, "name": "updateCustomerId_", "variant": "declaration", "kind": 2048, @@ -9260,7 +9280,7 @@ }, "signatures": [ { - "id": 320, + "id": 321, "name": "updateCustomerId_", "variant": "signature", "kind": 4096, @@ -9286,7 +9306,7 @@ }, "parameters": [ { - "id": 321, + "id": 322, "name": "cart", "variant": "param", "kind": 32768, @@ -9310,7 +9330,7 @@ } }, { - "id": 322, + "id": 323, "name": "customerId", "variant": "param", "kind": 32768, @@ -9348,14 +9368,14 @@ ] }, { - "id": 302, + "id": 303, "name": "updateLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 303, + "id": 304, "name": "updateLineItem", "variant": "signature", "kind": 4096, @@ -9381,7 +9401,7 @@ }, "parameters": [ { - "id": 304, + "id": 305, "name": "cartId", "variant": "param", "kind": 32768, @@ -9400,7 +9420,7 @@ } }, { - "id": 305, + "id": 306, "name": "lineItemId", "variant": "param", "kind": 32768, @@ -9419,7 +9439,7 @@ } }, { - "id": 306, + "id": 307, "name": "update", "variant": "param", "kind": 32768, @@ -9459,14 +9479,14 @@ ] }, { - "id": 352, + "id": 353, "name": "updatePaymentSession", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 353, + "id": 354, "name": "updatePaymentSession", "variant": "signature", "kind": 4096, @@ -9492,7 +9512,7 @@ }, "parameters": [ { - "id": 354, + "id": 355, "name": "cartId", "variant": "param", "kind": 32768, @@ -9511,7 +9531,7 @@ } }, { - "id": 355, + "id": 356, "name": "update", "variant": "param", "kind": 32768, @@ -9569,7 +9589,7 @@ ] }, { - "id": 331, + "id": 332, "name": "updateShippingAddress_", "variant": "declaration", "kind": 2048, @@ -9578,7 +9598,7 @@ }, "signatures": [ { - "id": 332, + "id": 333, "name": "updateShippingAddress_", "variant": "signature", "kind": 4096, @@ -9604,7 +9624,7 @@ }, "parameters": [ { - "id": 333, + "id": 334, "name": "cart", "variant": "param", "kind": 32768, @@ -9628,7 +9648,7 @@ } }, { - "id": 334, + "id": 335, "name": "addressOrId", "variant": "param", "kind": 32768, @@ -9681,7 +9701,7 @@ } }, { - "id": 335, + "id": 336, "name": "addrRepo", "variant": "param", "kind": 32768, @@ -9735,7 +9755,7 @@ ] }, { - "id": 386, + "id": 387, "name": "updateUnitPrices_", "variant": "declaration", "kind": 2048, @@ -9744,14 +9764,14 @@ }, "signatures": [ { - "id": 387, + "id": 388, "name": "updateUnitPrices_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 388, + "id": 389, "name": "cart", "variant": "param", "kind": 32768, @@ -9767,7 +9787,7 @@ } }, { - "id": 389, + "id": 390, "name": "regionId", "variant": "param", "kind": 32768, @@ -9780,7 +9800,7 @@ } }, { - "id": 390, + "id": 391, "name": "customer_id", "variant": "param", "kind": 32768, @@ -9812,7 +9832,7 @@ ] }, { - "id": 282, + "id": 283, "name": "validateLineItem", "variant": "declaration", "kind": 2048, @@ -9821,7 +9841,7 @@ }, "signatures": [ { - "id": 283, + "id": 284, "name": "validateLineItem", "variant": "signature", "kind": 4096, @@ -9847,7 +9867,7 @@ }, "parameters": [ { - "id": 284, + "id": 285, "name": "sales_channel_id", "variant": "param", "kind": 32768, @@ -9863,14 +9883,14 @@ "type": { "type": "reflection", "declaration": { - "id": 285, + "id": 286, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 286, + "id": 287, "name": "sales_channel_id", "variant": "declaration", "kind": 1024, @@ -9894,7 +9914,7 @@ { "title": "Properties", "children": [ - 286 + 287 ] } ] @@ -9902,7 +9922,7 @@ } }, { - "id": 287, + "id": 288, "name": "lineItem", "variant": "param", "kind": 32768, @@ -9945,7 +9965,7 @@ ] }, { - "id": 278, + "id": 279, "name": "validateLineItemShipping_", "variant": "declaration", "kind": 2048, @@ -9954,7 +9974,7 @@ }, "signatures": [ { - "id": 279, + "id": 280, "name": "validateLineItemShipping_", "variant": "signature", "kind": 4096, @@ -9980,7 +10000,7 @@ }, "parameters": [ { - "id": 280, + "id": 281, "name": "shippingMethods", "variant": "param", "kind": 32768, @@ -10007,7 +10027,7 @@ } }, { - "id": 281, + "id": 282, "name": "lineItemShippingProfiledId", "variant": "param", "kind": 32768, @@ -10026,21 +10046,21 @@ ] }, { - "id": 437, + "id": 438, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 438, + "id": 439, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 439, + "id": 440, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -10060,7 +10080,7 @@ ], "type": { "type": "reference", - "target": 198, + "target": 199, "name": "CartService", "package": "@medusajs/medusa" }, @@ -10082,101 +10102,101 @@ { "title": "Constructors", "children": [ - 204 + 205 ] }, { "title": "Properties", "children": [ - 435, - 434, 436, - 218, - 208, + 435, + 437, + 219, + 209, + 244, + 236, + 239, + 228, + 247, + 240, + 246, + 221, + 234, + 431, 243, 235, - 238, - 227, - 246, - 239, - 245, 220, - 233, - 430, - 242, - 234, - 219, - 244, + 245, + 249, + 230, 248, 229, - 247, - 228, + 233, 232, - 231, - 207, - 236, + 208, 237, - 230, - 240, + 238, + 231, 241, - 431, - 199 + 242, + 432, + 200 ] }, { "title": "Accessors", "children": [ - 432 + 433 ] }, { "title": "Methods", "children": [ - 288, - 295, - 377, - 307, - 340, - 344, - 336, - 445, - 356, - 268, - 323, - 404, - 410, - 422, - 396, - 369, - 407, - 382, - 427, - 271, - 249, - 315, - 414, - 373, - 348, - 274, - 253, - 258, - 263, - 399, - 362, - 366, - 391, - 440, - 417, - 311, - 326, - 319, - 302, - 352, - 331, - 386, - 282, - 278, - 437 + 289, + 296, + 378, + 308, + 341, + 345, + 337, + 446, + 357, + 269, + 324, + 405, + 411, + 423, + 397, + 370, + 408, + 383, + 428, + 272, + 250, + 316, + 415, + 374, + 349, + 275, + 254, + 259, + 264, + 400, + 363, + 367, + 392, + 441, + 418, + 312, + 327, + 320, + 303, + 353, + 332, + 387, + 283, + 279, + 438 ] } ], @@ -10193,41 +10213,116 @@ ] }, { - "id": 577, + "id": 578, "name": "ClaimItemService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 583, + "id": 584, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 584, + "id": 585, "name": "new ClaimItemService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 585, + "id": 586, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "Object" + "type": "reflection", + "declaration": { + "id": 587, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 590, + "name": "claimImageRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 588, + "name": "claimItemRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 589, + "name": "claimTagRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 592, + "name": "eventBusService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 591, + "name": "lineItemService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 590, + 588, + 589, + 592, + 591 + ] + } + ] + } } } ], "type": { "type": "reference", - "target": 577, + "target": 578, "name": "ClaimItemService", "package": "@medusajs/medusa" }, @@ -10245,7 +10340,7 @@ } }, { - "id": 611, + "id": 618, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -10280,7 +10375,7 @@ } }, { - "id": 610, + "id": 617, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -10299,7 +10394,7 @@ } }, { - "id": 612, + "id": 619, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -10334,7 +10429,7 @@ } }, { - "id": 590, + "id": 597, "name": "claimImageRepository_", "variant": "declaration", "kind": 1024, @@ -10364,7 +10459,7 @@ } }, { - "id": 588, + "id": 595, "name": "claimItemRepository_", "variant": "declaration", "kind": 1024, @@ -10394,7 +10489,7 @@ } }, { - "id": 589, + "id": 596, "name": "claimTagRepository_", "variant": "declaration", "kind": 1024, @@ -10424,7 +10519,7 @@ } }, { - "id": 587, + "id": 594, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -10434,13 +10529,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 586, + "id": 593, "name": "lineItemService_", "variant": "declaration", "kind": 1024, @@ -10450,13 +10545,13 @@ }, "type": { "type": "reference", - "target": 1713, + "target": 1767, "name": "LineItemService", "package": "@medusajs/medusa" } }, { - "id": 606, + "id": 613, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -10479,7 +10574,7 @@ } }, { - "id": 607, + "id": 614, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -10511,7 +10606,7 @@ } }, { - "id": 578, + "id": 579, "name": "Events", "variant": "declaration", "kind": 1024, @@ -10521,14 +10616,14 @@ "type": { "type": "reflection", "declaration": { - "id": 579, + "id": 580, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 582, + "id": 583, "name": "CANCELED", "variant": "declaration", "kind": 1024, @@ -10540,7 +10635,7 @@ "defaultValue": "\"claim_item.canceled\"" }, { - "id": 580, + "id": 581, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -10552,7 +10647,7 @@ "defaultValue": "\"claim_item.created\"" }, { - "id": 581, + "id": 582, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -10568,9 +10663,9 @@ { "title": "Properties", "children": [ - 582, - 580, - 581 + 583, + 581, + 582 ] } ] @@ -10579,7 +10674,7 @@ "defaultValue": "..." }, { - "id": 608, + "id": 615, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -10587,7 +10682,7 @@ "isProtected": true }, "getSignature": { - "id": 609, + "id": 616, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -10614,7 +10709,7 @@ } }, { - "id": 621, + "id": 628, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -10623,7 +10718,7 @@ }, "signatures": [ { - "id": 622, + "id": 629, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -10649,14 +10744,14 @@ }, "typeParameter": [ { - "id": 623, + "id": 630, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 624, + "id": 631, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -10665,7 +10760,7 @@ ], "parameters": [ { - "id": 625, + "id": 632, "name": "work", "variant": "param", "kind": 32768, @@ -10681,21 +10776,21 @@ "type": { "type": "reflection", "declaration": { - "id": 626, + "id": 633, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 627, + "id": 634, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 628, + "id": 635, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -10734,7 +10829,7 @@ } }, { - "id": 629, + "id": 636, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -10764,21 +10859,21 @@ { "type": "reflection", "declaration": { - "id": 630, + "id": 637, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 631, + "id": 638, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 632, + "id": 639, "name": "error", "variant": "param", "kind": 32768, @@ -10825,7 +10920,7 @@ } }, { - "id": 633, + "id": 640, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -10843,21 +10938,21 @@ "type": { "type": "reflection", "declaration": { - "id": 634, + "id": 641, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 635, + "id": 642, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 636, + "id": 643, "name": "error", "variant": "param", "kind": 32768, @@ -10933,21 +11028,21 @@ } }, { - "id": 591, + "id": 598, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 592, + "id": 599, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 593, + "id": 600, "name": "data", "variant": "param", "kind": 32768, @@ -10987,14 +11082,14 @@ ] }, { - "id": 598, + "id": 605, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 599, + "id": 606, "name": "list", "variant": "signature", "kind": 4096, @@ -11015,7 +11110,7 @@ }, "parameters": [ { - "id": 600, + "id": 607, "name": "selector", "variant": "param", "kind": 32768, @@ -11050,7 +11145,7 @@ } }, { - "id": 601, + "id": 608, "name": "config", "variant": "param", "kind": 32768, @@ -11113,14 +11208,14 @@ ] }, { - "id": 602, + "id": 609, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 603, + "id": 610, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -11146,7 +11241,7 @@ }, "parameters": [ { - "id": 604, + "id": 611, "name": "claimItemId", "variant": "param", "kind": 32768, @@ -11165,7 +11260,7 @@ } }, { - "id": 605, + "id": 612, "name": "config", "variant": "param", "kind": 32768, @@ -11225,7 +11320,7 @@ ] }, { - "id": 616, + "id": 623, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -11234,14 +11329,14 @@ }, "signatures": [ { - "id": 617, + "id": 624, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 618, + "id": 625, "name": "err", "variant": "param", "kind": 32768, @@ -11271,14 +11366,14 @@ { "type": "reflection", "declaration": { - "id": 619, + "id": 626, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 620, + "id": 627, "name": "code", "variant": "declaration", "kind": 1024, @@ -11293,7 +11388,7 @@ { "title": "Properties", "children": [ - 620 + 627 ] } ] @@ -11321,21 +11416,21 @@ } }, { - "id": 594, + "id": 601, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 595, + "id": 602, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 596, + "id": 603, "name": "id", "variant": "param", "kind": 32768, @@ -11346,7 +11441,7 @@ } }, { - "id": 597, + "id": 604, "name": "data", "variant": "param", "kind": 32768, @@ -11381,21 +11476,21 @@ ] }, { - "id": 613, + "id": 620, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 614, + "id": 621, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 615, + "id": 622, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -11415,7 +11510,7 @@ ], "type": { "type": "reference", - "target": 577, + "target": 578, "name": "ClaimItemService", "package": "@medusajs/medusa" }, @@ -11437,41 +11532,41 @@ { "title": "Constructors", "children": [ - 583 + 584 ] }, { "title": "Properties", "children": [ - 611, - 610, - 612, - 590, - 588, - 589, - 587, - 586, - 606, - 607, - 578 + 618, + 617, + 619, + 597, + 595, + 596, + 594, + 593, + 613, + 614, + 579 ] }, { "title": "Accessors", "children": [ - 608 + 615 ] }, { "title": "Methods", "children": [ - 621, - 591, + 628, 598, - 602, - 616, - 594, - 613 + 605, + 609, + 623, + 601, + 620 ] } ], @@ -11488,28 +11583,28 @@ ] }, { - "id": 461, + "id": 462, "name": "ClaimService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 470, + "id": 471, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 471, + "id": 472, "name": "new ClaimService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 472, + "id": 473, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -11527,7 +11622,7 @@ ], "type": { "type": "reference", - "target": 461, + "target": 462, "name": "default", "package": "@medusajs/medusa" }, @@ -11545,7 +11640,7 @@ } }, { - "id": 551, + "id": 552, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -11580,7 +11675,7 @@ } }, { - "id": 550, + "id": 551, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -11599,7 +11694,7 @@ } }, { - "id": 552, + "id": 553, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -11634,7 +11729,7 @@ } }, { - "id": 473, + "id": 474, "name": "addressRepository_", "variant": "declaration", "kind": 1024, @@ -11664,7 +11759,7 @@ } }, { - "id": 483, + "id": 484, "name": "claimItemService_", "variant": "declaration", "kind": 1024, @@ -11674,13 +11769,13 @@ }, "type": { "type": "reference", - "target": 577, + "target": 578, "name": "ClaimItemService", "package": "@medusajs/medusa" } }, { - "id": 474, + "id": 475, "name": "claimRepository_", "variant": "declaration", "kind": 1024, @@ -11710,7 +11805,7 @@ } }, { - "id": 484, + "id": 485, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -11720,13 +11815,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 485, + "id": 486, "name": "fulfillmentProviderService_", "variant": "declaration", "kind": 1024, @@ -11736,13 +11831,13 @@ }, "type": { "type": "reference", - "target": 1484, + "target": 1538, "name": "FulfillmentProviderService", "package": "@medusajs/medusa" } }, { - "id": 486, + "id": 487, "name": "fulfillmentService_", "variant": "declaration", "kind": 1024, @@ -11752,13 +11847,13 @@ }, "type": { "type": "reference", - "target": 1404, + "target": 1458, "name": "FulfillmentService", "package": "@medusajs/medusa" } }, { - "id": 476, + "id": 477, "name": "lineItemRepository_", "variant": "declaration", "kind": 1024, @@ -11792,21 +11887,21 @@ { "type": "reflection", "declaration": { - "id": 477, + "id": 478, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 478, + "id": 479, "name": "findByReturn", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 479, + "id": 480, "name": "findByReturn", "variant": "signature", "kind": 4096, @@ -11848,7 +11943,7 @@ }, "parameters": [ { - "id": 480, + "id": 481, "name": "returnId", "variant": "param", "kind": 32768, @@ -11891,14 +11986,14 @@ { "type": "reflection", "declaration": { - "id": 481, + "id": 482, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 482, + "id": 483, "name": "return_item", "variant": "declaration", "kind": 1024, @@ -11918,7 +12013,7 @@ { "title": "Properties", "children": [ - 482 + 483 ] } ] @@ -11939,7 +12034,7 @@ { "title": "Methods", "children": [ - 478 + 479 ] } ] @@ -11949,7 +12044,7 @@ } }, { - "id": 487, + "id": 488, "name": "lineItemService_", "variant": "declaration", "kind": 1024, @@ -11959,13 +12054,13 @@ }, "type": { "type": "reference", - "target": 1713, + "target": 1767, "name": "LineItemService", "package": "@medusajs/medusa" } }, { - "id": 546, + "id": 547, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -11988,7 +12083,7 @@ } }, { - "id": 488, + "id": 489, "name": "paymentProviderService_", "variant": "declaration", "kind": 1024, @@ -11998,13 +12093,13 @@ }, "type": { "type": "reference", - "target": 2919, + "target": 2973, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 494, + "id": 495, "name": "productVariantInventoryService_", "variant": "declaration", "kind": 1024, @@ -12014,13 +12109,13 @@ }, "type": { "type": "reference", - "target": 4409, + "target": 4497, "name": "ProductVariantInventoryService", "package": "@medusajs/medusa" } }, { - "id": 489, + "id": 490, "name": "regionService_", "variant": "declaration", "kind": 1024, @@ -12030,13 +12125,13 @@ }, "type": { "type": "reference", - "target": 4533, + "target": 4621, "name": "RegionService", "package": "@medusajs/medusa" } }, { - "id": 490, + "id": 491, "name": "returnService_", "variant": "declaration", "kind": 1024, @@ -12046,13 +12141,13 @@ }, "type": { "type": "reference", - "target": 4652, + "target": 4740, "name": "ReturnService", "package": "@medusajs/medusa" } }, { - "id": 475, + "id": 476, "name": "shippingMethodRepository_", "variant": "declaration", "kind": 1024, @@ -12082,7 +12177,7 @@ } }, { - "id": 491, + "id": 492, "name": "shippingOptionService_", "variant": "declaration", "kind": 1024, @@ -12092,13 +12187,13 @@ }, "type": { "type": "reference", - "target": 5056, + "target": 5163, "name": "ShippingOptionService", "package": "@medusajs/medusa" } }, { - "id": 492, + "id": 493, "name": "taxProviderService_", "variant": "declaration", "kind": 1024, @@ -12108,13 +12203,13 @@ }, "type": { "type": "reference", - "target": 5702, + "target": 5814, "name": "TaxProviderService", "package": "@medusajs/medusa" } }, { - "id": 493, + "id": 494, "name": "totalsService_", "variant": "declaration", "kind": 1024, @@ -12124,13 +12219,13 @@ }, "type": { "type": "reference", - "target": 5964, + "target": 6081, "name": "TotalsService", "package": "@medusajs/medusa" } }, { - "id": 547, + "id": 548, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -12162,7 +12257,7 @@ } }, { - "id": 462, + "id": 463, "name": "Events", "variant": "declaration", "kind": 1024, @@ -12173,14 +12268,14 @@ "type": { "type": "reflection", "declaration": { - "id": 463, + "id": 464, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 466, + "id": 467, "name": "CANCELED", "variant": "declaration", "kind": 1024, @@ -12192,7 +12287,7 @@ "defaultValue": "\"claim.canceled\"" }, { - "id": 464, + "id": 465, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -12204,7 +12299,7 @@ "defaultValue": "\"claim.created\"" }, { - "id": 467, + "id": 468, "name": "FULFILLMENT_CREATED", "variant": "declaration", "kind": 1024, @@ -12216,7 +12311,7 @@ "defaultValue": "\"claim.fulfillment_created\"" }, { - "id": 469, + "id": 470, "name": "REFUND_PROCESSED", "variant": "declaration", "kind": 1024, @@ -12228,7 +12323,7 @@ "defaultValue": "\"claim.refund_processed\"" }, { - "id": 468, + "id": 469, "name": "SHIPMENT_CREATED", "variant": "declaration", "kind": 1024, @@ -12240,7 +12335,7 @@ "defaultValue": "\"claim.shipment_created\"" }, { - "id": 465, + "id": 466, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -12256,12 +12351,12 @@ { "title": "Properties", "children": [ - 466, - 464, 467, - 469, + 465, 468, - 465 + 470, + 469, + 466 ] } ] @@ -12270,7 +12365,7 @@ "defaultValue": "..." }, { - "id": 548, + "id": 549, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -12278,7 +12373,7 @@ "isProtected": true }, "getSignature": { - "id": 549, + "id": 550, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -12305,7 +12400,7 @@ } }, { - "id": 561, + "id": 562, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -12314,7 +12409,7 @@ }, "signatures": [ { - "id": 562, + "id": 563, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -12340,14 +12435,14 @@ }, "typeParameter": [ { - "id": 563, + "id": 564, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 564, + "id": 565, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -12356,7 +12451,7 @@ ], "parameters": [ { - "id": 565, + "id": 566, "name": "work", "variant": "param", "kind": 32768, @@ -12372,21 +12467,21 @@ "type": { "type": "reflection", "declaration": { - "id": 566, + "id": 567, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 567, + "id": 568, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 568, + "id": 569, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -12425,7 +12520,7 @@ } }, { - "id": 569, + "id": 570, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -12455,21 +12550,21 @@ { "type": "reflection", "declaration": { - "id": 570, + "id": 571, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 571, + "id": 572, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 572, + "id": 573, "name": "error", "variant": "param", "kind": 32768, @@ -12516,7 +12611,7 @@ } }, { - "id": 573, + "id": 574, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -12534,21 +12629,21 @@ "type": { "type": "reflection", "declaration": { - "id": 574, + "id": 575, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 575, + "id": 576, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 576, + "id": 577, "name": "error", "variant": "param", "kind": 32768, @@ -12624,21 +12719,21 @@ } }, { - "id": 535, + "id": 536, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 536, + "id": 537, "name": "cancel", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 537, + "id": 538, "name": "id", "variant": "param", "kind": 32768, @@ -12673,21 +12768,21 @@ ] }, { - "id": 517, + "id": 518, "name": "cancelFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 518, + "id": 519, "name": "cancelFulfillment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 519, + "id": 520, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -12722,14 +12817,14 @@ ] }, { - "id": 506, + "id": 507, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 507, + "id": 508, "name": "create", "variant": "signature", "kind": 4096, @@ -12755,7 +12850,7 @@ }, "parameters": [ { - "id": 508, + "id": 509, "name": "data", "variant": "param", "kind": 32768, @@ -12803,14 +12898,14 @@ ] }, { - "id": 509, + "id": 510, "name": "createFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 510, + "id": 511, "name": "createFulfillment", "variant": "signature", "kind": 4096, @@ -12831,7 +12926,7 @@ }, "parameters": [ { - "id": 511, + "id": 512, "name": "id", "variant": "param", "kind": 32768, @@ -12850,7 +12945,7 @@ } }, { - "id": 512, + "id": 513, "name": "config", "variant": "param", "kind": 32768, @@ -12866,14 +12961,14 @@ "type": { "type": "reflection", "declaration": { - "id": 513, + "id": 514, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 516, + "id": 517, "name": "location_id", "variant": "declaration", "kind": 1024, @@ -12886,7 +12981,7 @@ } }, { - "id": 514, + "id": 515, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -12922,7 +13017,7 @@ } }, { - "id": 515, + "id": 516, "name": "no_notification", "variant": "declaration", "kind": 1024, @@ -12947,9 +13042,9 @@ { "title": "Properties", "children": [ - 516, - 514, - 515 + 517, + 515, + 516 ] } ] @@ -12982,21 +13077,21 @@ ] }, { - "id": 523, + "id": 524, "name": "createShipment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 524, + "id": 525, "name": "createShipment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 525, + "id": 526, "name": "id", "variant": "param", "kind": 32768, @@ -13007,7 +13102,7 @@ } }, { - "id": 526, + "id": 527, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -13018,7 +13113,7 @@ } }, { - "id": 527, + "id": 528, "name": "trackingLinks", "variant": "param", "kind": 32768, @@ -13028,14 +13123,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 528, + "id": 529, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 529, + "id": 530, "name": "tracking_number", "variant": "declaration", "kind": 1024, @@ -13050,7 +13145,7 @@ { "title": "Properties", "children": [ - 529 + 530 ] } ] @@ -13060,7 +13155,7 @@ "defaultValue": "[]" }, { - "id": 530, + "id": 531, "name": "config", "variant": "param", "kind": 32768, @@ -13068,14 +13163,14 @@ "type": { "type": "reflection", "declaration": { - "id": 531, + "id": 532, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 532, + "id": 533, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -13083,7 +13178,7 @@ "type": { "type": "reflection", "declaration": { - "id": 533, + "id": 534, "name": "__type", "variant": "declaration", "kind": 65536, @@ -13093,7 +13188,7 @@ "defaultValue": "{}" }, { - "id": 534, + "id": 535, "name": "no_notification", "variant": "declaration", "kind": 1024, @@ -13109,8 +13204,8 @@ { "title": "Properties", "children": [ - 532, - 534 + 533, + 535 ] } ] @@ -13143,7 +13238,7 @@ ] }, { - "id": 502, + "id": 503, "name": "getRefundTotalForClaimLinesOnOrder", "variant": "declaration", "kind": 2048, @@ -13152,7 +13247,7 @@ }, "signatures": [ { - "id": 503, + "id": 504, "name": "getRefundTotalForClaimLinesOnOrder", "variant": "signature", "kind": 4096, @@ -13178,7 +13273,7 @@ }, "parameters": [ { - "id": 504, + "id": 505, "name": "order", "variant": "param", "kind": 32768, @@ -13202,7 +13297,7 @@ } }, { - "id": 505, + "id": 506, "name": "claimItems", "variant": "param", "kind": 32768, @@ -13248,14 +13343,14 @@ ] }, { - "id": 538, + "id": 539, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 539, + "id": 540, "name": "list", "variant": "signature", "kind": 4096, @@ -13276,7 +13371,7 @@ }, "parameters": [ { - "id": 540, + "id": 541, "name": "selector", "variant": "param", "kind": 32768, @@ -13295,7 +13390,7 @@ } }, { - "id": 541, + "id": 542, "name": "config", "variant": "param", "kind": 32768, @@ -13358,21 +13453,21 @@ ] }, { - "id": 520, + "id": 521, "name": "processRefund", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 521, + "id": 522, "name": "processRefund", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 522, + "id": 523, "name": "id", "variant": "param", "kind": 32768, @@ -13407,14 +13502,14 @@ ] }, { - "id": 542, + "id": 543, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 543, + "id": 544, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -13440,7 +13535,7 @@ }, "parameters": [ { - "id": 544, + "id": 545, "name": "claimId", "variant": "param", "kind": 32768, @@ -13459,7 +13554,7 @@ } }, { - "id": 545, + "id": 546, "name": "config", "variant": "param", "kind": 32768, @@ -13519,7 +13614,7 @@ ] }, { - "id": 556, + "id": 557, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -13528,14 +13623,14 @@ }, "signatures": [ { - "id": 557, + "id": 558, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 558, + "id": 559, "name": "err", "variant": "param", "kind": 32768, @@ -13565,14 +13660,14 @@ { "type": "reflection", "declaration": { - "id": 559, + "id": 560, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 560, + "id": 561, "name": "code", "variant": "declaration", "kind": 1024, @@ -13587,7 +13682,7 @@ { "title": "Properties", "children": [ - 560 + 561 ] } ] @@ -13615,21 +13710,21 @@ } }, { - "id": 495, + "id": 496, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 496, + "id": 497, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 497, + "id": 498, "name": "id", "variant": "param", "kind": 32768, @@ -13640,7 +13735,7 @@ } }, { - "id": 498, + "id": 499, "name": "data", "variant": "param", "kind": 32768, @@ -13680,7 +13775,7 @@ ] }, { - "id": 499, + "id": 500, "name": "validateCreateClaimInput", "variant": "declaration", "kind": 2048, @@ -13689,14 +13784,14 @@ }, "signatures": [ { - "id": 500, + "id": 501, "name": "validateCreateClaimInput", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 501, + "id": 502, "name": "data", "variant": "param", "kind": 32768, @@ -13731,21 +13826,21 @@ ] }, { - "id": 553, + "id": 554, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 554, + "id": 555, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 555, + "id": 556, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -13765,7 +13860,7 @@ ], "type": { "type": "reference", - "target": 461, + "target": 462, "name": "default", "package": "@medusajs/medusa" }, @@ -13787,59 +13882,59 @@ { "title": "Constructors", "children": [ - 470 + 471 ] }, { "title": "Properties", "children": [ - 551, - 550, 552, - 473, - 483, + 551, + 553, 474, 484, + 475, 485, 486, - 476, 487, - 546, + 477, 488, - 494, + 547, 489, + 495, 490, - 475, 491, + 476, 492, 493, - 547, - 462 + 494, + 548, + 463 ] }, { "title": "Accessors", "children": [ - 548 + 549 ] }, { "title": "Methods", "children": [ - 561, - 535, - 517, - 506, - 509, - 523, - 502, - 538, - 520, - 542, - 556, - 495, - 499, - 553 + 562, + 536, + 518, + 507, + 510, + 524, + 503, + 539, + 521, + 543, + 557, + 496, + 500, + 554 ] } ], @@ -13856,28 +13951,28 @@ ] }, { - "id": 637, + "id": 644, "name": "CurrencyService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 641, + "id": 648, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 642, + "id": 649, "name": "new CurrencyService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 643, + "id": 650, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -13895,7 +13990,7 @@ ], "type": { "type": "reference", - "target": 637, + "target": 644, "name": "default", "package": "@medusajs/medusa" }, @@ -13913,7 +14008,7 @@ } }, { - "id": 663, + "id": 670, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -13948,7 +14043,7 @@ } }, { - "id": 662, + "id": 669, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -13967,7 +14062,7 @@ } }, { - "id": 664, + "id": 671, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -14002,7 +14097,7 @@ } }, { - "id": 644, + "id": 651, "name": "currencyRepository_", "variant": "declaration", "kind": 1024, @@ -14032,7 +14127,7 @@ } }, { - "id": 645, + "id": 652, "name": "eventBusService_", "variant": "declaration", "kind": 1024, @@ -14042,13 +14137,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 646, + "id": 653, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -14067,7 +14162,7 @@ } }, { - "id": 658, + "id": 665, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -14090,7 +14185,7 @@ } }, { - "id": 659, + "id": 666, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -14122,7 +14217,7 @@ } }, { - "id": 638, + "id": 645, "name": "Events", "variant": "declaration", "kind": 1024, @@ -14133,14 +14228,14 @@ "type": { "type": "reflection", "declaration": { - "id": 639, + "id": 646, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 640, + "id": 647, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -14156,7 +14251,7 @@ { "title": "Properties", "children": [ - 640 + 647 ] } ] @@ -14165,7 +14260,7 @@ "defaultValue": "..." }, { - "id": 660, + "id": 667, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -14173,7 +14268,7 @@ "isProtected": true }, "getSignature": { - "id": 661, + "id": 668, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -14200,7 +14295,7 @@ } }, { - "id": 673, + "id": 680, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -14209,7 +14304,7 @@ }, "signatures": [ { - "id": 674, + "id": 681, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -14235,14 +14330,14 @@ }, "typeParameter": [ { - "id": 675, + "id": 682, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 676, + "id": 683, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -14251,7 +14346,7 @@ ], "parameters": [ { - "id": 677, + "id": 684, "name": "work", "variant": "param", "kind": 32768, @@ -14267,21 +14362,21 @@ "type": { "type": "reflection", "declaration": { - "id": 678, + "id": 685, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 679, + "id": 686, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 680, + "id": 687, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -14320,7 +14415,7 @@ } }, { - "id": 681, + "id": 688, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -14350,21 +14445,21 @@ { "type": "reflection", "declaration": { - "id": 682, + "id": 689, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 683, + "id": 690, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 684, + "id": 691, "name": "error", "variant": "param", "kind": 32768, @@ -14411,7 +14506,7 @@ } }, { - "id": 685, + "id": 692, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -14429,21 +14524,21 @@ "type": { "type": "reflection", "declaration": { - "id": 686, + "id": 693, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 687, + "id": 694, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 688, + "id": 695, "name": "error", "variant": "param", "kind": 32768, @@ -14519,14 +14614,14 @@ } }, { - "id": 650, + "id": 657, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 651, + "id": 658, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -14552,7 +14647,7 @@ }, "parameters": [ { - "id": 652, + "id": 659, "name": "selector", "variant": "param", "kind": 32768, @@ -14587,7 +14682,7 @@ } }, { - "id": 653, + "id": 660, "name": "config", "variant": "param", "kind": 32768, @@ -14659,14 +14754,14 @@ ] }, { - "id": 647, + "id": 654, "name": "retrieveByCode", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 648, + "id": 655, "name": "retrieveByCode", "variant": "signature", "kind": 4096, @@ -14692,7 +14787,7 @@ }, "parameters": [ { - "id": 649, + "id": 656, "name": "code", "variant": "param", "kind": 32768, @@ -14735,7 +14830,7 @@ ] }, { - "id": 668, + "id": 675, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -14744,14 +14839,14 @@ }, "signatures": [ { - "id": 669, + "id": 676, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 670, + "id": 677, "name": "err", "variant": "param", "kind": 32768, @@ -14781,14 +14876,14 @@ { "type": "reflection", "declaration": { - "id": 671, + "id": 678, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 672, + "id": 679, "name": "code", "variant": "declaration", "kind": 1024, @@ -14803,7 +14898,7 @@ { "title": "Properties", "children": [ - 672 + 679 ] } ] @@ -14831,14 +14926,14 @@ } }, { - "id": 654, + "id": 661, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 655, + "id": 662, "name": "update", "variant": "signature", "kind": 4096, @@ -14864,7 +14959,7 @@ }, "parameters": [ { - "id": 656, + "id": 663, "name": "code", "variant": "param", "kind": 32768, @@ -14883,7 +14978,7 @@ } }, { - "id": 657, + "id": 664, "name": "data", "variant": "param", "kind": 32768, @@ -14940,21 +15035,21 @@ ] }, { - "id": 665, + "id": 672, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 666, + "id": 673, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 667, + "id": 674, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -14974,7 +15069,7 @@ ], "type": { "type": "reference", - "target": 637, + "target": 644, "name": "default", "package": "@medusajs/medusa" }, @@ -14996,38 +15091,38 @@ { "title": "Constructors", "children": [ - 641 + 648 ] }, { "title": "Properties", "children": [ - 663, - 662, - 664, - 644, - 645, - 646, - 658, - 659, - 638 + 670, + 669, + 671, + 651, + 652, + 653, + 665, + 666, + 645 ] }, { "title": "Accessors", "children": [ - 660 + 667 ] }, { "title": "Methods", "children": [ - 673, - 650, - 647, - 668, + 680, + 657, 654, - 665 + 675, + 661, + 672 ] } ], @@ -15044,28 +15139,28 @@ ] }, { - "id": 689, + "id": 696, "name": "CustomShippingOptionService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 690, + "id": 697, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 691, + "id": 698, "name": "new CustomShippingOptionService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 692, + "id": 699, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -15083,7 +15178,7 @@ ], "type": { "type": "reference", - "target": 689, + "target": 696, "name": "CustomShippingOptionService", "package": "@medusajs/medusa" }, @@ -15101,7 +15196,7 @@ } }, { - "id": 712, + "id": 719, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -15136,7 +15231,7 @@ } }, { - "id": 711, + "id": 718, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -15155,7 +15250,7 @@ } }, { - "id": 713, + "id": 720, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -15190,7 +15285,7 @@ } }, { - "id": 693, + "id": 700, "name": "customShippingOptionRepository_", "variant": "declaration", "kind": 1024, @@ -15219,7 +15314,7 @@ } }, { - "id": 707, + "id": 714, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -15242,7 +15337,7 @@ } }, { - "id": 708, + "id": 715, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -15274,7 +15369,7 @@ } }, { - "id": 709, + "id": 716, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -15282,7 +15377,7 @@ "isProtected": true }, "getSignature": { - "id": 710, + "id": 717, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -15309,7 +15404,7 @@ } }, { - "id": 722, + "id": 729, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -15318,7 +15413,7 @@ }, "signatures": [ { - "id": 723, + "id": 730, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -15344,14 +15439,14 @@ }, "typeParameter": [ { - "id": 724, + "id": 731, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 725, + "id": 732, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -15360,7 +15455,7 @@ ], "parameters": [ { - "id": 726, + "id": 733, "name": "work", "variant": "param", "kind": 32768, @@ -15376,21 +15471,21 @@ "type": { "type": "reflection", "declaration": { - "id": 727, + "id": 734, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 728, + "id": 735, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 729, + "id": 736, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -15429,7 +15524,7 @@ } }, { - "id": 730, + "id": 737, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -15459,21 +15554,21 @@ { "type": "reflection", "declaration": { - "id": 731, + "id": 738, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 732, + "id": 739, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 733, + "id": 740, "name": "error", "variant": "param", "kind": 32768, @@ -15520,7 +15615,7 @@ } }, { - "id": 734, + "id": 741, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -15538,21 +15633,21 @@ "type": { "type": "reflection", "declaration": { - "id": 735, + "id": 742, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 736, + "id": 743, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 737, + "id": 744, "name": "error", "variant": "param", "kind": 32768, @@ -15628,14 +15723,14 @@ } }, { - "id": 702, + "id": 709, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 703, + "id": 710, "name": "create", "variant": "signature", "kind": 4096, @@ -15661,7 +15756,7 @@ }, "typeParameter": [ { - "id": 704, + "id": 711, "name": "T", "variant": "typeParam", "kind": 131072, @@ -15694,7 +15789,7 @@ } }, { - "id": 705, + "id": 712, "name": "TResult", "variant": "typeParam", "kind": 131072, @@ -15745,7 +15840,7 @@ ], "parameters": [ { - "id": 706, + "id": 713, "name": "data", "variant": "param", "kind": 32768, @@ -15787,14 +15882,14 @@ ] }, { - "id": 698, + "id": 705, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 699, + "id": 706, "name": "list", "variant": "signature", "kind": 4096, @@ -15820,7 +15915,7 @@ }, "parameters": [ { - "id": 700, + "id": 707, "name": "selector", "variant": "param", "kind": 32768, @@ -15855,7 +15950,7 @@ } }, { - "id": 701, + "id": 708, "name": "config", "variant": "param", "kind": 32768, @@ -15918,14 +16013,14 @@ ] }, { - "id": 694, + "id": 701, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 695, + "id": 702, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -15951,7 +16046,7 @@ }, "parameters": [ { - "id": 696, + "id": 703, "name": "id", "variant": "param", "kind": 32768, @@ -15970,7 +16065,7 @@ } }, { - "id": 697, + "id": 704, "name": "config", "variant": "param", "kind": 32768, @@ -16030,7 +16125,7 @@ ] }, { - "id": 717, + "id": 724, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -16039,14 +16134,14 @@ }, "signatures": [ { - "id": 718, + "id": 725, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 719, + "id": 726, "name": "err", "variant": "param", "kind": 32768, @@ -16076,14 +16171,14 @@ { "type": "reflection", "declaration": { - "id": 720, + "id": 727, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 721, + "id": 728, "name": "code", "variant": "declaration", "kind": 1024, @@ -16098,7 +16193,7 @@ { "title": "Properties", "children": [ - 721 + 728 ] } ] @@ -16126,21 +16221,21 @@ } }, { - "id": 714, + "id": 721, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 715, + "id": 722, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 716, + "id": 723, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -16160,7 +16255,7 @@ ], "type": { "type": "reference", - "target": 689, + "target": 696, "name": "CustomShippingOptionService", "package": "@medusajs/medusa" }, @@ -16182,35 +16277,35 @@ { "title": "Constructors", "children": [ - 690 + 697 ] }, { "title": "Properties", "children": [ - 712, - 711, - 713, - 693, - 707, - 708 + 719, + 718, + 720, + 700, + 714, + 715 ] }, { "title": "Accessors", "children": [ - 709 + 716 ] }, { "title": "Methods", "children": [ - 722, - 702, - 698, - 694, - 717, - 714 + 729, + 709, + 705, + 701, + 724, + 721 ] } ], @@ -16227,28 +16322,28 @@ ] }, { - "id": 863, + "id": 893, "name": "CustomerGroupService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 864, + "id": 894, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 865, + "id": 895, "name": "new CustomerGroupService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 866, + "id": 896, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -16266,7 +16361,7 @@ ], "type": { "type": "reference", - "target": 863, + "target": 893, "name": "CustomerGroupService", "package": "@medusajs/medusa" }, @@ -16284,7 +16379,7 @@ } }, { - "id": 929, + "id": 959, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -16319,7 +16414,7 @@ } }, { - "id": 928, + "id": 958, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -16338,7 +16433,7 @@ } }, { - "id": 930, + "id": 960, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -16373,7 +16468,7 @@ } }, { - "id": 867, + "id": 897, "name": "customerGroupRepository_", "variant": "declaration", "kind": 1024, @@ -16407,28 +16502,28 @@ { "type": "reflection", "declaration": { - "id": 868, + "id": 898, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 869, + "id": 899, "name": "addCustomers", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 870, + "id": 900, "name": "addCustomers", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 871, + "id": 901, "name": "groupId", "variant": "param", "kind": 32768, @@ -16439,7 +16534,7 @@ } }, { - "id": 872, + "id": 902, "name": "customerIds", "variant": "param", "kind": 32768, @@ -16477,21 +16572,21 @@ ] }, { - "id": 877, + "id": 907, "name": "findWithRelationsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 878, + "id": 908, "name": "findWithRelationsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 879, + "id": 909, "name": "relations", "variant": "param", "kind": 32768, @@ -16519,7 +16614,7 @@ "defaultValue": "{}" }, { - "id": 880, + "id": 910, "name": "idsOrOptionsWithoutRelations", "variant": "param", "kind": 32768, @@ -16584,21 +16679,21 @@ ] }, { - "id": 873, + "id": 903, "name": "removeCustomers", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 874, + "id": 904, "name": "removeCustomers", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 875, + "id": 905, "name": "groupId", "variant": "param", "kind": 32768, @@ -16609,7 +16704,7 @@ } }, { - "id": 876, + "id": 906, "name": "customerIds", "variant": "param", "kind": 32768, @@ -16651,9 +16746,9 @@ { "title": "Methods", "children": [ - 869, - 877, - 873 + 899, + 907, + 903 ] } ] @@ -16663,7 +16758,7 @@ } }, { - "id": 881, + "id": 911, "name": "customerService_", "variant": "declaration", "kind": 1024, @@ -16673,13 +16768,13 @@ }, "type": { "type": "reference", - "target": 738, + "target": 745, "name": "CustomerService", "package": "@medusajs/medusa" } }, { - "id": 924, + "id": 954, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -16702,7 +16797,7 @@ } }, { - "id": 925, + "id": 955, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -16734,7 +16829,7 @@ } }, { - "id": 926, + "id": 956, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -16742,7 +16837,7 @@ "isProtected": true }, "getSignature": { - "id": 927, + "id": 957, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -16769,14 +16864,14 @@ } }, { - "id": 890, + "id": 920, "name": "addCustomers", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 891, + "id": 921, "name": "addCustomers", "variant": "signature", "kind": 4096, @@ -16802,7 +16897,7 @@ }, "parameters": [ { - "id": 892, + "id": 922, "name": "id", "variant": "param", "kind": 32768, @@ -16821,7 +16916,7 @@ } }, { - "id": 893, + "id": 923, "name": "customerIds", "variant": "param", "kind": 32768, @@ -16876,7 +16971,7 @@ ] }, { - "id": 939, + "id": 969, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -16885,7 +16980,7 @@ }, "signatures": [ { - "id": 940, + "id": 970, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -16911,14 +17006,14 @@ }, "typeParameter": [ { - "id": 941, + "id": 971, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 942, + "id": 972, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -16927,7 +17022,7 @@ ], "parameters": [ { - "id": 943, + "id": 973, "name": "work", "variant": "param", "kind": 32768, @@ -16943,21 +17038,21 @@ "type": { "type": "reflection", "declaration": { - "id": 944, + "id": 974, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 945, + "id": 975, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 946, + "id": 976, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -16996,7 +17091,7 @@ } }, { - "id": 947, + "id": 977, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -17026,21 +17121,21 @@ { "type": "reflection", "declaration": { - "id": 948, + "id": 978, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 949, + "id": 979, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 950, + "id": 980, "name": "error", "variant": "param", "kind": 32768, @@ -17087,7 +17182,7 @@ } }, { - "id": 951, + "id": 981, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -17105,21 +17200,21 @@ "type": { "type": "reflection", "declaration": { - "id": 952, + "id": 982, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 953, + "id": 983, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 954, + "id": 984, "name": "error", "variant": "param", "kind": 32768, @@ -17195,14 +17290,14 @@ } }, { - "id": 887, + "id": 917, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 888, + "id": 918, "name": "create", "variant": "signature", "kind": 4096, @@ -17228,7 +17323,7 @@ }, "parameters": [ { - "id": 889, + "id": 919, "name": "group", "variant": "param", "kind": 32768, @@ -17287,14 +17382,14 @@ ] }, { - "id": 898, + "id": 928, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 899, + "id": 929, "name": "delete", "variant": "signature", "kind": 4096, @@ -17320,7 +17415,7 @@ }, "parameters": [ { - "id": 900, + "id": 930, "name": "groupId", "variant": "param", "kind": 32768, @@ -17358,7 +17453,7 @@ ] }, { - "id": 919, + "id": 949, "name": "handleCreationFail", "variant": "declaration", "kind": 2048, @@ -17367,14 +17462,14 @@ }, "signatures": [ { - "id": 920, + "id": 950, "name": "handleCreationFail", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 921, + "id": 951, "name": "id", "variant": "param", "kind": 32768, @@ -17385,7 +17480,7 @@ } }, { - "id": 922, + "id": 952, "name": "ids", "variant": "param", "kind": 32768, @@ -17399,7 +17494,7 @@ } }, { - "id": 923, + "id": 953, "name": "error", "variant": "param", "kind": 32768, @@ -17429,14 +17524,14 @@ ] }, { - "id": 901, + "id": 931, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 902, + "id": 932, "name": "list", "variant": "signature", "kind": 4096, @@ -17462,7 +17557,7 @@ }, "parameters": [ { - "id": 903, + "id": 933, "name": "selector", "variant": "param", "kind": 32768, @@ -17476,81 +17571,56 @@ ] }, "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "Selector" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer-group.ts", - "qualifiedName": "CustomerGroup" - }, - "name": "CustomerGroup", - "package": "@medusajs/medusa" + "type": "reflection", + "declaration": { + "id": 934, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 936, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" } - ], - "name": "Selector", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 904, - "name": "__type", + }, + { + "id": 935, + "name": "q", "variant": "declaration", - "kind": 65536, - "flags": {}, + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", "children": [ - { - "id": 906, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 905, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 906, - 905 - ] - } + 936, + 935 ] } - } - ] + ] + } }, "defaultValue": "{}" }, { - "id": 907, + "id": 937, "name": "config", "variant": "param", "kind": 32768, @@ -17612,14 +17682,14 @@ ] }, { - "id": 908, + "id": 938, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 909, + "id": 939, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -17645,7 +17715,7 @@ }, "parameters": [ { - "id": 910, + "id": 940, "name": "selector", "variant": "param", "kind": 32768, @@ -17659,81 +17729,56 @@ ] }, "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "Selector" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer-group.ts", - "qualifiedName": "CustomerGroup" - }, - "name": "CustomerGroup", - "package": "@medusajs/medusa" + "type": "reflection", + "declaration": { + "id": 941, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 943, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" } - ], - "name": "Selector", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 911, - "name": "__type", + }, + { + "id": 942, + "name": "q", "variant": "declaration", - "kind": 65536, - "flags": {}, + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", "children": [ - { - "id": 913, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 912, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 913, - 912 - ] - } + 943, + 942 ] } - } - ] + ] + } }, "defaultValue": "{}" }, { - "id": 914, + "id": 944, "name": "config", "variant": "param", "kind": 32768, @@ -17804,14 +17849,14 @@ ] }, { - "id": 915, + "id": 945, "name": "removeCustomer", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 916, + "id": 946, "name": "removeCustomer", "variant": "signature", "kind": 4096, @@ -17837,7 +17882,7 @@ }, "parameters": [ { - "id": 917, + "id": 947, "name": "id", "variant": "param", "kind": 32768, @@ -17856,7 +17901,7 @@ } }, { - "id": 918, + "id": 948, "name": "customerIds", "variant": "param", "kind": 32768, @@ -17911,21 +17956,21 @@ ] }, { - "id": 882, + "id": 912, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 883, + "id": 913, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 884, + "id": 914, "name": "customerGroupId", "variant": "param", "kind": 32768, @@ -17936,7 +17981,7 @@ } }, { - "id": 885, + "id": 915, "name": "config", "variant": "param", "kind": 32768, @@ -17944,7 +17989,7 @@ "type": { "type": "reflection", "declaration": { - "id": 886, + "id": 916, "name": "__type", "variant": "declaration", "kind": 65536, @@ -17978,7 +18023,7 @@ ] }, { - "id": 934, + "id": 964, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -17987,14 +18032,14 @@ }, "signatures": [ { - "id": 935, + "id": 965, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 936, + "id": 966, "name": "err", "variant": "param", "kind": 32768, @@ -18024,14 +18069,14 @@ { "type": "reflection", "declaration": { - "id": 937, + "id": 967, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 938, + "id": 968, "name": "code", "variant": "declaration", "kind": 1024, @@ -18046,7 +18091,7 @@ { "title": "Properties", "children": [ - 938 + 968 ] } ] @@ -18074,14 +18119,14 @@ } }, { - "id": 894, + "id": 924, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 895, + "id": 925, "name": "update", "variant": "signature", "kind": 4096, @@ -18107,7 +18152,7 @@ }, "parameters": [ { - "id": 896, + "id": 926, "name": "customerGroupId", "variant": "param", "kind": 32768, @@ -18126,7 +18171,7 @@ } }, { - "id": 897, + "id": 927, "name": "update", "variant": "param", "kind": 32768, @@ -18174,21 +18219,21 @@ ] }, { - "id": 931, + "id": 961, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 932, + "id": 962, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 933, + "id": 963, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -18208,7 +18253,7 @@ ], "type": { "type": "reference", - "target": 863, + "target": 893, "name": "CustomerGroupService", "package": "@medusajs/medusa" }, @@ -18230,42 +18275,42 @@ { "title": "Constructors", "children": [ - 864 + 894 ] }, { "title": "Properties", "children": [ - 929, - 928, - 930, - 867, - 881, - 924, - 925 + 959, + 958, + 960, + 897, + 911, + 954, + 955 ] }, { "title": "Accessors", "children": [ - 926 + 956 ] }, { "title": "Methods", "children": [ - 890, - 939, - 887, - 898, - 919, - 901, - 908, - 915, - 882, - 934, - 894, - 931 + 920, + 969, + 917, + 928, + 949, + 931, + 938, + 945, + 912, + 964, + 924, + 961 ] } ], @@ -18282,7 +18327,7 @@ ] }, { - "id": 738, + "id": 745, "name": "CustomerService", "variant": "declaration", "kind": 128, @@ -18297,21 +18342,21 @@ }, "children": [ { - "id": 744, + "id": 751, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 745, + "id": 752, "name": "new CustomerService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 746, + "id": 753, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -18329,7 +18374,7 @@ ], "type": { "type": "reference", - "target": 738, + "target": 745, "name": "CustomerService", "package": "@medusajs/medusa" }, @@ -18347,7 +18392,7 @@ } }, { - "id": 837, + "id": 867, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -18382,7 +18427,7 @@ } }, { - "id": 836, + "id": 866, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -18401,7 +18446,7 @@ } }, { - "id": 838, + "id": 868, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -18436,7 +18481,7 @@ } }, { - "id": 753, + "id": 781, "name": "addressRepository_", "variant": "declaration", "kind": 1024, @@ -18466,7 +18511,7 @@ } }, { - "id": 747, + "id": 754, "name": "customerRepository_", "variant": "declaration", "kind": 1024, @@ -18500,39 +18545,1060 @@ { "type": "reflection", "declaration": { - "id": 748, + "id": 755, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 749, + "id": 756, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 750, + "id": 757, "name": "listAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 751, + "id": 758, "name": "query", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "Object" + "type": "reflection", + "declaration": { + "id": 759, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 761, + "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": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + ], + "name": "FindOptionsRelations", + "package": "typeorm" + } + }, + { + "id": 760, + "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": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + ], + "name": "FindOptionsSelect", + "package": "typeorm" + } + }, + { + "id": 762, + "name": "where", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 763, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 768, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "FindOperator", + "package": "typeorm" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/address.ts", + "qualifiedName": "Address" + }, + "name": "Address", + "package": "@medusajs/medusa" + } + ], + "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": { + "sourceFileName": "../../../packages/medusa/src/models/address.ts", + "qualifiedName": "Address" + }, + "name": "Address", + "package": "@medusajs/medusa" + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/EqualOperator.d.ts", + "qualifiedName": "EqualOperator" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/address.ts", + "qualifiedName": "Address" + }, + "name": "Address", + "package": "@medusajs/medusa" + } + ], + "name": "EqualOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 767, + "name": "billing_address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 778, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 776, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 764, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 765, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 774, + "name": "groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "FindOperator", + "package": "typeorm" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer-group.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + ], + "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": { + "sourceFileName": "../../../packages/medusa/src/models/customer-group.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/EqualOperator.d.ts", + "qualifiedName": "EqualOperator" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer-group.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + ], + "name": "EqualOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 772, + "name": "has_account", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "boolean" + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 777, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 766, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 775, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "FindOperator", + "package": "typeorm" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "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": "FindOptionsWhere", + "package": "typeorm" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "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": "FindOptionsWhere", + "package": "typeorm" + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/EqualOperator.d.ts", + "qualifiedName": "EqualOperator" + }, + "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": "EqualOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 773, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "FindOperator", + "package": "typeorm" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + ], + "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": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/EqualOperator.d.ts", + "qualifiedName": "EqualOperator" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + ], + "name": "EqualOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 770, + "name": "password_hash", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 771, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 769, + "name": "shipping_addresses", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "FindOperator", + "package": "typeorm" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/address.ts", + "qualifiedName": "Address" + }, + "name": "Address", + "package": "@medusajs/medusa" + } + ], + "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": { + "sourceFileName": "../../../packages/medusa/src/models/address.ts", + "qualifiedName": "Address" + }, + "name": "Address", + "package": "@medusajs/medusa" + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/EqualOperator.d.ts", + "qualifiedName": "EqualOperator" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/address.ts", + "qualifiedName": "Address" + }, + "name": "Address", + "package": "@medusajs/medusa" + } + ], + "name": "EqualOperator", + "package": "typeorm" + } + ] + } + }, + { + "id": 779, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 768, + 767, + 778, + 776, + 764, + 765, + 774, + 772, + 777, + 766, + 775, + 773, + 770, + 771, + 769, + 779 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 761, + 760, + 762 + ] + } + ] + } } }, { - "id": 752, + "id": 780, "name": "q", "variant": "param", "kind": 32768, @@ -18593,7 +19659,7 @@ { "title": "Methods", "children": [ - 749 + 756 ] } ] @@ -18603,7 +19669,7 @@ } }, { - "id": 754, + "id": 782, "name": "eventBusService_", "variant": "declaration", "kind": 1024, @@ -18613,13 +19679,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 832, + "id": 862, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -18642,7 +19708,7 @@ } }, { - "id": 833, + "id": 863, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -18674,7 +19740,7 @@ } }, { - "id": 739, + "id": 746, "name": "Events", "variant": "declaration", "kind": 1024, @@ -18684,14 +19750,14 @@ "type": { "type": "reflection", "declaration": { - "id": 740, + "id": 747, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 742, + "id": 749, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -18703,7 +19769,7 @@ "defaultValue": "\"customer.created\"" }, { - "id": 741, + "id": 748, "name": "PASSWORD_RESET", "variant": "declaration", "kind": 1024, @@ -18715,7 +19781,7 @@ "defaultValue": "\"customer.password_reset\"" }, { - "id": 743, + "id": 750, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -18731,9 +19797,9 @@ { "title": "Properties", "children": [ - 742, - 741, - 743 + 749, + 748, + 750 ] } ] @@ -18742,7 +19808,7 @@ "defaultValue": "..." }, { - "id": 834, + "id": 864, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -18750,7 +19816,7 @@ "isProtected": true }, "getSignature": { - "id": 835, + "id": 865, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -18777,21 +19843,21 @@ } }, { - "id": 825, + "id": 855, "name": "addAddress", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 826, + "id": 856, "name": "addAddress", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 827, + "id": 857, "name": "customerId", "variant": "param", "kind": 32768, @@ -18802,7 +19868,7 @@ } }, { - "id": 828, + "id": 858, "name": "address", "variant": "param", "kind": 32768, @@ -18856,7 +19922,7 @@ ] }, { - "id": 847, + "id": 877, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -18865,7 +19931,7 @@ }, "signatures": [ { - "id": 848, + "id": 878, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -18891,14 +19957,14 @@ }, "typeParameter": [ { - "id": 849, + "id": 879, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 850, + "id": 880, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -18907,7 +19973,7 @@ ], "parameters": [ { - "id": 851, + "id": 881, "name": "work", "variant": "param", "kind": 32768, @@ -18923,21 +19989,21 @@ "type": { "type": "reflection", "declaration": { - "id": 852, + "id": 882, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 853, + "id": 883, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 854, + "id": 884, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -18976,7 +20042,7 @@ } }, { - "id": 855, + "id": 885, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -19006,21 +20072,21 @@ { "type": "reflection", "declaration": { - "id": 856, + "id": 886, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 857, + "id": 887, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 858, + "id": 888, "name": "error", "variant": "param", "kind": 32768, @@ -19067,7 +20133,7 @@ } }, { - "id": 859, + "id": 889, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -19085,21 +20151,21 @@ "type": { "type": "reflection", "declaration": { - "id": 860, + "id": 890, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 861, + "id": 891, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 862, + "id": 892, "name": "error", "variant": "param", "kind": 32768, @@ -19175,14 +20241,14 @@ } }, { - "id": 772, + "id": 802, "name": "count", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 773, + "id": 803, "name": "count", "variant": "signature", "kind": 4096, @@ -19225,14 +20291,14 @@ ] }, { - "id": 805, + "id": 835, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 806, + "id": 836, "name": "create", "variant": "signature", "kind": 4096, @@ -19258,7 +20324,7 @@ }, "parameters": [ { - "id": 807, + "id": 837, "name": "customer", "variant": "param", "kind": 32768, @@ -19306,14 +20372,14 @@ ] }, { - "id": 829, + "id": 859, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 830, + "id": 860, "name": "delete", "variant": "signature", "kind": 4096, @@ -19339,7 +20405,7 @@ }, "parameters": [ { - "id": 831, + "id": 861, "name": "customerId", "variant": "param", "kind": 32768, @@ -19391,14 +20457,14 @@ ] }, { - "id": 755, + "id": 783, "name": "generateResetPasswordToken", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 756, + "id": 784, "name": "generateResetPasswordToken", "variant": "signature", "kind": 4096, @@ -19424,7 +20490,7 @@ }, "parameters": [ { - "id": 757, + "id": 785, "name": "customerId", "variant": "param", "kind": 32768, @@ -19462,14 +20528,14 @@ ] }, { - "id": 802, + "id": 832, "name": "hashPassword_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 803, + "id": 833, "name": "hashPassword_", "variant": "signature", "kind": 4096, @@ -19495,7 +20561,7 @@ }, "parameters": [ { - "id": 804, + "id": 834, "name": "password", "variant": "param", "kind": 32768, @@ -19533,14 +20599,14 @@ ] }, { - "id": 758, + "id": 786, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 759, + "id": 787, "name": "list", "variant": "signature", "kind": 4096, @@ -19561,7 +20627,7 @@ }, "parameters": [ { - "id": 760, + "id": 788, "name": "selector", "variant": "param", "kind": 32768, @@ -19575,84 +20641,74 @@ ] }, "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "Selector" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer.ts", - "qualifiedName": "Customer" - }, - "name": "Customer", - "package": "@medusajs/medusa" - } - ], - "name": "Selector", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 761, - "name": "__type", + "type": "reflection", + "declaration": { + "id": 789, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 790, + "name": "groups", "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 763, - "name": "groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } - } - }, - { - "id": 762, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true }, - "type": { - "type": "intrinsic", - "name": "string" + { + "type": "reflection", + "declaration": { + "id": 791, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {} + } } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 763, - 762 - ] - } + ] + } + }, + { + "id": 792, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 790, + 792 ] } - } - ] + ] + } }, "defaultValue": "{}" }, { - "id": 764, + "id": 793, "name": "config", "variant": "param", "kind": 32768, @@ -19715,14 +20771,14 @@ ] }, { - "id": 765, + "id": 794, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 766, + "id": 795, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -19743,7 +20799,7 @@ }, "parameters": [ { - "id": 767, + "id": 796, "name": "selector", "variant": "param", "kind": 32768, @@ -19757,83 +20813,73 @@ ] }, "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "Selector" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer.ts", - "qualifiedName": "Customer" - }, - "name": "Customer", - "package": "@medusajs/medusa" - } - ], - "name": "Selector", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 768, - "name": "__type", + "type": "reflection", + "declaration": { + "id": 797, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 798, + "name": "groups", "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 770, - "name": "groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } - } - }, - { - "id": 769, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true }, - "type": { - "type": "intrinsic", - "name": "string" + { + "type": "reflection", + "declaration": { + "id": 799, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {} + } } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 770, - 769 - ] - } + ] + } + }, + { + "id": 800, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 798, + 800 ] } - } - ] + ] + } } }, { - "id": 771, + "id": 801, "name": "config", "variant": "param", "kind": 32768, @@ -19905,21 +20951,21 @@ ] }, { - "id": 790, + "id": 820, "name": "listByEmail", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 791, + "id": 821, "name": "listByEmail", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 792, + "id": 822, "name": "email", "variant": "param", "kind": 32768, @@ -19930,7 +20976,7 @@ } }, { - "id": 793, + "id": 823, "name": "config", "variant": "param", "kind": 32768, @@ -19985,21 +21031,21 @@ ] }, { - "id": 821, + "id": 851, "name": "removeAddress", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 822, + "id": 852, "name": "removeAddress", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 823, + "id": 853, "name": "customerId", "variant": "param", "kind": 32768, @@ -20010,7 +21056,7 @@ } }, { - "id": 824, + "id": 854, "name": "addressId", "variant": "param", "kind": 32768, @@ -20040,14 +21086,14 @@ ] }, { - "id": 798, + "id": 828, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 799, + "id": 829, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -20073,7 +21119,7 @@ }, "parameters": [ { - "id": 800, + "id": 830, "name": "customerId", "variant": "param", "kind": 32768, @@ -20092,7 +21138,7 @@ } }, { - "id": 801, + "id": 831, "name": "config", "variant": "param", "kind": 32768, @@ -20152,14 +21198,14 @@ ] }, { - "id": 778, + "id": 808, "name": "retrieveByEmail", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 779, + "id": 809, "name": "retrieveByEmail", "variant": "signature", "kind": 4096, @@ -20189,7 +21235,7 @@ }, "parameters": [ { - "id": 780, + "id": 810, "name": "email", "variant": "param", "kind": 32768, @@ -20208,7 +21254,7 @@ } }, { - "id": 781, + "id": 811, "name": "config", "variant": "param", "kind": 32768, @@ -20268,14 +21314,14 @@ ] }, { - "id": 794, + "id": 824, "name": "retrieveByPhone", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 795, + "id": 825, "name": "retrieveByPhone", "variant": "signature", "kind": 4096, @@ -20301,7 +21347,7 @@ }, "parameters": [ { - "id": 796, + "id": 826, "name": "phone", "variant": "param", "kind": 32768, @@ -20320,7 +21366,7 @@ } }, { - "id": 797, + "id": 827, "name": "config", "variant": "param", "kind": 32768, @@ -20380,21 +21426,21 @@ ] }, { - "id": 786, + "id": 816, "name": "retrieveRegisteredByEmail", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 787, + "id": 817, "name": "retrieveRegisteredByEmail", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 788, + "id": 818, "name": "email", "variant": "param", "kind": 32768, @@ -20405,7 +21451,7 @@ } }, { - "id": 789, + "id": 819, "name": "config", "variant": "param", "kind": 32768, @@ -20457,21 +21503,21 @@ ] }, { - "id": 782, + "id": 812, "name": "retrieveUnregisteredByEmail", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 783, + "id": 813, "name": "retrieveUnregisteredByEmail", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 784, + "id": 814, "name": "email", "variant": "param", "kind": 32768, @@ -20482,7 +21528,7 @@ } }, { - "id": 785, + "id": 815, "name": "config", "variant": "param", "kind": 32768, @@ -20534,7 +21580,7 @@ ] }, { - "id": 774, + "id": 804, "name": "retrieve_", "variant": "declaration", "kind": 2048, @@ -20543,14 +21589,14 @@ }, "signatures": [ { - "id": 775, + "id": 805, "name": "retrieve_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 776, + "id": 806, "name": "selector", "variant": "param", "kind": 32768, @@ -20577,7 +21623,7 @@ } }, { - "id": 777, + "id": 807, "name": "config", "variant": "param", "kind": 32768, @@ -20629,7 +21675,7 @@ ] }, { - "id": 842, + "id": 872, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -20638,14 +21684,14 @@ }, "signatures": [ { - "id": 843, + "id": 873, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 844, + "id": 874, "name": "err", "variant": "param", "kind": 32768, @@ -20675,14 +21721,14 @@ { "type": "reflection", "declaration": { - "id": 845, + "id": 875, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 846, + "id": 876, "name": "code", "variant": "declaration", "kind": 1024, @@ -20697,7 +21743,7 @@ { "title": "Properties", "children": [ - 846 + 876 ] } ] @@ -20725,14 +21771,14 @@ } }, { - "id": 808, + "id": 838, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 809, + "id": 839, "name": "update", "variant": "signature", "kind": 4096, @@ -20758,7 +21804,7 @@ }, "parameters": [ { - "id": 810, + "id": 840, "name": "customerId", "variant": "param", "kind": 32768, @@ -20777,7 +21823,7 @@ } }, { - "id": 811, + "id": 841, "name": "update", "variant": "param", "kind": 32768, @@ -20825,21 +21871,21 @@ ] }, { - "id": 816, + "id": 846, "name": "updateAddress", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 817, + "id": 847, "name": "updateAddress", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 818, + "id": 848, "name": "customerId", "variant": "param", "kind": 32768, @@ -20850,7 +21896,7 @@ } }, { - "id": 819, + "id": 849, "name": "addressId", "variant": "param", "kind": 32768, @@ -20861,7 +21907,7 @@ } }, { - "id": 820, + "id": 850, "name": "address", "variant": "param", "kind": 32768, @@ -20901,14 +21947,14 @@ ] }, { - "id": 812, + "id": 842, "name": "updateBillingAddress_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 813, + "id": 843, "name": "updateBillingAddress_", "variant": "signature", "kind": 4096, @@ -20934,7 +21980,7 @@ }, "parameters": [ { - "id": 814, + "id": 844, "name": "customer", "variant": "param", "kind": 32768, @@ -20958,7 +22004,7 @@ } }, { - "id": 815, + "id": 845, "name": "addressOrId", "variant": "param", "kind": 32768, @@ -21025,21 +22071,21 @@ ] }, { - "id": 839, + "id": 869, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 840, + "id": 870, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 841, + "id": 871, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -21059,7 +22105,7 @@ ], "type": { "type": "reference", - "target": 738, + "target": 745, "name": "CustomerService", "package": "@medusajs/medusa" }, @@ -21081,54 +22127,54 @@ { "title": "Constructors", "children": [ - 744 + 751 ] }, { "title": "Properties", "children": [ - 837, - 836, - 838, - 753, - 747, + 867, + 866, + 868, + 781, 754, - 832, - 833, - 739 + 782, + 862, + 863, + 746 ] }, { "title": "Accessors", "children": [ - 834 + 864 ] }, { "title": "Methods", "children": [ - 825, - 847, - 772, - 805, - 829, - 755, + 855, + 877, 802, - 758, - 765, - 790, - 821, - 798, - 778, - 794, + 835, + 859, + 783, + 832, 786, - 782, - 774, - 842, + 794, + 820, + 851, + 828, 808, + 824, 816, 812, - 839 + 804, + 872, + 838, + 846, + 842, + 869 ] } ], @@ -21145,7 +22191,7 @@ ] }, { - "id": 1139, + "id": 1189, "name": "DiscountConditionService", "variant": "declaration", "kind": 128, @@ -21166,21 +22212,21 @@ }, "children": [ { - "id": 1148, + "id": 1198, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1149, + "id": 1199, "name": "new DiscountConditionService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1150, + "id": 1200, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -21198,7 +22244,7 @@ ], "type": { "type": "reference", - "target": 1139, + "target": 1189, "name": "DiscountConditionService", "package": "@medusajs/medusa" }, @@ -21216,7 +22262,7 @@ } }, { - "id": 1217, + "id": 1271, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -21251,7 +22297,7 @@ } }, { - "id": 1216, + "id": 1270, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -21270,7 +22316,7 @@ } }, { - "id": 1218, + "id": 1272, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -21305,7 +22351,7 @@ } }, { - "id": 1151, + "id": 1201, "name": "discountConditionRepository_", "variant": "declaration", "kind": 1024, @@ -21339,28 +22385,28 @@ { "type": "reflection", "declaration": { - "id": 1152, + "id": 1202, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1176, + "id": 1226, "name": "addConditionResources", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1177, + "id": 1227, "name": "addConditionResources", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1178, + "id": 1228, "name": "conditionId", "variant": "param", "kind": 32768, @@ -21371,7 +22417,7 @@ } }, { - "id": 1179, + "id": 1229, "name": "resourceIds", "variant": "param", "kind": 32768, @@ -21388,14 +22434,14 @@ { "type": "reflection", "declaration": { - "id": 1180, + "id": 1230, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1181, + "id": 1231, "name": "id", "variant": "declaration", "kind": 1024, @@ -21410,7 +22456,7 @@ { "title": "Properties", "children": [ - 1181 + 1231 ] } ] @@ -21421,7 +22467,7 @@ } }, { - "id": 1182, + "id": 1232, "name": "type", "variant": "param", "kind": 32768, @@ -21437,7 +22483,7 @@ } }, { - "id": 1183, + "id": 1233, "name": "overrideExisting", "variant": "param", "kind": 32768, @@ -21517,21 +22563,21 @@ ] }, { - "id": 1191, + "id": 1245, "name": "canApplyForCustomer", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1192, + "id": 1246, "name": "canApplyForCustomer", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1193, + "id": 1247, "name": "discountRuleId", "variant": "param", "kind": 32768, @@ -21542,7 +22588,7 @@ } }, { - "id": 1194, + "id": 1248, "name": "customerId", "variant": "param", "kind": 32768, @@ -21572,21 +22618,21 @@ ] }, { - "id": 1153, + "id": 1203, "name": "findOneWithDiscount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1154, + "id": 1204, "name": "findOneWithDiscount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1155, + "id": 1205, "name": "conditionId", "variant": "param", "kind": 32768, @@ -21597,7 +22643,7 @@ } }, { - "id": 1156, + "id": 1206, "name": "discountId", "variant": "param", "kind": 32768, @@ -21637,14 +22683,14 @@ { "type": "reflection", "declaration": { - "id": 1157, + "id": 1207, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1158, + "id": 1208, "name": "discount", "variant": "declaration", "kind": 1024, @@ -21664,7 +22710,7 @@ { "title": "Properties", "children": [ - 1158 + 1208 ] } ] @@ -21682,21 +22728,21 @@ ] }, { - "id": 1159, + "id": 1209, "name": "getJoinTableResourceIdentifiers", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1160, + "id": 1210, "name": "getJoinTableResourceIdentifiers", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1161, + "id": 1211, "name": "type", "variant": "param", "kind": 32768, @@ -21710,14 +22756,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1162, + "id": 1212, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1166, + "id": 1216, "name": "conditionTable", "variant": "declaration", "kind": 1024, @@ -21733,7 +22779,7 @@ } }, { - "id": 1163, + "id": 1213, "name": "joinTable", "variant": "declaration", "kind": 1024, @@ -21744,7 +22790,7 @@ } }, { - "id": 1165, + "id": 1215, "name": "joinTableForeignKey", "variant": "declaration", "kind": 1024, @@ -21760,7 +22806,7 @@ } }, { - "id": 1167, + "id": 1217, "name": "joinTableKey", "variant": "declaration", "kind": 1024, @@ -21771,7 +22817,7 @@ } }, { - "id": 1168, + "id": 1218, "name": "relatedTable", "variant": "declaration", "kind": 1024, @@ -21782,7 +22828,7 @@ } }, { - "id": 1164, + "id": 1214, "name": "resourceKey", "variant": "declaration", "kind": 1024, @@ -21797,12 +22843,12 @@ { "title": "Properties", "children": [ - 1166, - 1163, - 1165, - 1167, - 1168, - 1164 + 1216, + 1213, + 1215, + 1217, + 1218, + 1214 ] } ] @@ -21812,21 +22858,21 @@ ] }, { - "id": 1187, + "id": 1241, "name": "isValidForProduct", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1188, + "id": 1242, "name": "isValidForProduct", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1189, + "id": 1243, "name": "discountRuleId", "variant": "param", "kind": 32768, @@ -21837,7 +22883,7 @@ } }, { - "id": 1190, + "id": 1244, "name": "productId", "variant": "param", "kind": 32768, @@ -21867,28 +22913,79 @@ ] }, { - "id": 1184, + "id": 1234, "name": "queryConditionTable", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1185, + "id": 1235, "name": "queryConditionTable", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1186, + "id": 1236, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "Object" + "type": "reflection", + "declaration": { + "id": 1237, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1239, + "name": "conditionId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1240, + "name": "resourceId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1238, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1239, + 1240, + 1238 + ] + } + ] + } } } ], @@ -21911,21 +23008,21 @@ ] }, { - "id": 1169, + "id": 1219, "name": "removeConditionResources", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1170, + "id": 1220, "name": "removeConditionResources", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1171, + "id": 1221, "name": "id", "variant": "param", "kind": 32768, @@ -21936,7 +23033,7 @@ } }, { - "id": 1172, + "id": 1222, "name": "type", "variant": "param", "kind": 32768, @@ -21952,7 +23049,7 @@ } }, { - "id": 1173, + "id": 1223, "name": "resourceIds", "variant": "param", "kind": 32768, @@ -21969,14 +23066,14 @@ { "type": "reflection", "declaration": { - "id": 1174, + "id": 1224, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1175, + "id": 1225, "name": "id", "variant": "declaration", "kind": 1024, @@ -21991,7 +23088,7 @@ { "title": "Properties", "children": [ - 1175 + 1225 ] } ] @@ -22039,13 +23136,13 @@ { "title": "Methods", "children": [ - 1176, - 1191, - 1153, - 1159, - 1187, - 1184, - 1169 + 1226, + 1245, + 1203, + 1209, + 1241, + 1234, + 1219 ] } ] @@ -22055,7 +23152,7 @@ } }, { - "id": 1195, + "id": 1249, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -22065,13 +23162,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 1212, + "id": 1266, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -22094,7 +23191,7 @@ } }, { - "id": 1213, + "id": 1267, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -22126,7 +23223,7 @@ } }, { - "id": 1214, + "id": 1268, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -22134,7 +23231,7 @@ "isProtected": true }, "getSignature": { - "id": 1215, + "id": 1269, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -22161,7 +23258,7 @@ } }, { - "id": 1227, + "id": 1281, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -22170,7 +23267,7 @@ }, "signatures": [ { - "id": 1228, + "id": 1282, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -22196,14 +23293,14 @@ }, "typeParameter": [ { - "id": 1229, + "id": 1283, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 1230, + "id": 1284, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -22212,7 +23309,7 @@ ], "parameters": [ { - "id": 1231, + "id": 1285, "name": "work", "variant": "param", "kind": 32768, @@ -22228,21 +23325,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1232, + "id": 1286, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1233, + "id": 1287, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1234, + "id": 1288, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -22281,7 +23378,7 @@ } }, { - "id": 1235, + "id": 1289, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -22311,21 +23408,21 @@ { "type": "reflection", "declaration": { - "id": 1236, + "id": 1290, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1237, + "id": 1291, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1238, + "id": 1292, "name": "error", "variant": "param", "kind": 32768, @@ -22372,7 +23469,7 @@ } }, { - "id": 1239, + "id": 1293, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -22390,21 +23487,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1240, + "id": 1294, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1241, + "id": 1295, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1242, + "id": 1296, "name": "error", "variant": "param", "kind": 32768, @@ -22480,21 +23577,21 @@ } }, { - "id": 1209, + "id": 1263, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1210, + "id": 1264, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1211, + "id": 1265, "name": "discountConditionId", "variant": "param", "kind": 32768, @@ -22538,21 +23635,21 @@ ] }, { - "id": 1204, + "id": 1258, "name": "removeResources", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1205, + "id": 1259, "name": "removeResources", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1206, + "id": 1260, "name": "data", "variant": "param", "kind": 32768, @@ -22587,14 +23684,14 @@ { "type": "reflection", "declaration": { - "id": 1207, + "id": 1261, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1208, + "id": 1262, "name": "id", "variant": "declaration", "kind": 1024, @@ -22609,7 +23706,7 @@ { "title": "Properties", "children": [ - 1208 + 1262 ] } ] @@ -22638,21 +23735,21 @@ ] }, { - "id": 1196, + "id": 1250, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1197, + "id": 1251, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1198, + "id": 1252, "name": "conditionId", "variant": "param", "kind": 32768, @@ -22663,7 +23760,7 @@ } }, { - "id": 1199, + "id": 1253, "name": "config", "variant": "param", "kind": 32768, @@ -22716,7 +23813,7 @@ ] }, { - "id": 1222, + "id": 1276, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -22725,14 +23822,14 @@ }, "signatures": [ { - "id": 1223, + "id": 1277, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1224, + "id": 1278, "name": "err", "variant": "param", "kind": 32768, @@ -22762,14 +23859,14 @@ { "type": "reflection", "declaration": { - "id": 1225, + "id": 1279, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1226, + "id": 1280, "name": "code", "variant": "declaration", "kind": 1024, @@ -22784,7 +23881,7 @@ { "title": "Properties", "children": [ - 1226 + 1280 ] } ] @@ -22812,21 +23909,21 @@ } }, { - "id": 1200, + "id": 1254, "name": "upsertCondition", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1201, + "id": 1255, "name": "upsertCondition", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1202, + "id": 1256, "name": "data", "variant": "param", "kind": 32768, @@ -22842,7 +23939,7 @@ } }, { - "id": 1203, + "id": 1257, "name": "overrideExisting", "variant": "param", "kind": 32768, @@ -22922,21 +24019,21 @@ ] }, { - "id": 1219, + "id": 1273, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1220, + "id": 1274, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1221, + "id": 1275, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -22956,7 +24053,7 @@ ], "type": { "type": "reference", - "target": 1139, + "target": 1189, "name": "DiscountConditionService", "package": "@medusajs/medusa" }, @@ -22974,7 +24071,7 @@ } }, { - "id": 1140, + "id": 1190, "name": "resolveConditionType_", "variant": "declaration", "kind": 2048, @@ -22984,14 +24081,14 @@ }, "signatures": [ { - "id": 1141, + "id": 1191, "name": "resolveConditionType_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1142, + "id": 1192, "name": "data", "variant": "param", "kind": 32768, @@ -23017,14 +24114,14 @@ { "type": "reflection", "declaration": { - "id": 1143, + "id": 1193, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1145, + "id": 1195, "name": "resource_ids", "variant": "declaration", "kind": 1024, @@ -23041,14 +24138,14 @@ { "type": "reflection", "declaration": { - "id": 1146, + "id": 1196, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1147, + "id": 1197, "name": "id", "variant": "declaration", "kind": 1024, @@ -23063,7 +24160,7 @@ { "title": "Properties", "children": [ - 1147 + 1197 ] } ] @@ -23074,7 +24171,7 @@ } }, { - "id": 1144, + "id": 1194, "name": "type", "variant": "declaration", "kind": 1024, @@ -23094,8 +24191,8 @@ { "title": "Properties", "children": [ - 1145, - 1144 + 1195, + 1194 ] } ] @@ -23111,38 +24208,38 @@ { "title": "Constructors", "children": [ - 1148 + 1198 ] }, { "title": "Properties", "children": [ - 1217, - 1216, - 1218, - 1151, - 1195, - 1212, - 1213 + 1271, + 1270, + 1272, + 1201, + 1249, + 1266, + 1267 ] }, { "title": "Accessors", "children": [ - 1214 + 1268 ] }, { "title": "Methods", "children": [ - 1227, - 1209, - 1204, - 1196, - 1222, - 1200, - 1219, - 1140 + 1281, + 1263, + 1258, + 1250, + 1276, + 1254, + 1273, + 1190 ] } ], @@ -23159,7 +24256,7 @@ ] }, { - "id": 955, + "id": 985, "name": "DiscountService", "variant": "declaration", "kind": 128, @@ -23180,34 +24277,193 @@ }, "children": [ { - "id": 956, + "id": 989, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 957, + "id": 990, "name": "new DiscountService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 958, + "id": 991, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "Object" + "type": "reflection", + "declaration": { + "id": 992, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1002, + "name": "customerService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 996, + "name": "discountConditionRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 997, + "name": "discountConditionService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 993, + "name": "discountRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 994, + "name": "discountRuleRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1003, + "name": "eventBusService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1004, + "name": "featureFlagRouter", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 995, + "name": "giftCardRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 999, + "name": "newTotalsService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1000, + "name": "productService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1001, + "name": "regionService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 998, + "name": "totalsService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1002, + 996, + 997, + 993, + 994, + 1003, + 1004, + 995, + 999, + 1000, + 1001, + 998 + ] + } + ] + } } } ], "type": { "type": "reference", - "target": 955, + "target": 985, "name": "DiscountService", "package": "@medusajs/medusa" }, @@ -23225,7 +24481,7 @@ } }, { - "id": 1113, + "id": 1163, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -23260,7 +24516,7 @@ } }, { - "id": 1112, + "id": 1162, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -23279,7 +24535,7 @@ } }, { - "id": 1114, + "id": 1164, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -23314,7 +24570,7 @@ } }, { - "id": 960, + "id": 1006, "name": "customerService_", "variant": "declaration", "kind": 1024, @@ -23324,13 +24580,13 @@ }, "type": { "type": "reference", - "target": 738, + "target": 745, "name": "CustomerService", "package": "@medusajs/medusa" } }, { - "id": 968, + "id": 1014, "name": "discountConditionRepository_", "variant": "declaration", "kind": 1024, @@ -23364,28 +24620,28 @@ { "type": "reflection", "declaration": { - "id": 969, + "id": 1015, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 993, + "id": 1039, "name": "addConditionResources", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 994, + "id": 1040, "name": "addConditionResources", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 995, + "id": 1041, "name": "conditionId", "variant": "param", "kind": 32768, @@ -23396,7 +24652,7 @@ } }, { - "id": 996, + "id": 1042, "name": "resourceIds", "variant": "param", "kind": 32768, @@ -23413,14 +24669,14 @@ { "type": "reflection", "declaration": { - "id": 997, + "id": 1043, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 998, + "id": 1044, "name": "id", "variant": "declaration", "kind": 1024, @@ -23435,7 +24691,7 @@ { "title": "Properties", "children": [ - 998 + 1044 ] } ] @@ -23446,7 +24702,7 @@ } }, { - "id": 999, + "id": 1045, "name": "type", "variant": "param", "kind": 32768, @@ -23462,7 +24718,7 @@ } }, { - "id": 1000, + "id": 1046, "name": "overrideExisting", "variant": "param", "kind": 32768, @@ -23542,21 +24798,21 @@ ] }, { - "id": 1008, + "id": 1058, "name": "canApplyForCustomer", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1009, + "id": 1059, "name": "canApplyForCustomer", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1010, + "id": 1060, "name": "discountRuleId", "variant": "param", "kind": 32768, @@ -23567,7 +24823,7 @@ } }, { - "id": 1011, + "id": 1061, "name": "customerId", "variant": "param", "kind": 32768, @@ -23597,21 +24853,21 @@ ] }, { - "id": 970, + "id": 1016, "name": "findOneWithDiscount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 971, + "id": 1017, "name": "findOneWithDiscount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 972, + "id": 1018, "name": "conditionId", "variant": "param", "kind": 32768, @@ -23622,7 +24878,7 @@ } }, { - "id": 973, + "id": 1019, "name": "discountId", "variant": "param", "kind": 32768, @@ -23662,14 +24918,14 @@ { "type": "reflection", "declaration": { - "id": 974, + "id": 1020, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 975, + "id": 1021, "name": "discount", "variant": "declaration", "kind": 1024, @@ -23689,7 +24945,7 @@ { "title": "Properties", "children": [ - 975 + 1021 ] } ] @@ -23707,21 +24963,21 @@ ] }, { - "id": 976, + "id": 1022, "name": "getJoinTableResourceIdentifiers", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 977, + "id": 1023, "name": "getJoinTableResourceIdentifiers", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 978, + "id": 1024, "name": "type", "variant": "param", "kind": 32768, @@ -23735,14 +24991,14 @@ "type": { "type": "reflection", "declaration": { - "id": 979, + "id": 1025, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 983, + "id": 1029, "name": "conditionTable", "variant": "declaration", "kind": 1024, @@ -23758,7 +25014,7 @@ } }, { - "id": 980, + "id": 1026, "name": "joinTable", "variant": "declaration", "kind": 1024, @@ -23769,7 +25025,7 @@ } }, { - "id": 982, + "id": 1028, "name": "joinTableForeignKey", "variant": "declaration", "kind": 1024, @@ -23785,7 +25041,7 @@ } }, { - "id": 984, + "id": 1030, "name": "joinTableKey", "variant": "declaration", "kind": 1024, @@ -23796,7 +25052,7 @@ } }, { - "id": 985, + "id": 1031, "name": "relatedTable", "variant": "declaration", "kind": 1024, @@ -23807,7 +25063,7 @@ } }, { - "id": 981, + "id": 1027, "name": "resourceKey", "variant": "declaration", "kind": 1024, @@ -23822,12 +25078,12 @@ { "title": "Properties", "children": [ - 983, - 980, - 982, - 984, - 985, - 981 + 1029, + 1026, + 1028, + 1030, + 1031, + 1027 ] } ] @@ -23837,21 +25093,21 @@ ] }, { - "id": 1004, + "id": 1054, "name": "isValidForProduct", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1005, + "id": 1055, "name": "isValidForProduct", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1006, + "id": 1056, "name": "discountRuleId", "variant": "param", "kind": 32768, @@ -23862,7 +25118,7 @@ } }, { - "id": 1007, + "id": 1057, "name": "productId", "variant": "param", "kind": 32768, @@ -23892,28 +25148,79 @@ ] }, { - "id": 1001, + "id": 1047, "name": "queryConditionTable", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1002, + "id": 1048, "name": "queryConditionTable", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1003, + "id": 1049, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "Object" + "type": "reflection", + "declaration": { + "id": 1050, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1052, + "name": "conditionId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1053, + "name": "resourceId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1051, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1052, + 1053, + 1051 + ] + } + ] + } } } ], @@ -23936,21 +25243,21 @@ ] }, { - "id": 986, + "id": 1032, "name": "removeConditionResources", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 987, + "id": 1033, "name": "removeConditionResources", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 988, + "id": 1034, "name": "id", "variant": "param", "kind": 32768, @@ -23961,7 +25268,7 @@ } }, { - "id": 989, + "id": 1035, "name": "type", "variant": "param", "kind": 32768, @@ -23977,7 +25284,7 @@ } }, { - "id": 990, + "id": 1036, "name": "resourceIds", "variant": "param", "kind": 32768, @@ -23994,14 +25301,14 @@ { "type": "reflection", "declaration": { - "id": 991, + "id": 1037, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 992, + "id": 1038, "name": "id", "variant": "declaration", "kind": 1024, @@ -24016,7 +25323,7 @@ { "title": "Properties", "children": [ - 992 + 1038 ] } ] @@ -24064,13 +25371,13 @@ { "title": "Methods", "children": [ - 993, - 1008, - 970, - 976, - 1004, - 1001, - 986 + 1039, + 1058, + 1016, + 1022, + 1054, + 1047, + 1032 ] } ] @@ -24080,7 +25387,7 @@ } }, { - "id": 1012, + "id": 1062, "name": "discountConditionService_", "variant": "declaration", "kind": 1024, @@ -24090,13 +25397,13 @@ }, "type": { "type": "reference", - "target": 1139, + "target": 1189, "name": "DiscountConditionService", "package": "@medusajs/medusa" } }, { - "id": 959, + "id": 1005, "name": "discountRepository_", "variant": "declaration", "kind": 1024, @@ -24126,7 +25433,7 @@ } }, { - "id": 961, + "id": 1007, "name": "discountRuleRepository_", "variant": "declaration", "kind": 1024, @@ -24156,7 +25463,7 @@ } }, { - "id": 1017, + "id": 1067, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -24166,13 +25473,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 1018, + "id": 1068, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -24191,7 +25498,7 @@ } }, { - "id": 962, + "id": 1008, "name": "giftCardRepository_", "variant": "declaration", "kind": 1024, @@ -24225,28 +25532,28 @@ { "type": "reflection", "declaration": { - "id": 963, + "id": 1009, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 964, + "id": 1010, "name": "listGiftCardsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 965, + "id": 1011, "name": "listGiftCardsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 966, + "id": 1012, "name": "query", "variant": "param", "kind": 32768, @@ -24273,7 +25580,7 @@ } }, { - "id": 967, + "id": 1013, "name": "q", "variant": "param", "kind": 32768, @@ -24326,7 +25633,7 @@ { "title": "Methods", "children": [ - 964 + 1010 ] } ] @@ -24336,7 +25643,7 @@ } }, { - "id": 1108, + "id": 1158, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -24359,7 +25666,7 @@ } }, { - "id": 1014, + "id": 1064, "name": "newTotalsService_", "variant": "declaration", "kind": 1024, @@ -24369,13 +25676,13 @@ }, "type": { "type": "reference", - "target": 1956, + "target": 2010, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 1015, + "id": 1065, "name": "productService_", "variant": "declaration", "kind": 1024, @@ -24385,13 +25692,13 @@ }, "type": { "type": "reference", - "target": 3441, + "target": 3495, "name": "ProductService", "package": "@medusajs/medusa" } }, { - "id": 1016, + "id": 1066, "name": "regionService_", "variant": "declaration", "kind": 1024, @@ -24401,13 +25708,13 @@ }, "type": { "type": "reference", - "target": 4533, + "target": 4621, "name": "RegionService", "package": "@medusajs/medusa" } }, { - "id": 1013, + "id": 1063, "name": "totalsService_", "variant": "declaration", "kind": 1024, @@ -24417,13 +25724,13 @@ }, "type": { "type": "reference", - "target": 5964, + "target": 6081, "name": "TotalsService", "package": "@medusajs/medusa" } }, { - "id": 1109, + "id": 1159, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -24455,7 +25762,50 @@ } }, { - "id": 1110, + "id": 986, + "name": "Events", + "variant": "declaration", + "kind": 1024, + "flags": { + "isStatic": true, + "isReadonly": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 987, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 988, + "name": "CREATED", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"discount.created\"" + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 988 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 1160, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -24463,7 +25813,7 @@ "isProtected": true }, "getSignature": { - "id": 1111, + "id": 1161, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -24490,14 +25840,14 @@ } }, { - "id": 1061, + "id": 1111, "name": "addRegion", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1062, + "id": 1112, "name": "addRegion", "variant": "signature", "kind": 4096, @@ -24523,7 +25873,7 @@ }, "parameters": [ { - "id": 1063, + "id": 1113, "name": "discountId", "variant": "param", "kind": 32768, @@ -24542,7 +25892,7 @@ } }, { - "id": 1064, + "id": 1114, "name": "regionId", "variant": "param", "kind": 32768, @@ -24585,7 +25935,7 @@ ] }, { - "id": 1123, + "id": 1173, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -24594,7 +25944,7 @@ }, "signatures": [ { - "id": 1124, + "id": 1174, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -24620,14 +25970,14 @@ }, "typeParameter": [ { - "id": 1125, + "id": 1175, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 1126, + "id": 1176, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -24636,7 +25986,7 @@ ], "parameters": [ { - "id": 1127, + "id": 1177, "name": "work", "variant": "param", "kind": 32768, @@ -24652,21 +26002,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1128, + "id": 1178, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1129, + "id": 1179, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1130, + "id": 1180, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -24705,7 +26055,7 @@ } }, { - "id": 1131, + "id": 1181, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -24735,21 +26085,21 @@ { "type": "reflection", "declaration": { - "id": 1132, + "id": 1182, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1133, + "id": 1183, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1134, + "id": 1184, "name": "error", "variant": "param", "kind": 32768, @@ -24796,7 +26146,7 @@ } }, { - "id": 1135, + "id": 1185, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -24814,21 +26164,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1136, + "id": 1186, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1137, + "id": 1187, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1138, + "id": 1188, "name": "error", "variant": "param", "kind": 32768, @@ -24904,21 +26254,21 @@ } }, { - "id": 1076, + "id": 1126, "name": "calculateDiscountForLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1077, + "id": 1127, "name": "calculateDiscountForLineItem", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1078, + "id": 1128, "name": "discountId", "variant": "param", "kind": 32768, @@ -24929,7 +26279,7 @@ } }, { - "id": 1079, + "id": 1129, "name": "lineItem", "variant": "param", "kind": 32768, @@ -24945,7 +26295,7 @@ } }, { - "id": 1080, + "id": 1130, "name": "calculationContextData", "variant": "param", "kind": 32768, @@ -24980,21 +26330,21 @@ ] }, { - "id": 1104, + "id": 1154, "name": "canApplyForCustomer", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1105, + "id": 1155, "name": "canApplyForCustomer", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1106, + "id": 1156, "name": "discountRuleId", "variant": "param", "kind": 32768, @@ -25005,7 +26355,7 @@ } }, { - "id": 1107, + "id": 1157, "name": "customerId", "variant": "param", "kind": 32768, @@ -25044,14 +26394,14 @@ ] }, { - "id": 1034, + "id": 1084, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1035, + "id": 1085, "name": "create", "variant": "signature", "kind": 4096, @@ -25077,7 +26427,7 @@ }, "parameters": [ { - "id": 1036, + "id": 1086, "name": "discount", "variant": "param", "kind": 32768, @@ -25125,14 +26475,14 @@ ] }, { - "id": 1053, + "id": 1103, "name": "createDynamicCode", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1054, + "id": 1104, "name": "createDynamicCode", "variant": "signature", "kind": 4096, @@ -25158,7 +26508,7 @@ }, "parameters": [ { - "id": 1055, + "id": 1105, "name": "discountId", "variant": "param", "kind": 32768, @@ -25177,7 +26527,7 @@ } }, { - "id": 1056, + "id": 1106, "name": "data", "variant": "param", "kind": 32768, @@ -25225,14 +26575,14 @@ ] }, { - "id": 1069, + "id": 1119, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1070, + "id": 1120, "name": "delete", "variant": "signature", "kind": 4096, @@ -25258,7 +26608,7 @@ }, "parameters": [ { - "id": 1071, + "id": 1121, "name": "discountId", "variant": "param", "kind": 32768, @@ -25296,14 +26646,14 @@ ] }, { - "id": 1057, + "id": 1107, "name": "deleteDynamicCode", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1058, + "id": 1108, "name": "deleteDynamicCode", "variant": "signature", "kind": 4096, @@ -25329,7 +26679,7 @@ }, "parameters": [ { - "id": 1059, + "id": 1109, "name": "discountId", "variant": "param", "kind": 32768, @@ -25348,7 +26698,7 @@ } }, { - "id": 1060, + "id": 1110, "name": "code", "variant": "param", "kind": 32768, @@ -25386,21 +26736,21 @@ ] }, { - "id": 1085, + "id": 1135, "name": "hasCustomersGroupCondition", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1086, + "id": 1136, "name": "hasCustomersGroupCondition", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1087, + "id": 1137, "name": "discount", "variant": "param", "kind": 32768, @@ -25424,21 +26774,21 @@ ] }, { - "id": 1094, + "id": 1144, "name": "hasExpired", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1095, + "id": 1145, "name": "hasExpired", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1096, + "id": 1146, "name": "discount", "variant": "param", "kind": 32768, @@ -25462,21 +26812,21 @@ ] }, { - "id": 1091, + "id": 1141, "name": "hasNotStarted", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1092, + "id": 1142, "name": "hasNotStarted", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1093, + "id": 1143, "name": "discount", "variant": "param", "kind": 32768, @@ -25500,21 +26850,21 @@ ] }, { - "id": 1088, + "id": 1138, "name": "hasReachedLimit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1089, + "id": 1139, "name": "hasReachedLimit", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1090, + "id": 1140, "name": "discount", "variant": "param", "kind": 32768, @@ -25538,21 +26888,21 @@ ] }, { - "id": 1097, + "id": 1147, "name": "isDisabled", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1098, + "id": 1148, "name": "isDisabled", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1099, + "id": 1149, "name": "discount", "variant": "param", "kind": 32768, @@ -25576,21 +26926,21 @@ ] }, { - "id": 1100, + "id": 1150, "name": "isValidForRegion", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1101, + "id": 1151, "name": "isValidForRegion", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1102, + "id": 1152, "name": "discount", "variant": "param", "kind": 32768, @@ -25606,7 +26956,7 @@ } }, { - "id": 1103, + "id": 1153, "name": "region_id", "variant": "param", "kind": 32768, @@ -25636,14 +26986,14 @@ ] }, { - "id": 1026, + "id": 1076, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1027, + "id": 1077, "name": "list", "variant": "signature", "kind": 4096, @@ -25664,7 +27014,7 @@ }, "parameters": [ { - "id": 1028, + "id": 1078, "name": "selector", "variant": "param", "kind": 32768, @@ -25689,7 +27039,7 @@ "defaultValue": "{}" }, { - "id": 1029, + "id": 1079, "name": "config", "variant": "param", "kind": 32768, @@ -25752,14 +27102,14 @@ ] }, { - "id": 1030, + "id": 1080, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1031, + "id": 1081, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -25780,7 +27130,7 @@ }, "parameters": [ { - "id": 1032, + "id": 1082, "name": "selector", "variant": "param", "kind": 32768, @@ -25805,7 +27155,7 @@ "defaultValue": "{}" }, { - "id": 1033, + "id": 1083, "name": "config", "variant": "param", "kind": 32768, @@ -25877,14 +27227,14 @@ ] }, { - "id": 1045, + "id": 1095, "name": "listByCodes", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1046, + "id": 1096, "name": "listByCodes", "variant": "signature", "kind": 4096, @@ -25910,7 +27260,7 @@ }, "parameters": [ { - "id": 1047, + "id": 1097, "name": "discountCodes", "variant": "param", "kind": 32768, @@ -25932,7 +27282,7 @@ } }, { - "id": 1048, + "id": 1098, "name": "config", "variant": "param", "kind": 32768, @@ -25995,14 +27345,14 @@ ] }, { - "id": 1065, + "id": 1115, "name": "removeRegion", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1066, + "id": 1116, "name": "removeRegion", "variant": "signature", "kind": 4096, @@ -26028,7 +27378,7 @@ }, "parameters": [ { - "id": 1067, + "id": 1117, "name": "discountId", "variant": "param", "kind": 32768, @@ -26047,7 +27397,7 @@ } }, { - "id": 1068, + "id": 1118, "name": "regionId", "variant": "param", "kind": 32768, @@ -26090,14 +27440,14 @@ ] }, { - "id": 1037, + "id": 1087, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1038, + "id": 1088, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -26123,7 +27473,7 @@ }, "parameters": [ { - "id": 1039, + "id": 1089, "name": "discountId", "variant": "param", "kind": 32768, @@ -26142,7 +27492,7 @@ } }, { - "id": 1040, + "id": 1090, "name": "config", "variant": "param", "kind": 32768, @@ -26202,14 +27552,14 @@ ] }, { - "id": 1041, + "id": 1091, "name": "retrieveByCode", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1042, + "id": 1092, "name": "retrieveByCode", "variant": "signature", "kind": 4096, @@ -26235,7 +27585,7 @@ }, "parameters": [ { - "id": 1043, + "id": 1093, "name": "discountCode", "variant": "param", "kind": 32768, @@ -26254,7 +27604,7 @@ } }, { - "id": 1044, + "id": 1094, "name": "config", "variant": "param", "kind": 32768, @@ -26314,7 +27664,7 @@ ] }, { - "id": 1118, + "id": 1168, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -26323,14 +27673,14 @@ }, "signatures": [ { - "id": 1119, + "id": 1169, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1120, + "id": 1170, "name": "err", "variant": "param", "kind": 32768, @@ -26360,14 +27710,14 @@ { "type": "reflection", "declaration": { - "id": 1121, + "id": 1171, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1122, + "id": 1172, "name": "code", "variant": "declaration", "kind": 1024, @@ -26382,7 +27732,7 @@ { "title": "Properties", "children": [ - 1122 + 1172 ] } ] @@ -26410,14 +27760,14 @@ } }, { - "id": 1049, + "id": 1099, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1050, + "id": 1100, "name": "update", "variant": "signature", "kind": 4096, @@ -26443,7 +27793,7 @@ }, "parameters": [ { - "id": 1051, + "id": 1101, "name": "discountId", "variant": "param", "kind": 32768, @@ -26462,7 +27812,7 @@ } }, { - "id": 1052, + "id": 1102, "name": "update", "variant": "param", "kind": 32768, @@ -26510,21 +27860,21 @@ ] }, { - "id": 1081, + "id": 1131, "name": "validateDiscountForCartOrThrow", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1082, + "id": 1132, "name": "validateDiscountForCartOrThrow", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1083, + "id": 1133, "name": "cart", "variant": "param", "kind": 32768, @@ -26540,7 +27890,7 @@ } }, { - "id": 1084, + "id": 1134, "name": "discount", "variant": "param", "kind": 32768, @@ -26592,21 +27942,21 @@ ] }, { - "id": 1072, + "id": 1122, "name": "validateDiscountForProduct", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1073, + "id": 1123, "name": "validateDiscountForProduct", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1074, + "id": 1124, "name": "discountRuleId", "variant": "param", "kind": 32768, @@ -26617,7 +27967,7 @@ } }, { - "id": 1075, + "id": 1125, "name": "productId", "variant": "param", "kind": 32768, @@ -26649,14 +27999,14 @@ ] }, { - "id": 1019, + "id": 1069, "name": "validateDiscountRule_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1020, + "id": 1070, "name": "validateDiscountRule_", "variant": "signature", "kind": 4096, @@ -26682,7 +28032,7 @@ }, "typeParameter": [ { - "id": 1021, + "id": 1071, "name": "T", "variant": "typeParam", "kind": 131072, @@ -26690,14 +28040,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1022, + "id": 1072, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1023, + "id": 1073, "name": "type", "variant": "declaration", "kind": 1024, @@ -26713,7 +28063,7 @@ } }, { - "id": 1024, + "id": 1074, "name": "value", "variant": "declaration", "kind": 1024, @@ -26728,8 +28078,8 @@ { "title": "Properties", "children": [ - 1023, - 1024 + 1073, + 1074 ] } ] @@ -26739,7 +28089,7 @@ ], "parameters": [ { - "id": 1025, + "id": 1075, "name": "discountRule", "variant": "param", "kind": 32768, @@ -26770,21 +28120,21 @@ ] }, { - "id": 1115, + "id": 1165, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1116, + "id": 1166, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1117, + "id": 1167, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -26804,7 +28154,7 @@ ], "type": { "type": "reference", - "target": 955, + "target": 985, "name": "DiscountService", "package": "@medusajs/medusa" }, @@ -26826,66 +28176,67 @@ { "title": "Constructors", "children": [ - 956 + 989 ] }, { "title": "Properties", "children": [ - 1113, - 1112, - 1114, - 960, - 968, - 1012, - 959, - 961, - 1017, - 1018, - 962, - 1108, + 1163, + 1162, + 1164, + 1006, 1014, - 1015, - 1016, - 1013, - 1109 + 1062, + 1005, + 1007, + 1067, + 1068, + 1008, + 1158, + 1064, + 1065, + 1066, + 1063, + 1159, + 986 ] }, { "title": "Accessors", "children": [ - 1110 + 1160 ] }, { "title": "Methods", "children": [ - 1061, - 1123, + 1111, + 1173, + 1126, + 1154, + 1084, + 1103, + 1119, + 1107, + 1135, + 1144, + 1141, + 1138, + 1147, + 1150, 1076, - 1104, - 1034, - 1053, - 1069, - 1057, - 1085, - 1094, + 1080, + 1095, + 1115, + 1087, 1091, - 1088, - 1097, - 1100, - 1026, - 1030, - 1045, - 1065, - 1037, - 1041, - 1118, - 1049, - 1081, - 1072, - 1019, - 1115 + 1168, + 1099, + 1131, + 1122, + 1069, + 1165 ] } ], @@ -26902,7 +28253,7 @@ ] }, { - "id": 1243, + "id": 1297, "name": "DraftOrderService", "variant": "declaration", "kind": 128, @@ -26923,21 +28274,21 @@ }, "children": [ { - "id": 1248, + "id": 1302, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1249, + "id": 1303, "name": "new DraftOrderService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1250, + "id": 1304, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -26955,7 +28306,7 @@ ], "type": { "type": "reference", - "target": 1243, + "target": 1297, "name": "DraftOrderService", "package": "@medusajs/medusa" }, @@ -26973,7 +28324,7 @@ } }, { - "id": 1306, + "id": 1360, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -27008,7 +28359,7 @@ } }, { - "id": 1305, + "id": 1359, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -27027,7 +28378,7 @@ } }, { - "id": 1307, + "id": 1361, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -27062,7 +28413,7 @@ } }, { - "id": 1264, + "id": 1318, "name": "cartService_", "variant": "declaration", "kind": 1024, @@ -27072,13 +28423,13 @@ }, "type": { "type": "reference", - "target": 198, + "target": 199, "name": "CartService", "package": "@medusajs/medusa" } }, { - "id": 1268, + "id": 1322, "name": "customShippingOptionService_", "variant": "declaration", "kind": 1024, @@ -27088,13 +28439,13 @@ }, "type": { "type": "reference", - "target": 689, + "target": 696, "name": "CustomShippingOptionService", "package": "@medusajs/medusa" } }, { - "id": 1251, + "id": 1305, "name": "draftOrderRepository_", "variant": "declaration", "kind": 1024, @@ -27124,7 +28475,7 @@ } }, { - "id": 1263, + "id": 1317, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -27134,13 +28485,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 1265, + "id": 1319, "name": "lineItemService_", "variant": "declaration", "kind": 1024, @@ -27150,13 +28501,13 @@ }, "type": { "type": "reference", - "target": 1713, + "target": 1767, "name": "LineItemService", "package": "@medusajs/medusa" } }, { - "id": 1301, + "id": 1355, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -27179,7 +28530,7 @@ } }, { - "id": 1253, + "id": 1307, "name": "orderRepository_", "variant": "declaration", "kind": 1024, @@ -27213,28 +28564,28 @@ { "type": "reflection", "declaration": { - "id": 1254, + "id": 1308, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1259, + "id": 1313, "name": "findOneWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1260, + "id": 1314, "name": "findOneWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1261, + "id": 1315, "name": "relations", "variant": "param", "kind": 32768, @@ -27262,7 +28613,7 @@ "defaultValue": "{}" }, { - "id": 1262, + "id": 1316, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -27329,21 +28680,21 @@ ] }, { - "id": 1255, + "id": 1309, "name": "findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1256, + "id": 1310, "name": "findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1257, + "id": 1311, "name": "relations", "variant": "param", "kind": 32768, @@ -27371,7 +28722,7 @@ "defaultValue": "{}" }, { - "id": 1258, + "id": 1312, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -27445,8 +28796,8 @@ { "title": "Methods", "children": [ - 1259, - 1255 + 1313, + 1309 ] } ] @@ -27456,7 +28807,7 @@ } }, { - "id": 1252, + "id": 1306, "name": "paymentRepository_", "variant": "declaration", "kind": 1024, @@ -27486,7 +28837,7 @@ } }, { - "id": 1266, + "id": 1320, "name": "productVariantService_", "variant": "declaration", "kind": 1024, @@ -27496,13 +28847,13 @@ }, "type": { "type": "reference", - "target": 4076, + "target": 4150, "name": "ProductVariantService", "package": "@medusajs/medusa" } }, { - "id": 1267, + "id": 1321, "name": "shippingOptionService_", "variant": "declaration", "kind": 1024, @@ -27512,13 +28863,13 @@ }, "type": { "type": "reference", - "target": 5056, + "target": 5163, "name": "ShippingOptionService", "package": "@medusajs/medusa" } }, { - "id": 1302, + "id": 1356, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -27550,7 +28901,7 @@ } }, { - "id": 1244, + "id": 1298, "name": "Events", "variant": "declaration", "kind": 1024, @@ -27561,14 +28912,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1245, + "id": 1299, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1246, + "id": 1300, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -27580,7 +28931,7 @@ "defaultValue": "\"draft_order.created\"" }, { - "id": 1247, + "id": 1301, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -27596,8 +28947,8 @@ { "title": "Properties", "children": [ - 1246, - 1247 + 1300, + 1301 ] } ] @@ -27606,7 +28957,7 @@ "defaultValue": "..." }, { - "id": 1303, + "id": 1357, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -27614,7 +28965,7 @@ "isProtected": true }, "getSignature": { - "id": 1304, + "id": 1358, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -27641,7 +28992,7 @@ } }, { - "id": 1316, + "id": 1370, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -27650,7 +29001,7 @@ }, "signatures": [ { - "id": 1317, + "id": 1371, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -27676,14 +29027,14 @@ }, "typeParameter": [ { - "id": 1318, + "id": 1372, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 1319, + "id": 1373, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -27692,7 +29043,7 @@ ], "parameters": [ { - "id": 1320, + "id": 1374, "name": "work", "variant": "param", "kind": 32768, @@ -27708,21 +29059,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1321, + "id": 1375, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1322, + "id": 1376, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1323, + "id": 1377, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -27761,7 +29112,7 @@ } }, { - "id": 1324, + "id": 1378, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -27791,21 +29142,21 @@ { "type": "reflection", "declaration": { - "id": 1325, + "id": 1379, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1326, + "id": 1380, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1327, + "id": 1381, "name": "error", "variant": "param", "kind": 32768, @@ -27852,7 +29203,7 @@ } }, { - "id": 1328, + "id": 1382, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -27870,21 +29221,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1329, + "id": 1383, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1330, + "id": 1384, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1331, + "id": 1385, "name": "error", "variant": "param", "kind": 32768, @@ -27960,14 +29311,14 @@ } }, { - "id": 1288, + "id": 1342, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1289, + "id": 1343, "name": "create", "variant": "signature", "kind": 4096, @@ -27993,7 +29344,7 @@ }, "parameters": [ { - "id": 1290, + "id": 1344, "name": "data", "variant": "param", "kind": 32768, @@ -28041,14 +29392,14 @@ ] }, { - "id": 1277, + "id": 1331, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1278, + "id": 1332, "name": "delete", "variant": "signature", "kind": 4096, @@ -28074,7 +29425,7 @@ }, "parameters": [ { - "id": 1279, + "id": 1333, "name": "draftOrderId", "variant": "param", "kind": 32768, @@ -28126,14 +29477,14 @@ ] }, { - "id": 1284, + "id": 1338, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1285, + "id": 1339, "name": "list", "variant": "signature", "kind": 4096, @@ -28159,7 +29510,7 @@ }, "parameters": [ { - "id": 1286, + "id": 1340, "name": "selector", "variant": "param", "kind": 32768, @@ -28178,7 +29529,7 @@ } }, { - "id": 1287, + "id": 1341, "name": "config", "variant": "param", "kind": 32768, @@ -28241,14 +29592,14 @@ ] }, { - "id": 1280, + "id": 1334, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1281, + "id": 1335, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -28274,7 +29625,7 @@ }, "parameters": [ { - "id": 1282, + "id": 1336, "name": "selector", "variant": "param", "kind": 32768, @@ -28293,7 +29644,7 @@ } }, { - "id": 1283, + "id": 1337, "name": "config", "variant": "param", "kind": 32768, @@ -28365,14 +29716,14 @@ ] }, { - "id": 1291, + "id": 1345, "name": "registerCartCompletion", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1292, + "id": 1346, "name": "registerCartCompletion", "variant": "signature", "kind": 4096, @@ -28398,7 +29749,7 @@ }, "parameters": [ { - "id": 1293, + "id": 1347, "name": "draftOrderId", "variant": "param", "kind": 32768, @@ -28417,7 +29768,7 @@ } }, { - "id": 1294, + "id": 1348, "name": "orderId", "variant": "param", "kind": 32768, @@ -28460,14 +29811,14 @@ ] }, { - "id": 1269, + "id": 1323, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1270, + "id": 1324, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -28493,7 +29844,7 @@ }, "parameters": [ { - "id": 1271, + "id": 1325, "name": "draftOrderId", "variant": "param", "kind": 32768, @@ -28512,7 +29863,7 @@ } }, { - "id": 1272, + "id": 1326, "name": "config", "variant": "param", "kind": 32768, @@ -28572,14 +29923,14 @@ ] }, { - "id": 1273, + "id": 1327, "name": "retrieveByCartId", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1274, + "id": 1328, "name": "retrieveByCartId", "variant": "signature", "kind": 4096, @@ -28605,7 +29956,7 @@ }, "parameters": [ { - "id": 1275, + "id": 1329, "name": "cartId", "variant": "param", "kind": 32768, @@ -28624,7 +29975,7 @@ } }, { - "id": 1276, + "id": 1330, "name": "config", "variant": "param", "kind": 32768, @@ -28684,7 +30035,7 @@ ] }, { - "id": 1311, + "id": 1365, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -28693,14 +30044,14 @@ }, "signatures": [ { - "id": 1312, + "id": 1366, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1313, + "id": 1367, "name": "err", "variant": "param", "kind": 32768, @@ -28730,14 +30081,14 @@ { "type": "reflection", "declaration": { - "id": 1314, + "id": 1368, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1315, + "id": 1369, "name": "code", "variant": "declaration", "kind": 1024, @@ -28752,7 +30103,7 @@ { "title": "Properties", "children": [ - 1315 + 1369 ] } ] @@ -28780,14 +30131,14 @@ } }, { - "id": 1295, + "id": 1349, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1296, + "id": 1350, "name": "update", "variant": "signature", "kind": 4096, @@ -28813,7 +30164,7 @@ }, "parameters": [ { - "id": 1297, + "id": 1351, "name": "id", "variant": "param", "kind": 32768, @@ -28832,7 +30183,7 @@ } }, { - "id": 1298, + "id": 1352, "name": "data", "variant": "param", "kind": 32768, @@ -28848,14 +30199,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1299, + "id": 1353, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1300, + "id": 1354, "name": "no_notification_order", "variant": "declaration", "kind": 1024, @@ -28870,7 +30221,7 @@ { "title": "Properties", "children": [ - 1300 + 1354 ] } ] @@ -28902,21 +30253,21 @@ ] }, { - "id": 1308, + "id": 1362, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1309, + "id": 1363, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1310, + "id": 1364, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -28936,7 +30287,7 @@ ], "type": { "type": "reference", - "target": 1243, + "target": 1297, "name": "DraftOrderService", "package": "@medusajs/medusa" }, @@ -28958,49 +30309,49 @@ { "title": "Constructors", "children": [ - 1248 + 1302 ] }, { "title": "Properties", "children": [ - 1306, + 1360, + 1359, + 1361, + 1318, + 1322, 1305, + 1317, + 1319, + 1355, 1307, - 1264, - 1268, - 1251, - 1263, - 1265, - 1301, - 1253, - 1252, - 1266, - 1267, - 1302, - 1244 + 1306, + 1320, + 1321, + 1356, + 1298 ] }, { "title": "Accessors", "children": [ - 1303 + 1357 ] }, { "title": "Methods", "children": [ - 1316, - 1288, - 1277, - 1284, - 1280, - 1291, - 1269, - 1273, - 1311, - 1295, - 1308 + 1370, + 1342, + 1331, + 1338, + 1334, + 1345, + 1323, + 1327, + 1365, + 1349, + 1362 ] } ], @@ -29017,7 +30368,7 @@ ] }, { - "id": 1332, + "id": 1386, "name": "EventBusService", "variant": "declaration", "kind": 128, @@ -29032,21 +30383,21 @@ }, "children": [ { - "id": 1333, + "id": 1387, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1334, + "id": 1388, "name": "new EventBusService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1335, + "id": 1389, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -29062,7 +30413,7 @@ } }, { - "id": 1336, + "id": 1390, "name": "config", "variant": "param", "kind": 32768, @@ -29073,7 +30424,7 @@ } }, { - "id": 1337, + "id": 1391, "name": "isSingleton", "variant": "param", "kind": 32768, @@ -29087,7 +30438,7 @@ ], "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" }, @@ -29105,7 +30456,7 @@ } }, { - "id": 1381, + "id": 1435, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -29140,7 +30491,7 @@ } }, { - "id": 1380, + "id": 1434, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -29159,7 +30510,7 @@ } }, { - "id": 1382, + "id": 1436, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -29194,7 +30545,7 @@ } }, { - "id": 1338, + "id": 1392, "name": "config_", "variant": "declaration", "kind": 1024, @@ -29213,7 +30564,7 @@ } }, { - "id": 1344, + "id": 1398, "name": "enqueue_", "variant": "declaration", "kind": 1024, @@ -29237,7 +30588,7 @@ } }, { - "id": 1342, + "id": 1396, "name": "logger_", "variant": "declaration", "kind": 1024, @@ -29256,7 +30607,7 @@ } }, { - "id": 1376, + "id": 1430, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -29279,7 +30630,7 @@ } }, { - "id": 1343, + "id": 1397, "name": "shouldEnqueuerRun", "variant": "declaration", "kind": 1024, @@ -29292,7 +30643,7 @@ } }, { - "id": 1339, + "id": 1393, "name": "stagedJobService_", "variant": "declaration", "kind": 1024, @@ -29302,13 +30653,13 @@ }, "type": { "type": "reference", - "target": 5343, + "target": 5455, "name": "StagedJobService", "package": "@medusajs/medusa" } }, { - "id": 1377, + "id": 1431, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -29340,7 +30691,7 @@ } }, { - "id": 1378, + "id": 1432, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -29348,7 +30699,7 @@ "isProtected": true }, "getSignature": { - "id": 1379, + "id": 1433, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -29375,7 +30726,7 @@ } }, { - "id": 1340, + "id": 1394, "name": "eventBusModuleService_", "variant": "declaration", "kind": 262144, @@ -29383,7 +30734,7 @@ "isProtected": true }, "getSignature": { - "id": 1341, + "id": 1395, "name": "eventBusModuleService_", "variant": "signature", "kind": 524288, @@ -29400,7 +30751,7 @@ } }, { - "id": 1388, + "id": 1442, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -29409,7 +30760,7 @@ }, "signatures": [ { - "id": 1389, + "id": 1443, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -29435,14 +30786,14 @@ }, "typeParameter": [ { - "id": 1390, + "id": 1444, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 1391, + "id": 1445, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -29451,7 +30802,7 @@ ], "parameters": [ { - "id": 1392, + "id": 1446, "name": "work", "variant": "param", "kind": 32768, @@ -29467,21 +30818,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1393, + "id": 1447, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1394, + "id": 1448, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1395, + "id": 1449, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -29520,7 +30871,7 @@ } }, { - "id": 1396, + "id": 1450, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -29550,21 +30901,21 @@ { "type": "reflection", "declaration": { - "id": 1397, + "id": 1451, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1398, + "id": 1452, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1399, + "id": 1453, "name": "error", "variant": "param", "kind": 32768, @@ -29611,7 +30962,7 @@ } }, { - "id": 1400, + "id": 1454, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -29629,21 +30980,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1401, + "id": 1455, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1402, + "id": 1456, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1403, + "id": 1457, "name": "error", "variant": "param", "kind": 32768, @@ -29719,14 +31070,14 @@ } }, { - "id": 1358, + "id": 1412, "name": "emit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1359, + "id": 1413, "name": "emit", "variant": "signature", "kind": 4096, @@ -29752,7 +31103,7 @@ }, "typeParameter": [ { - "id": 1360, + "id": 1414, "name": "T", "variant": "typeParam", "kind": 131072, @@ -29761,7 +31112,7 @@ ], "parameters": [ { - "id": 1361, + "id": 1415, "name": "data", "variant": "param", "kind": 32768, @@ -29835,7 +31186,7 @@ } }, { - "id": 1362, + "id": 1416, "name": "emit", "variant": "signature", "kind": 4096, @@ -29861,7 +31212,7 @@ }, "typeParameter": [ { - "id": 1363, + "id": 1417, "name": "T", "variant": "typeParam", "kind": 131072, @@ -29870,7 +31221,7 @@ ], "parameters": [ { - "id": 1364, + "id": 1418, "name": "eventName", "variant": "param", "kind": 32768, @@ -29889,7 +31240,7 @@ } }, { - "id": 1365, + "id": 1419, "name": "data", "variant": "param", "kind": 32768, @@ -29910,7 +31261,7 @@ } }, { - "id": 1366, + "id": 1420, "name": "options", "variant": "param", "kind": 32768, @@ -29989,14 +31340,14 @@ } }, { - "id": 1371, + "id": 1425, "name": "enqueuer_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1372, + "id": 1426, "name": "enqueuer_", "variant": "signature", "kind": 4096, @@ -30020,7 +31371,7 @@ ] }, { - "id": 1373, + "id": 1427, "name": "listJobs", "variant": "declaration", "kind": 2048, @@ -30029,14 +31380,14 @@ }, "signatures": [ { - "id": 1374, + "id": 1428, "name": "listJobs", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1375, + "id": 1429, "name": "listConfig", "variant": "param", "kind": 32768, @@ -30102,7 +31453,7 @@ ] }, { - "id": 1383, + "id": 1437, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -30111,14 +31462,14 @@ }, "signatures": [ { - "id": 1384, + "id": 1438, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1385, + "id": 1439, "name": "err", "variant": "param", "kind": 32768, @@ -30148,14 +31499,14 @@ { "type": "reflection", "declaration": { - "id": 1386, + "id": 1440, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1387, + "id": 1441, "name": "code", "variant": "declaration", "kind": 1024, @@ -30170,7 +31521,7 @@ { "title": "Properties", "children": [ - 1387 + 1441 ] } ] @@ -30198,14 +31549,14 @@ } }, { - "id": 1367, + "id": 1421, "name": "startEnqueuer", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1368, + "id": 1422, "name": "startEnqueuer", "variant": "signature", "kind": 4096, @@ -30218,14 +31569,14 @@ ] }, { - "id": 1369, + "id": 1423, "name": "stopEnqueuer", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1370, + "id": 1424, "name": "stopEnqueuer", "variant": "signature", "kind": 4096, @@ -30249,14 +31600,14 @@ ] }, { - "id": 1348, + "id": 1402, "name": "subscribe", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1349, + "id": 1403, "name": "subscribe", "variant": "signature", "kind": 4096, @@ -30282,7 +31633,7 @@ }, "parameters": [ { - "id": 1350, + "id": 1404, "name": "event", "variant": "param", "kind": 32768, @@ -30310,7 +31661,7 @@ } }, { - "id": 1351, + "id": 1405, "name": "subscriber", "variant": "param", "kind": 32768, @@ -30340,7 +31691,7 @@ } }, { - "id": 1352, + "id": 1406, "name": "context", "variant": "param", "kind": 32768, @@ -30368,7 +31719,7 @@ ], "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" }, @@ -30386,14 +31737,14 @@ } }, { - "id": 1353, + "id": 1407, "name": "unsubscribe", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1354, + "id": 1408, "name": "unsubscribe", "variant": "signature", "kind": 4096, @@ -30419,7 +31770,7 @@ }, "parameters": [ { - "id": 1355, + "id": 1409, "name": "event", "variant": "param", "kind": 32768, @@ -30447,7 +31798,7 @@ } }, { - "id": 1356, + "id": 1410, "name": "subscriber", "variant": "param", "kind": 32768, @@ -30477,7 +31828,7 @@ } }, { - "id": 1357, + "id": 1411, "name": "context", "variant": "param", "kind": 32768, @@ -30503,7 +31854,7 @@ ], "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" }, @@ -30521,21 +31872,21 @@ } }, { - "id": 1345, + "id": 1399, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1346, + "id": 1400, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1347, + "id": 1401, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -30555,7 +31906,7 @@ ], "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" }, @@ -30587,44 +31938,44 @@ { "title": "Constructors", "children": [ - 1333 + 1387 ] }, { "title": "Properties", "children": [ - 1381, - 1380, - 1382, - 1338, - 1344, - 1342, - 1376, - 1343, - 1339, - 1377 + 1435, + 1434, + 1436, + 1392, + 1398, + 1396, + 1430, + 1397, + 1393, + 1431 ] }, { "title": "Accessors", "children": [ - 1378, - 1340 + 1432, + 1394 ] }, { "title": "Methods", "children": [ - 1388, - 1358, - 1371, - 1373, - 1383, - 1367, - 1369, - 1348, - 1353, - 1345 + 1442, + 1412, + 1425, + 1427, + 1437, + 1421, + 1423, + 1402, + 1407, + 1399 ] } ], @@ -30652,7 +32003,7 @@ ] }, { - "id": 1484, + "id": 1538, "name": "FulfillmentProviderService", "variant": "declaration", "kind": 128, @@ -30667,21 +32018,21 @@ }, "children": [ { - "id": 1485, + "id": 1539, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1486, + "id": 1540, "name": "new FulfillmentProviderService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1487, + "id": 1541, "name": "container", "variant": "param", "kind": 32768, @@ -30699,7 +32050,7 @@ ], "type": { "type": "reference", - "target": 1484, + "target": 1538, "name": "FulfillmentProviderService", "package": "@medusajs/medusa" }, @@ -30717,7 +32068,7 @@ } }, { - "id": 1539, + "id": 1593, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -30752,7 +32103,7 @@ } }, { - "id": 1538, + "id": 1592, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -30771,7 +32122,7 @@ } }, { - "id": 1540, + "id": 1594, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -30806,7 +32157,7 @@ } }, { - "id": 1488, + "id": 1542, "name": "container_", "variant": "declaration", "kind": 1024, @@ -30825,7 +32176,7 @@ } }, { - "id": 1489, + "id": 1543, "name": "fulfillmentProviderRepository_", "variant": "declaration", "kind": 1024, @@ -30855,7 +32206,7 @@ } }, { - "id": 1534, + "id": 1588, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -30878,7 +32229,7 @@ } }, { - "id": 1535, + "id": 1589, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -30910,7 +32261,7 @@ } }, { - "id": 1536, + "id": 1590, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -30918,7 +32269,7 @@ "isProtected": true }, "getSignature": { - "id": 1537, + "id": 1591, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -30945,7 +32296,7 @@ } }, { - "id": 1549, + "id": 1603, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -30954,7 +32305,7 @@ }, "signatures": [ { - "id": 1550, + "id": 1604, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -30980,14 +32331,14 @@ }, "typeParameter": [ { - "id": 1551, + "id": 1605, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 1552, + "id": 1606, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -30996,7 +32347,7 @@ ], "parameters": [ { - "id": 1553, + "id": 1607, "name": "work", "variant": "param", "kind": 32768, @@ -31012,21 +32363,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1554, + "id": 1608, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1555, + "id": 1609, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1556, + "id": 1610, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -31065,7 +32416,7 @@ } }, { - "id": 1557, + "id": 1611, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -31095,21 +32446,21 @@ { "type": "reflection", "declaration": { - "id": 1558, + "id": 1612, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1559, + "id": 1613, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1560, + "id": 1614, "name": "error", "variant": "param", "kind": 32768, @@ -31156,7 +32507,7 @@ } }, { - "id": 1561, + "id": 1615, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -31174,21 +32525,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1562, + "id": 1616, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1563, + "id": 1617, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1564, + "id": 1618, "name": "error", "variant": "param", "kind": 32768, @@ -31264,21 +32615,21 @@ } }, { - "id": 1518, + "id": 1572, "name": "calculatePrice", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1519, + "id": 1573, "name": "calculatePrice", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1520, + "id": 1574, "name": "option", "variant": "param", "kind": 32768, @@ -31294,7 +32645,7 @@ } }, { - "id": 1521, + "id": 1575, "name": "data", "variant": "param", "kind": 32768, @@ -31320,7 +32671,7 @@ } }, { - "id": 1522, + "id": 1576, "name": "cart", "variant": "param", "kind": 32768, @@ -31371,21 +32722,21 @@ ] }, { - "id": 1507, + "id": 1561, "name": "canCalculate", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1508, + "id": 1562, "name": "canCalculate", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1509, + "id": 1563, "name": "option", "variant": "param", "kind": 32768, @@ -31420,21 +32771,21 @@ ] }, { - "id": 1515, + "id": 1569, "name": "cancelFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1516, + "id": 1570, "name": "cancelFulfillment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1517, + "id": 1571, "name": "fulfillment", "variant": "param", "kind": 32768, @@ -31474,21 +32825,21 @@ ] }, { - "id": 1501, + "id": 1555, "name": "createFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1502, + "id": 1556, "name": "createFulfillment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1503, + "id": 1557, "name": "method", "variant": "param", "kind": 32768, @@ -31504,7 +32855,7 @@ } }, { - "id": 1504, + "id": 1558, "name": "items", "variant": "param", "kind": 32768, @@ -31523,7 +32874,7 @@ } }, { - "id": 1505, + "id": 1559, "name": "order", "variant": "param", "kind": 32768, @@ -31539,7 +32890,7 @@ } }, { - "id": 1506, + "id": 1560, "name": "fulfillment", "variant": "param", "kind": 32768, @@ -31604,21 +32955,21 @@ ] }, { - "id": 1526, + "id": 1580, "name": "createReturn", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1527, + "id": 1581, "name": "createReturn", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1528, + "id": 1582, "name": "returnOrder", "variant": "param", "kind": 32768, @@ -31668,14 +33019,14 @@ ] }, { - "id": 1493, + "id": 1547, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1494, + "id": 1548, "name": "list", "variant": "signature", "kind": 4096, @@ -31707,21 +33058,21 @@ ] }, { - "id": 1495, + "id": 1549, "name": "listFulfillmentOptions", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1496, + "id": 1550, "name": "listFulfillmentOptions", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1497, + "id": 1551, "name": "providerIds", "variant": "param", "kind": 32768, @@ -31762,21 +33113,21 @@ ] }, { - "id": 1490, + "id": 1544, "name": "registerInstalledProviders", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1491, + "id": 1545, "name": "registerInstalledProviders", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1492, + "id": 1546, "name": "providers", "variant": "param", "kind": 32768, @@ -31809,14 +33160,14 @@ ] }, { - "id": 1529, + "id": 1583, "name": "retrieveDocuments", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1530, + "id": 1584, "name": "retrieveDocuments", "variant": "signature", "kind": 4096, @@ -31842,7 +33193,7 @@ }, "parameters": [ { - "id": 1531, + "id": 1585, "name": "providerId", "variant": "param", "kind": 32768, @@ -31861,7 +33212,7 @@ } }, { - "id": 1532, + "id": 1586, "name": "fulfillmentData", "variant": "param", "kind": 32768, @@ -31895,7 +33246,7 @@ } }, { - "id": 1533, + "id": 1587, "name": "documentType", "variant": "param", "kind": 32768, @@ -31942,14 +33293,14 @@ ] }, { - "id": 1498, + "id": 1552, "name": "retrieveProvider", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1499, + "id": 1553, "name": "retrieveProvider", "variant": "signature", "kind": 4096, @@ -31970,7 +33321,7 @@ }, "parameters": [ { - "id": 1500, + "id": 1554, "name": "providerId", "variant": "param", "kind": 32768, @@ -31997,7 +33348,7 @@ ] }, { - "id": 1544, + "id": 1598, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -32006,14 +33357,14 @@ }, "signatures": [ { - "id": 1545, + "id": 1599, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1546, + "id": 1600, "name": "err", "variant": "param", "kind": 32768, @@ -32043,14 +33394,14 @@ { "type": "reflection", "declaration": { - "id": 1547, + "id": 1601, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1548, + "id": 1602, "name": "code", "variant": "declaration", "kind": 1024, @@ -32065,7 +33416,7 @@ { "title": "Properties", "children": [ - 1548 + 1602 ] } ] @@ -32093,21 +33444,21 @@ } }, { - "id": 1510, + "id": 1564, "name": "validateFulfillmentData", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1511, + "id": 1565, "name": "validateFulfillmentData", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1512, + "id": 1566, "name": "option", "variant": "param", "kind": 32768, @@ -32123,7 +33474,7 @@ } }, { - "id": 1513, + "id": 1567, "name": "data", "variant": "param", "kind": 32768, @@ -32149,7 +33500,7 @@ } }, { - "id": 1514, + "id": 1568, "name": "cart", "variant": "param", "kind": 32768, @@ -32223,21 +33574,21 @@ ] }, { - "id": 1523, + "id": 1577, "name": "validateOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1524, + "id": 1578, "name": "validateOption", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1525, + "id": 1579, "name": "option", "variant": "param", "kind": 32768, @@ -32272,21 +33623,21 @@ ] }, { - "id": 1541, + "id": 1595, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1542, + "id": 1596, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1543, + "id": 1597, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -32306,7 +33657,7 @@ ], "type": { "type": "reference", - "target": 1484, + "target": 1538, "name": "FulfillmentProviderService", "package": "@medusajs/medusa" }, @@ -32328,45 +33679,45 @@ { "title": "Constructors", "children": [ - 1485 + 1539 ] }, { "title": "Properties", "children": [ - 1539, - 1538, - 1540, - 1488, - 1489, - 1534, - 1535 + 1593, + 1592, + 1594, + 1542, + 1543, + 1588, + 1589 ] }, { "title": "Accessors", "children": [ - 1536 + 1590 ] }, { "title": "Methods", "children": [ + 1603, + 1572, + 1561, + 1569, + 1555, + 1580, + 1547, 1549, - 1518, - 1507, - 1515, - 1501, - 1526, - 1493, - 1495, - 1490, - 1529, - 1498, 1544, - 1510, - 1523, - 1541 + 1583, + 1552, + 1598, + 1564, + 1577, + 1595 ] } ], @@ -32383,7 +33734,7 @@ ] }, { - "id": 1404, + "id": 1458, "name": "FulfillmentService", "variant": "declaration", "kind": 128, @@ -32398,21 +33749,21 @@ }, "children": [ { - "id": 1405, + "id": 1459, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1406, + "id": 1460, "name": "new FulfillmentService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1407, + "id": 1461, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -32430,7 +33781,7 @@ ], "type": { "type": "reference", - "target": 1404, + "target": 1458, "name": "FulfillmentService", "package": "@medusajs/medusa" }, @@ -32448,7 +33799,7 @@ } }, { - "id": 1458, + "id": 1512, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -32483,7 +33834,7 @@ } }, { - "id": 1457, + "id": 1511, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -32502,7 +33853,7 @@ } }, { - "id": 1459, + "id": 1513, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -32537,7 +33888,7 @@ } }, { - "id": 1411, + "id": 1465, "name": "fulfillmentProviderService_", "variant": "declaration", "kind": 1024, @@ -32547,13 +33898,13 @@ }, "type": { "type": "reference", - "target": 1484, + "target": 1538, "name": "FulfillmentProviderService", "package": "@medusajs/medusa" } }, { - "id": 1412, + "id": 1466, "name": "fulfillmentRepository_", "variant": "declaration", "kind": 1024, @@ -32583,7 +33934,7 @@ } }, { - "id": 1414, + "id": 1468, "name": "lineItemRepository_", "variant": "declaration", "kind": 1024, @@ -32617,21 +33968,21 @@ { "type": "reflection", "declaration": { - "id": 1415, + "id": 1469, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1416, + "id": 1470, "name": "findByReturn", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1417, + "id": 1471, "name": "findByReturn", "variant": "signature", "kind": 4096, @@ -32673,7 +34024,7 @@ }, "parameters": [ { - "id": 1418, + "id": 1472, "name": "returnId", "variant": "param", "kind": 32768, @@ -32716,14 +34067,14 @@ { "type": "reflection", "declaration": { - "id": 1419, + "id": 1473, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1420, + "id": 1474, "name": "return_item", "variant": "declaration", "kind": 1024, @@ -32743,7 +34094,7 @@ { "title": "Properties", "children": [ - 1420 + 1474 ] } ] @@ -32764,7 +34115,7 @@ { "title": "Methods", "children": [ - 1416 + 1470 ] } ] @@ -32774,7 +34125,7 @@ } }, { - "id": 1409, + "id": 1463, "name": "lineItemService_", "variant": "declaration", "kind": 1024, @@ -32784,13 +34135,13 @@ }, "type": { "type": "reference", - "target": 1713, + "target": 1767, "name": "LineItemService", "package": "@medusajs/medusa" } }, { - "id": 1453, + "id": 1507, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -32813,7 +34164,7 @@ } }, { - "id": 1421, + "id": 1475, "name": "productVariantInventoryService_", "variant": "declaration", "kind": 1024, @@ -32823,13 +34174,13 @@ }, "type": { "type": "reference", - "target": 4409, + "target": 4497, "name": "ProductVariantInventoryService", "package": "@medusajs/medusa" } }, { - "id": 1410, + "id": 1464, "name": "shippingProfileService_", "variant": "declaration", "kind": 1024, @@ -32839,13 +34190,13 @@ }, "type": { "type": "reference", - "target": 5168, + "target": 5275, "name": "ShippingProfileService", "package": "@medusajs/medusa" } }, { - "id": 1408, + "id": 1462, "name": "totalsService_", "variant": "declaration", "kind": 1024, @@ -32855,13 +34206,13 @@ }, "type": { "type": "reference", - "target": 5964, + "target": 6081, "name": "TotalsService", "package": "@medusajs/medusa" } }, { - "id": 1413, + "id": 1467, "name": "trackingLinkRepository_", "variant": "declaration", "kind": 1024, @@ -32891,7 +34242,7 @@ } }, { - "id": 1454, + "id": 1508, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -32923,7 +34274,7 @@ } }, { - "id": 1455, + "id": 1509, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -32931,7 +34282,7 @@ "isProtected": true }, "getSignature": { - "id": 1456, + "id": 1510, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -32958,7 +34309,7 @@ } }, { - "id": 1468, + "id": 1522, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -32967,7 +34318,7 @@ }, "signatures": [ { - "id": 1469, + "id": 1523, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -32993,14 +34344,14 @@ }, "typeParameter": [ { - "id": 1470, + "id": 1524, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 1471, + "id": 1525, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -33009,7 +34360,7 @@ ], "parameters": [ { - "id": 1472, + "id": 1526, "name": "work", "variant": "param", "kind": 32768, @@ -33025,21 +34376,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1473, + "id": 1527, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1474, + "id": 1528, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1475, + "id": 1529, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -33078,7 +34429,7 @@ } }, { - "id": 1476, + "id": 1530, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -33108,21 +34459,21 @@ { "type": "reflection", "declaration": { - "id": 1477, + "id": 1531, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1478, + "id": 1532, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1479, + "id": 1533, "name": "error", "variant": "param", "kind": 32768, @@ -33169,7 +34520,7 @@ } }, { - "id": 1480, + "id": 1534, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -33187,21 +34538,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1481, + "id": 1535, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1482, + "id": 1536, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1483, + "id": 1537, "name": "error", "variant": "param", "kind": 32768, @@ -33277,14 +34628,14 @@ } }, { - "id": 1443, + "id": 1497, "name": "cancelFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1444, + "id": 1498, "name": "cancelFulfillment", "variant": "signature", "kind": 4096, @@ -33310,7 +34661,7 @@ }, "parameters": [ { - "id": 1445, + "id": 1499, "name": "fulfillmentOrId", "variant": "param", "kind": 32768, @@ -33367,14 +34718,14 @@ ] }, { - "id": 1438, + "id": 1492, "name": "createFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1439, + "id": 1493, "name": "createFulfillment", "variant": "signature", "kind": 4096, @@ -33400,7 +34751,7 @@ }, "parameters": [ { - "id": 1440, + "id": 1494, "name": "order", "variant": "param", "kind": 32768, @@ -33424,7 +34775,7 @@ } }, { - "id": 1441, + "id": 1495, "name": "itemsToFulfill", "variant": "param", "kind": 32768, @@ -33451,7 +34802,7 @@ } }, { - "id": 1442, + "id": 1496, "name": "custom", "variant": "param", "kind": 32768, @@ -33514,14 +34865,14 @@ ] }, { - "id": 1446, + "id": 1500, "name": "createShipment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1447, + "id": 1501, "name": "createShipment", "variant": "signature", "kind": 4096, @@ -33547,7 +34898,7 @@ }, "parameters": [ { - "id": 1448, + "id": 1502, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -33566,7 +34917,7 @@ } }, { - "id": 1449, + "id": 1503, "name": "trackingLinks", "variant": "param", "kind": 32768, @@ -33586,14 +34937,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 1450, + "id": 1504, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1451, + "id": 1505, "name": "tracking_number", "variant": "declaration", "kind": 1024, @@ -33608,7 +34959,7 @@ { "title": "Properties", "children": [ - 1451 + 1505 ] } ] @@ -33617,7 +34968,7 @@ } }, { - "id": 1452, + "id": 1506, "name": "config", "variant": "param", "kind": 32768, @@ -33666,14 +35017,14 @@ ] }, { - "id": 1426, + "id": 1480, "name": "getFulfillmentItems_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1427, + "id": 1481, "name": "getFulfillmentItems_", "variant": "signature", "kind": 4096, @@ -33699,7 +35050,7 @@ }, "parameters": [ { - "id": 1428, + "id": 1482, "name": "order", "variant": "param", "kind": 32768, @@ -33723,7 +35074,7 @@ } }, { - "id": 1429, + "id": 1483, "name": "items", "variant": "param", "kind": 32768, @@ -33786,21 +35137,21 @@ ] }, { - "id": 1422, + "id": 1476, "name": "partitionItems_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1423, + "id": 1477, "name": "partitionItems_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1424, + "id": 1478, "name": "shippingMethods", "variant": "param", "kind": 32768, @@ -33819,7 +35170,7 @@ } }, { - "id": 1425, + "id": 1479, "name": "items", "variant": "param", "kind": 32768, @@ -33854,14 +35205,14 @@ ] }, { - "id": 1434, + "id": 1488, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1435, + "id": 1489, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -33887,7 +35238,7 @@ }, "parameters": [ { - "id": 1436, + "id": 1490, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -33906,7 +35257,7 @@ } }, { - "id": 1437, + "id": 1491, "name": "config", "variant": "param", "kind": 32768, @@ -33966,7 +35317,7 @@ ] }, { - "id": 1463, + "id": 1517, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -33975,14 +35326,14 @@ }, "signatures": [ { - "id": 1464, + "id": 1518, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1465, + "id": 1519, "name": "err", "variant": "param", "kind": 32768, @@ -34012,14 +35363,14 @@ { "type": "reflection", "declaration": { - "id": 1466, + "id": 1520, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1467, + "id": 1521, "name": "code", "variant": "declaration", "kind": 1024, @@ -34034,7 +35385,7 @@ { "title": "Properties", "children": [ - 1467 + 1521 ] } ] @@ -34062,14 +35413,14 @@ } }, { - "id": 1430, + "id": 1484, "name": "validateFulfillmentLineItem_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1431, + "id": 1485, "name": "validateFulfillmentLineItem_", "variant": "signature", "kind": 4096, @@ -34095,7 +35446,7 @@ }, "parameters": [ { - "id": 1432, + "id": 1486, "name": "item", "variant": "param", "kind": 32768, @@ -34128,7 +35479,7 @@ } }, { - "id": 1433, + "id": 1487, "name": "quantity", "variant": "param", "kind": 32768, @@ -34169,21 +35520,21 @@ ] }, { - "id": 1460, + "id": 1514, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1461, + "id": 1515, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1462, + "id": 1516, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -34203,7 +35554,7 @@ ], "type": { "type": "reference", - "target": 1404, + "target": 1458, "name": "FulfillmentService", "package": "@medusajs/medusa" }, @@ -34225,46 +35576,46 @@ { "title": "Constructors", "children": [ - 1405 + 1459 ] }, { "title": "Properties", "children": [ - 1458, - 1457, - 1459, - 1411, - 1412, - 1414, - 1409, - 1453, - 1421, - 1410, - 1408, - 1413, - 1454 + 1512, + 1511, + 1513, + 1465, + 1466, + 1468, + 1463, + 1507, + 1475, + 1464, + 1462, + 1467, + 1508 ] }, { "title": "Accessors", "children": [ - 1455 + 1509 ] }, { "title": "Methods", "children": [ - 1468, - 1443, - 1438, - 1446, - 1426, - 1422, - 1434, - 1463, - 1430, - 1460 + 1522, + 1497, + 1492, + 1500, + 1480, + 1476, + 1488, + 1517, + 1484, + 1514 ] } ], @@ -34281,7 +35632,7 @@ ] }, { - "id": 1565, + "id": 1619, "name": "GiftCardService", "variant": "declaration", "kind": 128, @@ -34296,21 +35647,21 @@ }, "children": [ { - "id": 1575, + "id": 1629, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1576, + "id": 1630, "name": "new GiftCardService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1577, + "id": 1631, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -34328,7 +35679,7 @@ ], "type": { "type": "reference", - "target": 1565, + "target": 1619, "name": "GiftCardService", "package": "@medusajs/medusa" }, @@ -34346,7 +35697,7 @@ } }, { - "id": 1625, + "id": 1679, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -34381,7 +35732,7 @@ } }, { - "id": 1624, + "id": 1678, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -34400,7 +35751,7 @@ } }, { - "id": 1626, + "id": 1680, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -34435,7 +35786,7 @@ } }, { - "id": 1586, + "id": 1640, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -34445,13 +35796,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 1578, + "id": 1632, "name": "giftCardRepository_", "variant": "declaration", "kind": 1024, @@ -34485,28 +35836,28 @@ { "type": "reflection", "declaration": { - "id": 1579, + "id": 1633, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1580, + "id": 1634, "name": "listGiftCardsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1581, + "id": 1635, "name": "listGiftCardsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1582, + "id": 1636, "name": "query", "variant": "param", "kind": 32768, @@ -34533,7 +35884,7 @@ } }, { - "id": 1583, + "id": 1637, "name": "q", "variant": "param", "kind": 32768, @@ -34586,7 +35937,7 @@ { "title": "Methods", "children": [ - 1580 + 1634 ] } ] @@ -34596,7 +35947,7 @@ } }, { - "id": 1584, + "id": 1638, "name": "giftCardTransactionRepo_", "variant": "declaration", "kind": 1024, @@ -34626,7 +35977,7 @@ } }, { - "id": 1620, + "id": 1674, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -34649,7 +36000,7 @@ } }, { - "id": 1585, + "id": 1639, "name": "regionService_", "variant": "declaration", "kind": 1024, @@ -34659,13 +36010,13 @@ }, "type": { "type": "reference", - "target": 4533, + "target": 4621, "name": "RegionService", "package": "@medusajs/medusa" } }, { - "id": 1621, + "id": 1675, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -34697,7 +36048,7 @@ } }, { - "id": 1566, + "id": 1620, "name": "Events", "variant": "declaration", "kind": 1024, @@ -34707,14 +36058,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1567, + "id": 1621, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1568, + "id": 1622, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -34730,7 +36081,7 @@ { "title": "Properties", "children": [ - 1568 + 1622 ] } ] @@ -34739,7 +36090,7 @@ "defaultValue": "..." }, { - "id": 1622, + "id": 1676, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -34747,7 +36098,7 @@ "isProtected": true }, "getSignature": { - "id": 1623, + "id": 1677, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -34774,7 +36125,7 @@ } }, { - "id": 1635, + "id": 1689, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -34783,7 +36134,7 @@ }, "signatures": [ { - "id": 1636, + "id": 1690, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -34809,14 +36160,14 @@ }, "typeParameter": [ { - "id": 1637, + "id": 1691, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 1638, + "id": 1692, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -34825,7 +36176,7 @@ ], "parameters": [ { - "id": 1639, + "id": 1693, "name": "work", "variant": "param", "kind": 32768, @@ -34841,21 +36192,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1640, + "id": 1694, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1641, + "id": 1695, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1642, + "id": 1696, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -34894,7 +36245,7 @@ } }, { - "id": 1643, + "id": 1697, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -34924,21 +36275,21 @@ { "type": "reflection", "declaration": { - "id": 1644, + "id": 1698, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1645, + "id": 1699, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1646, + "id": 1700, "name": "error", "variant": "param", "kind": 32768, @@ -34985,7 +36336,7 @@ } }, { - "id": 1647, + "id": 1701, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -35003,21 +36354,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1648, + "id": 1702, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1649, + "id": 1703, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1650, + "id": 1704, "name": "error", "variant": "param", "kind": 32768, @@ -35093,14 +36444,14 @@ } }, { - "id": 1598, + "id": 1652, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1599, + "id": 1653, "name": "create", "variant": "signature", "kind": 4096, @@ -35126,7 +36477,7 @@ }, "parameters": [ { - "id": 1600, + "id": 1654, "name": "giftCard", "variant": "param", "kind": 32768, @@ -35174,21 +36525,21 @@ ] }, { - "id": 1595, + "id": 1649, "name": "createTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1596, + "id": 1650, "name": "createTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1597, + "id": 1651, "name": "data", "variant": "param", "kind": 32768, @@ -35223,14 +36574,14 @@ ] }, { - "id": 1617, + "id": 1671, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1618, + "id": 1672, "name": "delete", "variant": "signature", "kind": 4096, @@ -35256,7 +36607,7 @@ }, "parameters": [ { - "id": 1619, + "id": 1673, "name": "giftCardId", "variant": "param", "kind": 32768, @@ -35308,14 +36659,14 @@ ] }, { - "id": 1591, + "id": 1645, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1592, + "id": 1646, "name": "list", "variant": "signature", "kind": 4096, @@ -35336,7 +36687,7 @@ }, "parameters": [ { - "id": 1593, + "id": 1647, "name": "selector", "variant": "param", "kind": 32768, @@ -35372,7 +36723,7 @@ "defaultValue": "{}" }, { - "id": 1594, + "id": 1648, "name": "config", "variant": "param", "kind": 32768, @@ -35435,14 +36786,14 @@ ] }, { - "id": 1587, + "id": 1641, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1588, + "id": 1642, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -35463,7 +36814,7 @@ }, "parameters": [ { - "id": 1589, + "id": 1643, "name": "selector", "variant": "param", "kind": 32768, @@ -35499,7 +36850,7 @@ "defaultValue": "{}" }, { - "id": 1590, + "id": 1644, "name": "config", "variant": "param", "kind": 32768, @@ -35571,14 +36922,14 @@ ] }, { - "id": 1605, + "id": 1659, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1606, + "id": 1660, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -35604,7 +36955,7 @@ }, "parameters": [ { - "id": 1607, + "id": 1661, "name": "giftCardId", "variant": "param", "kind": 32768, @@ -35623,7 +36974,7 @@ } }, { - "id": 1608, + "id": 1662, "name": "config", "variant": "param", "kind": 32768, @@ -35683,21 +37034,21 @@ ] }, { - "id": 1609, + "id": 1663, "name": "retrieveByCode", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1610, + "id": 1664, "name": "retrieveByCode", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1611, + "id": 1665, "name": "code", "variant": "param", "kind": 32768, @@ -35708,7 +37059,7 @@ } }, { - "id": 1612, + "id": 1666, "name": "config", "variant": "param", "kind": 32768, @@ -35760,7 +37111,7 @@ ] }, { - "id": 1601, + "id": 1655, "name": "retrieve_", "variant": "declaration", "kind": 2048, @@ -35769,14 +37120,14 @@ }, "signatures": [ { - "id": 1602, + "id": 1656, "name": "retrieve_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1603, + "id": 1657, "name": "selector", "variant": "param", "kind": 32768, @@ -35803,7 +37154,7 @@ } }, { - "id": 1604, + "id": 1658, "name": "config", "variant": "param", "kind": 32768, @@ -35855,7 +37206,7 @@ ] }, { - "id": 1630, + "id": 1684, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -35864,14 +37215,14 @@ }, "signatures": [ { - "id": 1631, + "id": 1685, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1632, + "id": 1686, "name": "err", "variant": "param", "kind": 32768, @@ -35901,14 +37252,14 @@ { "type": "reflection", "declaration": { - "id": 1633, + "id": 1687, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1634, + "id": 1688, "name": "code", "variant": "declaration", "kind": 1024, @@ -35923,7 +37274,7 @@ { "title": "Properties", "children": [ - 1634 + 1688 ] } ] @@ -35951,14 +37302,14 @@ } }, { - "id": 1613, + "id": 1667, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1614, + "id": 1668, "name": "update", "variant": "signature", "kind": 4096, @@ -35984,7 +37335,7 @@ }, "parameters": [ { - "id": 1615, + "id": 1669, "name": "giftCardId", "variant": "param", "kind": 32768, @@ -36003,7 +37354,7 @@ } }, { - "id": 1616, + "id": 1670, "name": "update", "variant": "param", "kind": 32768, @@ -36051,21 +37402,21 @@ ] }, { - "id": 1627, + "id": 1681, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1628, + "id": 1682, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1629, + "id": 1683, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -36085,7 +37436,7 @@ ], "type": { "type": "reference", - "target": 1565, + "target": 1619, "name": "GiftCardService", "package": "@medusajs/medusa" }, @@ -36103,7 +37454,7 @@ } }, { - "id": 1569, + "id": 1623, "name": "generateCode", "variant": "declaration", "kind": 2048, @@ -36112,7 +37463,7 @@ }, "signatures": [ { - "id": 1570, + "id": 1624, "name": "generateCode", "variant": "signature", "kind": 4096, @@ -36144,7 +37495,7 @@ ] }, { - "id": 1571, + "id": 1625, "name": "resolveTaxRate", "variant": "declaration", "kind": 2048, @@ -36154,7 +37505,7 @@ }, "signatures": [ { - "id": 1572, + "id": 1626, "name": "resolveTaxRate", "variant": "signature", "kind": 4096, @@ -36180,7 +37531,7 @@ }, "parameters": [ { - "id": 1573, + "id": 1627, "name": "giftCardTaxRate", "variant": "param", "kind": 32768, @@ -36200,7 +37551,7 @@ } }, { - "id": 1574, + "id": 1628, "name": "region", "variant": "param", "kind": 32768, @@ -36237,47 +37588,47 @@ { "title": "Constructors", "children": [ - 1575 + 1629 ] }, { "title": "Properties", "children": [ - 1625, - 1624, - 1626, - 1586, - 1578, - 1584, - 1620, - 1585, - 1621, - 1566 + 1679, + 1678, + 1680, + 1640, + 1632, + 1638, + 1674, + 1639, + 1675, + 1620 ] }, { "title": "Accessors", "children": [ - 1622 + 1676 ] }, { "title": "Methods", "children": [ - 1635, - 1598, - 1595, - 1617, - 1591, - 1587, - 1605, - 1609, - 1601, - 1630, - 1613, - 1627, - 1569, - 1571 + 1689, + 1652, + 1649, + 1671, + 1645, + 1641, + 1659, + 1663, + 1655, + 1684, + 1667, + 1681, + 1623, + 1625 ] } ], @@ -36294,28 +37645,28 @@ ] }, { - "id": 1651, + "id": 1705, "name": "IdempotencyKeyService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 1652, + "id": 1706, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1653, + "id": 1707, "name": "new IdempotencyKeyService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1654, + "id": 1708, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -36333,7 +37684,7 @@ ], "type": { "type": "reference", - "target": 1651, + "target": 1705, "name": "IdempotencyKeyService", "package": "@medusajs/medusa" }, @@ -36351,7 +37702,7 @@ } }, { - "id": 1687, + "id": 1741, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -36386,7 +37737,7 @@ } }, { - "id": 1686, + "id": 1740, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -36405,7 +37756,7 @@ } }, { - "id": 1688, + "id": 1742, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -36440,7 +37791,7 @@ } }, { - "id": 1655, + "id": 1709, "name": "idempotencyKeyRepository_", "variant": "declaration", "kind": 1024, @@ -36470,7 +37821,7 @@ } }, { - "id": 1682, + "id": 1736, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -36493,7 +37844,7 @@ } }, { - "id": 1683, + "id": 1737, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -36525,7 +37876,7 @@ } }, { - "id": 1684, + "id": 1738, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -36533,7 +37884,7 @@ "isProtected": true }, "getSignature": { - "id": 1685, + "id": 1739, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -36560,7 +37911,7 @@ } }, { - "id": 1697, + "id": 1751, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -36569,7 +37920,7 @@ }, "signatures": [ { - "id": 1698, + "id": 1752, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -36595,14 +37946,14 @@ }, "typeParameter": [ { - "id": 1699, + "id": 1753, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 1700, + "id": 1754, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -36611,7 +37962,7 @@ ], "parameters": [ { - "id": 1701, + "id": 1755, "name": "work", "variant": "param", "kind": 32768, @@ -36627,21 +37978,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1702, + "id": 1756, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1703, + "id": 1757, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1704, + "id": 1758, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -36680,7 +38031,7 @@ } }, { - "id": 1705, + "id": 1759, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -36710,21 +38061,21 @@ { "type": "reflection", "declaration": { - "id": 1706, + "id": 1760, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1707, + "id": 1761, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1708, + "id": 1762, "name": "error", "variant": "param", "kind": 32768, @@ -36771,7 +38122,7 @@ } }, { - "id": 1709, + "id": 1763, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -36789,21 +38140,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1710, + "id": 1764, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1711, + "id": 1765, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1712, + "id": 1766, "name": "error", "variant": "param", "kind": 32768, @@ -36879,14 +38230,14 @@ } }, { - "id": 1662, + "id": 1716, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1663, + "id": 1717, "name": "create", "variant": "signature", "kind": 4096, @@ -36912,7 +38263,7 @@ }, "parameters": [ { - "id": 1664, + "id": 1718, "name": "payload", "variant": "param", "kind": 32768, @@ -36960,14 +38311,14 @@ ] }, { - "id": 1656, + "id": 1710, "name": "initializeRequest", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1657, + "id": 1711, "name": "initializeRequest", "variant": "signature", "kind": 4096, @@ -36993,7 +38344,7 @@ }, "parameters": [ { - "id": 1658, + "id": 1712, "name": "headerKey", "variant": "param", "kind": 32768, @@ -37012,7 +38363,7 @@ } }, { - "id": 1659, + "id": 1713, "name": "reqMethod", "variant": "param", "kind": 32768, @@ -37031,7 +38382,7 @@ } }, { - "id": 1660, + "id": 1714, "name": "reqParams", "variant": "param", "kind": 32768, @@ -37065,7 +38416,7 @@ } }, { - "id": 1661, + "id": 1715, "name": "reqPath", "variant": "param", "kind": 32768, @@ -37108,14 +38459,14 @@ ] }, { - "id": 1668, + "id": 1722, "name": "lock", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1669, + "id": 1723, "name": "lock", "variant": "signature", "kind": 4096, @@ -37141,7 +38492,7 @@ }, "parameters": [ { - "id": 1670, + "id": 1724, "name": "idempotencyKey", "variant": "param", "kind": 32768, @@ -37184,14 +38535,14 @@ ] }, { - "id": 1665, + "id": 1719, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1666, + "id": 1720, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -37217,7 +38568,7 @@ }, "parameters": [ { - "id": 1667, + "id": 1721, "name": "idempotencyKeyOrSelector", "variant": "param", "kind": 32768, @@ -37285,7 +38636,7 @@ ] }, { - "id": 1692, + "id": 1746, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -37294,14 +38645,14 @@ }, "signatures": [ { - "id": 1693, + "id": 1747, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1694, + "id": 1748, "name": "err", "variant": "param", "kind": 32768, @@ -37331,14 +38682,14 @@ { "type": "reflection", "declaration": { - "id": 1695, + "id": 1749, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1696, + "id": 1750, "name": "code", "variant": "declaration", "kind": 1024, @@ -37353,7 +38704,7 @@ { "title": "Properties", "children": [ - 1696 + 1750 ] } ] @@ -37381,14 +38732,14 @@ } }, { - "id": 1671, + "id": 1725, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1672, + "id": 1726, "name": "update", "variant": "signature", "kind": 4096, @@ -37414,7 +38765,7 @@ }, "parameters": [ { - "id": 1673, + "id": 1727, "name": "idempotencyKey", "variant": "param", "kind": 32768, @@ -37433,7 +38784,7 @@ } }, { - "id": 1674, + "id": 1728, "name": "update", "variant": "param", "kind": 32768, @@ -37492,21 +38843,21 @@ ] }, { - "id": 1689, + "id": 1743, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1690, + "id": 1744, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1691, + "id": 1745, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -37526,7 +38877,7 @@ ], "type": { "type": "reference", - "target": 1651, + "target": 1705, "name": "IdempotencyKeyService", "package": "@medusajs/medusa" }, @@ -37544,14 +38895,14 @@ } }, { - "id": 1675, + "id": 1729, "name": "workStage", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1676, + "id": 1730, "name": "workStage", "variant": "signature", "kind": 4096, @@ -37577,7 +38928,7 @@ }, "parameters": [ { - "id": 1677, + "id": 1731, "name": "idempotencyKey", "variant": "param", "kind": 32768, @@ -37596,7 +38947,7 @@ } }, { - "id": 1678, + "id": 1732, "name": "callback", "variant": "param", "kind": 32768, @@ -37612,21 +38963,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1679, + "id": 1733, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1680, + "id": 1734, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1681, + "id": 1735, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -37696,38 +39047,38 @@ { "title": "Constructors", "children": [ - 1652 + 1706 ] }, { "title": "Properties", "children": [ - 1687, - 1686, - 1688, - 1655, - 1682, - 1683 + 1741, + 1740, + 1742, + 1709, + 1736, + 1737 ] }, { "title": "Accessors", "children": [ - 1684 + 1738 ] }, { "title": "Methods", "children": [ - 1697, - 1662, - 1656, - 1668, - 1665, - 1692, - 1671, - 1689, - 1675 + 1751, + 1716, + 1710, + 1722, + 1719, + 1746, + 1725, + 1743, + 1729 ] } ], @@ -37744,7 +39095,7 @@ ] }, { - "id": 1850, + "id": 1904, "name": "LineItemAdjustmentService", "variant": "declaration", "kind": 128, @@ -37759,21 +39110,21 @@ }, "children": [ { - "id": 1851, + "id": 1905, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1852, + "id": 1906, "name": "new LineItemAdjustmentService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1853, + "id": 1907, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -37791,7 +39142,7 @@ ], "type": { "type": "reference", - "target": 1850, + "target": 1904, "name": "LineItemAdjustmentService", "package": "@medusajs/medusa" }, @@ -37809,7 +39160,7 @@ } }, { - "id": 1894, + "id": 1948, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -37844,7 +39195,7 @@ } }, { - "id": 1893, + "id": 1947, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -37863,7 +39214,7 @@ } }, { - "id": 1895, + "id": 1949, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -37898,7 +39249,7 @@ } }, { - "id": 1855, + "id": 1909, "name": "discountService", "variant": "declaration", "kind": 1024, @@ -37908,13 +39259,13 @@ }, "type": { "type": "reference", - "target": 955, + "target": 985, "name": "DiscountService", "package": "@medusajs/medusa" } }, { - "id": 1854, + "id": 1908, "name": "lineItemAdjustmentRepo_", "variant": "declaration", "kind": 1024, @@ -37944,7 +39295,7 @@ } }, { - "id": 1889, + "id": 1943, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -37967,7 +39318,7 @@ } }, { - "id": 1890, + "id": 1944, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -37999,7 +39350,7 @@ } }, { - "id": 1891, + "id": 1945, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -38007,7 +39358,7 @@ "isProtected": true }, "getSignature": { - "id": 1892, + "id": 1946, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -38034,7 +39385,7 @@ } }, { - "id": 1904, + "id": 1958, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -38043,7 +39394,7 @@ }, "signatures": [ { - "id": 1905, + "id": 1959, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -38069,14 +39420,14 @@ }, "typeParameter": [ { - "id": 1906, + "id": 1960, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 1907, + "id": 1961, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -38085,7 +39436,7 @@ ], "parameters": [ { - "id": 1908, + "id": 1962, "name": "work", "variant": "param", "kind": 32768, @@ -38101,21 +39452,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1909, + "id": 1963, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1910, + "id": 1964, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1911, + "id": 1965, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -38154,7 +39505,7 @@ } }, { - "id": 1912, + "id": 1966, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -38184,21 +39535,21 @@ { "type": "reflection", "declaration": { - "id": 1913, + "id": 1967, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1914, + "id": 1968, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1915, + "id": 1969, "name": "error", "variant": "param", "kind": 32768, @@ -38245,7 +39596,7 @@ } }, { - "id": 1916, + "id": 1970, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -38263,21 +39614,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1917, + "id": 1971, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1918, + "id": 1972, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1919, + "id": 1973, "name": "error", "variant": "param", "kind": 32768, @@ -38353,14 +39704,14 @@ } }, { - "id": 1860, + "id": 1914, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1861, + "id": 1915, "name": "create", "variant": "signature", "kind": 4096, @@ -38386,7 +39737,7 @@ }, "parameters": [ { - "id": 1862, + "id": 1916, "name": "data", "variant": "param", "kind": 32768, @@ -38445,14 +39796,14 @@ ] }, { - "id": 1881, + "id": 1935, "name": "createAdjustmentForLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1882, + "id": 1936, "name": "createAdjustmentForLineItem", "variant": "signature", "kind": 4096, @@ -38478,7 +39829,7 @@ }, "parameters": [ { - "id": 1883, + "id": 1937, "name": "cart", "variant": "param", "kind": 32768, @@ -38502,7 +39853,7 @@ } }, { - "id": 1884, + "id": 1938, "name": "lineItem", "variant": "param", "kind": 32768, @@ -38553,14 +39904,14 @@ ] }, { - "id": 1885, + "id": 1939, "name": "createAdjustments", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1886, + "id": 1940, "name": "createAdjustments", "variant": "signature", "kind": 4096, @@ -38586,7 +39937,7 @@ }, "parameters": [ { - "id": 1887, + "id": 1941, "name": "cart", "variant": "param", "kind": 32768, @@ -38610,7 +39961,7 @@ } }, { - "id": 1888, + "id": 1942, "name": "lineItem", "variant": "param", "kind": 32768, @@ -38683,14 +40034,14 @@ ] }, { - "id": 1871, + "id": 1925, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1872, + "id": 1926, "name": "delete", "variant": "signature", "kind": 4096, @@ -38716,7 +40067,7 @@ }, "parameters": [ { - "id": 1873, + "id": 1927, "name": "selectorOrIds", "variant": "param", "kind": 32768, @@ -38758,14 +40109,14 @@ { "type": "reflection", "declaration": { - "id": 1874, + "id": 1928, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1875, + "id": 1929, "name": "discount_id", "variant": "declaration", "kind": 1024, @@ -38802,7 +40153,7 @@ { "title": "Properties", "children": [ - 1875 + 1929 ] } ] @@ -38833,14 +40184,14 @@ ] }, { - "id": 1876, + "id": 1930, "name": "generateAdjustments", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1877, + "id": 1931, "name": "generateAdjustments", "variant": "signature", "kind": 4096, @@ -38866,7 +40217,7 @@ }, "parameters": [ { - "id": 1878, + "id": 1932, "name": "calculationContextData", "variant": "param", "kind": 32768, @@ -38890,7 +40241,7 @@ } }, { - "id": 1879, + "id": 1933, "name": "generatedLineItem", "variant": "param", "kind": 32768, @@ -38914,7 +40265,7 @@ } }, { - "id": 1880, + "id": 1934, "name": "context", "variant": "param", "kind": 32768, @@ -38965,14 +40316,14 @@ ] }, { - "id": 1867, + "id": 1921, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1868, + "id": 1922, "name": "list", "variant": "signature", "kind": 4096, @@ -38998,7 +40349,7 @@ }, "parameters": [ { - "id": 1869, + "id": 1923, "name": "selector", "variant": "param", "kind": 32768, @@ -39023,7 +40374,7 @@ "defaultValue": "{}" }, { - "id": 1870, + "id": 1924, "name": "config", "variant": "param", "kind": 32768, @@ -39086,14 +40437,14 @@ ] }, { - "id": 1856, + "id": 1910, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1857, + "id": 1911, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -39119,7 +40470,7 @@ }, "parameters": [ { - "id": 1858, + "id": 1912, "name": "lineItemAdjustmentId", "variant": "param", "kind": 32768, @@ -39138,7 +40489,7 @@ } }, { - "id": 1859, + "id": 1913, "name": "config", "variant": "param", "kind": 32768, @@ -39198,7 +40549,7 @@ ] }, { - "id": 1899, + "id": 1953, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -39207,14 +40558,14 @@ }, "signatures": [ { - "id": 1900, + "id": 1954, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1901, + "id": 1955, "name": "err", "variant": "param", "kind": 32768, @@ -39244,14 +40595,14 @@ { "type": "reflection", "declaration": { - "id": 1902, + "id": 1956, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1903, + "id": 1957, "name": "code", "variant": "declaration", "kind": 1024, @@ -39266,7 +40617,7 @@ { "title": "Properties", "children": [ - 1903 + 1957 ] } ] @@ -39294,14 +40645,14 @@ } }, { - "id": 1863, + "id": 1917, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1864, + "id": 1918, "name": "update", "variant": "signature", "kind": 4096, @@ -39327,7 +40678,7 @@ }, "parameters": [ { - "id": 1865, + "id": 1919, "name": "id", "variant": "param", "kind": 32768, @@ -39346,7 +40697,7 @@ } }, { - "id": 1866, + "id": 1920, "name": "data", "variant": "param", "kind": 32768, @@ -39405,21 +40756,21 @@ ] }, { - "id": 1896, + "id": 1950, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1897, + "id": 1951, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1898, + "id": 1952, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -39439,7 +40790,7 @@ ], "type": { "type": "reference", - "target": 1850, + "target": 1904, "name": "LineItemAdjustmentService", "package": "@medusajs/medusa" }, @@ -39461,41 +40812,41 @@ { "title": "Constructors", "children": [ - 1851 + 1905 ] }, { "title": "Properties", "children": [ - 1894, - 1893, - 1895, - 1855, - 1854, - 1889, - 1890 + 1948, + 1947, + 1949, + 1909, + 1908, + 1943, + 1944 ] }, { "title": "Accessors", "children": [ - 1891 + 1945 ] }, { "title": "Methods", "children": [ - 1904, - 1860, - 1881, - 1885, - 1871, - 1876, - 1867, - 1856, - 1899, - 1863, - 1896 + 1958, + 1914, + 1935, + 1939, + 1925, + 1930, + 1921, + 1910, + 1953, + 1917, + 1950 ] } ], @@ -39512,28 +40863,28 @@ ] }, { - "id": 1713, + "id": 1767, "name": "LineItemService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 1714, + "id": 1768, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1715, + "id": 1769, "name": "new LineItemService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1716, + "id": 1770, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -39551,7 +40902,7 @@ ], "type": { "type": "reference", - "target": 1713, + "target": 1767, "name": "LineItemService", "package": "@medusajs/medusa" }, @@ -39569,7 +40920,7 @@ } }, { - "id": 1824, + "id": 1878, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -39604,7 +40955,7 @@ } }, { - "id": 1823, + "id": 1877, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -39623,7 +40974,7 @@ } }, { - "id": 1825, + "id": 1879, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -39658,7 +41009,7 @@ } }, { - "id": 1732, + "id": 1786, "name": "cartRepository_", "variant": "declaration", "kind": 1024, @@ -39692,28 +41043,28 @@ { "type": "reflection", "declaration": { - "id": 1733, + "id": 1787, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1738, + "id": 1792, "name": "findOneWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1739, + "id": 1793, "name": "findOneWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1740, + "id": 1794, "name": "relations", "variant": "param", "kind": 32768, @@ -39741,7 +41092,7 @@ "defaultValue": "{}" }, { - "id": 1741, + "id": 1795, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -39808,21 +41159,21 @@ ] }, { - "id": 1734, + "id": 1788, "name": "findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1735, + "id": 1789, "name": "findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1736, + "id": 1790, "name": "relations", "variant": "param", "kind": 32768, @@ -39850,7 +41201,7 @@ "defaultValue": "{}" }, { - "id": 1737, + "id": 1791, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -39924,8 +41275,8 @@ { "title": "Methods", "children": [ - 1738, - 1734 + 1792, + 1788 ] } ] @@ -39935,7 +41286,7 @@ } }, { - "id": 1746, + "id": 1800, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -39954,7 +41305,7 @@ } }, { - "id": 1724, + "id": 1778, "name": "itemTaxLineRepo_", "variant": "declaration", "kind": 1024, @@ -39988,28 +41339,28 @@ { "type": "reflection", "declaration": { - "id": 1725, + "id": 1779, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1729, + "id": 1783, "name": "deleteForCart", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1730, + "id": 1784, "name": "deleteForCart", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1731, + "id": 1785, "name": "cartId", "variant": "param", "kind": 32768, @@ -40039,21 +41390,21 @@ ] }, { - "id": 1726, + "id": 1780, "name": "upsertLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1727, + "id": 1781, "name": "upsertLines", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1728, + "id": 1782, "name": "lines", "variant": "param", "kind": 32768, @@ -40103,8 +41454,8 @@ { "title": "Methods", "children": [ - 1729, - 1726 + 1783, + 1780 ] } ] @@ -40114,7 +41465,7 @@ } }, { - "id": 1747, + "id": 1801, "name": "lineItemAdjustmentService_", "variant": "declaration", "kind": 1024, @@ -40124,13 +41475,13 @@ }, "type": { "type": "reference", - "target": 1850, + "target": 1904, "name": "LineItemAdjustmentService", "package": "@medusajs/medusa" } }, { - "id": 1717, + "id": 1771, "name": "lineItemRepository_", "variant": "declaration", "kind": 1024, @@ -40164,21 +41515,21 @@ { "type": "reflection", "declaration": { - "id": 1718, + "id": 1772, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1719, + "id": 1773, "name": "findByReturn", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1720, + "id": 1774, "name": "findByReturn", "variant": "signature", "kind": 4096, @@ -40220,7 +41571,7 @@ }, "parameters": [ { - "id": 1721, + "id": 1775, "name": "returnId", "variant": "param", "kind": 32768, @@ -40263,14 +41614,14 @@ { "type": "reflection", "declaration": { - "id": 1722, + "id": 1776, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1723, + "id": 1777, "name": "return_item", "variant": "declaration", "kind": 1024, @@ -40290,7 +41641,7 @@ { "title": "Properties", "children": [ - 1723 + 1777 ] } ] @@ -40311,7 +41662,7 @@ { "title": "Methods", "children": [ - 1719 + 1773 ] } ] @@ -40321,7 +41672,7 @@ } }, { - "id": 1819, + "id": 1873, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -40344,7 +41695,7 @@ } }, { - "id": 1744, + "id": 1798, "name": "pricingService_", "variant": "declaration", "kind": 1024, @@ -40354,13 +41705,13 @@ }, "type": { "type": "reference", - "target": 3316, + "target": 3370, "name": "PricingService", "package": "@medusajs/medusa" } }, { - "id": 1743, + "id": 1797, "name": "productService_", "variant": "declaration", "kind": 1024, @@ -40370,13 +41721,13 @@ }, "type": { "type": "reference", - "target": 3441, + "target": 3495, "name": "ProductService", "package": "@medusajs/medusa" } }, { - "id": 1742, + "id": 1796, "name": "productVariantService_", "variant": "declaration", "kind": 1024, @@ -40386,13 +41737,13 @@ }, "type": { "type": "reference", - "target": 4076, + "target": 4150, "name": "ProductVariantService", "package": "@medusajs/medusa" } }, { - "id": 1745, + "id": 1799, "name": "regionService_", "variant": "declaration", "kind": 1024, @@ -40402,13 +41753,13 @@ }, "type": { "type": "reference", - "target": 4533, + "target": 4621, "name": "RegionService", "package": "@medusajs/medusa" } }, { - "id": 1748, + "id": 1802, "name": "taxProviderService_", "variant": "declaration", "kind": 1024, @@ -40418,13 +41769,13 @@ }, "type": { "type": "reference", - "target": 5702, + "target": 5814, "name": "TaxProviderService", "package": "@medusajs/medusa" } }, { - "id": 1820, + "id": 1874, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -40456,7 +41807,7 @@ } }, { - "id": 1821, + "id": 1875, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -40464,7 +41815,7 @@ "isProtected": true }, "getSignature": { - "id": 1822, + "id": 1876, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -40491,7 +41842,7 @@ } }, { - "id": 1834, + "id": 1888, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -40500,7 +41851,7 @@ }, "signatures": [ { - "id": 1835, + "id": 1889, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -40526,14 +41877,14 @@ }, "typeParameter": [ { - "id": 1836, + "id": 1890, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 1837, + "id": 1891, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -40542,7 +41893,7 @@ ], "parameters": [ { - "id": 1838, + "id": 1892, "name": "work", "variant": "param", "kind": 32768, @@ -40558,21 +41909,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1839, + "id": 1893, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1840, + "id": 1894, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1841, + "id": 1895, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -40611,7 +41962,7 @@ } }, { - "id": 1842, + "id": 1896, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -40641,21 +41992,21 @@ { "type": "reflection", "declaration": { - "id": 1843, + "id": 1897, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1844, + "id": 1898, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1845, + "id": 1899, "name": "error", "variant": "param", "kind": 32768, @@ -40702,7 +42053,7 @@ } }, { - "id": 1846, + "id": 1900, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -40720,21 +42071,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1847, + "id": 1901, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1848, + "id": 1902, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1849, + "id": 1903, "name": "error", "variant": "param", "kind": 32768, @@ -40810,21 +42161,21 @@ } }, { - "id": 1805, + "id": 1859, "name": "cloneTo", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1806, + "id": 1860, "name": "cloneTo", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1807, + "id": 1861, "name": "ids", "variant": "param", "kind": 32768, @@ -40847,7 +42198,7 @@ } }, { - "id": 1808, + "id": 1862, "name": "data", "variant": "param", "kind": 32768, @@ -40875,7 +42226,7 @@ "defaultValue": "{}" }, { - "id": 1809, + "id": 1863, "name": "options", "variant": "param", "kind": 32768, @@ -40883,14 +42234,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1810, + "id": 1864, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1811, + "id": 1865, "name": "setOriginalLineItemId", "variant": "declaration", "kind": 1024, @@ -40907,7 +42258,7 @@ { "title": "Properties", "children": [ - 1811 + 1865 ] } ] @@ -40943,14 +42294,14 @@ ] }, { - "id": 1787, + "id": 1841, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1788, + "id": 1842, "name": "create", "variant": "signature", "kind": 4096, @@ -40976,7 +42327,7 @@ }, "typeParameter": [ { - "id": 1789, + "id": 1843, "name": "T", "variant": "typeParam", "kind": 131072, @@ -41009,7 +42360,7 @@ } }, { - "id": 1790, + "id": 1844, "name": "TResult", "variant": "typeParam", "kind": 131072, @@ -41060,7 +42411,7 @@ ], "parameters": [ { - "id": 1791, + "id": 1845, "name": "data", "variant": "param", "kind": 32768, @@ -41102,14 +42453,14 @@ ] }, { - "id": 1758, + "id": 1812, "name": "createReturnLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1759, + "id": 1813, "name": "createReturnLines", "variant": "signature", "kind": 4096, @@ -41135,7 +42486,7 @@ }, "parameters": [ { - "id": 1760, + "id": 1814, "name": "returnId", "variant": "param", "kind": 32768, @@ -41154,7 +42505,7 @@ } }, { - "id": 1761, + "id": 1815, "name": "cartId", "variant": "param", "kind": 32768, @@ -41200,7 +42551,7 @@ ] }, { - "id": 1802, + "id": 1856, "name": "createTaxLine", "variant": "declaration", "kind": 2048, @@ -41209,7 +42560,7 @@ }, "signatures": [ { - "id": 1803, + "id": 1857, "name": "createTaxLine", "variant": "signature", "kind": 4096, @@ -41235,7 +42586,7 @@ }, "parameters": [ { - "id": 1804, + "id": 1858, "name": "args", "variant": "param", "kind": 32768, @@ -41283,14 +42634,14 @@ ] }, { - "id": 1796, + "id": 1850, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1797, + "id": 1851, "name": "delete", "variant": "signature", "kind": 4096, @@ -41316,7 +42667,7 @@ }, "parameters": [ { - "id": 1798, + "id": 1852, "name": "id", "variant": "param", "kind": 32768, @@ -41372,14 +42723,14 @@ ] }, { - "id": 1799, + "id": 1853, "name": "deleteWithTaxLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1800, + "id": 1854, "name": "deleteWithTaxLines", "variant": "signature", "kind": 4096, @@ -41409,7 +42760,7 @@ }, "parameters": [ { - "id": 1801, + "id": 1855, "name": "id", "variant": "param", "kind": 32768, @@ -41465,14 +42816,14 @@ ] }, { - "id": 1762, + "id": 1816, "name": "generate", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1763, + "id": 1817, "name": "generate", "variant": "signature", "kind": 4096, @@ -41487,7 +42838,7 @@ }, "typeParameter": [ { - "id": 1764, + "id": 1818, "name": "T", "variant": "typeParam", "kind": 131072, @@ -41524,7 +42875,7 @@ } }, { - "id": 1765, + "id": 1819, "name": "TResult", "variant": "typeParam", "kind": 131072, @@ -41594,7 +42945,7 @@ ], "parameters": [ { - "id": 1766, + "id": 1820, "name": "variantIdOrData", "variant": "param", "kind": 32768, @@ -41607,7 +42958,7 @@ } }, { - "id": 1767, + "id": 1821, "name": "regionIdOrContext", "variant": "param", "kind": 32768, @@ -41640,7 +42991,7 @@ } }, { - "id": 1768, + "id": 1822, "name": "quantity", "variant": "param", "kind": 32768, @@ -41653,7 +43004,7 @@ } }, { - "id": 1769, + "id": 1823, "name": "context", "variant": "param", "kind": 32768, @@ -41691,7 +43042,7 @@ ] }, { - "id": 1770, + "id": 1824, "name": "generateLineItem", "variant": "declaration", "kind": 2048, @@ -41700,14 +43051,14 @@ }, "signatures": [ { - "id": 1771, + "id": 1825, "name": "generateLineItem", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1772, + "id": 1826, "name": "variant", "variant": "param", "kind": 32768, @@ -41715,14 +43066,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1773, + "id": 1827, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1774, + "id": 1828, "name": "id", "variant": "declaration", "kind": 1024, @@ -41733,7 +43084,7 @@ } }, { - "id": 1777, + "id": 1831, "name": "product", "variant": "declaration", "kind": 1024, @@ -41741,14 +43092,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1778, + "id": 1832, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1781, + "id": 1835, "name": "discountable", "variant": "declaration", "kind": 1024, @@ -41759,7 +43110,7 @@ } }, { - "id": 1782, + "id": 1836, "name": "is_giftcard", "variant": "declaration", "kind": 1024, @@ -41770,7 +43121,7 @@ } }, { - "id": 1780, + "id": 1834, "name": "thumbnail", "variant": "declaration", "kind": 1024, @@ -41790,7 +43141,7 @@ } }, { - "id": 1779, + "id": 1833, "name": "title", "variant": "declaration", "kind": 1024, @@ -41805,10 +43156,10 @@ { "title": "Properties", "children": [ - 1781, - 1782, - 1780, - 1779 + 1835, + 1836, + 1834, + 1833 ] } ] @@ -41816,7 +43167,7 @@ } }, { - "id": 1776, + "id": 1830, "name": "product_id", "variant": "declaration", "kind": 1024, @@ -41827,7 +43178,7 @@ } }, { - "id": 1775, + "id": 1829, "name": "title", "variant": "declaration", "kind": 1024, @@ -41842,10 +43193,10 @@ { "title": "Properties", "children": [ - 1774, - 1777, - 1776, - 1775 + 1828, + 1831, + 1830, + 1829 ] } ] @@ -41853,7 +43204,7 @@ } }, { - "id": 1783, + "id": 1837, "name": "quantity", "variant": "param", "kind": 32768, @@ -41864,7 +43215,7 @@ } }, { - "id": 1784, + "id": 1838, "name": "context", "variant": "param", "kind": 32768, @@ -41884,14 +43235,14 @@ { "type": "reflection", "declaration": { - "id": 1785, + "id": 1839, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1786, + "id": 1840, "name": "variantPricing", "variant": "declaration", "kind": 1024, @@ -41911,7 +43262,7 @@ { "title": "Properties", "children": [ - 1786 + 1840 ] } ] @@ -41945,21 +43296,21 @@ ] }, { - "id": 1749, + "id": 1803, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1750, + "id": 1804, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1751, + "id": 1805, "name": "selector", "variant": "param", "kind": 32768, @@ -41986,7 +43337,7 @@ } }, { - "id": 1752, + "id": 1806, "name": "config", "variant": "param", "kind": 32768, @@ -42041,14 +43392,14 @@ ] }, { - "id": 1753, + "id": 1807, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1754, + "id": 1808, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -42074,7 +43425,7 @@ }, "parameters": [ { - "id": 1755, + "id": 1809, "name": "id", "variant": "param", "kind": 32768, @@ -42093,7 +43444,7 @@ } }, { - "id": 1756, + "id": 1810, "name": "config", "variant": "param", "kind": 32768, @@ -42109,7 +43460,7 @@ "type": { "type": "reflection", "declaration": { - "id": 1757, + "id": 1811, "name": "__type", "variant": "declaration", "kind": 65536, @@ -42143,7 +43494,7 @@ ] }, { - "id": 1829, + "id": 1883, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -42152,14 +43503,14 @@ }, "signatures": [ { - "id": 1830, + "id": 1884, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1831, + "id": 1885, "name": "err", "variant": "param", "kind": 32768, @@ -42189,14 +43540,14 @@ { "type": "reflection", "declaration": { - "id": 1832, + "id": 1886, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1833, + "id": 1887, "name": "code", "variant": "declaration", "kind": 1024, @@ -42211,7 +43562,7 @@ { "title": "Properties", "children": [ - 1833 + 1887 ] } ] @@ -42239,14 +43590,14 @@ } }, { - "id": 1792, + "id": 1846, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1793, + "id": 1847, "name": "update", "variant": "signature", "kind": 4096, @@ -42272,7 +43623,7 @@ }, "parameters": [ { - "id": 1794, + "id": 1848, "name": "idOrSelector", "variant": "param", "kind": 32768, @@ -42316,7 +43667,7 @@ } }, { - "id": 1795, + "id": 1849, "name": "data", "variant": "param", "kind": 32768, @@ -42378,7 +43729,7 @@ ] }, { - "id": 1812, + "id": 1866, "name": "validateGenerateArguments", "variant": "declaration", "kind": 2048, @@ -42387,14 +43738,14 @@ }, "signatures": [ { - "id": 1813, + "id": 1867, "name": "validateGenerateArguments", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 1814, + "id": 1868, "name": "T", "variant": "typeParam", "kind": 131072, @@ -42431,7 +43782,7 @@ } }, { - "id": 1815, + "id": 1869, "name": "TResult", "variant": "typeParam", "kind": 131072, @@ -42501,7 +43852,7 @@ ], "parameters": [ { - "id": 1816, + "id": 1870, "name": "variantIdOrData", "variant": "param", "kind": 32768, @@ -42523,7 +43874,7 @@ } }, { - "id": 1817, + "id": 1871, "name": "regionIdOrContext", "variant": "param", "kind": 32768, @@ -42556,7 +43907,7 @@ } }, { - "id": 1818, + "id": 1872, "name": "quantity", "variant": "param", "kind": 32768, @@ -42577,21 +43928,21 @@ ] }, { - "id": 1826, + "id": 1880, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1827, + "id": 1881, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1828, + "id": 1882, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -42611,7 +43962,7 @@ ], "type": { "type": "reference", - "target": 1713, + "target": 1767, "name": "LineItemService", "package": "@medusajs/medusa" }, @@ -42633,53 +43984,53 @@ { "title": "Constructors", "children": [ - 1714 + 1768 ] }, { "title": "Properties", "children": [ - 1824, - 1823, - 1825, - 1732, - 1746, - 1724, - 1747, - 1717, - 1819, - 1744, - 1743, - 1742, - 1745, - 1748, - 1820 + 1878, + 1877, + 1879, + 1786, + 1800, + 1778, + 1801, + 1771, + 1873, + 1798, + 1797, + 1796, + 1799, + 1802, + 1874 ] }, { "title": "Accessors", "children": [ - 1821 + 1875 ] }, { "title": "Methods", "children": [ - 1834, - 1805, - 1787, - 1758, - 1802, - 1796, - 1799, - 1762, - 1770, - 1749, - 1753, - 1829, - 1792, + 1888, + 1859, + 1841, 1812, - 1826 + 1856, + 1850, + 1853, + 1816, + 1824, + 1803, + 1807, + 1883, + 1846, + 1866, + 1880 ] } ], @@ -42696,7 +44047,7 @@ ] }, { - "id": 1920, + "id": 1974, "name": "MiddlewareService", "variant": "declaration", "kind": 128, @@ -42711,21 +44062,21 @@ }, "children": [ { - "id": 1921, + "id": 1975, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1922, + "id": 1976, "name": "new MiddlewareService", "variant": "signature", "kind": 16384, "flags": {}, "type": { "type": "reference", - "target": 1920, + "target": 1974, "name": "MiddlewareService", "package": "@medusajs/medusa" } @@ -42733,7 +44084,7 @@ ] }, { - "id": 1923, + "id": 1977, "name": "postAuthentication_", "variant": "declaration", "kind": 1024, @@ -42755,7 +44106,7 @@ } }, { - "id": 1924, + "id": 1978, "name": "preAuthentication_", "variant": "declaration", "kind": 1024, @@ -42777,7 +44128,7 @@ } }, { - "id": 1925, + "id": 1979, "name": "preCartCreation_", "variant": "declaration", "kind": 1024, @@ -42848,7 +44199,7 @@ } }, { - "id": 1926, + "id": 1980, "name": "routers", "variant": "declaration", "kind": 1024, @@ -42886,14 +44237,14 @@ } }, { - "id": 1937, + "id": 1991, "name": "addPostAuthentication", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1938, + "id": 1992, "name": "addPostAuthentication", "variant": "signature", "kind": 4096, @@ -42919,7 +44270,7 @@ }, "parameters": [ { - "id": 1939, + "id": 1993, "name": "middleware", "variant": "param", "kind": 32768, @@ -42943,7 +44294,7 @@ } }, { - "id": 1940, + "id": 1994, "name": "options", "variant": "param", "kind": 32768, @@ -42985,14 +44336,14 @@ ] }, { - "id": 1941, + "id": 1995, "name": "addPreAuthentication", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1942, + "id": 1996, "name": "addPreAuthentication", "variant": "signature", "kind": 4096, @@ -43018,7 +44369,7 @@ }, "parameters": [ { - "id": 1943, + "id": 1997, "name": "middleware", "variant": "param", "kind": 32768, @@ -43042,7 +44393,7 @@ } }, { - "id": 1944, + "id": 1998, "name": "options", "variant": "param", "kind": 32768, @@ -43084,14 +44435,14 @@ ] }, { - "id": 1945, + "id": 1999, "name": "addPreCartCreation", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1946, + "id": 2000, "name": "addPreCartCreation", "variant": "signature", "kind": 4096, @@ -43112,7 +44463,7 @@ }, "parameters": [ { - "id": 1947, + "id": 2001, "name": "middleware", "variant": "param", "kind": 32768, @@ -43193,21 +44544,21 @@ ] }, { - "id": 1927, + "id": 1981, "name": "addRouter", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1928, + "id": 1982, "name": "addRouter", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1929, + "id": 1983, "name": "path", "variant": "param", "kind": 32768, @@ -43218,7 +44569,7 @@ } }, { - "id": 1930, + "id": 1984, "name": "router", "variant": "param", "kind": 32768, @@ -43243,21 +44594,21 @@ ] }, { - "id": 1931, + "id": 1985, "name": "getRouters", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1932, + "id": 1986, "name": "getRouters", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 1933, + "id": 1987, "name": "path", "variant": "param", "kind": 32768, @@ -43285,14 +44636,14 @@ ] }, { - "id": 1948, + "id": 2002, "name": "usePostAuthentication", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1949, + "id": 2003, "name": "usePostAuthentication", "variant": "signature", "kind": 4096, @@ -43313,7 +44664,7 @@ }, "parameters": [ { - "id": 1950, + "id": 2004, "name": "app", "variant": "param", "kind": 32768, @@ -43346,14 +44697,14 @@ ] }, { - "id": 1951, + "id": 2005, "name": "usePreAuthentication", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1952, + "id": 2006, "name": "usePreAuthentication", "variant": "signature", "kind": 4096, @@ -43374,7 +44725,7 @@ }, "parameters": [ { - "id": 1953, + "id": 2007, "name": "app", "variant": "param", "kind": 32768, @@ -43407,14 +44758,14 @@ ] }, { - "id": 1954, + "id": 2008, "name": "usePreCartCreation", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1955, + "id": 2009, "name": "usePreCartCreation", "variant": "signature", "kind": 4096, @@ -43484,14 +44835,14 @@ ] }, { - "id": 1934, + "id": 1988, "name": "validateMiddleware_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1935, + "id": 1989, "name": "validateMiddleware_", "variant": "signature", "kind": 4096, @@ -43517,7 +44868,7 @@ }, "parameters": [ { - "id": 1936, + "id": 1990, "name": "fn", "variant": "param", "kind": 32768, @@ -43548,57 +44899,57 @@ { "title": "Constructors", "children": [ - 1921 + 1975 ] }, { "title": "Properties", "children": [ - 1923, - 1924, - 1925, - 1926 + 1977, + 1978, + 1979, + 1980 ] }, { "title": "Methods", "children": [ - 1937, - 1941, - 1945, - 1927, - 1931, - 1948, - 1951, - 1954, - 1934 + 1991, + 1995, + 1999, + 1981, + 1985, + 2002, + 2005, + 2008, + 1988 ] } ] }, { - "id": 1956, + "id": 2010, "name": "NewTotalsService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 1957, + "id": 2011, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 1958, + "id": 2012, "name": "new NewTotalsService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 1959, + "id": 2013, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -43616,7 +44967,7 @@ ], "type": { "type": "reference", - "target": 1956, + "target": 2010, "name": "default", "package": "@medusajs/medusa" }, @@ -43634,7 +44985,7 @@ } }, { - "id": 2088, + "id": 2142, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -43669,7 +45020,7 @@ } }, { - "id": 2087, + "id": 2141, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -43688,7 +45039,7 @@ } }, { - "id": 2089, + "id": 2143, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -43723,7 +45074,7 @@ } }, { - "id": 1961, + "id": 2015, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -43742,7 +45093,7 @@ } }, { - "id": 2083, + "id": 2137, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -43765,7 +45116,7 @@ } }, { - "id": 1962, + "id": 2016, "name": "taxCalculationStrategy_", "variant": "declaration", "kind": 1024, @@ -43784,7 +45135,7 @@ } }, { - "id": 1960, + "id": 2014, "name": "taxProviderService_", "variant": "declaration", "kind": 1024, @@ -43794,13 +45145,13 @@ }, "type": { "type": "reference", - "target": 5702, + "target": 5814, "name": "TaxProviderService", "package": "@medusajs/medusa" } }, { - "id": 2084, + "id": 2138, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -43832,7 +45183,7 @@ } }, { - "id": 2085, + "id": 2139, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -43840,7 +45191,7 @@ "isProtected": true }, "getSignature": { - "id": 2086, + "id": 2140, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -43867,7 +45218,7 @@ } }, { - "id": 2098, + "id": 2152, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -43876,7 +45227,7 @@ }, "signatures": [ { - "id": 2099, + "id": 2153, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -43902,14 +45253,14 @@ }, "typeParameter": [ { - "id": 2100, + "id": 2154, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 2101, + "id": 2155, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -43918,7 +45269,7 @@ ], "parameters": [ { - "id": 2102, + "id": 2156, "name": "work", "variant": "param", "kind": 32768, @@ -43934,21 +45285,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2103, + "id": 2157, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2104, + "id": 2158, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2105, + "id": 2159, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -43987,7 +45338,7 @@ } }, { - "id": 2106, + "id": 2160, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -44017,21 +45368,21 @@ { "type": "reflection", "declaration": { - "id": 2107, + "id": 2161, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2108, + "id": 2162, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2109, + "id": 2163, "name": "error", "variant": "param", "kind": 32768, @@ -44078,7 +45429,7 @@ } }, { - "id": 2110, + "id": 2164, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -44096,21 +45447,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2111, + "id": 2165, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2112, + "id": 2166, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2113, + "id": 2167, "name": "error", "variant": "param", "kind": 32768, @@ -44186,14 +45537,14 @@ } }, { - "id": 2022, + "id": 2076, "name": "getGiftCardTotals", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2023, + "id": 2077, "name": "getGiftCardTotals", "variant": "signature", "kind": 4096, @@ -44208,7 +45559,7 @@ }, "parameters": [ { - "id": 2024, + "id": 2078, "name": "giftCardableAmount", "variant": "param", "kind": 32768, @@ -44219,7 +45570,7 @@ } }, { - "id": 2025, + "id": 2079, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -44227,14 +45578,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2026, + "id": 2080, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2028, + "id": 2082, "name": "giftCardTransactions", "variant": "declaration", "kind": 1024, @@ -44255,7 +45606,7 @@ } }, { - "id": 2029, + "id": 2083, "name": "giftCards", "variant": "declaration", "kind": 1024, @@ -44276,7 +45627,7 @@ } }, { - "id": 2027, + "id": 2081, "name": "region", "variant": "declaration", "kind": 1024, @@ -44296,9 +45647,9 @@ { "title": "Properties", "children": [ - 2028, - 2029, - 2027 + 2082, + 2083, + 2081 ] } ] @@ -44316,14 +45667,14 @@ { "type": "reflection", "declaration": { - "id": 2030, + "id": 2084, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2032, + "id": 2086, "name": "tax_total", "variant": "declaration", "kind": 1024, @@ -44334,7 +45685,7 @@ } }, { - "id": 2031, + "id": 2085, "name": "total", "variant": "declaration", "kind": 1024, @@ -44349,8 +45700,8 @@ { "title": "Properties", "children": [ - 2032, - 2031 + 2086, + 2085 ] } ] @@ -44364,14 +45715,14 @@ ] }, { - "id": 2033, + "id": 2087, "name": "getGiftCardTransactionsTotals", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2034, + "id": 2088, "name": "getGiftCardTransactionsTotals", "variant": "signature", "kind": 4096, @@ -44386,7 +45737,7 @@ }, "parameters": [ { - "id": 2035, + "id": 2089, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -44394,14 +45745,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2036, + "id": 2090, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2037, + "id": 2091, "name": "giftCardTransactions", "variant": "declaration", "kind": 1024, @@ -44420,7 +45771,7 @@ } }, { - "id": 2038, + "id": 2092, "name": "region", "variant": "declaration", "kind": 1024, @@ -44428,14 +45779,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2039, + "id": 2093, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2040, + "id": 2094, "name": "gift_cards_taxable", "variant": "declaration", "kind": 1024, @@ -44446,7 +45797,7 @@ } }, { - "id": 2041, + "id": 2095, "name": "tax_rate", "variant": "declaration", "kind": 1024, @@ -44461,8 +45812,8 @@ { "title": "Properties", "children": [ - 2040, - 2041 + 2094, + 2095 ] } ] @@ -44474,8 +45825,8 @@ { "title": "Properties", "children": [ - 2037, - 2038 + 2091, + 2092 ] } ] @@ -44486,14 +45837,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2042, + "id": 2096, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2044, + "id": 2098, "name": "tax_total", "variant": "declaration", "kind": 1024, @@ -44504,7 +45855,7 @@ } }, { - "id": 2043, + "id": 2097, "name": "total", "variant": "declaration", "kind": 1024, @@ -44519,8 +45870,8 @@ { "title": "Properties", "children": [ - 2044, - 2043 + 2098, + 2097 ] } ] @@ -44530,21 +45881,21 @@ ] }, { - "id": 2057, + "id": 2111, "name": "getGiftCardableAmount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2058, + "id": 2112, "name": "getGiftCardableAmount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2059, + "id": 2113, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -44552,14 +45903,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2060, + "id": 2114, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2064, + "id": 2118, "name": "discount_total", "variant": "declaration", "kind": 1024, @@ -44570,7 +45921,7 @@ } }, { - "id": 2061, + "id": 2115, "name": "gift_cards_taxable", "variant": "declaration", "kind": 1024, @@ -44583,7 +45934,7 @@ } }, { - "id": 2063, + "id": 2117, "name": "shipping_total", "variant": "declaration", "kind": 1024, @@ -44594,7 +45945,7 @@ } }, { - "id": 2062, + "id": 2116, "name": "subtotal", "variant": "declaration", "kind": 1024, @@ -44605,7 +45956,7 @@ } }, { - "id": 2065, + "id": 2119, "name": "tax_total", "variant": "declaration", "kind": 1024, @@ -44620,11 +45971,11 @@ { "title": "Properties", "children": [ - 2064, - 2061, - 2063, - 2062, - 2065 + 2118, + 2115, + 2117, + 2116, + 2119 ] } ] @@ -44640,14 +45991,14 @@ ] }, { - "id": 1997, + "id": 2051, "name": "getLineItemRefund", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1998, + "id": 2052, "name": "getLineItemRefund", "variant": "signature", "kind": 4096, @@ -44662,7 +46013,7 @@ }, "parameters": [ { - "id": 1999, + "id": 2053, "name": "lineItem", "variant": "param", "kind": 32768, @@ -44670,14 +46021,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2000, + "id": 2054, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2001, + "id": 2055, "name": "id", "variant": "declaration", "kind": 1024, @@ -44688,7 +46039,7 @@ } }, { - "id": 2003, + "id": 2057, "name": "includes_tax", "variant": "declaration", "kind": 1024, @@ -44699,7 +46050,7 @@ } }, { - "id": 2004, + "id": 2058, "name": "quantity", "variant": "declaration", "kind": 1024, @@ -44710,7 +46061,7 @@ } }, { - "id": 2005, + "id": 2059, "name": "tax_lines", "variant": "declaration", "kind": 1024, @@ -44729,7 +46080,7 @@ } }, { - "id": 2002, + "id": 2056, "name": "unit_price", "variant": "declaration", "kind": 1024, @@ -44744,11 +46095,11 @@ { "title": "Properties", "children": [ - 2001, - 2003, - 2004, - 2005, - 2002 + 2055, + 2057, + 2058, + 2059, + 2056 ] } ] @@ -44756,7 +46107,7 @@ } }, { - "id": 2006, + "id": 2060, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -44764,14 +46115,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2007, + "id": 2061, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2008, + "id": 2062, "name": "calculationContext", "variant": "declaration", "kind": 1024, @@ -44787,7 +46138,7 @@ } }, { - "id": 2009, + "id": 2063, "name": "taxRate", "variant": "declaration", "kind": 1024, @@ -44813,8 +46164,8 @@ { "title": "Properties", "children": [ - 2008, - 2009 + 2062, + 2063 ] } ] @@ -44830,7 +46181,7 @@ ] }, { - "id": 2010, + "id": 2064, "name": "getLineItemRefundLegacy", "variant": "declaration", "kind": 2048, @@ -44839,7 +46190,7 @@ }, "signatures": [ { - "id": 2011, + "id": 2065, "name": "getLineItemRefundLegacy", "variant": "signature", "kind": 4096, @@ -44848,7 +46199,7 @@ }, "parameters": [ { - "id": 2012, + "id": 2066, "name": "lineItem", "variant": "param", "kind": 32768, @@ -44856,14 +46207,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2013, + "id": 2067, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2014, + "id": 2068, "name": "id", "variant": "declaration", "kind": 1024, @@ -44874,7 +46225,7 @@ } }, { - "id": 2016, + "id": 2070, "name": "includes_tax", "variant": "declaration", "kind": 1024, @@ -44885,7 +46236,7 @@ } }, { - "id": 2017, + "id": 2071, "name": "quantity", "variant": "declaration", "kind": 1024, @@ -44896,7 +46247,7 @@ } }, { - "id": 2015, + "id": 2069, "name": "unit_price", "variant": "declaration", "kind": 1024, @@ -44911,10 +46262,10 @@ { "title": "Properties", "children": [ - 2014, - 2016, - 2017, - 2015 + 2068, + 2070, + 2071, + 2069 ] } ] @@ -44922,7 +46273,7 @@ } }, { - "id": 2018, + "id": 2072, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -44930,14 +46281,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2019, + "id": 2073, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2020, + "id": 2074, "name": "calculationContext", "variant": "declaration", "kind": 1024, @@ -44953,7 +46304,7 @@ } }, { - "id": 2021, + "id": 2075, "name": "taxRate", "variant": "declaration", "kind": 1024, @@ -44968,8 +46319,8 @@ { "title": "Properties", "children": [ - 2020, - 2021 + 2074, + 2075 ] } ] @@ -44985,14 +46336,14 @@ ] }, { - "id": 1963, + "id": 2017, "name": "getLineItemTotals", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 1964, + "id": 2018, "name": "getLineItemTotals", "variant": "signature", "kind": 4096, @@ -45007,7 +46358,7 @@ }, "parameters": [ { - "id": 1965, + "id": 2019, "name": "items", "variant": "param", "kind": 32768, @@ -45040,7 +46391,7 @@ } }, { - "id": 1966, + "id": 2020, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -45048,14 +46399,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1967, + "id": 2021, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1969, + "id": 2023, "name": "calculationContext", "variant": "declaration", "kind": 1024, @@ -45071,7 +46422,7 @@ } }, { - "id": 1968, + "id": 2022, "name": "includeTax", "variant": "declaration", "kind": 1024, @@ -45084,7 +46435,7 @@ } }, { - "id": 1970, + "id": 2024, "name": "taxRate", "variant": "declaration", "kind": 1024, @@ -45110,9 +46461,9 @@ { "title": "Properties", "children": [ - 1969, - 1968, - 1970 + 2023, + 2022, + 2024 ] } ] @@ -45130,20 +46481,20 @@ { "type": "reflection", "declaration": { - "id": 1971, + "id": 2025, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 1972, + "id": 2026, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 1973, + "id": 2027, "name": "lineItemId", "variant": "param", "kind": 32768, @@ -45174,7 +46525,7 @@ ] }, { - "id": 1986, + "id": 2040, "name": "getLineItemTotalsLegacy", "variant": "declaration", "kind": 2048, @@ -45183,7 +46534,7 @@ }, "signatures": [ { - "id": 1987, + "id": 2041, "name": "getLineItemTotalsLegacy", "variant": "signature", "kind": 4096, @@ -45198,7 +46549,7 @@ }, "parameters": [ { - "id": 1988, + "id": 2042, "name": "item", "variant": "param", "kind": 32768, @@ -45214,7 +46565,7 @@ } }, { - "id": 1989, + "id": 2043, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -45222,14 +46573,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1990, + "id": 2044, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1995, + "id": 2049, "name": "calculationContext", "variant": "declaration", "kind": 1024, @@ -45245,7 +46596,7 @@ } }, { - "id": 1991, + "id": 2045, "name": "lineItemAllocation", "variant": "declaration", "kind": 1024, @@ -45253,14 +46604,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1992, + "id": 2046, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1994, + "id": 2048, "name": "discount", "variant": "declaration", "kind": 1024, @@ -45278,7 +46629,7 @@ } }, { - "id": 1993, + "id": 2047, "name": "gift_card", "variant": "declaration", "kind": 1024, @@ -45300,8 +46651,8 @@ { "title": "Properties", "children": [ - 1994, - 1993 + 2048, + 2047 ] } ] @@ -45309,7 +46660,7 @@ } }, { - "id": 1996, + "id": 2050, "name": "taxRate", "variant": "declaration", "kind": 1024, @@ -45324,9 +46675,9 @@ { "title": "Properties", "children": [ - 1995, - 1991, - 1996 + 2049, + 2045, + 2050 ] } ] @@ -45358,7 +46709,7 @@ ] }, { - "id": 1974, + "id": 2028, "name": "getLineItemTotals_", "variant": "declaration", "kind": 2048, @@ -45367,7 +46718,7 @@ }, "signatures": [ { - "id": 1975, + "id": 2029, "name": "getLineItemTotals_", "variant": "signature", "kind": 4096, @@ -45382,7 +46733,7 @@ }, "parameters": [ { - "id": 1976, + "id": 2030, "name": "item", "variant": "param", "kind": 32768, @@ -45398,7 +46749,7 @@ } }, { - "id": 1977, + "id": 2031, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -45406,14 +46757,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1978, + "id": 2032, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1985, + "id": 2039, "name": "calculationContext", "variant": "declaration", "kind": 1024, @@ -45429,7 +46780,7 @@ } }, { - "id": 1979, + "id": 2033, "name": "includeTax", "variant": "declaration", "kind": 1024, @@ -45442,7 +46793,7 @@ } }, { - "id": 1980, + "id": 2034, "name": "lineItemAllocation", "variant": "declaration", "kind": 1024, @@ -45450,14 +46801,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1981, + "id": 2035, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1983, + "id": 2037, "name": "discount", "variant": "declaration", "kind": 1024, @@ -45475,7 +46826,7 @@ } }, { - "id": 1982, + "id": 2036, "name": "gift_card", "variant": "declaration", "kind": 1024, @@ -45497,8 +46848,8 @@ { "title": "Properties", "children": [ - 1983, - 1982 + 2037, + 2036 ] } ] @@ -45506,7 +46857,7 @@ } }, { - "id": 1984, + "id": 2038, "name": "taxLines", "variant": "declaration", "kind": 1024, @@ -45531,10 +46882,10 @@ { "title": "Properties", "children": [ - 1985, - 1979, - 1980, - 1984 + 2039, + 2033, + 2034, + 2038 ] } ] @@ -45566,14 +46917,14 @@ ] }, { - "id": 2045, + "id": 2099, "name": "getShippingMethodTotals", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2046, + "id": 2100, "name": "getShippingMethodTotals", "variant": "signature", "kind": 4096, @@ -45588,7 +46939,7 @@ }, "parameters": [ { - "id": 2047, + "id": 2101, "name": "shippingMethods", "variant": "param", "kind": 32768, @@ -45621,7 +46972,7 @@ } }, { - "id": 2048, + "id": 2102, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -45629,14 +46980,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2049, + "id": 2103, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2051, + "id": 2105, "name": "calculationContext", "variant": "declaration", "kind": 1024, @@ -45652,7 +47003,7 @@ } }, { - "id": 2052, + "id": 2106, "name": "discounts", "variant": "declaration", "kind": 1024, @@ -45673,7 +47024,7 @@ } }, { - "id": 2050, + "id": 2104, "name": "includeTax", "variant": "declaration", "kind": 1024, @@ -45686,7 +47037,7 @@ } }, { - "id": 2053, + "id": 2107, "name": "taxRate", "variant": "declaration", "kind": 1024, @@ -45712,10 +47063,10 @@ { "title": "Properties", "children": [ - 2051, - 2052, - 2050, - 2053 + 2105, + 2106, + 2104, + 2107 ] } ] @@ -45733,20 +47084,20 @@ { "type": "reflection", "declaration": { - "id": 2054, + "id": 2108, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 2055, + "id": 2109, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 2056, + "id": 2110, "name": "shippingMethodId", "variant": "param", "kind": 32768, @@ -45777,7 +47128,7 @@ ] }, { - "id": 2075, + "id": 2129, "name": "getShippingMethodTotalsLegacy", "variant": "declaration", "kind": 2048, @@ -45786,7 +47137,7 @@ }, "signatures": [ { - "id": 2076, + "id": 2130, "name": "getShippingMethodTotalsLegacy", "variant": "signature", "kind": 4096, @@ -45801,7 +47152,7 @@ }, "parameters": [ { - "id": 2077, + "id": 2131, "name": "shippingMethod", "variant": "param", "kind": 32768, @@ -45817,7 +47168,7 @@ } }, { - "id": 2078, + "id": 2132, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -45825,14 +47176,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2079, + "id": 2133, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2080, + "id": 2134, "name": "calculationContext", "variant": "declaration", "kind": 1024, @@ -45848,7 +47199,7 @@ } }, { - "id": 2081, + "id": 2135, "name": "discounts", "variant": "declaration", "kind": 1024, @@ -45869,7 +47220,7 @@ } }, { - "id": 2082, + "id": 2136, "name": "taxRate", "variant": "declaration", "kind": 1024, @@ -45884,9 +47235,9 @@ { "title": "Properties", "children": [ - 2080, - 2081, - 2082 + 2134, + 2135, + 2136 ] } ] @@ -45918,7 +47269,7 @@ ] }, { - "id": 2066, + "id": 2120, "name": "getShippingMethodTotals_", "variant": "declaration", "kind": 2048, @@ -45927,7 +47278,7 @@ }, "signatures": [ { - "id": 2067, + "id": 2121, "name": "getShippingMethodTotals_", "variant": "signature", "kind": 4096, @@ -45942,7 +47293,7 @@ }, "parameters": [ { - "id": 2068, + "id": 2122, "name": "shippingMethod", "variant": "param", "kind": 32768, @@ -45958,7 +47309,7 @@ } }, { - "id": 2069, + "id": 2123, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -45966,14 +47317,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2070, + "id": 2124, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2072, + "id": 2126, "name": "calculationContext", "variant": "declaration", "kind": 1024, @@ -45989,7 +47340,7 @@ } }, { - "id": 2074, + "id": 2128, "name": "discounts", "variant": "declaration", "kind": 1024, @@ -46010,7 +47361,7 @@ } }, { - "id": 2071, + "id": 2125, "name": "includeTax", "variant": "declaration", "kind": 1024, @@ -46023,7 +47374,7 @@ } }, { - "id": 2073, + "id": 2127, "name": "taxLines", "variant": "declaration", "kind": 1024, @@ -46048,10 +47399,10 @@ { "title": "Properties", "children": [ - 2072, - 2074, - 2071, - 2073 + 2126, + 2128, + 2125, + 2127 ] } ] @@ -46083,7 +47434,7 @@ ] }, { - "id": 2093, + "id": 2147, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -46092,14 +47443,14 @@ }, "signatures": [ { - "id": 2094, + "id": 2148, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2095, + "id": 2149, "name": "err", "variant": "param", "kind": 32768, @@ -46129,14 +47480,14 @@ { "type": "reflection", "declaration": { - "id": 2096, + "id": 2150, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2097, + "id": 2151, "name": "code", "variant": "declaration", "kind": 1024, @@ -46151,7 +47502,7 @@ { "title": "Properties", "children": [ - 2097 + 2151 ] } ] @@ -46179,21 +47530,21 @@ } }, { - "id": 2090, + "id": 2144, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2091, + "id": 2145, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2092, + "id": 2146, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -46213,7 +47564,7 @@ ], "type": { "type": "reference", - "target": 1956, + "target": 2010, "name": "default", "package": "@medusajs/medusa" }, @@ -46235,45 +47586,45 @@ { "title": "Constructors", "children": [ - 1957 + 2011 ] }, { "title": "Properties", "children": [ - 2088, - 2087, - 2089, - 1961, - 2083, - 1962, - 1960, - 2084 + 2142, + 2141, + 2143, + 2015, + 2137, + 2016, + 2014, + 2138 ] }, { "title": "Accessors", "children": [ - 2085 + 2139 ] }, { "title": "Methods", "children": [ - 2098, - 2022, - 2033, - 2057, - 1997, - 2010, - 1963, - 1986, - 1974, - 2045, - 2075, - 2066, - 2093, - 2090 + 2152, + 2076, + 2087, + 2111, + 2051, + 2064, + 2017, + 2040, + 2028, + 2099, + 2129, + 2120, + 2147, + 2144 ] } ], @@ -46290,28 +47641,28 @@ ] }, { - "id": 2114, + "id": 2168, "name": "NoteService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 2120, + "id": 2174, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2121, + "id": 2175, "name": "new NoteService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 2122, + "id": 2176, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -46329,7 +47680,7 @@ ], "type": { "type": "reference", - "target": 2114, + "target": 2168, "name": "NoteService", "package": "@medusajs/medusa" }, @@ -46347,7 +47698,7 @@ } }, { - "id": 2155, + "id": 2209, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -46382,7 +47733,7 @@ } }, { - "id": 2154, + "id": 2208, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -46401,7 +47752,7 @@ } }, { - "id": 2156, + "id": 2210, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -46436,7 +47787,7 @@ } }, { - "id": 2124, + "id": 2178, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -46446,13 +47797,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 2150, + "id": 2204, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -46475,7 +47826,7 @@ } }, { - "id": 2123, + "id": 2177, "name": "noteRepository_", "variant": "declaration", "kind": 1024, @@ -46505,7 +47856,7 @@ } }, { - "id": 2151, + "id": 2205, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -46537,7 +47888,7 @@ } }, { - "id": 2115, + "id": 2169, "name": "Events", "variant": "declaration", "kind": 1024, @@ -46548,14 +47899,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2116, + "id": 2170, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2117, + "id": 2171, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -46567,7 +47918,7 @@ "defaultValue": "\"note.created\"" }, { - "id": 2119, + "id": 2173, "name": "DELETED", "variant": "declaration", "kind": 1024, @@ -46579,7 +47930,7 @@ "defaultValue": "\"note.deleted\"" }, { - "id": 2118, + "id": 2172, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -46595,9 +47946,9 @@ { "title": "Properties", "children": [ - 2117, - 2119, - 2118 + 2171, + 2173, + 2172 ] } ] @@ -46606,7 +47957,7 @@ "defaultValue": "..." }, { - "id": 2152, + "id": 2206, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -46614,7 +47965,7 @@ "isProtected": true }, "getSignature": { - "id": 2153, + "id": 2207, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -46641,7 +47992,7 @@ } }, { - "id": 2165, + "id": 2219, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -46650,7 +48001,7 @@ }, "signatures": [ { - "id": 2166, + "id": 2220, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -46676,14 +48027,14 @@ }, "typeParameter": [ { - "id": 2167, + "id": 2221, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 2168, + "id": 2222, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -46692,7 +48043,7 @@ ], "parameters": [ { - "id": 2169, + "id": 2223, "name": "work", "variant": "param", "kind": 32768, @@ -46708,21 +48059,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2170, + "id": 2224, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2171, + "id": 2225, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2172, + "id": 2226, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -46761,7 +48112,7 @@ } }, { - "id": 2173, + "id": 2227, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -46791,21 +48142,21 @@ { "type": "reflection", "declaration": { - "id": 2174, + "id": 2228, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2175, + "id": 2229, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2176, + "id": 2230, "name": "error", "variant": "param", "kind": 32768, @@ -46852,7 +48203,7 @@ } }, { - "id": 2177, + "id": 2231, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -46870,21 +48221,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2178, + "id": 2232, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2179, + "id": 2233, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2180, + "id": 2234, "name": "error", "variant": "param", "kind": 32768, @@ -46960,14 +48311,14 @@ } }, { - "id": 2137, + "id": 2191, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2138, + "id": 2192, "name": "create", "variant": "signature", "kind": 4096, @@ -46993,7 +48344,7 @@ }, "parameters": [ { - "id": 2139, + "id": 2193, "name": "data", "variant": "param", "kind": 32768, @@ -47017,7 +48368,7 @@ } }, { - "id": 2140, + "id": 2194, "name": "config", "variant": "param", "kind": 32768, @@ -47033,14 +48384,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2141, + "id": 2195, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2142, + "id": 2196, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -47070,7 +48421,7 @@ { "title": "Properties", "children": [ - 2142 + 2196 ] } ] @@ -47103,14 +48454,14 @@ ] }, { - "id": 2147, + "id": 2201, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2148, + "id": 2202, "name": "delete", "variant": "signature", "kind": 4096, @@ -47125,7 +48476,7 @@ }, "parameters": [ { - "id": 2149, + "id": 2203, "name": "noteId", "variant": "param", "kind": 32768, @@ -47163,14 +48514,14 @@ ] }, { - "id": 2129, + "id": 2183, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2130, + "id": 2184, "name": "list", "variant": "signature", "kind": 4096, @@ -47196,7 +48547,7 @@ }, "parameters": [ { - "id": 2131, + "id": 2185, "name": "selector", "variant": "param", "kind": 32768, @@ -47231,7 +48582,7 @@ } }, { - "id": 2132, + "id": 2186, "name": "config", "variant": "param", "kind": 32768, @@ -47294,14 +48645,14 @@ ] }, { - "id": 2133, + "id": 2187, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2134, + "id": 2188, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -47327,7 +48678,7 @@ }, "parameters": [ { - "id": 2135, + "id": 2189, "name": "selector", "variant": "param", "kind": 32768, @@ -47362,7 +48713,7 @@ } }, { - "id": 2136, + "id": 2190, "name": "config", "variant": "param", "kind": 32768, @@ -47434,14 +48785,14 @@ ] }, { - "id": 2125, + "id": 2179, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2126, + "id": 2180, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -47467,7 +48818,7 @@ }, "parameters": [ { - "id": 2127, + "id": 2181, "name": "noteId", "variant": "param", "kind": 32768, @@ -47486,7 +48837,7 @@ } }, { - "id": 2128, + "id": 2182, "name": "config", "variant": "param", "kind": 32768, @@ -47546,7 +48897,7 @@ ] }, { - "id": 2160, + "id": 2214, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -47555,14 +48906,14 @@ }, "signatures": [ { - "id": 2161, + "id": 2215, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2162, + "id": 2216, "name": "err", "variant": "param", "kind": 32768, @@ -47592,14 +48943,14 @@ { "type": "reflection", "declaration": { - "id": 2163, + "id": 2217, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2164, + "id": 2218, "name": "code", "variant": "declaration", "kind": 1024, @@ -47614,7 +48965,7 @@ { "title": "Properties", "children": [ - 2164 + 2218 ] } ] @@ -47642,14 +48993,14 @@ } }, { - "id": 2143, + "id": 2197, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2144, + "id": 2198, "name": "update", "variant": "signature", "kind": 4096, @@ -47675,7 +49026,7 @@ }, "parameters": [ { - "id": 2145, + "id": 2199, "name": "noteId", "variant": "param", "kind": 32768, @@ -47694,7 +49045,7 @@ } }, { - "id": 2146, + "id": 2200, "name": "value", "variant": "param", "kind": 32768, @@ -47737,21 +49088,21 @@ ] }, { - "id": 2157, + "id": 2211, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2158, + "id": 2212, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2159, + "id": 2213, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -47771,7 +49122,7 @@ ], "type": { "type": "reference", - "target": 2114, + "target": 2168, "name": "NoteService", "package": "@medusajs/medusa" }, @@ -47793,40 +49144,40 @@ { "title": "Constructors", "children": [ - 2120 + 2174 ] }, { "title": "Properties", "children": [ - 2155, - 2154, - 2156, - 2124, - 2150, - 2123, - 2151, - 2115 + 2209, + 2208, + 2210, + 2178, + 2204, + 2177, + 2205, + 2169 ] }, { "title": "Accessors", "children": [ - 2152 + 2206 ] }, { "title": "Methods", "children": [ - 2165, - 2137, - 2147, - 2129, - 2133, - 2125, - 2160, - 2143, - 2157 + 2219, + 2191, + 2201, + 2183, + 2187, + 2179, + 2214, + 2197, + 2211 ] } ], @@ -47843,28 +49194,28 @@ ] }, { - "id": 2181, + "id": 2235, "name": "NotificationService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 2182, + "id": 2236, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2183, + "id": 2237, "name": "new NotificationService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 2184, + "id": 2238, "name": "container", "variant": "param", "kind": 32768, @@ -47882,7 +49233,7 @@ ], "type": { "type": "reference", - "target": 2181, + "target": 2235, "name": "NotificationService", "package": "@medusajs/medusa" }, @@ -47900,7 +49251,7 @@ } }, { - "id": 2236, + "id": 2290, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -47935,7 +49286,7 @@ } }, { - "id": 2235, + "id": 2289, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -47954,7 +49305,7 @@ } }, { - "id": 2237, + "id": 2291, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -47989,7 +49340,7 @@ } }, { - "id": 2187, + "id": 2241, "name": "attachmentGenerator_", "variant": "declaration", "kind": 1024, @@ -48003,7 +49354,7 @@ "defaultValue": "null" }, { - "id": 2188, + "id": 2242, "name": "container_", "variant": "declaration", "kind": 1024, @@ -48026,7 +49377,7 @@ { "type": "reflection", "declaration": { - "id": 2189, + "id": 2243, "name": "__type", "variant": "declaration", "kind": 65536, @@ -48037,7 +49388,7 @@ } }, { - "id": 2190, + "id": 2244, "name": "logger_", "variant": "declaration", "kind": 1024, @@ -48056,7 +49407,7 @@ } }, { - "id": 2231, + "id": 2285, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -48079,7 +49430,7 @@ } }, { - "id": 2192, + "id": 2246, "name": "notificationProviderRepository_", "variant": "declaration", "kind": 1024, @@ -48109,7 +49460,7 @@ } }, { - "id": 2191, + "id": 2245, "name": "notificationRepository_", "variant": "declaration", "kind": 1024, @@ -48139,7 +49490,7 @@ } }, { - "id": 2185, + "id": 2239, "name": "subscribers_", "variant": "declaration", "kind": 1024, @@ -48149,7 +49500,7 @@ "type": { "type": "reflection", "declaration": { - "id": 2186, + "id": 2240, "name": "__type", "variant": "declaration", "kind": 65536, @@ -48159,7 +49510,7 @@ "defaultValue": "{}" }, { - "id": 2232, + "id": 2286, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -48191,7 +49542,7 @@ } }, { - "id": 2233, + "id": 2287, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -48199,7 +49550,7 @@ "isProtected": true }, "getSignature": { - "id": 2234, + "id": 2288, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -48226,7 +49577,7 @@ } }, { - "id": 2246, + "id": 2300, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -48235,7 +49586,7 @@ }, "signatures": [ { - "id": 2247, + "id": 2301, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -48261,14 +49612,14 @@ }, "typeParameter": [ { - "id": 2248, + "id": 2302, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 2249, + "id": 2303, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -48277,7 +49628,7 @@ ], "parameters": [ { - "id": 2250, + "id": 2304, "name": "work", "variant": "param", "kind": 32768, @@ -48293,21 +49644,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2251, + "id": 2305, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2252, + "id": 2306, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2253, + "id": 2307, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -48346,7 +49697,7 @@ } }, { - "id": 2254, + "id": 2308, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -48376,21 +49727,21 @@ { "type": "reflection", "declaration": { - "id": 2255, + "id": 2309, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2256, + "id": 2310, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2257, + "id": 2311, "name": "error", "variant": "param", "kind": 32768, @@ -48437,7 +49788,7 @@ } }, { - "id": 2258, + "id": 2312, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -48455,21 +49806,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2259, + "id": 2313, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2260, + "id": 2314, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2261, + "id": 2315, "name": "error", "variant": "param", "kind": 32768, @@ -48545,14 +49896,14 @@ } }, { - "id": 2218, + "id": 2272, "name": "handleEvent", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2219, + "id": 2273, "name": "handleEvent", "variant": "signature", "kind": 4096, @@ -48578,7 +49929,7 @@ }, "parameters": [ { - "id": 2220, + "id": 2274, "name": "eventName", "variant": "param", "kind": 32768, @@ -48597,7 +49948,7 @@ } }, { - "id": 2221, + "id": 2275, "name": "data", "variant": "param", "kind": 32768, @@ -48671,14 +50022,14 @@ ] }, { - "id": 2199, + "id": 2253, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2200, + "id": 2254, "name": "list", "variant": "signature", "kind": 4096, @@ -48704,7 +50055,7 @@ }, "parameters": [ { - "id": 2201, + "id": 2255, "name": "selector", "variant": "param", "kind": 32768, @@ -48739,7 +50090,7 @@ } }, { - "id": 2202, + "id": 2256, "name": "config", "variant": "param", "kind": 32768, @@ -48802,14 +50153,14 @@ ] }, { - "id": 2203, + "id": 2257, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2204, + "id": 2258, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -48835,7 +50186,7 @@ }, "parameters": [ { - "id": 2205, + "id": 2259, "name": "selector", "variant": "param", "kind": 32768, @@ -48870,7 +50221,7 @@ } }, { - "id": 2206, + "id": 2260, "name": "config", "variant": "param", "kind": 32768, @@ -48942,14 +50293,14 @@ ] }, { - "id": 2193, + "id": 2247, "name": "registerAttachmentGenerator", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2194, + "id": 2248, "name": "registerAttachmentGenerator", "variant": "signature", "kind": 4096, @@ -48964,7 +50315,7 @@ }, "parameters": [ { - "id": 2195, + "id": 2249, "name": "service", "variant": "param", "kind": 32768, @@ -48991,14 +50342,14 @@ ] }, { - "id": 2196, + "id": 2250, "name": "registerInstalledProviders", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2197, + "id": 2251, "name": "registerInstalledProviders", "variant": "signature", "kind": 4096, @@ -49013,7 +50364,7 @@ }, "parameters": [ { - "id": 2198, + "id": 2252, "name": "providerIds", "variant": "param", "kind": 32768, @@ -49054,14 +50405,14 @@ ] }, { - "id": 2227, + "id": 2281, "name": "resend", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2228, + "id": 2282, "name": "resend", "variant": "signature", "kind": 4096, @@ -49087,7 +50438,7 @@ }, "parameters": [ { - "id": 2229, + "id": 2283, "name": "id", "variant": "param", "kind": 32768, @@ -49106,7 +50457,7 @@ } }, { - "id": 2230, + "id": 2284, "name": "config", "variant": "param", "kind": 32768, @@ -49166,14 +50517,14 @@ ] }, { - "id": 2207, + "id": 2261, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2208, + "id": 2262, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -49199,7 +50550,7 @@ }, "parameters": [ { - "id": 2209, + "id": 2263, "name": "id", "variant": "param", "kind": 32768, @@ -49218,7 +50569,7 @@ } }, { - "id": 2210, + "id": 2264, "name": "config", "variant": "param", "kind": 32768, @@ -49278,7 +50629,7 @@ ] }, { - "id": 2215, + "id": 2269, "name": "retrieveProvider_", "variant": "declaration", "kind": 2048, @@ -49287,7 +50638,7 @@ }, "signatures": [ { - "id": 2216, + "id": 2270, "name": "retrieveProvider_", "variant": "signature", "kind": 4096, @@ -49313,7 +50664,7 @@ }, "parameters": [ { - "id": 2217, + "id": 2271, "name": "id", "variant": "param", "kind": 32768, @@ -49345,14 +50696,14 @@ ] }, { - "id": 2222, + "id": 2276, "name": "send", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2223, + "id": 2277, "name": "send", "variant": "signature", "kind": 4096, @@ -49378,7 +50729,7 @@ }, "parameters": [ { - "id": 2224, + "id": 2278, "name": "event", "variant": "param", "kind": 32768, @@ -49397,7 +50748,7 @@ } }, { - "id": 2225, + "id": 2279, "name": "eventData", "variant": "param", "kind": 32768, @@ -49431,7 +50782,7 @@ } }, { - "id": 2226, + "id": 2280, "name": "providerId", "variant": "param", "kind": 32768, @@ -49483,7 +50834,7 @@ ] }, { - "id": 2241, + "id": 2295, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -49492,14 +50843,14 @@ }, "signatures": [ { - "id": 2242, + "id": 2296, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2243, + "id": 2297, "name": "err", "variant": "param", "kind": 32768, @@ -49529,14 +50880,14 @@ { "type": "reflection", "declaration": { - "id": 2244, + "id": 2298, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2245, + "id": 2299, "name": "code", "variant": "declaration", "kind": 1024, @@ -49551,7 +50902,7 @@ { "title": "Properties", "children": [ - 2245 + 2299 ] } ] @@ -49579,14 +50930,14 @@ } }, { - "id": 2211, + "id": 2265, "name": "subscribe", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2212, + "id": 2266, "name": "subscribe", "variant": "signature", "kind": 4096, @@ -49601,7 +50952,7 @@ }, "parameters": [ { - "id": 2213, + "id": 2267, "name": "eventName", "variant": "param", "kind": 32768, @@ -49620,7 +50971,7 @@ } }, { - "id": 2214, + "id": 2268, "name": "providerId", "variant": "param", "kind": 32768, @@ -49647,21 +50998,21 @@ ] }, { - "id": 2238, + "id": 2292, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2239, + "id": 2293, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2240, + "id": 2294, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -49681,7 +51032,7 @@ ], "type": { "type": "reference", - "target": 2181, + "target": 2235, "name": "NotificationService", "package": "@medusajs/medusa" }, @@ -49703,47 +51054,47 @@ { "title": "Constructors", "children": [ - 2182 + 2236 ] }, { "title": "Properties", "children": [ - 2236, - 2235, - 2237, - 2187, - 2188, - 2190, - 2231, - 2192, - 2191, - 2185, - 2232 + 2290, + 2289, + 2291, + 2241, + 2242, + 2244, + 2285, + 2246, + 2245, + 2239, + 2286 ] }, { "title": "Accessors", "children": [ - 2233 + 2287 ] }, { "title": "Methods", "children": [ - 2246, - 2218, - 2199, - 2203, - 2193, - 2196, - 2227, - 2207, - 2215, - 2222, - 2241, - 2211, - 2238 + 2300, + 2272, + 2253, + 2257, + 2247, + 2250, + 2281, + 2261, + 2269, + 2276, + 2295, + 2265, + 2292 ] } ], @@ -49760,28 +51111,28 @@ ] }, { - "id": 2262, + "id": 2316, "name": "OauthService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 2267, + "id": 2321, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2268, + "id": 2322, "name": "new OauthService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 2269, + "id": 2323, "name": "cradle", "variant": "param", "kind": 32768, @@ -49799,7 +51150,7 @@ ], "type": { "type": "reference", - "target": 2262, + "target": 2316, "name": "Oauth", "package": "@medusajs/medusa" }, @@ -49817,7 +51168,7 @@ } }, { - "id": 2305, + "id": 2359, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -49852,7 +51203,7 @@ } }, { - "id": 2304, + "id": 2358, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -49871,7 +51222,7 @@ } }, { - "id": 2306, + "id": 2360, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -49906,7 +51257,7 @@ } }, { - "id": 2270, + "id": 2324, "name": "container_", "variant": "declaration", "kind": 1024, @@ -49924,7 +51275,7 @@ } }, { - "id": 2272, + "id": 2326, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -49933,13 +51284,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 2300, + "id": 2354, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -49962,7 +51313,7 @@ } }, { - "id": 2271, + "id": 2325, "name": "oauthRepository_", "variant": "declaration", "kind": 1024, @@ -49991,7 +51342,7 @@ } }, { - "id": 2301, + "id": 2355, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -50023,7 +51374,7 @@ } }, { - "id": 2263, + "id": 2317, "name": "Events", "variant": "declaration", "kind": 1024, @@ -50033,14 +51384,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2264, + "id": 2318, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2265, + "id": 2319, "name": "TOKEN_GENERATED", "variant": "declaration", "kind": 1024, @@ -50052,7 +51403,7 @@ "defaultValue": "\"oauth.token_generated\"" }, { - "id": 2266, + "id": 2320, "name": "TOKEN_REFRESHED", "variant": "declaration", "kind": 1024, @@ -50068,8 +51419,8 @@ { "title": "Properties", "children": [ - 2265, - 2266 + 2319, + 2320 ] } ] @@ -50078,7 +51429,7 @@ "defaultValue": "..." }, { - "id": 2302, + "id": 2356, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -50086,7 +51437,7 @@ "isProtected": true }, "getSignature": { - "id": 2303, + "id": 2357, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -50113,7 +51464,7 @@ } }, { - "id": 2315, + "id": 2369, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -50122,7 +51473,7 @@ }, "signatures": [ { - "id": 2316, + "id": 2370, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -50148,14 +51499,14 @@ }, "typeParameter": [ { - "id": 2317, + "id": 2371, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 2318, + "id": 2372, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -50164,7 +51515,7 @@ ], "parameters": [ { - "id": 2319, + "id": 2373, "name": "work", "variant": "param", "kind": 32768, @@ -50180,21 +51531,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2320, + "id": 2374, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2321, + "id": 2375, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2322, + "id": 2376, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -50233,7 +51584,7 @@ } }, { - "id": 2323, + "id": 2377, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -50263,21 +51614,21 @@ { "type": "reflection", "declaration": { - "id": 2324, + "id": 2378, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2325, + "id": 2379, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2326, + "id": 2380, "name": "error", "variant": "param", "kind": 32768, @@ -50324,7 +51675,7 @@ } }, { - "id": 2327, + "id": 2381, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -50342,21 +51693,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2328, + "id": 2382, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2329, + "id": 2383, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2330, + "id": 2384, "name": "error", "variant": "param", "kind": 32768, @@ -50432,21 +51783,21 @@ } }, { - "id": 2282, + "id": 2336, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2283, + "id": 2337, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2284, + "id": 2338, "name": "data", "variant": "param", "kind": 32768, @@ -50486,21 +51837,21 @@ ] }, { - "id": 2292, + "id": 2346, "name": "generateToken", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2293, + "id": 2347, "name": "generateToken", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2294, + "id": 2348, "name": "appName", "variant": "param", "kind": 32768, @@ -50511,7 +51862,7 @@ } }, { - "id": 2295, + "id": 2349, "name": "code", "variant": "param", "kind": 32768, @@ -50522,7 +51873,7 @@ } }, { - "id": 2296, + "id": 2350, "name": "state", "variant": "param", "kind": 32768, @@ -50557,21 +51908,21 @@ ] }, { - "id": 2279, + "id": 2333, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2280, + "id": 2334, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2281, + "id": 2335, "name": "selector", "variant": "param", "kind": 32768, @@ -50625,21 +51976,21 @@ ] }, { - "id": 2297, + "id": 2351, "name": "refreshToken", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2298, + "id": 2352, "name": "refreshToken", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2299, + "id": 2353, "name": "appName", "variant": "param", "kind": 32768, @@ -50674,21 +52025,21 @@ ] }, { - "id": 2289, + "id": 2343, "name": "registerOauthApp", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2290, + "id": 2344, "name": "registerOauthApp", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2291, + "id": 2345, "name": "appDetails", "variant": "param", "kind": 32768, @@ -50728,21 +52079,21 @@ ] }, { - "id": 2276, + "id": 2330, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2277, + "id": 2331, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2278, + "id": 2332, "name": "oauthId", "variant": "param", "kind": 32768, @@ -50777,21 +52128,21 @@ ] }, { - "id": 2273, + "id": 2327, "name": "retrieveByName", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2274, + "id": 2328, "name": "retrieveByName", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2275, + "id": 2329, "name": "appName", "variant": "param", "kind": 32768, @@ -50826,7 +52177,7 @@ ] }, { - "id": 2310, + "id": 2364, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -50835,14 +52186,14 @@ }, "signatures": [ { - "id": 2311, + "id": 2365, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2312, + "id": 2366, "name": "err", "variant": "param", "kind": 32768, @@ -50872,14 +52223,14 @@ { "type": "reflection", "declaration": { - "id": 2313, + "id": 2367, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2314, + "id": 2368, "name": "code", "variant": "declaration", "kind": 1024, @@ -50894,7 +52245,7 @@ { "title": "Properties", "children": [ - 2314 + 2368 ] } ] @@ -50922,21 +52273,21 @@ } }, { - "id": 2285, + "id": 2339, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2286, + "id": 2340, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2287, + "id": 2341, "name": "id", "variant": "param", "kind": 32768, @@ -50947,7 +52298,7 @@ } }, { - "id": 2288, + "id": 2342, "name": "update", "variant": "param", "kind": 32768, @@ -50987,21 +52338,21 @@ ] }, { - "id": 2307, + "id": 2361, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2308, + "id": 2362, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2309, + "id": 2363, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -51021,7 +52372,7 @@ ], "type": { "type": "reference", - "target": 2262, + "target": 2316, "name": "Oauth", "package": "@medusajs/medusa" }, @@ -51043,43 +52394,43 @@ { "title": "Constructors", "children": [ - 2267 + 2321 ] }, { "title": "Properties", "children": [ - 2305, - 2304, - 2306, - 2270, - 2272, - 2300, - 2271, - 2301, - 2263 + 2359, + 2358, + 2360, + 2324, + 2326, + 2354, + 2325, + 2355, + 2317 ] }, { "title": "Accessors", "children": [ - 2302 + 2356 ] }, { "title": "Methods", "children": [ - 2315, - 2282, - 2292, - 2279, - 2297, - 2289, - 2276, - 2273, - 2310, - 2285, - 2307 + 2369, + 2336, + 2346, + 2333, + 2351, + 2343, + 2330, + 2327, + 2364, + 2339, + 2361 ] } ], @@ -51096,28 +52447,28 @@ ] }, { - "id": 2698, + "id": 2752, "name": "OrderEditItemChangeService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 2703, + "id": 2757, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2704, + "id": 2758, "name": "new OrderEditItemChangeService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 2705, + "id": 2759, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -51135,7 +52486,7 @@ ], "type": { "type": "reference", - "target": 2698, + "target": 2752, "name": "default", "package": "@medusajs/medusa" }, @@ -51153,7 +52504,7 @@ } }, { - "id": 2729, + "id": 2783, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -51188,7 +52539,7 @@ } }, { - "id": 2728, + "id": 2782, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -51207,7 +52558,7 @@ } }, { - "id": 2730, + "id": 2784, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -51242,7 +52593,7 @@ } }, { - "id": 2707, + "id": 2761, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -51261,7 +52612,7 @@ } }, { - "id": 2708, + "id": 2762, "name": "lineItemService_", "variant": "declaration", "kind": 1024, @@ -51271,13 +52622,13 @@ }, "type": { "type": "reference", - "target": 1713, + "target": 1767, "name": "LineItemService", "package": "@medusajs/medusa" } }, { - "id": 2724, + "id": 2778, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -51300,7 +52651,7 @@ } }, { - "id": 2706, + "id": 2760, "name": "orderItemChangeRepository_", "variant": "declaration", "kind": 1024, @@ -51330,7 +52681,7 @@ } }, { - "id": 2709, + "id": 2763, "name": "taxProviderService_", "variant": "declaration", "kind": 1024, @@ -51340,13 +52691,13 @@ }, "type": { "type": "reference", - "target": 5702, + "target": 5814, "name": "TaxProviderService", "package": "@medusajs/medusa" } }, { - "id": 2725, + "id": 2779, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -51378,7 +52729,7 @@ } }, { - "id": 2699, + "id": 2753, "name": "Events", "variant": "declaration", "kind": 1024, @@ -51389,14 +52740,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2700, + "id": 2754, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2701, + "id": 2755, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -51408,7 +52759,7 @@ "defaultValue": "\"order-edit-item-change.CREATED\"" }, { - "id": 2702, + "id": 2756, "name": "DELETED", "variant": "declaration", "kind": 1024, @@ -51424,8 +52775,8 @@ { "title": "Properties", "children": [ - 2701, - 2702 + 2755, + 2756 ] } ] @@ -51434,7 +52785,7 @@ "defaultValue": "..." }, { - "id": 2726, + "id": 2780, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -51442,7 +52793,7 @@ "isProtected": true }, "getSignature": { - "id": 2727, + "id": 2781, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -51469,7 +52820,7 @@ } }, { - "id": 2739, + "id": 2793, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -51478,7 +52829,7 @@ }, "signatures": [ { - "id": 2740, + "id": 2794, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -51504,14 +52855,14 @@ }, "typeParameter": [ { - "id": 2741, + "id": 2795, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 2742, + "id": 2796, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -51520,7 +52871,7 @@ ], "parameters": [ { - "id": 2743, + "id": 2797, "name": "work", "variant": "param", "kind": 32768, @@ -51536,21 +52887,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2744, + "id": 2798, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2745, + "id": 2799, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2746, + "id": 2800, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -51589,7 +52940,7 @@ } }, { - "id": 2747, + "id": 2801, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -51619,21 +52970,21 @@ { "type": "reflection", "declaration": { - "id": 2748, + "id": 2802, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2749, + "id": 2803, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2750, + "id": 2804, "name": "error", "variant": "param", "kind": 32768, @@ -51680,7 +53031,7 @@ } }, { - "id": 2751, + "id": 2805, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -51698,21 +53049,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2752, + "id": 2806, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2753, + "id": 2807, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2754, + "id": 2808, "name": "error", "variant": "param", "kind": 32768, @@ -51788,21 +53139,21 @@ } }, { - "id": 2718, + "id": 2772, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2719, + "id": 2773, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2720, + "id": 2774, "name": "data", "variant": "param", "kind": 32768, @@ -51842,21 +53193,21 @@ ] }, { - "id": 2721, + "id": 2775, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2722, + "id": 2776, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2723, + "id": 2777, "name": "itemChangeIds", "variant": "param", "kind": 32768, @@ -51898,21 +53249,21 @@ ] }, { - "id": 2714, + "id": 2768, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2715, + "id": 2769, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2716, + "id": 2770, "name": "selector", "variant": "param", "kind": 32768, @@ -51939,7 +53290,7 @@ } }, { - "id": 2717, + "id": 2771, "name": "config", "variant": "param", "kind": 32768, @@ -51994,21 +53345,21 @@ ] }, { - "id": 2710, + "id": 2764, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2711, + "id": 2765, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2712, + "id": 2766, "name": "id", "variant": "param", "kind": 32768, @@ -52019,7 +53370,7 @@ } }, { - "id": 2713, + "id": 2767, "name": "config", "variant": "param", "kind": 32768, @@ -52071,7 +53422,7 @@ ] }, { - "id": 2734, + "id": 2788, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -52080,14 +53431,14 @@ }, "signatures": [ { - "id": 2735, + "id": 2789, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2736, + "id": 2790, "name": "err", "variant": "param", "kind": 32768, @@ -52117,14 +53468,14 @@ { "type": "reflection", "declaration": { - "id": 2737, + "id": 2791, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2738, + "id": 2792, "name": "code", "variant": "declaration", "kind": 1024, @@ -52139,7 +53490,7 @@ { "title": "Properties", "children": [ - 2738 + 2792 ] } ] @@ -52167,21 +53518,21 @@ } }, { - "id": 2731, + "id": 2785, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2732, + "id": 2786, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2733, + "id": 2787, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -52201,7 +53552,7 @@ ], "type": { "type": "reference", - "target": 2698, + "target": 2752, "name": "default", "package": "@medusajs/medusa" }, @@ -52223,40 +53574,40 @@ { "title": "Constructors", "children": [ - 2703 + 2757 ] }, { "title": "Properties", "children": [ - 2729, - 2728, - 2730, - 2707, - 2708, - 2724, - 2706, - 2709, - 2725, - 2699 + 2783, + 2782, + 2784, + 2761, + 2762, + 2778, + 2760, + 2763, + 2779, + 2753 ] }, { "title": "Accessors", "children": [ - 2726 + 2780 ] }, { "title": "Methods", "children": [ - 2739, - 2718, - 2721, - 2714, - 2710, - 2734, - 2731 + 2793, + 2772, + 2775, + 2768, + 2764, + 2788, + 2785 ] } ], @@ -52273,28 +53624,28 @@ ] }, { - "id": 2554, + "id": 2608, "name": "OrderEditService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 2566, + "id": 2620, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2567, + "id": 2621, "name": "new OrderEditService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 2568, + "id": 2622, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -52312,7 +53663,7 @@ ], "type": { "type": "reference", - "target": 2554, + "target": 2608, "name": "default", "package": "@medusajs/medusa" }, @@ -52330,7 +53681,7 @@ } }, { - "id": 2672, + "id": 2726, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -52365,7 +53716,7 @@ } }, { - "id": 2671, + "id": 2725, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -52384,7 +53735,7 @@ } }, { - "id": 2673, + "id": 2727, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -52419,7 +53770,7 @@ } }, { - "id": 2574, + "id": 2628, "name": "eventBusService_", "variant": "declaration", "kind": 1024, @@ -52429,13 +53780,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 2576, + "id": 2630, "name": "lineItemAdjustmentService_", "variant": "declaration", "kind": 1024, @@ -52445,13 +53796,13 @@ }, "type": { "type": "reference", - "target": 1850, + "target": 1904, "name": "LineItemAdjustmentService", "package": "@medusajs/medusa" } }, { - "id": 2573, + "id": 2627, "name": "lineItemService_", "variant": "declaration", "kind": 1024, @@ -52461,13 +53812,13 @@ }, "type": { "type": "reference", - "target": 1713, + "target": 1767, "name": "LineItemService", "package": "@medusajs/medusa" } }, { - "id": 2667, + "id": 2721, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -52490,7 +53841,7 @@ } }, { - "id": 2572, + "id": 2626, "name": "newTotalsService_", "variant": "declaration", "kind": 1024, @@ -52500,13 +53851,13 @@ }, "type": { "type": "reference", - "target": 1956, + "target": 2010, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 2577, + "id": 2631, "name": "orderEditItemChangeService_", "variant": "declaration", "kind": 1024, @@ -52516,13 +53867,13 @@ }, "type": { "type": "reference", - "target": 2698, + "target": 2752, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 2569, + "id": 2623, "name": "orderEditRepository_", "variant": "declaration", "kind": 1024, @@ -52552,7 +53903,7 @@ } }, { - "id": 2570, + "id": 2624, "name": "orderService_", "variant": "declaration", "kind": 1024, @@ -52562,13 +53913,13 @@ }, "type": { "type": "reference", - "target": 2331, + "target": 2385, "name": "OrderService", "package": "@medusajs/medusa" } }, { - "id": 2575, + "id": 2629, "name": "taxProviderService_", "variant": "declaration", "kind": 1024, @@ -52578,13 +53929,13 @@ }, "type": { "type": "reference", - "target": 5702, + "target": 5814, "name": "TaxProviderService", "package": "@medusajs/medusa" } }, { - "id": 2571, + "id": 2625, "name": "totalsService_", "variant": "declaration", "kind": 1024, @@ -52594,13 +53945,13 @@ }, "type": { "type": "reference", - "target": 5964, + "target": 6081, "name": "TotalsService", "package": "@medusajs/medusa" } }, { - "id": 2668, + "id": 2722, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -52632,7 +53983,7 @@ } }, { - "id": 2555, + "id": 2609, "name": "Events", "variant": "declaration", "kind": 1024, @@ -52643,14 +53994,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2556, + "id": 2610, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2561, + "id": 2615, "name": "CANCELED", "variant": "declaration", "kind": 1024, @@ -52662,7 +54013,7 @@ "defaultValue": "\"order-edit.canceled\"" }, { - "id": 2562, + "id": 2616, "name": "CONFIRMED", "variant": "declaration", "kind": 1024, @@ -52674,7 +54025,7 @@ "defaultValue": "\"order-edit.confirmed\"" }, { - "id": 2557, + "id": 2611, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -52686,7 +54037,7 @@ "defaultValue": "\"order-edit.created\"" }, { - "id": 2559, + "id": 2613, "name": "DECLINED", "variant": "declaration", "kind": 1024, @@ -52698,7 +54049,7 @@ "defaultValue": "\"order-edit.declined\"" }, { - "id": 2560, + "id": 2614, "name": "REQUESTED", "variant": "declaration", "kind": 1024, @@ -52710,7 +54061,7 @@ "defaultValue": "\"order-edit.requested\"" }, { - "id": 2558, + "id": 2612, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -52726,12 +54077,12 @@ { "title": "Properties", "children": [ - 2561, - 2562, - 2557, - 2559, - 2560, - 2558 + 2615, + 2616, + 2611, + 2613, + 2614, + 2612 ] } ] @@ -52740,7 +54091,7 @@ "defaultValue": "..." }, { - "id": 2669, + "id": 2723, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -52748,7 +54099,7 @@ "isProtected": true }, "getSignature": { - "id": 2670, + "id": 2724, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -52775,7 +54126,7 @@ } }, { - "id": 2578, + "id": 2632, "name": "inventoryService_", "variant": "declaration", "kind": 262144, @@ -52783,7 +54134,7 @@ "isProtected": true }, "getSignature": { - "id": 2579, + "id": 2633, "name": "inventoryService_", "variant": "signature", "kind": 524288, @@ -52809,21 +54160,21 @@ } }, { - "id": 2634, + "id": 2688, "name": "addLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2635, + "id": 2689, "name": "addLineItem", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2636, + "id": 2690, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -52834,7 +54185,7 @@ } }, { - "id": 2637, + "id": 2691, "name": "data", "variant": "param", "kind": 32768, @@ -52869,7 +54220,7 @@ ] }, { - "id": 2682, + "id": 2736, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -52878,7 +54229,7 @@ }, "signatures": [ { - "id": 2683, + "id": 2737, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -52904,14 +54255,14 @@ }, "typeParameter": [ { - "id": 2684, + "id": 2738, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 2685, + "id": 2739, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -52920,7 +54271,7 @@ ], "parameters": [ { - "id": 2686, + "id": 2740, "name": "work", "variant": "param", "kind": 32768, @@ -52936,21 +54287,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2687, + "id": 2741, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2688, + "id": 2742, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2689, + "id": 2743, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -52989,7 +54340,7 @@ } }, { - "id": 2690, + "id": 2744, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -53019,21 +54370,21 @@ { "type": "reflection", "declaration": { - "id": 2691, + "id": 2745, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2692, + "id": 2746, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2693, + "id": 2747, "name": "error", "variant": "param", "kind": 32768, @@ -53080,7 +54431,7 @@ } }, { - "id": 2694, + "id": 2748, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -53098,21 +54449,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2695, + "id": 2749, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2696, + "id": 2750, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2697, + "id": 2751, "name": "error", "variant": "param", "kind": 32768, @@ -53188,21 +54539,21 @@ } }, { - "id": 2648, + "id": 2702, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2649, + "id": 2703, "name": "cancel", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2650, + "id": 2704, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -53213,7 +54564,7 @@ } }, { - "id": 2651, + "id": 2705, "name": "context", "variant": "param", "kind": 32768, @@ -53221,14 +54572,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2652, + "id": 2706, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2653, + "id": 2707, "name": "canceledBy", "variant": "declaration", "kind": 1024, @@ -53245,7 +54596,7 @@ { "title": "Properties", "children": [ - 2653 + 2707 ] } ] @@ -53278,21 +54629,21 @@ ] }, { - "id": 2654, + "id": 2708, "name": "confirm", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2655, + "id": 2709, "name": "confirm", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2656, + "id": 2710, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -53303,7 +54654,7 @@ } }, { - "id": 2657, + "id": 2711, "name": "context", "variant": "param", "kind": 32768, @@ -53311,14 +54662,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2658, + "id": 2712, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2659, + "id": 2713, "name": "confirmedBy", "variant": "declaration", "kind": 1024, @@ -53335,7 +54686,7 @@ { "title": "Properties", "children": [ - 2659 + 2713 ] } ] @@ -53368,21 +54719,21 @@ ] }, { - "id": 2594, + "id": 2648, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2595, + "id": 2649, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2596, + "id": 2650, "name": "data", "variant": "param", "kind": 32768, @@ -53398,7 +54749,7 @@ } }, { - "id": 2597, + "id": 2651, "name": "context", "variant": "param", "kind": 32768, @@ -53406,14 +54757,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2598, + "id": 2652, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2599, + "id": 2653, "name": "createdBy", "variant": "declaration", "kind": 1024, @@ -53428,7 +54779,7 @@ { "title": "Properties", "children": [ - 2599 + 2653 ] } ] @@ -53460,21 +54811,21 @@ ] }, { - "id": 2607, + "id": 2661, "name": "decline", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2608, + "id": 2662, "name": "decline", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2609, + "id": 2663, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -53485,7 +54836,7 @@ } }, { - "id": 2610, + "id": 2664, "name": "context", "variant": "param", "kind": 32768, @@ -53493,14 +54844,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2611, + "id": 2665, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2613, + "id": 2667, "name": "declinedBy", "variant": "declaration", "kind": 1024, @@ -53513,7 +54864,7 @@ } }, { - "id": 2612, + "id": 2666, "name": "declinedReason", "variant": "declaration", "kind": 1024, @@ -53530,8 +54881,8 @@ { "title": "Properties", "children": [ - 2613, - 2612 + 2667, + 2666 ] } ] @@ -53563,21 +54914,21 @@ ] }, { - "id": 2631, + "id": 2685, "name": "decorateTotals", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2632, + "id": 2686, "name": "decorateTotals", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2633, + "id": 2687, "name": "orderEdit", "variant": "param", "kind": 32768, @@ -53617,21 +54968,21 @@ ] }, { - "id": 2604, + "id": 2658, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2605, + "id": 2659, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2606, + "id": 2660, "name": "id", "variant": "param", "kind": 32768, @@ -53661,7 +55012,7 @@ ] }, { - "id": 2664, + "id": 2718, "name": "deleteClonedItems", "variant": "declaration", "kind": 2048, @@ -53670,14 +55021,14 @@ }, "signatures": [ { - "id": 2665, + "id": 2719, "name": "deleteClonedItems", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2666, + "id": 2720, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -53707,21 +55058,21 @@ ] }, { - "id": 2638, + "id": 2692, "name": "deleteItemChange", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2639, + "id": 2693, "name": "deleteItemChange", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2640, + "id": 2694, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -53732,7 +55083,7 @@ } }, { - "id": 2641, + "id": 2695, "name": "itemChangeId", "variant": "param", "kind": 32768, @@ -53762,21 +55113,21 @@ ] }, { - "id": 2590, + "id": 2644, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2591, + "id": 2645, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2592, + "id": 2646, "name": "selector", "variant": "param", "kind": 32768, @@ -53803,7 +55154,7 @@ } }, { - "id": 2593, + "id": 2647, "name": "config", "variant": "param", "kind": 32768, @@ -53859,86 +55210,61 @@ ] }, { - "id": 2584, + "id": 2638, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2585, + "id": 2639, "name": "listAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2586, + "id": 2640, "name": "selector", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "Selector" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order-edit.ts", - "qualifiedName": "OrderEdit" - }, - "name": "OrderEdit", - "package": "@medusajs/medusa" - } - ], - "name": "Selector", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 2587, - "name": "__type", + "type": "reflection", + "declaration": { + "id": 2641, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2642, + "name": "q", "variant": "declaration", - "kind": 65536, - "flags": {}, + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", "children": [ - { - "id": 2588, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2588 - ] - } + 2642 ] } - } - ] + ] + } } }, { - "id": 2589, + "id": 2643, "name": "config", "variant": "param", "kind": 32768, @@ -54003,21 +55329,21 @@ ] }, { - "id": 2625, + "id": 2679, "name": "refreshAdjustments", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2626, + "id": 2680, "name": "refreshAdjustments", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2627, + "id": 2681, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -54028,7 +55354,7 @@ } }, { - "id": 2628, + "id": 2682, "name": "config", "variant": "param", "kind": 32768, @@ -54036,14 +55362,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2629, + "id": 2683, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2630, + "id": 2684, "name": "preserveCustomAdjustments", "variant": "declaration", "kind": 1024, @@ -54059,7 +55385,7 @@ { "title": "Properties", "children": [ - 2630 + 2684 ] } ] @@ -54087,21 +55413,21 @@ ] }, { - "id": 2621, + "id": 2675, "name": "removeLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2622, + "id": 2676, "name": "removeLineItem", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2623, + "id": 2677, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -54112,7 +55438,7 @@ } }, { - "id": 2624, + "id": 2678, "name": "lineItemId", "variant": "param", "kind": 32768, @@ -54142,21 +55468,21 @@ ] }, { - "id": 2642, + "id": 2696, "name": "requestConfirmation", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2643, + "id": 2697, "name": "requestConfirmation", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2644, + "id": 2698, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -54167,7 +55493,7 @@ } }, { - "id": 2645, + "id": 2699, "name": "context", "variant": "param", "kind": 32768, @@ -54175,14 +55501,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2646, + "id": 2700, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2647, + "id": 2701, "name": "requestedBy", "variant": "declaration", "kind": 1024, @@ -54199,7 +55525,7 @@ { "title": "Properties", "children": [ - 2647 + 2701 ] } ] @@ -54232,21 +55558,21 @@ ] }, { - "id": 2580, + "id": 2634, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2581, + "id": 2635, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2582, + "id": 2636, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -54257,7 +55583,7 @@ } }, { - "id": 2583, + "id": 2637, "name": "config", "variant": "param", "kind": 32768, @@ -54309,7 +55635,7 @@ ] }, { - "id": 2660, + "id": 2714, "name": "retrieveActive", "variant": "declaration", "kind": 2048, @@ -54318,14 +55644,14 @@ }, "signatures": [ { - "id": 2661, + "id": 2715, "name": "retrieveActive", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2662, + "id": 2716, "name": "orderId", "variant": "param", "kind": 32768, @@ -54336,7 +55662,7 @@ } }, { - "id": 2663, + "id": 2717, "name": "config", "variant": "param", "kind": 32768, @@ -54401,7 +55727,7 @@ ] }, { - "id": 2677, + "id": 2731, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -54410,14 +55736,14 @@ }, "signatures": [ { - "id": 2678, + "id": 2732, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2679, + "id": 2733, "name": "err", "variant": "param", "kind": 32768, @@ -54447,14 +55773,14 @@ { "type": "reflection", "declaration": { - "id": 2680, + "id": 2734, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2681, + "id": 2735, "name": "code", "variant": "declaration", "kind": 1024, @@ -54469,7 +55795,7 @@ { "title": "Properties", "children": [ - 2681 + 2735 ] } ] @@ -54497,21 +55823,21 @@ } }, { - "id": 2600, + "id": 2654, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2601, + "id": 2655, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2602, + "id": 2656, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -54522,7 +55848,7 @@ } }, { - "id": 2603, + "id": 2657, "name": "data", "variant": "param", "kind": 32768, @@ -54573,14 +55899,14 @@ ] }, { - "id": 2614, + "id": 2668, "name": "updateLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2615, + "id": 2669, "name": "updateLineItem", "variant": "signature", "kind": 4096, @@ -54595,7 +55921,7 @@ }, "parameters": [ { - "id": 2616, + "id": 2670, "name": "orderEditId", "variant": "param", "kind": 32768, @@ -54606,7 +55932,7 @@ } }, { - "id": 2617, + "id": 2671, "name": "itemId", "variant": "param", "kind": 32768, @@ -54617,7 +55943,7 @@ } }, { - "id": 2618, + "id": 2672, "name": "data", "variant": "param", "kind": 32768, @@ -54625,14 +55951,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2619, + "id": 2673, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2620, + "id": 2674, "name": "quantity", "variant": "declaration", "kind": 1024, @@ -54647,7 +55973,7 @@ { "title": "Properties", "children": [ - 2620 + 2674 ] } ] @@ -54674,21 +56000,21 @@ ] }, { - "id": 2674, + "id": 2728, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2675, + "id": 2729, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2676, + "id": 2730, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -54708,7 +56034,7 @@ ], "type": { "type": "reference", - "target": 2554, + "target": 2608, "name": "default", "package": "@medusajs/medusa" }, @@ -54726,7 +56052,7 @@ } }, { - "id": 2563, + "id": 2617, "name": "isOrderEditActive", "variant": "declaration", "kind": 2048, @@ -54736,14 +56062,14 @@ }, "signatures": [ { - "id": 2564, + "id": 2618, "name": "isOrderEditActive", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2565, + "id": 2619, "name": "orderEdit", "variant": "param", "kind": 32768, @@ -54771,61 +56097,61 @@ { "title": "Constructors", "children": [ - 2566 + 2620 ] }, { "title": "Properties", "children": [ - 2672, - 2671, - 2673, - 2574, - 2576, - 2573, - 2667, - 2572, - 2577, - 2569, - 2570, - 2575, - 2571, - 2668, - 2555 + 2726, + 2725, + 2727, + 2628, + 2630, + 2627, + 2721, + 2626, + 2631, + 2623, + 2624, + 2629, + 2625, + 2722, + 2609 ] }, { "title": "Accessors", "children": [ - 2669, - 2578 + 2723, + 2632 ] }, { "title": "Methods", "children": [ - 2634, - 2682, + 2688, + 2736, + 2702, + 2708, 2648, - 2654, - 2594, - 2607, - 2631, - 2604, - 2664, + 2661, + 2685, + 2658, + 2718, + 2692, + 2644, 2638, - 2590, - 2584, - 2625, - 2621, - 2642, - 2580, - 2660, - 2677, - 2600, - 2614, - 2674, - 2563 + 2679, + 2675, + 2696, + 2634, + 2714, + 2731, + 2654, + 2668, + 2728, + 2617 ] } ], @@ -54842,28 +56168,28 @@ ] }, { - "id": 2331, + "id": 2385, "name": "OrderService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 2350, + "id": 2404, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2351, + "id": 2405, "name": "new OrderService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 2352, + "id": 2406, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -54881,7 +56207,7 @@ ], "type": { "type": "reference", - "target": 2331, + "target": 2385, "name": "OrderService", "package": "@medusajs/medusa" }, @@ -54899,7 +56225,7 @@ } }, { - "id": 2528, + "id": 2582, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -54934,7 +56260,7 @@ } }, { - "id": 2527, + "id": 2581, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -54953,7 +56279,7 @@ } }, { - "id": 2529, + "id": 2583, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -54988,7 +56314,7 @@ } }, { - "id": 2376, + "id": 2430, "name": "addressRepository_", "variant": "declaration", "kind": 1024, @@ -55018,7 +56344,7 @@ } }, { - "id": 2375, + "id": 2429, "name": "cartService_", "variant": "declaration", "kind": 1024, @@ -55028,13 +56354,13 @@ }, "type": { "type": "reference", - "target": 198, + "target": 199, "name": "CartService", "package": "@medusajs/medusa" } }, { - "id": 2363, + "id": 2417, "name": "customerService_", "variant": "declaration", "kind": 1024, @@ -55044,13 +56370,13 @@ }, "type": { "type": "reference", - "target": 738, + "target": 745, "name": "CustomerService", "package": "@medusajs/medusa" } }, { - "id": 2367, + "id": 2421, "name": "discountService_", "variant": "declaration", "kind": 1024, @@ -55060,13 +56386,13 @@ }, "type": { "type": "reference", - "target": 955, + "target": 985, "name": "DiscountService", "package": "@medusajs/medusa" } }, { - "id": 2378, + "id": 2432, "name": "draftOrderService_", "variant": "declaration", "kind": 1024, @@ -55076,13 +56402,13 @@ }, "type": { "type": "reference", - "target": 1243, + "target": 1297, "name": "DraftOrderService", "package": "@medusajs/medusa" } }, { - "id": 2380, + "id": 2434, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -55092,13 +56418,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 2381, + "id": 2435, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -55117,7 +56443,7 @@ } }, { - "id": 2368, + "id": 2422, "name": "fulfillmentProviderService_", "variant": "declaration", "kind": 1024, @@ -55127,13 +56453,13 @@ }, "type": { "type": "reference", - "target": 1484, + "target": 1538, "name": "FulfillmentProviderService", "package": "@medusajs/medusa" } }, { - "id": 2369, + "id": 2423, "name": "fulfillmentService_", "variant": "declaration", "kind": 1024, @@ -55143,13 +56469,13 @@ }, "type": { "type": "reference", - "target": 1404, + "target": 1458, "name": "FulfillmentService", "package": "@medusajs/medusa" } }, { - "id": 2377, + "id": 2431, "name": "giftCardService_", "variant": "declaration", "kind": 1024, @@ -55159,13 +56485,13 @@ }, "type": { "type": "reference", - "target": 1565, + "target": 1619, "name": "GiftCardService", "package": "@medusajs/medusa" } }, { - "id": 2379, + "id": 2433, "name": "inventoryService_", "variant": "declaration", "kind": 1024, @@ -55184,7 +56510,7 @@ } }, { - "id": 2370, + "id": 2424, "name": "lineItemService_", "variant": "declaration", "kind": 1024, @@ -55194,13 +56520,13 @@ }, "type": { "type": "reference", - "target": 1713, + "target": 1767, "name": "LineItemService", "package": "@medusajs/medusa" } }, { - "id": 2523, + "id": 2577, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -55223,7 +56549,7 @@ } }, { - "id": 2372, + "id": 2426, "name": "newTotalsService_", "variant": "declaration", "kind": 1024, @@ -55233,13 +56559,13 @@ }, "type": { "type": "reference", - "target": 1956, + "target": 2010, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 2353, + "id": 2407, "name": "orderRepository_", "variant": "declaration", "kind": 1024, @@ -55273,28 +56599,28 @@ { "type": "reflection", "declaration": { - "id": 2354, + "id": 2408, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2359, + "id": 2413, "name": "findOneWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2360, + "id": 2414, "name": "findOneWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2361, + "id": 2415, "name": "relations", "variant": "param", "kind": 32768, @@ -55322,7 +56648,7 @@ "defaultValue": "{}" }, { - "id": 2362, + "id": 2416, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -55389,21 +56715,21 @@ ] }, { - "id": 2355, + "id": 2409, "name": "findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2356, + "id": 2410, "name": "findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2357, + "id": 2411, "name": "relations", "variant": "param", "kind": 32768, @@ -55431,7 +56757,7 @@ "defaultValue": "{}" }, { - "id": 2358, + "id": 2412, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -55505,8 +56831,8 @@ { "title": "Methods", "children": [ - 2359, - 2355 + 2413, + 2409 ] } ] @@ -55516,7 +56842,7 @@ } }, { - "id": 2364, + "id": 2418, "name": "paymentProviderService_", "variant": "declaration", "kind": 1024, @@ -55526,13 +56852,13 @@ }, "type": { "type": "reference", - "target": 2919, + "target": 2973, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 2382, + "id": 2436, "name": "productVariantInventoryService_", "variant": "declaration", "kind": 1024, @@ -55542,13 +56868,13 @@ }, "type": { "type": "reference", - "target": 4409, + "target": 4497, "name": "ProductVariantInventoryService", "package": "@medusajs/medusa" } }, { - "id": 2374, + "id": 2428, "name": "regionService_", "variant": "declaration", "kind": 1024, @@ -55558,13 +56884,13 @@ }, "type": { "type": "reference", - "target": 4533, + "target": 4621, "name": "RegionService", "package": "@medusajs/medusa" } }, { - "id": 2365, + "id": 2419, "name": "shippingOptionService_", "variant": "declaration", "kind": 1024, @@ -55574,13 +56900,13 @@ }, "type": { "type": "reference", - "target": 5056, + "target": 5163, "name": "ShippingOptionService", "package": "@medusajs/medusa" } }, { - "id": 2366, + "id": 2420, "name": "shippingProfileService_", "variant": "declaration", "kind": 1024, @@ -55590,13 +56916,13 @@ }, "type": { "type": "reference", - "target": 5168, + "target": 5275, "name": "ShippingProfileService", "package": "@medusajs/medusa" } }, { - "id": 2373, + "id": 2427, "name": "taxProviderService_", "variant": "declaration", "kind": 1024, @@ -55606,13 +56932,13 @@ }, "type": { "type": "reference", - "target": 5702, + "target": 5814, "name": "TaxProviderService", "package": "@medusajs/medusa" } }, { - "id": 2371, + "id": 2425, "name": "totalsService_", "variant": "declaration", "kind": 1024, @@ -55622,13 +56948,13 @@ }, "type": { "type": "reference", - "target": 5964, + "target": 6081, "name": "TotalsService", "package": "@medusajs/medusa" } }, { - "id": 2524, + "id": 2578, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -55660,7 +56986,7 @@ } }, { - "id": 2332, + "id": 2386, "name": "Events", "variant": "declaration", "kind": 1024, @@ -55671,14 +56997,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2333, + "id": 2387, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2348, + "id": 2402, "name": "CANCELED", "variant": "declaration", "kind": 1024, @@ -55690,7 +57016,7 @@ "defaultValue": "\"order.canceled\"" }, { - "id": 2349, + "id": 2403, "name": "COMPLETED", "variant": "declaration", "kind": 1024, @@ -55702,7 +57028,7 @@ "defaultValue": "\"order.completed\"" }, { - "id": 2339, + "id": 2393, "name": "FULFILLMENT_CANCELED", "variant": "declaration", "kind": 1024, @@ -55714,7 +57040,7 @@ "defaultValue": "\"order.fulfillment_canceled\"" }, { - "id": 2338, + "id": 2392, "name": "FULFILLMENT_CREATED", "variant": "declaration", "kind": 1024, @@ -55726,7 +57052,7 @@ "defaultValue": "\"order.fulfillment_created\"" }, { - "id": 2334, + "id": 2388, "name": "GIFT_CARD_CREATED", "variant": "declaration", "kind": 1024, @@ -55738,7 +57064,7 @@ "defaultValue": "\"order.gift_card_created\"" }, { - "id": 2341, + "id": 2395, "name": "ITEMS_RETURNED", "variant": "declaration", "kind": 1024, @@ -55750,7 +57076,7 @@ "defaultValue": "\"order.items_returned\"" }, { - "id": 2335, + "id": 2389, "name": "PAYMENT_CAPTURED", "variant": "declaration", "kind": 1024, @@ -55762,7 +57088,7 @@ "defaultValue": "\"order.payment_captured\"" }, { - "id": 2336, + "id": 2390, "name": "PAYMENT_CAPTURE_FAILED", "variant": "declaration", "kind": 1024, @@ -55774,7 +57100,7 @@ "defaultValue": "\"order.payment_capture_failed\"" }, { - "id": 2346, + "id": 2400, "name": "PLACED", "variant": "declaration", "kind": 1024, @@ -55786,7 +57112,7 @@ "defaultValue": "\"order.placed\"" }, { - "id": 2343, + "id": 2397, "name": "REFUND_CREATED", "variant": "declaration", "kind": 1024, @@ -55798,7 +57124,7 @@ "defaultValue": "\"order.refund_created\"" }, { - "id": 2344, + "id": 2398, "name": "REFUND_FAILED", "variant": "declaration", "kind": 1024, @@ -55810,7 +57136,7 @@ "defaultValue": "\"order.refund_failed\"" }, { - "id": 2342, + "id": 2396, "name": "RETURN_ACTION_REQUIRED", "variant": "declaration", "kind": 1024, @@ -55822,7 +57148,7 @@ "defaultValue": "\"order.return_action_required\"" }, { - "id": 2340, + "id": 2394, "name": "RETURN_REQUESTED", "variant": "declaration", "kind": 1024, @@ -55834,7 +57160,7 @@ "defaultValue": "\"order.return_requested\"" }, { - "id": 2337, + "id": 2391, "name": "SHIPMENT_CREATED", "variant": "declaration", "kind": 1024, @@ -55846,7 +57172,7 @@ "defaultValue": "\"order.shipment_created\"" }, { - "id": 2345, + "id": 2399, "name": "SWAP_CREATED", "variant": "declaration", "kind": 1024, @@ -55858,7 +57184,7 @@ "defaultValue": "\"order.swap_created\"" }, { - "id": 2347, + "id": 2401, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -55874,22 +57200,22 @@ { "title": "Properties", "children": [ - 2348, - 2349, - 2339, - 2338, - 2334, - 2341, - 2335, - 2336, - 2346, - 2343, - 2344, - 2342, - 2340, - 2337, - 2345, - 2347 + 2402, + 2403, + 2393, + 2392, + 2388, + 2395, + 2389, + 2390, + 2400, + 2397, + 2398, + 2396, + 2394, + 2391, + 2399, + 2401 ] } ] @@ -55898,7 +57224,7 @@ "defaultValue": "..." }, { - "id": 2525, + "id": 2579, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -55906,7 +57232,7 @@ "isProtected": true }, "getSignature": { - "id": 2526, + "id": 2580, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -55933,21 +57259,21 @@ } }, { - "id": 2451, + "id": 2505, "name": "addShippingMethod", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2452, + "id": 2506, "name": "addShippingMethod", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2453, + "id": 2507, "name": "orderId", "variant": "param", "kind": 32768, @@ -55958,7 +57284,7 @@ } }, { - "id": 2454, + "id": 2508, "name": "optionId", "variant": "param", "kind": 32768, @@ -55969,7 +57295,7 @@ } }, { - "id": 2455, + "id": 2509, "name": "data", "variant": "param", "kind": 32768, @@ -55997,7 +57323,7 @@ } }, { - "id": 2456, + "id": 2510, "name": "config", "variant": "param", "kind": 32768, @@ -56038,14 +57364,14 @@ ] }, { - "id": 2492, + "id": 2546, "name": "archive", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2493, + "id": 2547, "name": "archive", "variant": "signature", "kind": 4096, @@ -56071,7 +57397,7 @@ }, "parameters": [ { - "id": 2494, + "id": 2548, "name": "orderId", "variant": "param", "kind": 32768, @@ -56114,7 +57440,7 @@ ] }, { - "id": 2538, + "id": 2592, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -56123,7 +57449,7 @@ }, "signatures": [ { - "id": 2539, + "id": 2593, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -56149,14 +57475,14 @@ }, "typeParameter": [ { - "id": 2540, + "id": 2594, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 2541, + "id": 2595, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -56165,7 +57491,7 @@ ], "parameters": [ { - "id": 2542, + "id": 2596, "name": "work", "variant": "param", "kind": 32768, @@ -56181,21 +57507,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2543, + "id": 2597, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2544, + "id": 2598, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2545, + "id": 2599, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -56234,7 +57560,7 @@ } }, { - "id": 2546, + "id": 2600, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -56264,21 +57590,21 @@ { "type": "reflection", "declaration": { - "id": 2547, + "id": 2601, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2548, + "id": 2602, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2549, + "id": 2603, "name": "error", "variant": "param", "kind": 32768, @@ -56325,7 +57651,7 @@ } }, { - "id": 2550, + "id": 2604, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -56343,21 +57669,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2551, + "id": 2605, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2552, + "id": 2606, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2553, + "id": 2607, "name": "error", "variant": "param", "kind": 32768, @@ -56433,14 +57759,14 @@ } }, { - "id": 2461, + "id": 2515, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2462, + "id": 2516, "name": "cancel", "variant": "signature", "kind": 4096, @@ -56466,7 +57792,7 @@ }, "parameters": [ { - "id": 2463, + "id": 2517, "name": "orderId", "variant": "param", "kind": 32768, @@ -56509,14 +57835,14 @@ ] }, { - "id": 2480, + "id": 2534, "name": "cancelFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2481, + "id": 2535, "name": "cancelFulfillment", "variant": "signature", "kind": 4096, @@ -56542,7 +57868,7 @@ }, "parameters": [ { - "id": 2482, + "id": 2536, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -56585,14 +57911,14 @@ ] }, { - "id": 2464, + "id": 2518, "name": "capturePayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2465, + "id": 2519, "name": "capturePayment", "variant": "signature", "kind": 4096, @@ -56618,7 +57944,7 @@ }, "parameters": [ { - "id": 2466, + "id": 2520, "name": "orderId", "variant": "param", "kind": 32768, @@ -56661,14 +57987,14 @@ ] }, { - "id": 2423, + "id": 2477, "name": "completeOrder", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2424, + "id": 2478, "name": "completeOrder", "variant": "signature", "kind": 4096, @@ -56689,7 +58015,7 @@ }, "parameters": [ { - "id": 2425, + "id": 2479, "name": "orderId", "variant": "param", "kind": 32768, @@ -56732,14 +58058,14 @@ ] }, { - "id": 2426, + "id": 2480, "name": "createFromCart", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2427, + "id": 2481, "name": "createFromCart", "variant": "signature", "kind": 4096, @@ -56765,7 +58091,7 @@ }, "parameters": [ { - "id": 2428, + "id": 2482, "name": "cartOrId", "variant": "param", "kind": 32768, @@ -56814,14 +58140,14 @@ ] }, { - "id": 2471, + "id": 2525, "name": "createFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2472, + "id": 2526, "name": "createFulfillment", "variant": "signature", "kind": 4096, @@ -56847,7 +58173,7 @@ }, "parameters": [ { - "id": 2473, + "id": 2527, "name": "orderId", "variant": "param", "kind": 32768, @@ -56866,7 +58192,7 @@ } }, { - "id": 2474, + "id": 2528, "name": "itemsToFulfill", "variant": "param", "kind": 32768, @@ -56893,7 +58219,7 @@ } }, { - "id": 2475, + "id": 2529, "name": "config", "variant": "param", "kind": 32768, @@ -56909,14 +58235,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2476, + "id": 2530, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2478, + "id": 2532, "name": "location_id", "variant": "declaration", "kind": 1024, @@ -56929,7 +58255,7 @@ } }, { - "id": 2479, + "id": 2533, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -56957,7 +58283,7 @@ } }, { - "id": 2477, + "id": 2531, "name": "no_notification", "variant": "declaration", "kind": 1024, @@ -56974,9 +58300,9 @@ { "title": "Properties", "children": [ - 2478, - 2479, - 2477 + 2532, + 2533, + 2531 ] } ] @@ -57009,7 +58335,7 @@ ] }, { - "id": 2429, + "id": 2483, "name": "createGiftCardsFromLineItem_", "variant": "declaration", "kind": 2048, @@ -57018,14 +58344,14 @@ }, "signatures": [ { - "id": 2430, + "id": 2484, "name": "createGiftCardsFromLineItem_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2431, + "id": 2485, "name": "order", "variant": "param", "kind": 32768, @@ -57041,7 +58367,7 @@ } }, { - "id": 2432, + "id": 2486, "name": "lineItem", "variant": "param", "kind": 32768, @@ -57057,7 +58383,7 @@ } }, { - "id": 2433, + "id": 2487, "name": "manager", "variant": "param", "kind": 32768, @@ -57100,14 +58426,14 @@ ] }, { - "id": 2495, + "id": 2549, "name": "createRefund", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2496, + "id": 2550, "name": "createRefund", "variant": "signature", "kind": 4096, @@ -57133,7 +58459,7 @@ }, "parameters": [ { - "id": 2497, + "id": 2551, "name": "orderId", "variant": "param", "kind": 32768, @@ -57152,7 +58478,7 @@ } }, { - "id": 2498, + "id": 2552, "name": "refundAmount", "variant": "param", "kind": 32768, @@ -57171,7 +58497,7 @@ } }, { - "id": 2499, + "id": 2553, "name": "reason", "variant": "param", "kind": 32768, @@ -57190,7 +58516,7 @@ } }, { - "id": 2500, + "id": 2554, "name": "note", "variant": "param", "kind": 32768, @@ -57211,7 +58537,7 @@ } }, { - "id": 2501, + "id": 2555, "name": "config", "variant": "param", "kind": 32768, @@ -57227,14 +58553,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2502, + "id": 2556, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2503, + "id": 2557, "name": "no_notification", "variant": "declaration", "kind": 1024, @@ -57251,7 +58577,7 @@ { "title": "Properties", "children": [ - 2503 + 2557 ] } ] @@ -57284,14 +58610,14 @@ ] }, { - "id": 2434, + "id": 2488, "name": "createShipment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2435, + "id": 2489, "name": "createShipment", "variant": "signature", "kind": 4096, @@ -57317,7 +58643,7 @@ }, "parameters": [ { - "id": 2436, + "id": 2490, "name": "orderId", "variant": "param", "kind": 32768, @@ -57336,7 +58662,7 @@ } }, { - "id": 2437, + "id": 2491, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -57355,7 +58681,7 @@ } }, { - "id": 2438, + "id": 2492, "name": "trackingLinks", "variant": "param", "kind": 32768, @@ -57384,7 +58710,7 @@ } }, { - "id": 2439, + "id": 2493, "name": "config", "variant": "param", "kind": 32768, @@ -57400,14 +58726,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2440, + "id": 2494, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2442, + "id": 2496, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -57433,7 +58759,7 @@ } }, { - "id": 2441, + "id": 2495, "name": "no_notification", "variant": "declaration", "kind": 1024, @@ -57450,8 +58776,8 @@ { "title": "Properties", "children": [ - 2442, - 2441 + 2496, + 2495 ] } ] @@ -57484,14 +58810,14 @@ ] }, { - "id": 2508, + "id": 2562, "name": "decorateTotals", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2509, + "id": 2563, "name": "decorateTotals", "variant": "signature", "kind": 4096, @@ -57506,7 +58832,7 @@ }, "parameters": [ { - "id": 2510, + "id": 2564, "name": "order", "variant": "param", "kind": 32768, @@ -57522,7 +58848,7 @@ } }, { - "id": 2511, + "id": 2565, "name": "totalsFields", "variant": "param", "kind": 32768, @@ -57560,7 +58886,7 @@ } }, { - "id": 2512, + "id": 2566, "name": "decorateTotals", "variant": "signature", "kind": 4096, @@ -57575,7 +58901,7 @@ }, "parameters": [ { - "id": 2513, + "id": 2567, "name": "order", "variant": "param", "kind": 32768, @@ -57591,7 +58917,7 @@ } }, { - "id": 2514, + "id": 2568, "name": "context", "variant": "param", "kind": 32768, @@ -57633,7 +58959,7 @@ ] }, { - "id": 2504, + "id": 2558, "name": "decorateTotalsLegacy", "variant": "declaration", "kind": 2048, @@ -57642,14 +58968,14 @@ }, "signatures": [ { - "id": 2505, + "id": 2559, "name": "decorateTotalsLegacy", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2506, + "id": 2560, "name": "order", "variant": "param", "kind": 32768, @@ -57665,7 +58991,7 @@ } }, { - "id": 2507, + "id": 2561, "name": "totalsFields", "variant": "param", "kind": 32768, @@ -57704,7 +59030,7 @@ ] }, { - "id": 2483, + "id": 2537, "name": "getFulfillmentItems", "variant": "declaration", "kind": 2048, @@ -57713,7 +59039,7 @@ }, "signatures": [ { - "id": 2484, + "id": 2538, "name": "getFulfillmentItems", "variant": "signature", "kind": 4096, @@ -57739,7 +59065,7 @@ }, "parameters": [ { - "id": 2485, + "id": 2539, "name": "order", "variant": "param", "kind": 32768, @@ -57763,7 +59089,7 @@ } }, { - "id": 2486, + "id": 2540, "name": "items", "variant": "param", "kind": 32768, @@ -57790,7 +59116,7 @@ } }, { - "id": 2487, + "id": 2541, "name": "transformer", "variant": "param", "kind": 32768, @@ -57806,21 +59132,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2488, + "id": 2542, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2489, + "id": 2543, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2490, + "id": 2544, "name": "item", "variant": "param", "kind": 32768, @@ -57845,7 +59171,7 @@ } }, { - "id": 2491, + "id": 2545, "name": "quantity", "variant": "param", "kind": 32768, @@ -57893,7 +59219,7 @@ ] }, { - "id": 2520, + "id": 2574, "name": "getTotalsRelations", "variant": "declaration", "kind": 2048, @@ -57902,14 +59228,14 @@ }, "signatures": [ { - "id": 2521, + "id": 2575, "name": "getTotalsRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2522, + "id": 2576, "name": "config", "variant": "param", "kind": 32768, @@ -57947,14 +59273,14 @@ ] }, { - "id": 2383, + "id": 2437, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2384, + "id": 2438, "name": "list", "variant": "signature", "kind": 4096, @@ -57975,7 +59301,7 @@ }, "parameters": [ { - "id": 2385, + "id": 2439, "name": "selector", "variant": "param", "kind": 32768, @@ -58010,7 +59336,7 @@ } }, { - "id": 2386, + "id": 2440, "name": "config", "variant": "param", "kind": 32768, @@ -58073,14 +59399,14 @@ ] }, { - "id": 2387, + "id": 2441, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2388, + "id": 2442, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -58101,7 +59427,7 @@ }, "parameters": [ { - "id": 2389, + "id": 2443, "name": "selector", "variant": "param", "kind": 32768, @@ -58136,7 +59462,7 @@ } }, { - "id": 2390, + "id": 2444, "name": "config", "variant": "param", "kind": 32768, @@ -58208,14 +59534,14 @@ ] }, { - "id": 2515, + "id": 2569, "name": "registerReturnReceived", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2516, + "id": 2570, "name": "registerReturnReceived", "variant": "signature", "kind": 4096, @@ -58241,7 +59567,7 @@ }, "parameters": [ { - "id": 2517, + "id": 2571, "name": "orderId", "variant": "param", "kind": 32768, @@ -58260,7 +59586,7 @@ } }, { - "id": 2518, + "id": 2572, "name": "receivedReturn", "variant": "param", "kind": 32768, @@ -58284,7 +59610,7 @@ } }, { - "id": 2519, + "id": 2573, "name": "customRefundAmount", "variant": "param", "kind": 32768, @@ -58329,14 +59655,14 @@ ] }, { - "id": 2398, + "id": 2452, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2399, + "id": 2453, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -58362,7 +59688,7 @@ }, "parameters": [ { - "id": 2400, + "id": 2454, "name": "orderId", "variant": "param", "kind": 32768, @@ -58381,7 +59707,7 @@ } }, { - "id": 2401, + "id": 2455, "name": "config", "variant": "param", "kind": 32768, @@ -58441,14 +59767,14 @@ ] }, { - "id": 2411, + "id": 2465, "name": "retrieveByCartId", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2412, + "id": 2466, "name": "retrieveByCartId", "variant": "signature", "kind": 4096, @@ -58474,7 +59800,7 @@ }, "parameters": [ { - "id": 2413, + "id": 2467, "name": "cartId", "variant": "param", "kind": 32768, @@ -58493,7 +59819,7 @@ } }, { - "id": 2414, + "id": 2468, "name": "config", "variant": "param", "kind": 32768, @@ -58553,21 +59879,21 @@ ] }, { - "id": 2415, + "id": 2469, "name": "retrieveByCartIdWithTotals", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2416, + "id": 2470, "name": "retrieveByCartIdWithTotals", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2417, + "id": 2471, "name": "cartId", "variant": "param", "kind": 32768, @@ -58578,7 +59904,7 @@ } }, { - "id": 2418, + "id": 2472, "name": "options", "variant": "param", "kind": 32768, @@ -58630,14 +59956,14 @@ ] }, { - "id": 2419, + "id": 2473, "name": "retrieveByExternalId", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2420, + "id": 2474, "name": "retrieveByExternalId", "variant": "signature", "kind": 4096, @@ -58663,7 +59989,7 @@ }, "parameters": [ { - "id": 2421, + "id": 2475, "name": "externalId", "variant": "param", "kind": 32768, @@ -58682,7 +60008,7 @@ } }, { - "id": 2422, + "id": 2476, "name": "config", "variant": "param", "kind": 32768, @@ -58742,7 +60068,7 @@ ] }, { - "id": 2402, + "id": 2456, "name": "retrieveLegacy", "variant": "declaration", "kind": 2048, @@ -58751,14 +60077,14 @@ }, "signatures": [ { - "id": 2403, + "id": 2457, "name": "retrieveLegacy", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2404, + "id": 2458, "name": "orderIdOrSelector", "variant": "param", "kind": 32768, @@ -58794,7 +60120,7 @@ } }, { - "id": 2405, + "id": 2459, "name": "config", "variant": "param", "kind": 32768, @@ -58846,21 +60172,21 @@ ] }, { - "id": 2406, + "id": 2460, "name": "retrieveWithTotals", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2407, + "id": 2461, "name": "retrieveWithTotals", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2408, + "id": 2462, "name": "orderId", "variant": "param", "kind": 32768, @@ -58871,7 +60197,7 @@ } }, { - "id": 2409, + "id": 2463, "name": "options", "variant": "param", "kind": 32768, @@ -58899,7 +60225,7 @@ "defaultValue": "{}" }, { - "id": 2410, + "id": 2464, "name": "context", "variant": "param", "kind": 32768, @@ -58940,7 +60266,7 @@ ] }, { - "id": 2533, + "id": 2587, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -58949,14 +60275,14 @@ }, "signatures": [ { - "id": 2534, + "id": 2588, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2535, + "id": 2589, "name": "err", "variant": "param", "kind": 32768, @@ -58986,14 +60312,14 @@ { "type": "reflection", "declaration": { - "id": 2536, + "id": 2590, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2537, + "id": 2591, "name": "code", "variant": "declaration", "kind": 1024, @@ -59008,7 +60334,7 @@ { "title": "Properties", "children": [ - 2537 + 2591 ] } ] @@ -59036,7 +60362,7 @@ } }, { - "id": 2391, + "id": 2445, "name": "transformQueryForTotals", "variant": "declaration", "kind": 2048, @@ -59045,14 +60371,14 @@ }, "signatures": [ { - "id": 2392, + "id": 2446, "name": "transformQueryForTotals", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2393, + "id": 2447, "name": "config", "variant": "param", "kind": 32768, @@ -59082,14 +60408,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2394, + "id": 2448, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2395, + "id": 2449, "name": "relations", "variant": "declaration", "kind": 1024, @@ -59112,7 +60438,7 @@ } }, { - "id": 2396, + "id": 2450, "name": "select", "variant": "declaration", "kind": 1024, @@ -59144,7 +60470,7 @@ } }, { - "id": 2397, + "id": 2451, "name": "totalsToSelect", "variant": "declaration", "kind": 1024, @@ -59180,9 +60506,9 @@ { "title": "Properties", "children": [ - 2395, - 2396, - 2397 + 2449, + 2450, + 2451 ] } ] @@ -59192,14 +60518,14 @@ ] }, { - "id": 2457, + "id": 2511, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2458, + "id": 2512, "name": "update", "variant": "signature", "kind": 4096, @@ -59233,7 +60559,7 @@ }, "parameters": [ { - "id": 2459, + "id": 2513, "name": "orderId", "variant": "param", "kind": 32768, @@ -59252,7 +60578,7 @@ } }, { - "id": 2460, + "id": 2514, "name": "update", "variant": "param", "kind": 32768, @@ -59300,7 +60626,7 @@ ] }, { - "id": 2443, + "id": 2497, "name": "updateBillingAddress", "variant": "declaration", "kind": 2048, @@ -59309,7 +60635,7 @@ }, "signatures": [ { - "id": 2444, + "id": 2498, "name": "updateBillingAddress", "variant": "signature", "kind": 4096, @@ -59335,7 +60661,7 @@ }, "parameters": [ { - "id": 2445, + "id": 2499, "name": "order", "variant": "param", "kind": 32768, @@ -59359,7 +60685,7 @@ } }, { - "id": 2446, + "id": 2500, "name": "address", "variant": "param", "kind": 32768, @@ -59402,7 +60728,7 @@ ] }, { - "id": 2447, + "id": 2501, "name": "updateShippingAddress", "variant": "declaration", "kind": 2048, @@ -59411,7 +60737,7 @@ }, "signatures": [ { - "id": 2448, + "id": 2502, "name": "updateShippingAddress", "variant": "signature", "kind": 4096, @@ -59437,7 +60763,7 @@ }, "parameters": [ { - "id": 2449, + "id": 2503, "name": "order", "variant": "param", "kind": 32768, @@ -59461,7 +60787,7 @@ } }, { - "id": 2450, + "id": 2504, "name": "address", "variant": "param", "kind": 32768, @@ -59504,7 +60830,7 @@ ] }, { - "id": 2467, + "id": 2521, "name": "validateFulfillmentLineItem", "variant": "declaration", "kind": 2048, @@ -59513,7 +60839,7 @@ }, "signatures": [ { - "id": 2468, + "id": 2522, "name": "validateFulfillmentLineItem", "variant": "signature", "kind": 4096, @@ -59539,7 +60865,7 @@ }, "parameters": [ { - "id": 2469, + "id": 2523, "name": "item", "variant": "param", "kind": 32768, @@ -59563,7 +60889,7 @@ } }, { - "id": 2470, + "id": 2524, "name": "quantity", "variant": "param", "kind": 32768, @@ -59604,21 +60930,21 @@ ] }, { - "id": 2530, + "id": 2584, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2531, + "id": 2585, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2532, + "id": 2586, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -59638,7 +60964,7 @@ ], "type": { "type": "reference", - "target": 2331, + "target": 2385, "name": "OrderService", "package": "@medusajs/medusa" }, @@ -59660,82 +60986,82 @@ { "title": "Constructors", "children": [ - 2350 + 2404 ] }, { "title": "Properties", "children": [ - 2528, - 2527, - 2529, - 2376, - 2375, - 2363, - 2367, - 2378, - 2380, - 2381, - 2368, - 2369, - 2377, - 2379, - 2370, - 2523, - 2372, - 2353, - 2364, - 2382, - 2374, - 2365, - 2366, - 2373, - 2371, - 2524, - 2332 + 2582, + 2581, + 2583, + 2430, + 2429, + 2417, + 2421, + 2432, + 2434, + 2435, + 2422, + 2423, + 2431, + 2433, + 2424, + 2577, + 2426, + 2407, + 2418, + 2436, + 2428, + 2419, + 2420, + 2427, + 2425, + 2578, + 2386 ] }, { "title": "Accessors", "children": [ - 2525 + 2579 ] }, { "title": "Methods", "children": [ - 2451, - 2492, - 2538, - 2461, + 2505, + 2546, + 2592, + 2515, + 2534, + 2518, + 2477, 2480, - 2464, - 2423, - 2426, - 2471, - 2429, - 2495, - 2434, - 2508, - 2504, + 2525, 2483, - 2520, - 2383, - 2387, - 2515, - 2398, - 2411, - 2415, - 2419, - 2402, - 2406, - 2533, - 2391, - 2457, - 2443, - 2447, - 2467, - 2530 + 2549, + 2488, + 2562, + 2558, + 2537, + 2574, + 2437, + 2441, + 2569, + 2452, + 2465, + 2469, + 2473, + 2456, + 2460, + 2587, + 2445, + 2511, + 2497, + 2501, + 2521, + 2584 ] } ], @@ -59752,28 +61078,28 @@ ] }, { - "id": 2824, + "id": 2878, "name": "PaymentCollectionService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 2831, + "id": 2885, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2832, + "id": 2886, "name": "new PaymentCollectionService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 2833, + "id": 2887, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -59791,7 +61117,7 @@ ], "type": { "type": "reference", - "target": 2824, + "target": 2878, "name": "default", "package": "@medusajs/medusa" }, @@ -59809,7 +61135,7 @@ } }, { - "id": 2893, + "id": 2947, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -59844,7 +61170,7 @@ } }, { - "id": 2892, + "id": 2946, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -59863,7 +61189,7 @@ } }, { - "id": 2894, + "id": 2948, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -59898,7 +61224,7 @@ } }, { - "id": 2836, + "id": 2890, "name": "customerService_", "variant": "declaration", "kind": 1024, @@ -59908,13 +61234,13 @@ }, "type": { "type": "reference", - "target": 738, + "target": 745, "name": "CustomerService", "package": "@medusajs/medusa" } }, { - "id": 2834, + "id": 2888, "name": "eventBusService_", "variant": "declaration", "kind": 1024, @@ -59924,13 +61250,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 2888, + "id": 2942, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -59953,7 +61279,7 @@ } }, { - "id": 2837, + "id": 2891, "name": "paymentCollectionRepository_", "variant": "declaration", "kind": 1024, @@ -59987,28 +61313,28 @@ { "type": "reflection", "declaration": { - "id": 2838, + "id": 2892, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2843, + "id": 2897, "name": "getPaymentCollectionIdByPaymentId", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2844, + "id": 2898, "name": "getPaymentCollectionIdByPaymentId", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2845, + "id": 2899, "name": "paymentId", "variant": "param", "kind": 32768, @@ -60019,7 +61345,7 @@ } }, { - "id": 2846, + "id": 2900, "name": "config", "variant": "param", "kind": 32768, @@ -60071,21 +61397,21 @@ ] }, { - "id": 2839, + "id": 2893, "name": "getPaymentCollectionIdBySessionId", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2840, + "id": 2894, "name": "getPaymentCollectionIdBySessionId", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2841, + "id": 2895, "name": "sessionId", "variant": "param", "kind": 32768, @@ -60096,7 +61422,7 @@ } }, { - "id": 2842, + "id": 2896, "name": "config", "variant": "param", "kind": 32768, @@ -60152,8 +61478,8 @@ { "title": "Methods", "children": [ - 2843, - 2839 + 2897, + 2893 ] } ] @@ -60163,7 +61489,7 @@ } }, { - "id": 2835, + "id": 2889, "name": "paymentProviderService_", "variant": "declaration", "kind": 1024, @@ -60173,13 +61499,13 @@ }, "type": { "type": "reference", - "target": 2919, + "target": 2973, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 2889, + "id": 2943, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -60211,7 +61537,7 @@ } }, { - "id": 2825, + "id": 2879, "name": "Events", "variant": "declaration", "kind": 1024, @@ -60222,14 +61548,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2826, + "id": 2880, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2827, + "id": 2881, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -60241,7 +61567,7 @@ "defaultValue": "\"payment-collection.created\"" }, { - "id": 2829, + "id": 2883, "name": "DELETED", "variant": "declaration", "kind": 1024, @@ -60253,7 +61579,7 @@ "defaultValue": "\"payment-collection.deleted\"" }, { - "id": 2830, + "id": 2884, "name": "PAYMENT_AUTHORIZED", "variant": "declaration", "kind": 1024, @@ -60265,7 +61591,7 @@ "defaultValue": "\"payment-collection.payment_authorized\"" }, { - "id": 2828, + "id": 2882, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -60281,10 +61607,10 @@ { "title": "Properties", "children": [ - 2827, - 2829, - 2830, - 2828 + 2881, + 2883, + 2884, + 2882 ] } ] @@ -60293,7 +61619,7 @@ "defaultValue": "..." }, { - "id": 2890, + "id": 2944, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -60301,7 +61627,7 @@ "isProtected": true }, "getSignature": { - "id": 2891, + "id": 2945, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -60328,7 +61654,7 @@ } }, { - "id": 2903, + "id": 2957, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -60337,7 +61663,7 @@ }, "signatures": [ { - "id": 2904, + "id": 2958, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -60363,14 +61689,14 @@ }, "typeParameter": [ { - "id": 2905, + "id": 2959, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 2906, + "id": 2960, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -60379,7 +61705,7 @@ ], "parameters": [ { - "id": 2907, + "id": 2961, "name": "work", "variant": "param", "kind": 32768, @@ -60395,21 +61721,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2908, + "id": 2962, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2909, + "id": 2963, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2910, + "id": 2964, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -60448,7 +61774,7 @@ } }, { - "id": 2911, + "id": 2965, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -60478,21 +61804,21 @@ { "type": "reflection", "declaration": { - "id": 2912, + "id": 2966, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2913, + "id": 2967, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2914, + "id": 2968, "name": "error", "variant": "param", "kind": 32768, @@ -60539,7 +61865,7 @@ } }, { - "id": 2915, + "id": 2969, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -60557,21 +61883,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2916, + "id": 2970, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2917, + "id": 2971, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2918, + "id": 2972, "name": "error", "variant": "param", "kind": 32768, @@ -60647,14 +61973,14 @@ } }, { - "id": 2883, + "id": 2937, "name": "authorizePaymentSessions", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2884, + "id": 2938, "name": "authorizePaymentSessions", "variant": "signature", "kind": 4096, @@ -60680,7 +62006,7 @@ }, "parameters": [ { - "id": 2885, + "id": 2939, "name": "paymentCollectionId", "variant": "param", "kind": 32768, @@ -60699,7 +62025,7 @@ } }, { - "id": 2886, + "id": 2940, "name": "sessionIds", "variant": "param", "kind": 32768, @@ -60721,7 +62047,7 @@ } }, { - "id": 2887, + "id": 2941, "name": "context", "variant": "param", "kind": 32768, @@ -60780,14 +62106,14 @@ ] }, { - "id": 2851, + "id": 2905, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2852, + "id": 2906, "name": "create", "variant": "signature", "kind": 4096, @@ -60813,7 +62139,7 @@ }, "parameters": [ { - "id": 2853, + "id": 2907, "name": "data", "variant": "param", "kind": 32768, @@ -60861,14 +62187,14 @@ ] }, { - "id": 2858, + "id": 2912, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2859, + "id": 2913, "name": "delete", "variant": "signature", "kind": 4096, @@ -60894,7 +62220,7 @@ }, "parameters": [ { - "id": 2860, + "id": 2914, "name": "paymentCollectionId", "variant": "param", "kind": 32768, @@ -60946,7 +62272,7 @@ ] }, { - "id": 2861, + "id": 2915, "name": "isValidTotalAmount", "variant": "declaration", "kind": 2048, @@ -60955,14 +62281,14 @@ }, "signatures": [ { - "id": 2862, + "id": 2916, "name": "isValidTotalAmount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2863, + "id": 2917, "name": "total", "variant": "param", "kind": 32768, @@ -60973,7 +62299,7 @@ } }, { - "id": 2864, + "id": 2918, "name": "sessionsInput", "variant": "param", "kind": 32768, @@ -61000,14 +62326,14 @@ ] }, { - "id": 2880, + "id": 2934, "name": "markAsAuthorized", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2881, + "id": 2935, "name": "markAsAuthorized", "variant": "signature", "kind": 4096, @@ -61033,7 +62359,7 @@ }, "parameters": [ { - "id": 2882, + "id": 2936, "name": "paymentCollectionId", "variant": "param", "kind": 32768, @@ -61076,14 +62402,14 @@ ] }, { - "id": 2875, + "id": 2929, "name": "refreshPaymentSession", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2876, + "id": 2930, "name": "refreshPaymentSession", "variant": "signature", "kind": 4096, @@ -61109,7 +62435,7 @@ }, "parameters": [ { - "id": 2877, + "id": 2931, "name": "paymentCollectionId", "variant": "param", "kind": 32768, @@ -61128,7 +62454,7 @@ } }, { - "id": 2878, + "id": 2932, "name": "sessionId", "variant": "param", "kind": 32768, @@ -61147,7 +62473,7 @@ } }, { - "id": 2879, + "id": 2933, "name": "customerId", "variant": "param", "kind": 32768, @@ -61190,14 +62516,14 @@ ] }, { - "id": 2847, + "id": 2901, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2848, + "id": 2902, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -61223,7 +62549,7 @@ }, "parameters": [ { - "id": 2849, + "id": 2903, "name": "paymentCollectionId", "variant": "param", "kind": 32768, @@ -61242,7 +62568,7 @@ } }, { - "id": 2850, + "id": 2904, "name": "config", "variant": "param", "kind": 32768, @@ -61302,14 +62628,14 @@ ] }, { - "id": 2870, + "id": 2924, "name": "setPaymentSession", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2871, + "id": 2925, "name": "setPaymentSession", "variant": "signature", "kind": 4096, @@ -61335,7 +62661,7 @@ }, "parameters": [ { - "id": 2872, + "id": 2926, "name": "paymentCollectionId", "variant": "param", "kind": 32768, @@ -61354,7 +62680,7 @@ } }, { - "id": 2873, + "id": 2927, "name": "sessionInput", "variant": "param", "kind": 32768, @@ -61378,7 +62704,7 @@ } }, { - "id": 2874, + "id": 2928, "name": "customerId", "variant": "param", "kind": 32768, @@ -61421,14 +62747,14 @@ ] }, { - "id": 2865, + "id": 2919, "name": "setPaymentSessionsBatch", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2866, + "id": 2920, "name": "setPaymentSessionsBatch", "variant": "signature", "kind": 4096, @@ -61454,7 +62780,7 @@ }, "parameters": [ { - "id": 2867, + "id": 2921, "name": "paymentCollectionOrId", "variant": "param", "kind": 32768, @@ -61487,7 +62813,7 @@ } }, { - "id": 2868, + "id": 2922, "name": "sessionsInput", "variant": "param", "kind": 32768, @@ -61514,7 +62840,7 @@ } }, { - "id": 2869, + "id": 2923, "name": "customerId", "variant": "param", "kind": 32768, @@ -61557,7 +62883,7 @@ ] }, { - "id": 2898, + "id": 2952, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -61566,14 +62892,14 @@ }, "signatures": [ { - "id": 2899, + "id": 2953, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2900, + "id": 2954, "name": "err", "variant": "param", "kind": 32768, @@ -61603,14 +62929,14 @@ { "type": "reflection", "declaration": { - "id": 2901, + "id": 2955, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2902, + "id": 2956, "name": "code", "variant": "declaration", "kind": 1024, @@ -61625,7 +62951,7 @@ { "title": "Properties", "children": [ - 2902 + 2956 ] } ] @@ -61653,14 +62979,14 @@ } }, { - "id": 2854, + "id": 2908, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2855, + "id": 2909, "name": "update", "variant": "signature", "kind": 4096, @@ -61686,7 +63012,7 @@ }, "parameters": [ { - "id": 2856, + "id": 2910, "name": "paymentCollectionId", "variant": "param", "kind": 32768, @@ -61705,7 +63031,7 @@ } }, { - "id": 2857, + "id": 2911, "name": "data", "variant": "param", "kind": 32768, @@ -61764,21 +63090,21 @@ ] }, { - "id": 2895, + "id": 2949, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2896, + "id": 2950, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2897, + "id": 2951, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -61798,7 +63124,7 @@ ], "type": { "type": "reference", - "target": 2824, + "target": 2878, "name": "default", "package": "@medusajs/medusa" }, @@ -61820,46 +63146,46 @@ { "title": "Constructors", "children": [ - 2831 + 2885 ] }, { "title": "Properties", "children": [ - 2893, - 2892, - 2894, - 2836, - 2834, + 2947, + 2946, + 2948, + 2890, 2888, - 2837, - 2835, + 2942, + 2891, 2889, - 2825 + 2943, + 2879 ] }, { "title": "Accessors", "children": [ - 2890 + 2944 ] }, { "title": "Methods", "children": [ - 2903, - 2883, - 2851, - 2858, - 2861, - 2880, - 2875, - 2847, - 2870, - 2865, - 2898, - 2854, - 2895 + 2957, + 2937, + 2905, + 2912, + 2915, + 2934, + 2929, + 2901, + 2924, + 2919, + 2952, + 2908, + 2949 ] } ], @@ -61876,7 +63202,7 @@ ] }, { - "id": 2919, + "id": 2973, "name": "PaymentProviderService", "variant": "declaration", "kind": 128, @@ -61891,21 +63217,21 @@ }, "children": [ { - "id": 2920, + "id": 2974, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2921, + "id": 2975, "name": "new PaymentProviderService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 2922, + "id": 2976, "name": "container", "variant": "param", "kind": 32768, @@ -61923,7 +63249,7 @@ ], "type": { "type": "reference", - "target": 2919, + "target": 2973, "name": "default", "package": "@medusajs/medusa" }, @@ -61941,7 +63267,7 @@ } }, { - "id": 3057, + "id": 3111, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -61976,7 +63302,7 @@ } }, { - "id": 3056, + "id": 3110, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -61995,7 +63321,7 @@ } }, { - "id": 3058, + "id": 3112, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -62030,7 +63356,7 @@ } }, { - "id": 2923, + "id": 2977, "name": "container_", "variant": "declaration", "kind": 1024, @@ -62049,7 +63375,7 @@ } }, { - "id": 2930, + "id": 2984, "name": "customerService_", "variant": "declaration", "kind": 1024, @@ -62059,13 +63385,13 @@ }, "type": { "type": "reference", - "target": 738, + "target": 745, "name": "CustomerService", "package": "@medusajs/medusa" } }, { - "id": 2932, + "id": 2986, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -62084,7 +63410,7 @@ } }, { - "id": 2931, + "id": 2985, "name": "logger_", "variant": "declaration", "kind": 1024, @@ -62103,7 +63429,7 @@ } }, { - "id": 3052, + "id": 3106, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -62126,7 +63452,7 @@ } }, { - "id": 2925, + "id": 2979, "name": "paymentProviderRepository_", "variant": "declaration", "kind": 1024, @@ -62156,7 +63482,7 @@ } }, { - "id": 2926, + "id": 2980, "name": "paymentRepository_", "variant": "declaration", "kind": 1024, @@ -62186,7 +63512,7 @@ } }, { - "id": 2924, + "id": 2978, "name": "paymentSessionRepository_", "variant": "declaration", "kind": 1024, @@ -62216,7 +63542,7 @@ } }, { - "id": 2929, + "id": 2983, "name": "refundRepository_", "variant": "declaration", "kind": 1024, @@ -62246,7 +63572,7 @@ } }, { - "id": 3053, + "id": 3107, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -62278,7 +63604,7 @@ } }, { - "id": 3054, + "id": 3108, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -62286,7 +63612,7 @@ "isProtected": true }, "getSignature": { - "id": 3055, + "id": 3109, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -62313,7 +63639,7 @@ } }, { - "id": 2927, + "id": 2981, "name": "paymentService_", "variant": "declaration", "kind": 262144, @@ -62321,21 +63647,21 @@ "isProtected": true }, "getSignature": { - "id": 2928, + "id": 2982, "name": "paymentService_", "variant": "signature", "kind": 524288, "flags": {}, "type": { "type": "reference", - "target": 2755, + "target": 2809, "name": "default", "package": "@medusajs/medusa" } } }, { - "id": 3067, + "id": 3121, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -62344,7 +63670,7 @@ }, "signatures": [ { - "id": 3068, + "id": 3122, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -62370,14 +63696,14 @@ }, "typeParameter": [ { - "id": 3069, + "id": 3123, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 3070, + "id": 3124, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -62386,7 +63712,7 @@ ], "parameters": [ { - "id": 3071, + "id": 3125, "name": "work", "variant": "param", "kind": 32768, @@ -62402,21 +63728,21 @@ "type": { "type": "reflection", "declaration": { - "id": 3072, + "id": 3126, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3073, + "id": 3127, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3074, + "id": 3128, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -62455,7 +63781,7 @@ } }, { - "id": 3075, + "id": 3129, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -62485,21 +63811,21 @@ { "type": "reflection", "declaration": { - "id": 3076, + "id": 3130, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3077, + "id": 3131, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3078, + "id": 3132, "name": "error", "variant": "param", "kind": 32768, @@ -62546,7 +63872,7 @@ } }, { - "id": 3079, + "id": 3133, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -62564,21 +63890,21 @@ "type": { "type": "reflection", "declaration": { - "id": 3080, + "id": 3134, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3081, + "id": 3135, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3082, + "id": 3136, "name": "error", "variant": "param", "kind": 32768, @@ -62654,21 +63980,21 @@ } }, { - "id": 2989, + "id": 3043, "name": "authorizePayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2990, + "id": 3044, "name": "authorizePayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2991, + "id": 3045, "name": "paymentSession", "variant": "param", "kind": 32768, @@ -62684,7 +64010,7 @@ } }, { - "id": 2992, + "id": 3046, "name": "context", "variant": "param", "kind": 32768, @@ -62743,7 +64069,7 @@ ] }, { - "id": 3026, + "id": 3080, "name": "buildPaymentProcessorContext", "variant": "declaration", "kind": 2048, @@ -62752,7 +64078,7 @@ }, "signatures": [ { - "id": 3027, + "id": 3081, "name": "buildPaymentProcessorContext", "variant": "signature", "kind": 4096, @@ -62769,7 +64095,7 @@ }, "parameters": [ { - "id": 3028, + "id": 3082, "name": "cartOrData", "variant": "param", "kind": 32768, @@ -62826,21 +64152,21 @@ ] }, { - "id": 2997, + "id": 3051, "name": "cancelPayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2998, + "id": 3052, "name": "cancelPayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2999, + "id": 3053, "name": "paymentObj", "variant": "param", "kind": 32768, @@ -62871,14 +64197,14 @@ { "type": "reflection", "declaration": { - "id": 3000, + "id": 3054, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3001, + "id": 3055, "name": "id", "variant": "declaration", "kind": 1024, @@ -62893,7 +64219,7 @@ { "title": "Properties", "children": [ - 3001 + 3055 ] } ] @@ -62927,21 +64253,21 @@ ] }, { - "id": 3005, + "id": 3059, "name": "capturePayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3006, + "id": 3060, "name": "capturePayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3007, + "id": 3061, "name": "paymentObj", "variant": "param", "kind": 32768, @@ -62972,14 +64298,14 @@ { "type": "reflection", "declaration": { - "id": 3008, + "id": 3062, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3009, + "id": 3063, "name": "id", "variant": "declaration", "kind": 1024, @@ -62994,7 +64320,7 @@ { "title": "Properties", "children": [ - 3009 + 3063 ] } ] @@ -63028,21 +64354,21 @@ ] }, { - "id": 2979, + "id": 3033, "name": "createPayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2980, + "id": 3034, "name": "createPayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2981, + "id": 3035, "name": "data", "variant": "param", "kind": 32768, @@ -63082,14 +64408,14 @@ ] }, { - "id": 2950, + "id": 3004, "name": "createSession", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2951, + "id": 3005, "name": "createSession", "variant": "signature", "kind": 4096, @@ -63105,7 +64431,7 @@ }, "parameters": [ { - "id": 2952, + "id": 3006, "name": "providerId", "variant": "param", "kind": 32768, @@ -63116,7 +64442,7 @@ } }, { - "id": 2953, + "id": 3007, "name": "cart", "variant": "param", "kind": 32768, @@ -63154,7 +64480,7 @@ } }, { - "id": 2954, + "id": 3008, "name": "createSession", "variant": "signature", "kind": 4096, @@ -63169,7 +64495,7 @@ }, "parameters": [ { - "id": 2955, + "id": 3009, "name": "sessionInput", "variant": "param", "kind": 32768, @@ -63209,21 +64535,21 @@ ] }, { - "id": 2972, + "id": 3026, "name": "deleteSession", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2973, + "id": 3027, "name": "deleteSession", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2974, + "id": 3028, "name": "paymentSession", "variant": "param", "kind": 32768, @@ -63272,21 +64598,21 @@ ] }, { - "id": 3002, + "id": 3056, "name": "getStatus", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3003, + "id": 3057, "name": "getStatus", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3004, + "id": 3058, "name": "payment", "variant": "param", "kind": 32768, @@ -63326,14 +64652,14 @@ ] }, { - "id": 2936, + "id": 2990, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2937, + "id": 2991, "name": "list", "variant": "signature", "kind": 4096, @@ -63365,14 +64691,14 @@ ] }, { - "id": 2942, + "id": 2996, "name": "listPayments", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2943, + "id": 2997, "name": "listPayments", "variant": "signature", "kind": 4096, @@ -63387,7 +64713,7 @@ }, "parameters": [ { - "id": 2944, + "id": 2998, "name": "selector", "variant": "param", "kind": 32768, @@ -63414,7 +64740,7 @@ } }, { - "id": 2945, + "id": 2999, "name": "config", "variant": "param", "kind": 32768, @@ -63469,7 +64795,7 @@ ] }, { - "id": 3041, + "id": 3095, "name": "processUpdateRequestsData", "variant": "declaration", "kind": 2048, @@ -63478,7 +64804,7 @@ }, "signatures": [ { - "id": 3042, + "id": 3096, "name": "processUpdateRequestsData", "variant": "signature", "kind": 4096, @@ -63495,7 +64821,7 @@ }, "parameters": [ { - "id": 3043, + "id": 3097, "name": "data", "variant": "param", "kind": 32768, @@ -63503,14 +64829,14 @@ "type": { "type": "reflection", "declaration": { - "id": 3044, + "id": 3098, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3045, + "id": 3099, "name": "customer", "variant": "declaration", "kind": 1024, @@ -63520,14 +64846,14 @@ "type": { "type": "reflection", "declaration": { - "id": 3046, + "id": 3100, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3047, + "id": 3101, "name": "id", "variant": "declaration", "kind": 1024, @@ -63544,7 +64870,7 @@ { "title": "Properties", "children": [ - 3047 + 3101 ] } ] @@ -63556,7 +64882,7 @@ { "title": "Properties", "children": [ - 3045 + 3099 ] } ] @@ -63565,7 +64891,7 @@ "defaultValue": "{}" }, { - "id": 3048, + "id": 3102, "name": "paymentResponse", "variant": "param", "kind": 32768, @@ -63624,14 +64950,14 @@ ] }, { - "id": 2956, + "id": 3010, "name": "refreshSession", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2957, + "id": 3011, "name": "refreshSession", "variant": "signature", "kind": 4096, @@ -63657,7 +64983,7 @@ }, "parameters": [ { - "id": 2958, + "id": 3012, "name": "paymentSession", "variant": "param", "kind": 32768, @@ -63673,14 +64999,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2959, + "id": 3013, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2961, + "id": 3015, "name": "data", "variant": "declaration", "kind": 1024, @@ -63706,7 +65032,7 @@ } }, { - "id": 2960, + "id": 3014, "name": "id", "variant": "declaration", "kind": 1024, @@ -63717,7 +65043,7 @@ } }, { - "id": 2962, + "id": 3016, "name": "provider_id", "variant": "declaration", "kind": 1024, @@ -63732,9 +65058,9 @@ { "title": "Properties", "children": [ - 2961, - 2960, - 2962 + 3015, + 3014, + 3016 ] } ] @@ -63742,7 +65068,7 @@ } }, { - "id": 2963, + "id": 3017, "name": "sessionInput", "variant": "param", "kind": 32768, @@ -63782,21 +65108,21 @@ ] }, { - "id": 3016, + "id": 3070, "name": "refundFromPayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3017, + "id": 3071, "name": "refundFromPayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3018, + "id": 3072, "name": "payment", "variant": "param", "kind": 32768, @@ -63812,7 +65138,7 @@ } }, { - "id": 3019, + "id": 3073, "name": "amount", "variant": "param", "kind": 32768, @@ -63823,7 +65149,7 @@ } }, { - "id": 3020, + "id": 3074, "name": "reason", "variant": "param", "kind": 32768, @@ -63834,7 +65160,7 @@ } }, { - "id": 3021, + "id": 3075, "name": "note", "variant": "param", "kind": 32768, @@ -63871,21 +65197,21 @@ ] }, { - "id": 3010, + "id": 3064, "name": "refundPayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3011, + "id": 3065, "name": "refundPayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3012, + "id": 3066, "name": "payObjs", "variant": "param", "kind": 32768, @@ -63904,7 +65230,7 @@ } }, { - "id": 3013, + "id": 3067, "name": "amount", "variant": "param", "kind": 32768, @@ -63915,7 +65241,7 @@ } }, { - "id": 3014, + "id": 3068, "name": "reason", "variant": "param", "kind": 32768, @@ -63926,7 +65252,7 @@ } }, { - "id": 3015, + "id": 3069, "name": "note", "variant": "param", "kind": 32768, @@ -63963,21 +65289,21 @@ ] }, { - "id": 2933, + "id": 2987, "name": "registerInstalledProviders", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2934, + "id": 2988, "name": "registerInstalledProviders", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2935, + "id": 2989, "name": "providerIds", "variant": "param", "kind": 32768, @@ -64010,14 +65336,14 @@ ] }, { - "id": 2938, + "id": 2992, "name": "retrievePayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2939, + "id": 2993, "name": "retrievePayment", "variant": "signature", "kind": 4096, @@ -64032,7 +65358,7 @@ }, "parameters": [ { - "id": 2940, + "id": 2994, "name": "paymentId", "variant": "param", "kind": 32768, @@ -64043,7 +65369,7 @@ } }, { - "id": 2941, + "id": 2995, "name": "relations", "variant": "param", "kind": 32768, @@ -64082,14 +65408,14 @@ ] }, { - "id": 2975, + "id": 3029, "name": "retrieveProvider", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2976, + "id": 3030, "name": "retrieveProvider", "variant": "signature", "kind": 4096, @@ -64115,7 +65441,7 @@ }, "typeParameter": [ { - "id": 2977, + "id": 3031, "name": "TProvider", "variant": "typeParam", "kind": 131072, @@ -64128,7 +65454,7 @@ ], "parameters": [ { - "id": 2978, + "id": 3032, "name": "providerId", "variant": "param", "kind": 32768, @@ -64209,21 +65535,21 @@ ] }, { - "id": 3022, + "id": 3076, "name": "retrieveRefund", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3023, + "id": 3077, "name": "retrieveRefund", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3024, + "id": 3078, "name": "id", "variant": "param", "kind": 32768, @@ -64234,7 +65560,7 @@ } }, { - "id": 3025, + "id": 3079, "name": "config", "variant": "param", "kind": 32768, @@ -64286,14 +65612,14 @@ ] }, { - "id": 2946, + "id": 3000, "name": "retrieveSession", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2947, + "id": 3001, "name": "retrieveSession", "variant": "signature", "kind": 4096, @@ -64308,7 +65634,7 @@ }, "parameters": [ { - "id": 2948, + "id": 3002, "name": "paymentSessionId", "variant": "param", "kind": 32768, @@ -64319,7 +65645,7 @@ } }, { - "id": 2949, + "id": 3003, "name": "relations", "variant": "param", "kind": 32768, @@ -64358,7 +65684,7 @@ ] }, { - "id": 3029, + "id": 3083, "name": "saveSession", "variant": "declaration", "kind": 2048, @@ -64367,7 +65693,7 @@ }, "signatures": [ { - "id": 3030, + "id": 3084, "name": "saveSession", "variant": "signature", "kind": 4096, @@ -64384,7 +65710,7 @@ }, "parameters": [ { - "id": 3031, + "id": 3085, "name": "providerId", "variant": "param", "kind": 32768, @@ -64395,7 +65721,7 @@ } }, { - "id": 3032, + "id": 3086, "name": "data", "variant": "param", "kind": 32768, @@ -64403,14 +65729,14 @@ "type": { "type": "reflection", "declaration": { - "id": 3033, + "id": 3087, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3036, + "id": 3090, "name": "amount", "variant": "declaration", "kind": 1024, @@ -64423,7 +65749,7 @@ } }, { - "id": 3035, + "id": 3089, "name": "cartId", "variant": "declaration", "kind": 1024, @@ -64436,7 +65762,7 @@ } }, { - "id": 3039, + "id": 3093, "name": "isInitiated", "variant": "declaration", "kind": 1024, @@ -64449,7 +65775,7 @@ } }, { - "id": 3038, + "id": 3092, "name": "isSelected", "variant": "declaration", "kind": 1024, @@ -64462,7 +65788,7 @@ } }, { - "id": 3034, + "id": 3088, "name": "payment_session_id", "variant": "declaration", "kind": 1024, @@ -64475,7 +65801,7 @@ } }, { - "id": 3037, + "id": 3091, "name": "sessionData", "variant": "declaration", "kind": 1024, @@ -64501,7 +65827,7 @@ } }, { - "id": 3040, + "id": 3094, "name": "status", "variant": "declaration", "kind": 1024, @@ -64523,13 +65849,13 @@ { "title": "Properties", "children": [ - 3036, - 3035, - 3039, - 3038, - 3034, - 3037, - 3040 + 3090, + 3089, + 3093, + 3092, + 3088, + 3091, + 3094 ] } ] @@ -64561,7 +65887,7 @@ ] }, { - "id": 3062, + "id": 3116, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -64570,14 +65896,14 @@ }, "signatures": [ { - "id": 3063, + "id": 3117, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3064, + "id": 3118, "name": "err", "variant": "param", "kind": 32768, @@ -64607,14 +65933,14 @@ { "type": "reflection", "declaration": { - "id": 3065, + "id": 3119, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3066, + "id": 3120, "name": "code", "variant": "declaration", "kind": 1024, @@ -64629,7 +65955,7 @@ { "title": "Properties", "children": [ - 3066 + 3120 ] } ] @@ -64657,7 +65983,7 @@ } }, { - "id": 3049, + "id": 3103, "name": "throwFromPaymentProcessorError", "variant": "declaration", "kind": 2048, @@ -64666,14 +65992,14 @@ }, "signatures": [ { - "id": 3050, + "id": 3104, "name": "throwFromPaymentProcessorError", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3051, + "id": 3105, "name": "errObj", "variant": "param", "kind": 32768, @@ -64697,21 +66023,21 @@ ] }, { - "id": 2982, + "id": 3036, "name": "updatePayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2983, + "id": 3037, "name": "updatePayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2984, + "id": 3038, "name": "paymentId", "variant": "param", "kind": 32768, @@ -64722,7 +66048,7 @@ } }, { - "id": 2985, + "id": 3039, "name": "data", "variant": "param", "kind": 32768, @@ -64730,14 +66056,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2986, + "id": 3040, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2987, + "id": 3041, "name": "order_id", "variant": "declaration", "kind": 1024, @@ -64750,7 +66076,7 @@ } }, { - "id": 2988, + "id": 3042, "name": "swap_id", "variant": "declaration", "kind": 1024, @@ -64767,8 +66093,8 @@ { "title": "Properties", "children": [ - 2987, - 2988 + 3041, + 3042 ] } ] @@ -64800,14 +66126,14 @@ ] }, { - "id": 2964, + "id": 3018, "name": "updateSession", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2965, + "id": 3019, "name": "updateSession", "variant": "signature", "kind": 4096, @@ -64833,7 +66159,7 @@ }, "parameters": [ { - "id": 2966, + "id": 3020, "name": "paymentSession", "variant": "param", "kind": 32768, @@ -64849,14 +66175,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2967, + "id": 3021, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2969, + "id": 3023, "name": "data", "variant": "declaration", "kind": 1024, @@ -64882,7 +66208,7 @@ } }, { - "id": 2968, + "id": 3022, "name": "id", "variant": "declaration", "kind": 1024, @@ -64893,7 +66219,7 @@ } }, { - "id": 2970, + "id": 3024, "name": "provider_id", "variant": "declaration", "kind": 1024, @@ -64908,9 +66234,9 @@ { "title": "Properties", "children": [ - 2969, - 2968, - 2970 + 3023, + 3022, + 3024 ] } ] @@ -64918,7 +66244,7 @@ } }, { - "id": 2971, + "id": 3025, "name": "sessionInput", "variant": "param", "kind": 32768, @@ -64972,21 +66298,21 @@ ] }, { - "id": 2993, + "id": 3047, "name": "updateSessionData", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2994, + "id": 3048, "name": "updateSessionData", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2995, + "id": 3049, "name": "paymentSession", "variant": "param", "kind": 32768, @@ -65002,7 +66328,7 @@ } }, { - "id": 2996, + "id": 3050, "name": "data", "variant": "param", "kind": 32768, @@ -65052,21 +66378,21 @@ ] }, { - "id": 3059, + "id": 3113, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3060, + "id": 3114, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3061, + "id": 3115, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -65086,7 +66412,7 @@ ], "type": { "type": "reference", - "target": 2919, + "target": 2973, "name": "default", "package": "@medusajs/medusa" }, @@ -65108,64 +66434,64 @@ { "title": "Constructors", "children": [ - 2920 + 2974 ] }, { "title": "Properties", "children": [ - 3057, - 3056, - 3058, - 2923, - 2930, - 2932, - 2931, - 3052, - 2925, - 2926, - 2924, - 2929, - 3053 + 3111, + 3110, + 3112, + 2977, + 2984, + 2986, + 2985, + 3106, + 2979, + 2980, + 2978, + 2983, + 3107 ] }, { "title": "Accessors", "children": [ - 3054, - 2927 + 3108, + 2981 ] }, { "title": "Methods", "children": [ - 3067, - 2989, + 3121, + 3043, + 3080, + 3051, + 3059, + 3033, + 3004, 3026, - 2997, - 3005, - 2979, - 2950, - 2972, - 3002, - 2936, - 2942, - 3041, - 2956, - 3016, + 3056, + 2990, + 2996, + 3095, 3010, - 2933, - 2938, - 2975, - 3022, - 2946, + 3070, + 3064, + 2987, + 2992, 3029, - 3062, - 3049, - 2982, - 2964, - 2993, - 3059 + 3076, + 3000, + 3083, + 3116, + 3103, + 3036, + 3018, + 3047, + 3113 ] } ], @@ -65182,28 +66508,28 @@ ] }, { - "id": 2755, + "id": 2809, "name": "PaymentService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 2764, + "id": 2818, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2765, + "id": 2819, "name": "new PaymentService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 2766, + "id": 2820, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -65221,7 +66547,7 @@ ], "type": { "type": "reference", - "target": 2755, + "target": 2809, "name": "default", "package": "@medusajs/medusa" }, @@ -65239,7 +66565,7 @@ } }, { - "id": 2798, + "id": 2852, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -65274,7 +66600,7 @@ } }, { - "id": 2797, + "id": 2851, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -65293,7 +66619,7 @@ } }, { - "id": 2799, + "id": 2853, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -65328,7 +66654,7 @@ } }, { - "id": 2767, + "id": 2821, "name": "eventBusService_", "variant": "declaration", "kind": 1024, @@ -65338,13 +66664,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 2793, + "id": 2847, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -65367,7 +66693,7 @@ } }, { - "id": 2768, + "id": 2822, "name": "paymentProviderService_", "variant": "declaration", "kind": 1024, @@ -65377,13 +66703,13 @@ }, "type": { "type": "reference", - "target": 2919, + "target": 2973, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 2769, + "id": 2823, "name": "paymentRepository_", "variant": "declaration", "kind": 1024, @@ -65413,7 +66739,7 @@ } }, { - "id": 2794, + "id": 2848, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -65445,7 +66771,7 @@ } }, { - "id": 2756, + "id": 2810, "name": "Events", "variant": "declaration", "kind": 1024, @@ -65456,14 +66782,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2757, + "id": 2811, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2758, + "id": 2812, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -65475,7 +66801,7 @@ "defaultValue": "\"payment.created\"" }, { - "id": 2760, + "id": 2814, "name": "PAYMENT_CAPTURED", "variant": "declaration", "kind": 1024, @@ -65487,7 +66813,7 @@ "defaultValue": "\"payment.payment_captured\"" }, { - "id": 2761, + "id": 2815, "name": "PAYMENT_CAPTURE_FAILED", "variant": "declaration", "kind": 1024, @@ -65499,7 +66825,7 @@ "defaultValue": "\"payment.payment_capture_failed\"" }, { - "id": 2762, + "id": 2816, "name": "REFUND_CREATED", "variant": "declaration", "kind": 1024, @@ -65511,7 +66837,7 @@ "defaultValue": "\"payment.payment_refund_created\"" }, { - "id": 2763, + "id": 2817, "name": "REFUND_FAILED", "variant": "declaration", "kind": 1024, @@ -65523,7 +66849,7 @@ "defaultValue": "\"payment.payment_refund_failed\"" }, { - "id": 2759, + "id": 2813, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -65539,12 +66865,12 @@ { "title": "Properties", "children": [ - 2758, - 2760, - 2761, - 2762, - 2763, - 2759 + 2812, + 2814, + 2815, + 2816, + 2817, + 2813 ] } ] @@ -65553,7 +66879,7 @@ "defaultValue": "..." }, { - "id": 2795, + "id": 2849, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -65561,7 +66887,7 @@ "isProtected": true }, "getSignature": { - "id": 2796, + "id": 2850, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -65588,7 +66914,7 @@ } }, { - "id": 2808, + "id": 2862, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -65597,7 +66923,7 @@ }, "signatures": [ { - "id": 2809, + "id": 2863, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -65623,14 +66949,14 @@ }, "typeParameter": [ { - "id": 2810, + "id": 2864, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 2811, + "id": 2865, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -65639,7 +66965,7 @@ ], "parameters": [ { - "id": 2812, + "id": 2866, "name": "work", "variant": "param", "kind": 32768, @@ -65655,21 +66981,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2813, + "id": 2867, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2814, + "id": 2868, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2815, + "id": 2869, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -65708,7 +67034,7 @@ } }, { - "id": 2816, + "id": 2870, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -65738,21 +67064,21 @@ { "type": "reflection", "declaration": { - "id": 2817, + "id": 2871, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2818, + "id": 2872, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2819, + "id": 2873, "name": "error", "variant": "param", "kind": 32768, @@ -65799,7 +67125,7 @@ } }, { - "id": 2820, + "id": 2874, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -65817,21 +67143,21 @@ "type": { "type": "reflection", "declaration": { - "id": 2821, + "id": 2875, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 2822, + "id": 2876, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2823, + "id": 2877, "name": "error", "variant": "param", "kind": 32768, @@ -65907,14 +67233,14 @@ } }, { - "id": 2784, + "id": 2838, "name": "capture", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2785, + "id": 2839, "name": "capture", "variant": "signature", "kind": 4096, @@ -65940,7 +67266,7 @@ }, "parameters": [ { - "id": 2786, + "id": 2840, "name": "paymentOrId", "variant": "param", "kind": 32768, @@ -65997,14 +67323,14 @@ ] }, { - "id": 2774, + "id": 2828, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2775, + "id": 2829, "name": "create", "variant": "signature", "kind": 4096, @@ -66030,7 +67356,7 @@ }, "parameters": [ { - "id": 2776, + "id": 2830, "name": "paymentInput", "variant": "param", "kind": 32768, @@ -66078,14 +67404,14 @@ ] }, { - "id": 2787, + "id": 2841, "name": "refund", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2788, + "id": 2842, "name": "refund", "variant": "signature", "kind": 4096, @@ -66111,7 +67437,7 @@ }, "parameters": [ { - "id": 2789, + "id": 2843, "name": "paymentOrId", "variant": "param", "kind": 32768, @@ -66144,7 +67470,7 @@ } }, { - "id": 2790, + "id": 2844, "name": "amount", "variant": "param", "kind": 32768, @@ -66163,7 +67489,7 @@ } }, { - "id": 2791, + "id": 2845, "name": "reason", "variant": "param", "kind": 32768, @@ -66182,7 +67508,7 @@ } }, { - "id": 2792, + "id": 2846, "name": "note", "variant": "param", "kind": 32768, @@ -66227,14 +67553,14 @@ ] }, { - "id": 2770, + "id": 2824, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2771, + "id": 2825, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -66260,7 +67586,7 @@ }, "parameters": [ { - "id": 2772, + "id": 2826, "name": "paymentId", "variant": "param", "kind": 32768, @@ -66279,7 +67605,7 @@ } }, { - "id": 2773, + "id": 2827, "name": "config", "variant": "param", "kind": 32768, @@ -66339,7 +67665,7 @@ ] }, { - "id": 2803, + "id": 2857, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -66348,14 +67674,14 @@ }, "signatures": [ { - "id": 2804, + "id": 2858, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2805, + "id": 2859, "name": "err", "variant": "param", "kind": 32768, @@ -66385,14 +67711,14 @@ { "type": "reflection", "declaration": { - "id": 2806, + "id": 2860, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2807, + "id": 2861, "name": "code", "variant": "declaration", "kind": 1024, @@ -66407,7 +67733,7 @@ { "title": "Properties", "children": [ - 2807 + 2861 ] } ] @@ -66435,14 +67761,14 @@ } }, { - "id": 2777, + "id": 2831, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2778, + "id": 2832, "name": "update", "variant": "signature", "kind": 4096, @@ -66468,7 +67794,7 @@ }, "parameters": [ { - "id": 2779, + "id": 2833, "name": "paymentId", "variant": "param", "kind": 32768, @@ -66487,7 +67813,7 @@ } }, { - "id": 2780, + "id": 2834, "name": "data", "variant": "param", "kind": 32768, @@ -66503,14 +67829,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2781, + "id": 2835, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2782, + "id": 2836, "name": "order_id", "variant": "declaration", "kind": 1024, @@ -66523,7 +67849,7 @@ } }, { - "id": 2783, + "id": 2837, "name": "swap_id", "variant": "declaration", "kind": 1024, @@ -66540,8 +67866,8 @@ { "title": "Properties", "children": [ - 2782, - 2783 + 2836, + 2837 ] } ] @@ -66573,21 +67899,21 @@ ] }, { - "id": 2800, + "id": 2854, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 2801, + "id": 2855, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 2802, + "id": 2856, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -66607,7 +67933,7 @@ ], "type": { "type": "reference", - "target": 2755, + "target": 2809, "name": "default", "package": "@medusajs/medusa" }, @@ -66629,40 +67955,40 @@ { "title": "Constructors", "children": [ - 2764 + 2818 ] }, { "title": "Properties", "children": [ - 2798, - 2797, - 2799, - 2767, - 2793, - 2768, - 2769, - 2794, - 2756 + 2852, + 2851, + 2853, + 2821, + 2847, + 2822, + 2823, + 2848, + 2810 ] }, { "title": "Accessors", "children": [ - 2795 + 2849 ] }, { "title": "Methods", "children": [ - 2808, - 2784, - 2774, - 2787, - 2770, - 2803, - 2777, - 2800 + 2862, + 2838, + 2828, + 2841, + 2824, + 2857, + 2831, + 2854 ] } ], @@ -66679,7 +68005,7 @@ ] }, { - "id": 3083, + "id": 3137, "name": "PriceListService", "variant": "declaration", "kind": 128, @@ -66694,21 +68020,21 @@ }, "children": [ { - "id": 3084, + "id": 3138, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 3085, + "id": 3139, "name": "new PriceListService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 3086, + "id": 3140, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -66726,7 +68052,7 @@ ], "type": { "type": "reference", - "target": 3083, + "target": 3137, "name": "PriceListService", "package": "@medusajs/medusa" }, @@ -66744,7 +68070,7 @@ } }, { - "id": 3290, + "id": 3344, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -66779,7 +68105,7 @@ } }, { - "id": 3289, + "id": 3343, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -66798,7 +68124,7 @@ } }, { - "id": 3291, + "id": 3345, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -66833,7 +68159,7 @@ } }, { - "id": 3087, + "id": 3141, "name": "customerGroupService_", "variant": "declaration", "kind": 1024, @@ -66843,13 +68169,13 @@ }, "type": { "type": "reference", - "target": 863, + "target": 893, "name": "CustomerGroupService", "package": "@medusajs/medusa" } }, { - "id": 3214, + "id": 3268, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -66868,7 +68194,7 @@ } }, { - "id": 3285, + "id": 3339, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -66891,7 +68217,7 @@ } }, { - "id": 3103, + "id": 3157, "name": "moneyAmountRepo_", "variant": "declaration", "kind": 1024, @@ -66925,28 +68251,28 @@ { "type": "reflection", "declaration": { - "id": 3104, + "id": 3158, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3123, + "id": 3177, "name": "addPriceListPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3124, + "id": 3178, "name": "addPriceListPrices", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3125, + "id": 3179, "name": "priceListId", "variant": "param", "kind": 32768, @@ -66957,7 +68283,7 @@ } }, { - "id": 3126, + "id": 3180, "name": "prices", "variant": "param", "kind": 32768, @@ -66976,7 +68302,7 @@ } }, { - "id": 3127, + "id": 3181, "name": "overrideExisting", "variant": "param", "kind": 32768, @@ -67015,21 +68341,21 @@ ] }, { - "id": 3207, + "id": 3261, "name": "createProductVariantMoneyAmounts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3208, + "id": 3262, "name": "createProductVariantMoneyAmounts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3209, + "id": 3263, "name": "toCreate", "variant": "param", "kind": 32768, @@ -67039,14 +68365,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 3210, + "id": 3264, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3212, + "id": 3266, "name": "money_amount_id", "variant": "declaration", "kind": 1024, @@ -67057,7 +68383,7 @@ } }, { - "id": 3211, + "id": 3265, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -67072,8 +68398,8 @@ { "title": "Properties", "children": [ - 3212, - 3211 + 3266, + 3265 ] } ] @@ -67106,21 +68432,21 @@ ] }, { - "id": 3128, + "id": 3182, "name": "deletePriceListPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3129, + "id": 3183, "name": "deletePriceListPrices", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3130, + "id": 3184, "name": "priceListId", "variant": "param", "kind": 32768, @@ -67131,7 +68457,7 @@ } }, { - "id": 3131, + "id": 3185, "name": "moneyAmountIds", "variant": "param", "kind": 32768, @@ -67164,21 +68490,21 @@ ] }, { - "id": 3112, + "id": 3166, "name": "deleteVariantPricesNotIn", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3113, + "id": 3167, "name": "deleteVariantPricesNotIn", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3114, + "id": 3168, "name": "variantIdOrData", "variant": "param", "kind": 32768, @@ -67195,14 +68521,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 3115, + "id": 3169, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3117, + "id": 3171, "name": "prices", "variant": "declaration", "kind": 1024, @@ -67221,7 +68547,7 @@ } }, { - "id": 3116, + "id": 3170, "name": "variantId", "variant": "declaration", "kind": 1024, @@ -67236,8 +68562,8 @@ { "title": "Properties", "children": [ - 3117, - 3116 + 3171, + 3170 ] } ] @@ -67248,7 +68574,7 @@ } }, { - "id": 3118, + "id": 3172, "name": "prices", "variant": "param", "kind": 32768, @@ -67288,21 +68614,21 @@ ] }, { - "id": 3145, + "id": 3199, "name": "findCurrencyMoneyAmounts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3146, + "id": 3200, "name": "findCurrencyMoneyAmounts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3147, + "id": 3201, "name": "where", "variant": "param", "kind": 32768, @@ -67312,14 +68638,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 3148, + "id": 3202, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3150, + "id": 3204, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -67330,7 +68656,7 @@ } }, { - "id": 3149, + "id": 3203, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -67345,8 +68671,8 @@ { "title": "Properties", "children": [ - 3150, - 3149 + 3204, + 3203 ] } ] @@ -67367,14 +68693,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 3151, + "id": 3205, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3155, + "id": 3209, "name": "amount", "variant": "declaration", "kind": 1024, @@ -67385,7 +68711,7 @@ } }, { - "id": 3166, + "id": 3220, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -67401,7 +68727,7 @@ } }, { - "id": 3154, + "id": 3208, "name": "currency", "variant": "declaration", "kind": 1024, @@ -67419,7 +68745,7 @@ } }, { - "id": 3153, + "id": 3207, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -67430,7 +68756,7 @@ } }, { - "id": 3164, + "id": 3218, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -67455,7 +68781,7 @@ } }, { - "id": 3165, + "id": 3219, "name": "id", "variant": "declaration", "kind": 1024, @@ -67466,7 +68792,7 @@ } }, { - "id": 3157, + "id": 3211, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -67486,7 +68812,7 @@ } }, { - "id": 3156, + "id": 3210, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -67506,7 +68832,7 @@ } }, { - "id": 3159, + "id": 3213, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -67531,7 +68857,7 @@ } }, { - "id": 3158, + "id": 3212, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -67551,7 +68877,7 @@ } }, { - "id": 3163, + "id": 3217, "name": "region", "variant": "declaration", "kind": 1024, @@ -67569,7 +68895,7 @@ } }, { - "id": 3162, + "id": 3216, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -67589,7 +68915,7 @@ } }, { - "id": 3167, + "id": 3221, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -67605,7 +68931,7 @@ } }, { - "id": 3161, + "id": 3215, "name": "variant", "variant": "declaration", "kind": 1024, @@ -67621,7 +68947,7 @@ } }, { - "id": 3152, + "id": 3206, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -67633,7 +68959,7 @@ "defaultValue": "..." }, { - "id": 3160, + "id": 3214, "name": "variants", "variant": "declaration", "kind": 1024, @@ -67656,22 +68982,22 @@ { "title": "Properties", "children": [ - 3155, - 3166, - 3154, - 3153, - 3164, - 3165, - 3157, - 3156, - 3159, - 3158, - 3163, - 3162, - 3167, - 3161, - 3152, - 3160 + 3209, + 3220, + 3208, + 3207, + 3218, + 3219, + 3211, + 3210, + 3213, + 3212, + 3217, + 3216, + 3221, + 3215, + 3206, + 3214 ] } ] @@ -67686,21 +69012,21 @@ ] }, { - "id": 3132, + "id": 3186, "name": "findManyForVariantInPriceList", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3133, + "id": 3187, "name": "findManyForVariantInPriceList", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3134, + "id": 3188, "name": "variant_id", "variant": "param", "kind": 32768, @@ -67711,7 +69037,7 @@ } }, { - "id": 3135, + "id": 3189, "name": "price_list_id", "variant": "param", "kind": 32768, @@ -67722,7 +69048,7 @@ } }, { - "id": 3136, + "id": 3190, "name": "requiresPriceList", "variant": "param", "kind": 32768, @@ -67770,14 +69096,14 @@ ] }, { - "id": 3137, + "id": 3191, "name": "findManyForVariantInRegion", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3138, + "id": 3192, "name": "findManyForVariantInRegion", "variant": "signature", "kind": 4096, @@ -67796,7 +69122,7 @@ "kind": "inline-tag", "tag": "@link", "text": "findManyForVariantsInRegion", - "target": 3191 + "target": 3245 } ] } @@ -67804,7 +69130,7 @@ }, "parameters": [ { - "id": 3139, + "id": 3193, "name": "variant_id", "variant": "param", "kind": 32768, @@ -67815,7 +69141,7 @@ } }, { - "id": 3140, + "id": 3194, "name": "region_id", "variant": "param", "kind": 32768, @@ -67828,7 +69154,7 @@ } }, { - "id": 3141, + "id": 3195, "name": "currency_code", "variant": "param", "kind": 32768, @@ -67841,7 +69167,7 @@ } }, { - "id": 3142, + "id": 3196, "name": "customer_id", "variant": "param", "kind": 32768, @@ -67854,7 +69180,7 @@ } }, { - "id": 3143, + "id": 3197, "name": "include_discount_prices", "variant": "param", "kind": 32768, @@ -67867,7 +69193,7 @@ } }, { - "id": 3144, + "id": 3198, "name": "include_tax_inclusive_pricing", "variant": "param", "kind": 32768, @@ -67915,21 +69241,21 @@ ] }, { - "id": 3191, + "id": 3245, "name": "findManyForVariantsInRegion", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3192, + "id": 3246, "name": "findManyForVariantsInRegion", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3193, + "id": 3247, "name": "variant_ids", "variant": "param", "kind": 32768, @@ -67952,7 +69278,7 @@ } }, { - "id": 3194, + "id": 3248, "name": "region_id", "variant": "param", "kind": 32768, @@ -67965,7 +69291,7 @@ } }, { - "id": 3195, + "id": 3249, "name": "currency_code", "variant": "param", "kind": 32768, @@ -67978,7 +69304,7 @@ } }, { - "id": 3196, + "id": 3250, "name": "customer_id", "variant": "param", "kind": 32768, @@ -67991,7 +69317,7 @@ } }, { - "id": 3197, + "id": 3251, "name": "include_discount_prices", "variant": "param", "kind": 32768, @@ -68004,7 +69330,7 @@ } }, { - "id": 3198, + "id": 3252, "name": "include_tax_inclusive_pricing", "variant": "param", "kind": 32768, @@ -68067,21 +69393,21 @@ ] }, { - "id": 3168, + "id": 3222, "name": "findRegionMoneyAmounts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3169, + "id": 3223, "name": "findRegionMoneyAmounts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3170, + "id": 3224, "name": "where", "variant": "param", "kind": 32768, @@ -68091,14 +69417,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 3171, + "id": 3225, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3173, + "id": 3227, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -68109,7 +69435,7 @@ } }, { - "id": 3172, + "id": 3226, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -68124,8 +69450,8 @@ { "title": "Properties", "children": [ - 3173, - 3172 + 3227, + 3226 ] } ] @@ -68146,14 +69472,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 3174, + "id": 3228, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3178, + "id": 3232, "name": "amount", "variant": "declaration", "kind": 1024, @@ -68164,7 +69490,7 @@ } }, { - "id": 3189, + "id": 3243, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -68180,7 +69506,7 @@ } }, { - "id": 3177, + "id": 3231, "name": "currency", "variant": "declaration", "kind": 1024, @@ -68198,7 +69524,7 @@ } }, { - "id": 3176, + "id": 3230, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -68209,7 +69535,7 @@ } }, { - "id": 3187, + "id": 3241, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -68234,7 +69560,7 @@ } }, { - "id": 3188, + "id": 3242, "name": "id", "variant": "declaration", "kind": 1024, @@ -68245,7 +69571,7 @@ } }, { - "id": 3180, + "id": 3234, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -68265,7 +69591,7 @@ } }, { - "id": 3179, + "id": 3233, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -68285,7 +69611,7 @@ } }, { - "id": 3182, + "id": 3236, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -68310,7 +69636,7 @@ } }, { - "id": 3181, + "id": 3235, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -68330,7 +69656,7 @@ } }, { - "id": 3186, + "id": 3240, "name": "region", "variant": "declaration", "kind": 1024, @@ -68348,7 +69674,7 @@ } }, { - "id": 3185, + "id": 3239, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -68368,7 +69694,7 @@ } }, { - "id": 3190, + "id": 3244, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -68384,7 +69710,7 @@ } }, { - "id": 3184, + "id": 3238, "name": "variant", "variant": "declaration", "kind": 1024, @@ -68400,7 +69726,7 @@ } }, { - "id": 3175, + "id": 3229, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -68412,7 +69738,7 @@ "defaultValue": "..." }, { - "id": 3183, + "id": 3237, "name": "variants", "variant": "declaration", "kind": 1024, @@ -68435,22 +69761,22 @@ { "title": "Properties", "children": [ - 3178, - 3189, - 3177, - 3176, - 3187, - 3188, - 3180, - 3179, - 3182, - 3181, - 3186, - 3185, - 3190, - 3184, - 3175, - 3183 + 3232, + 3243, + 3231, + 3230, + 3241, + 3242, + 3234, + 3233, + 3236, + 3235, + 3240, + 3239, + 3244, + 3238, + 3229, + 3237 ] } ] @@ -68465,14 +69791,14 @@ ] }, { - "id": 3108, + "id": 3162, "name": "findVariantPricesNotIn", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3109, + "id": 3163, "name": "findVariantPricesNotIn", "variant": "signature", "kind": 4096, @@ -68501,7 +69827,7 @@ }, "parameters": [ { - "id": 3110, + "id": 3164, "name": "variantId", "variant": "param", "kind": 32768, @@ -68512,7 +69838,7 @@ } }, { - "id": 3111, + "id": 3165, "name": "prices", "variant": "param", "kind": 32768, @@ -68558,21 +69884,21 @@ ] }, { - "id": 3203, + "id": 3257, "name": "getPricesForVariantInRegion", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3204, + "id": 3258, "name": "getPricesForVariantInRegion", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3205, + "id": 3259, "name": "variantId", "variant": "param", "kind": 32768, @@ -68583,7 +69909,7 @@ } }, { - "id": 3206, + "id": 3260, "name": "regionId", "variant": "param", "kind": 32768, @@ -68630,21 +69956,21 @@ ] }, { - "id": 3105, + "id": 3159, "name": "insertBulk", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3106, + "id": 3160, "name": "insertBulk", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3107, + "id": 3161, "name": "data", "variant": "param", "kind": 32768, @@ -68701,21 +70027,21 @@ ] }, { - "id": 3199, + "id": 3253, "name": "updatePriceListPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3200, + "id": 3254, "name": "updatePriceListPrices", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3201, + "id": 3255, "name": "priceListId", "variant": "param", "kind": 32768, @@ -68726,7 +70052,7 @@ } }, { - "id": 3202, + "id": 3256, "name": "updates", "variant": "param", "kind": 32768, @@ -68772,21 +70098,21 @@ ] }, { - "id": 3119, + "id": 3173, "name": "upsertVariantCurrencyPrice", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3120, + "id": 3174, "name": "upsertVariantCurrencyPrice", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3121, + "id": 3175, "name": "variantId", "variant": "param", "kind": 32768, @@ -68797,7 +70123,7 @@ } }, { - "id": 3122, + "id": 3176, "name": "price", "variant": "param", "kind": 32768, @@ -68841,20 +70167,20 @@ { "title": "Methods", "children": [ - 3123, - 3207, - 3128, - 3112, - 3145, - 3132, - 3137, - 3191, - 3168, - 3108, - 3203, - 3105, + 3177, + 3261, + 3182, + 3166, 3199, - 3119 + 3186, + 3191, + 3245, + 3222, + 3162, + 3257, + 3159, + 3253, + 3173 ] } ] @@ -68864,7 +70190,7 @@ } }, { - "id": 3091, + "id": 3145, "name": "priceListRepo_", "variant": "declaration", "kind": 1024, @@ -68898,28 +70224,28 @@ { "type": "reflection", "declaration": { - "id": 3092, + "id": 3146, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3093, + "id": 3147, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3094, + "id": 3148, "name": "listAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3095, + "id": 3149, "name": "query", "variant": "param", "kind": 32768, @@ -68946,7 +70272,7 @@ } }, { - "id": 3096, + "id": 3150, "name": "q", "variant": "param", "kind": 32768, @@ -68995,21 +70321,21 @@ ] }, { - "id": 3097, + "id": 3151, "name": "listPriceListsVariantIdsMap", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3098, + "id": 3152, "name": "listPriceListsVariantIdsMap", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3099, + "id": 3153, "name": "priceListIds", "variant": "param", "kind": 32768, @@ -69042,20 +70368,20 @@ { "type": "reflection", "declaration": { - "id": 3100, + "id": 3154, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 3101, + "id": 3155, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 3102, + "id": 3156, "name": "priceListId", "variant": "param", "kind": 32768, @@ -69088,8 +70414,8 @@ { "title": "Methods", "children": [ - 3093, - 3097 + 3147, + 3151 ] } ] @@ -69099,7 +70425,7 @@ } }, { - "id": 3089, + "id": 3143, "name": "productService_", "variant": "declaration", "kind": 1024, @@ -69109,13 +70435,13 @@ }, "type": { "type": "reference", - "target": 3441, + "target": 3495, "name": "ProductService", "package": "@medusajs/medusa" } }, { - "id": 3213, + "id": 3267, "name": "productVariantRepo_", "variant": "declaration", "kind": 1024, @@ -69145,7 +70471,7 @@ } }, { - "id": 3088, + "id": 3142, "name": "regionService_", "variant": "declaration", "kind": 1024, @@ -69155,13 +70481,13 @@ }, "type": { "type": "reference", - "target": 4533, + "target": 4621, "name": "RegionService", "package": "@medusajs/medusa" } }, { - "id": 3286, + "id": 3340, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -69193,7 +70519,7 @@ } }, { - "id": 3090, + "id": 3144, "name": "variantService_", "variant": "declaration", "kind": 1024, @@ -69203,13 +70529,13 @@ }, "type": { "type": "reference", - "target": 4076, + "target": 4150, "name": "ProductVariantService", "package": "@medusajs/medusa" } }, { - "id": 3287, + "id": 3341, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -69217,7 +70543,7 @@ "isProtected": true }, "getSignature": { - "id": 3288, + "id": 3342, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -69244,7 +70570,7 @@ } }, { - "id": 3281, + "id": 3335, "name": "addCurrencyFromRegion", "variant": "declaration", "kind": 2048, @@ -69253,7 +70579,7 @@ }, "signatures": [ { - "id": 3282, + "id": 3336, "name": "addCurrencyFromRegion", "variant": "signature", "kind": 4096, @@ -69303,7 +70629,7 @@ }, "typeParameter": [ { - "id": 3283, + "id": 3337, "name": "T", "variant": "typeParam", "kind": 131072, @@ -69335,7 +70661,7 @@ ], "parameters": [ { - "id": 3284, + "id": 3338, "name": "prices", "variant": "param", "kind": 32768, @@ -69383,14 +70709,14 @@ ] }, { - "id": 3232, + "id": 3286, "name": "addPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3233, + "id": 3287, "name": "addPrices", "variant": "signature", "kind": 4096, @@ -69416,7 +70742,7 @@ }, "parameters": [ { - "id": 3234, + "id": 3288, "name": "id", "variant": "param", "kind": 32768, @@ -69435,7 +70761,7 @@ } }, { - "id": 3235, + "id": 3289, "name": "prices", "variant": "param", "kind": 32768, @@ -69462,7 +70788,7 @@ } }, { - "id": 3236, + "id": 3290, "name": "replace", "variant": "param", "kind": 32768, @@ -69506,7 +70832,7 @@ ] }, { - "id": 3300, + "id": 3354, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -69515,7 +70841,7 @@ }, "signatures": [ { - "id": 3301, + "id": 3355, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -69541,14 +70867,14 @@ }, "typeParameter": [ { - "id": 3302, + "id": 3356, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 3303, + "id": 3357, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -69557,7 +70883,7 @@ ], "parameters": [ { - "id": 3304, + "id": 3358, "name": "work", "variant": "param", "kind": 32768, @@ -69573,21 +70899,21 @@ "type": { "type": "reflection", "declaration": { - "id": 3305, + "id": 3359, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3306, + "id": 3360, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3307, + "id": 3361, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -69626,7 +70952,7 @@ } }, { - "id": 3308, + "id": 3362, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -69656,21 +70982,21 @@ { "type": "reflection", "declaration": { - "id": 3309, + "id": 3363, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3310, + "id": 3364, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3311, + "id": 3365, "name": "error", "variant": "param", "kind": 32768, @@ -69717,7 +71043,7 @@ } }, { - "id": 3312, + "id": 3366, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -69735,21 +71061,21 @@ "type": { "type": "reflection", "declaration": { - "id": 3313, + "id": 3367, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3314, + "id": 3368, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3315, + "id": 3369, "name": "error", "variant": "param", "kind": 32768, @@ -69825,14 +71151,14 @@ } }, { - "id": 3241, + "id": 3295, "name": "clearPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3242, + "id": 3296, "name": "clearPrices", "variant": "signature", "kind": 4096, @@ -69858,7 +71184,7 @@ }, "parameters": [ { - "id": 3243, + "id": 3297, "name": "id", "variant": "param", "kind": 32768, @@ -69896,14 +71222,14 @@ ] }, { - "id": 3225, + "id": 3279, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3226, + "id": 3280, "name": "create", "variant": "signature", "kind": 4096, @@ -69929,7 +71255,7 @@ }, "parameters": [ { - "id": 3227, + "id": 3281, "name": "priceListObject", "variant": "param", "kind": 32768, @@ -69977,14 +71303,14 @@ ] }, { - "id": 3244, + "id": 3298, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3245, + "id": 3299, "name": "delete", "variant": "signature", "kind": 4096, @@ -70010,7 +71336,7 @@ }, "parameters": [ { - "id": 3246, + "id": 3300, "name": "id", "variant": "param", "kind": 32768, @@ -70048,14 +71374,14 @@ ] }, { - "id": 3237, + "id": 3291, "name": "deletePrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3238, + "id": 3292, "name": "deletePrices", "variant": "signature", "kind": 4096, @@ -70081,7 +71407,7 @@ }, "parameters": [ { - "id": 3239, + "id": 3293, "name": "id", "variant": "param", "kind": 32768, @@ -70100,7 +71426,7 @@ } }, { - "id": 3240, + "id": 3294, "name": "priceIds", "variant": "param", "kind": 32768, @@ -70141,7 +71467,7 @@ ] }, { - "id": 3273, + "id": 3327, "name": "deleteProductPrices", "variant": "declaration", "kind": 2048, @@ -70150,14 +71476,14 @@ }, "signatures": [ { - "id": 3274, + "id": 3328, "name": "deleteProductPrices", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3275, + "id": 3329, "name": "priceListId", "variant": "param", "kind": 32768, @@ -70168,7 +71494,7 @@ } }, { - "id": 3276, + "id": 3330, "name": "productIds", "variant": "param", "kind": 32768, @@ -70213,7 +71539,7 @@ ] }, { - "id": 3277, + "id": 3331, "name": "deleteVariantPrices", "variant": "declaration", "kind": 2048, @@ -70222,14 +71548,14 @@ }, "signatures": [ { - "id": 3278, + "id": 3332, "name": "deleteVariantPrices", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3279, + "id": 3333, "name": "priceListId", "variant": "param", "kind": 32768, @@ -70240,7 +71566,7 @@ } }, { - "id": 3280, + "id": 3334, "name": "variantIds", "variant": "param", "kind": 32768, @@ -70285,14 +71611,14 @@ ] }, { - "id": 3247, + "id": 3301, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3248, + "id": 3302, "name": "list", "variant": "signature", "kind": 4096, @@ -70318,7 +71644,7 @@ }, "parameters": [ { - "id": 3249, + "id": 3303, "name": "selector", "variant": "param", "kind": 32768, @@ -70343,7 +71669,7 @@ "defaultValue": "{}" }, { - "id": 3250, + "id": 3304, "name": "config", "variant": "param", "kind": 32768, @@ -70406,14 +71732,14 @@ ] }, { - "id": 3251, + "id": 3305, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3252, + "id": 3306, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -70439,7 +71765,7 @@ }, "parameters": [ { - "id": 3253, + "id": 3307, "name": "selector", "variant": "param", "kind": 32768, @@ -70464,7 +71790,7 @@ "defaultValue": "{}" }, { - "id": 3254, + "id": 3308, "name": "config", "variant": "param", "kind": 32768, @@ -70536,21 +71862,21 @@ ] }, { - "id": 3219, + "id": 3273, "name": "listPriceListsVariantIdsMap", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3220, + "id": 3274, "name": "listPriceListsVariantIdsMap", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3221, + "id": 3275, "name": "priceListIds", "variant": "param", "kind": 32768, @@ -70583,20 +71909,20 @@ { "type": "reflection", "declaration": { - "id": 3222, + "id": 3276, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 3223, + "id": 3277, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 3224, + "id": 3278, "name": "priceListId", "variant": "param", "kind": 32768, @@ -70625,21 +71951,21 @@ ] }, { - "id": 3261, + "id": 3315, "name": "listProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3262, + "id": 3316, "name": "listProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3263, + "id": 3317, "name": "priceListId", "variant": "param", "kind": 32768, @@ -70650,7 +71976,7 @@ } }, { - "id": 3264, + "id": 3318, "name": "selector", "variant": "param", "kind": 32768, @@ -70692,7 +72018,7 @@ "defaultValue": "{}" }, { - "id": 3265, + "id": 3319, "name": "config", "variant": "param", "kind": 32768, @@ -70720,7 +72046,7 @@ "defaultValue": "..." }, { - "id": 3266, + "id": 3320, "name": "requiresPriceList", "variant": "param", "kind": 32768, @@ -70768,21 +72094,21 @@ ] }, { - "id": 3267, + "id": 3321, "name": "listVariants", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3268, + "id": 3322, "name": "listVariants", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3269, + "id": 3323, "name": "priceListId", "variant": "param", "kind": 32768, @@ -70793,7 +72119,7 @@ } }, { - "id": 3270, + "id": 3324, "name": "selector", "variant": "param", "kind": 32768, @@ -70810,7 +72136,7 @@ "defaultValue": "{}" }, { - "id": 3271, + "id": 3325, "name": "config", "variant": "param", "kind": 32768, @@ -70838,7 +72164,7 @@ "defaultValue": "..." }, { - "id": 3272, + "id": 3326, "name": "requiresPriceList", "variant": "param", "kind": 32768, @@ -70886,14 +72212,14 @@ ] }, { - "id": 3215, + "id": 3269, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3216, + "id": 3270, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -70919,7 +72245,7 @@ }, "parameters": [ { - "id": 3217, + "id": 3271, "name": "priceListId", "variant": "param", "kind": 32768, @@ -70938,7 +72264,7 @@ } }, { - "id": 3218, + "id": 3272, "name": "config", "variant": "param", "kind": 32768, @@ -70998,7 +72324,7 @@ ] }, { - "id": 3295, + "id": 3349, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -71007,14 +72333,14 @@ }, "signatures": [ { - "id": 3296, + "id": 3350, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3297, + "id": 3351, "name": "err", "variant": "param", "kind": 32768, @@ -71044,14 +72370,14 @@ { "type": "reflection", "declaration": { - "id": 3298, + "id": 3352, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3299, + "id": 3353, "name": "code", "variant": "declaration", "kind": 1024, @@ -71066,7 +72392,7 @@ { "title": "Properties", "children": [ - 3299 + 3353 ] } ] @@ -71094,14 +72420,14 @@ } }, { - "id": 3228, + "id": 3282, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3229, + "id": 3283, "name": "update", "variant": "signature", "kind": 4096, @@ -71127,7 +72453,7 @@ }, "parameters": [ { - "id": 3230, + "id": 3284, "name": "id", "variant": "param", "kind": 32768, @@ -71146,7 +72472,7 @@ } }, { - "id": 3231, + "id": 3285, "name": "update", "variant": "param", "kind": 32768, @@ -71194,7 +72520,7 @@ ] }, { - "id": 3255, + "id": 3309, "name": "upsertCustomerGroups_", "variant": "declaration", "kind": 2048, @@ -71203,14 +72529,14 @@ }, "signatures": [ { - "id": 3256, + "id": 3310, "name": "upsertCustomerGroups_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3257, + "id": 3311, "name": "priceListId", "variant": "param", "kind": 32768, @@ -71221,7 +72547,7 @@ } }, { - "id": 3258, + "id": 3312, "name": "customerGroups", "variant": "param", "kind": 32768, @@ -71231,14 +72557,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 3259, + "id": 3313, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3260, + "id": 3314, "name": "id", "variant": "declaration", "kind": 1024, @@ -71253,7 +72579,7 @@ { "title": "Properties", "children": [ - 3260 + 3314 ] } ] @@ -71281,21 +72607,21 @@ ] }, { - "id": 3292, + "id": 3346, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3293, + "id": 3347, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3294, + "id": 3348, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -71315,7 +72641,7 @@ ], "type": { "type": "reference", - "target": 3083, + "target": 3137, "name": "PriceListService", "package": "@medusajs/medusa" }, @@ -71337,55 +72663,55 @@ { "title": "Constructors", "children": [ - 3084 + 3138 ] }, { "title": "Properties", "children": [ - 3290, - 3289, - 3291, - 3087, - 3214, - 3285, - 3103, - 3091, - 3089, - 3213, - 3088, - 3286, - 3090 + 3344, + 3343, + 3345, + 3141, + 3268, + 3339, + 3157, + 3145, + 3143, + 3267, + 3142, + 3340, + 3144 ] }, { "title": "Accessors", "children": [ - 3287 + 3341 ] }, { "title": "Methods", "children": [ - 3281, - 3232, - 3300, - 3241, - 3225, - 3244, - 3237, - 3273, - 3277, - 3247, - 3251, - 3219, - 3261, - 3267, - 3215, + 3335, + 3286, + 3354, 3295, - 3228, - 3255, - 3292 + 3279, + 3298, + 3291, + 3327, + 3331, + 3301, + 3305, + 3273, + 3315, + 3321, + 3269, + 3349, + 3282, + 3309, + 3346 ] } ], @@ -71402,7 +72728,7 @@ ] }, { - "id": 3316, + "id": 3370, "name": "PricingService", "variant": "declaration", "kind": 128, @@ -71417,21 +72743,21 @@ }, "children": [ { - "id": 3317, + "id": 3371, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 3318, + "id": 3372, "name": "new PricingService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 3319, + "id": 3373, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -71449,7 +72775,7 @@ ], "type": { "type": "reference", - "target": 3316, + "target": 3370, "name": "PricingService", "package": "@medusajs/medusa" }, @@ -71467,7 +72793,7 @@ } }, { - "id": 3415, + "id": 3469, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -71502,7 +72828,7 @@ } }, { - "id": 3414, + "id": 3468, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -71521,7 +72847,7 @@ } }, { - "id": 3416, + "id": 3470, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -71556,7 +72882,7 @@ } }, { - "id": 3322, + "id": 3376, "name": "customerService_", "variant": "declaration", "kind": 1024, @@ -71566,13 +72892,13 @@ }, "type": { "type": "reference", - "target": 738, + "target": 745, "name": "CustomerService", "package": "@medusajs/medusa" } }, { - "id": 3325, + "id": 3379, "name": "featureFlagRouter", "variant": "declaration", "kind": 1024, @@ -71591,7 +72917,7 @@ } }, { - "id": 3410, + "id": 3464, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -71614,7 +72940,7 @@ } }, { - "id": 3323, + "id": 3377, "name": "priceSelectionStrategy", "variant": "declaration", "kind": 1024, @@ -71633,7 +72959,7 @@ } }, { - "id": 3324, + "id": 3378, "name": "productVariantService", "variant": "declaration", "kind": 1024, @@ -71643,13 +72969,13 @@ }, "type": { "type": "reference", - "target": 4076, + "target": 4150, "name": "ProductVariantService", "package": "@medusajs/medusa" } }, { - "id": 3320, + "id": 3374, "name": "regionService", "variant": "declaration", "kind": 1024, @@ -71659,13 +72985,13 @@ }, "type": { "type": "reference", - "target": 4533, + "target": 4621, "name": "RegionService", "package": "@medusajs/medusa" } }, { - "id": 3321, + "id": 3375, "name": "taxProviderService", "variant": "declaration", "kind": 1024, @@ -71675,13 +73001,13 @@ }, "type": { "type": "reference", - "target": 5702, + "target": 5814, "name": "TaxProviderService", "package": "@medusajs/medusa" } }, { - "id": 3411, + "id": 3465, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -71713,7 +73039,7 @@ } }, { - "id": 3412, + "id": 3466, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -71721,7 +73047,7 @@ "isProtected": true }, "getSignature": { - "id": 3413, + "id": 3467, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -71748,7 +73074,7 @@ } }, { - "id": 3326, + "id": 3380, "name": "pricingModuleService", "variant": "declaration", "kind": 262144, @@ -71756,7 +73082,7 @@ "isProtected": true }, "getSignature": { - "id": 3327, + "id": 3381, "name": "pricingModuleService", "variant": "signature", "kind": 524288, @@ -71773,7 +73099,7 @@ } }, { - "id": 3328, + "id": 3382, "name": "remoteQuery", "variant": "declaration", "kind": 262144, @@ -71781,7 +73107,7 @@ "isProtected": true }, "getSignature": { - "id": 3329, + "id": 3383, "name": "remoteQuery", "variant": "signature", "kind": 524288, @@ -71798,7 +73124,7 @@ } }, { - "id": 3425, + "id": 3479, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -71807,7 +73133,7 @@ }, "signatures": [ { - "id": 3426, + "id": 3480, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -71833,14 +73159,14 @@ }, "typeParameter": [ { - "id": 3427, + "id": 3481, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 3428, + "id": 3482, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -71849,7 +73175,7 @@ ], "parameters": [ { - "id": 3429, + "id": 3483, "name": "work", "variant": "param", "kind": 32768, @@ -71865,21 +73191,21 @@ "type": { "type": "reflection", "declaration": { - "id": 3430, + "id": 3484, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3431, + "id": 3485, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3432, + "id": 3486, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -71918,7 +73244,7 @@ } }, { - "id": 3433, + "id": 3487, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -71948,21 +73274,21 @@ { "type": "reflection", "declaration": { - "id": 3434, + "id": 3488, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3435, + "id": 3489, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3436, + "id": 3490, "name": "error", "variant": "param", "kind": 32768, @@ -72009,7 +73335,7 @@ } }, { - "id": 3437, + "id": 3491, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -72027,21 +73353,21 @@ "type": { "type": "reflection", "declaration": { - "id": 3438, + "id": 3492, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3439, + "id": 3493, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3440, + "id": 3494, "name": "error", "variant": "param", "kind": 32768, @@ -72117,14 +73443,14 @@ } }, { - "id": 3333, + "id": 3387, "name": "calculateTaxes", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3334, + "id": 3388, "name": "calculateTaxes", "variant": "signature", "kind": 4096, @@ -72150,7 +73476,7 @@ }, "parameters": [ { - "id": 3335, + "id": 3389, "name": "variantPricing", "variant": "param", "kind": 32768, @@ -72174,7 +73500,7 @@ } }, { - "id": 3336, + "id": 3390, "name": "productRates", "variant": "param", "kind": 32768, @@ -72214,14 +73540,14 @@ ] }, { - "id": 3330, + "id": 3384, "name": "collectPricingContext", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3331, + "id": 3385, "name": "collectPricingContext", "variant": "signature", "kind": 4096, @@ -72247,7 +73573,7 @@ }, "parameters": [ { - "id": 3332, + "id": 3386, "name": "context", "variant": "param", "kind": 32768, @@ -72295,7 +73621,7 @@ ] }, { - "id": 3392, + "id": 3446, "name": "getPricingModuleVariantMoneyAmounts", "variant": "declaration", "kind": 2048, @@ -72304,14 +73630,14 @@ }, "signatures": [ { - "id": 3393, + "id": 3447, "name": "getPricingModuleVariantMoneyAmounts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3394, + "id": 3448, "name": "variantIds", "variant": "param", "kind": 32768, @@ -72367,14 +73693,14 @@ ] }, { - "id": 3376, + "id": 3430, "name": "getProductPricing", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3377, + "id": 3431, "name": "getProductPricing", "variant": "signature", "kind": 4096, @@ -72400,7 +73726,7 @@ }, "parameters": [ { - "id": 3378, + "id": 3432, "name": "product", "variant": "param", "kind": 32768, @@ -72448,7 +73774,7 @@ } }, { - "id": 3379, + "id": 3433, "name": "context", "variant": "param", "kind": 32768, @@ -72511,14 +73837,14 @@ ] }, { - "id": 3380, + "id": 3434, "name": "getProductPricingById", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3381, + "id": 3435, "name": "getProductPricingById", "variant": "signature", "kind": 4096, @@ -72544,7 +73870,7 @@ }, "parameters": [ { - "id": 3382, + "id": 3436, "name": "productId", "variant": "param", "kind": 32768, @@ -72563,7 +73889,7 @@ } }, { - "id": 3383, + "id": 3437, "name": "context", "variant": "param", "kind": 32768, @@ -72626,7 +73952,7 @@ ] }, { - "id": 3369, + "id": 3423, "name": "getProductPricing_", "variant": "declaration", "kind": 2048, @@ -72635,14 +73961,14 @@ }, "signatures": [ { - "id": 3370, + "id": 3424, "name": "getProductPricing_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3371, + "id": 3425, "name": "data", "variant": "param", "kind": 32768, @@ -72652,14 +73978,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 3372, + "id": 3426, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3373, + "id": 3427, "name": "productId", "variant": "declaration", "kind": 1024, @@ -72670,7 +73996,7 @@ } }, { - "id": 3374, + "id": 3428, "name": "variants", "variant": "declaration", "kind": 1024, @@ -72693,8 +74019,8 @@ { "title": "Properties", "children": [ - 3373, - 3374 + 3427, + 3428 ] } ] @@ -72703,7 +74029,7 @@ } }, { - "id": 3375, + "id": 3429, "name": "context", "variant": "param", "kind": 32768, @@ -72773,14 +74099,14 @@ ] }, { - "id": 3351, + "id": 3405, "name": "getProductVariantPricing", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3352, + "id": 3406, "name": "getProductVariantPricing", "variant": "signature", "kind": 4096, @@ -72806,7 +74132,7 @@ }, "parameters": [ { - "id": 3353, + "id": 3407, "name": "variant", "variant": "param", "kind": 32768, @@ -72846,7 +74172,7 @@ } }, { - "id": 3354, + "id": 3408, "name": "context", "variant": "param", "kind": 32768, @@ -72908,14 +74234,14 @@ ] }, { - "id": 3355, + "id": 3409, "name": "getProductVariantPricingById", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3356, + "id": 3410, "name": "getProductVariantPricingById", "variant": "signature", "kind": 4096, @@ -72948,7 +74274,7 @@ "kind": "inline-tag", "tag": "@link", "text": "getProductVariantsPricing", - "target": 3359, + "target": 3413, "tsLinkText": "" }, { @@ -72961,7 +74287,7 @@ }, "parameters": [ { - "id": 3357, + "id": 3411, "name": "variantId", "variant": "param", "kind": 32768, @@ -72980,7 +74306,7 @@ } }, { - "id": 3358, + "id": 3412, "name": "context", "variant": "param", "kind": 32768, @@ -73042,7 +74368,7 @@ ] }, { - "id": 3337, + "id": 3391, "name": "getProductVariantPricingModulePricing_", "variant": "declaration", "kind": 2048, @@ -73051,14 +74377,14 @@ }, "signatures": [ { - "id": 3338, + "id": 3392, "name": "getProductVariantPricingModulePricing_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3339, + "id": 3393, "name": "variantPriceData", "variant": "param", "kind": 32768, @@ -73068,14 +74394,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 3340, + "id": 3394, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3342, + "id": 3396, "name": "quantity", "variant": "declaration", "kind": 1024, @@ -73088,7 +74414,7 @@ } }, { - "id": 3341, + "id": 3395, "name": "variantId", "variant": "declaration", "kind": 1024, @@ -73103,8 +74429,8 @@ { "title": "Properties", "children": [ - 3342, - 3341 + 3396, + 3395 ] } ] @@ -73113,7 +74439,7 @@ } }, { - "id": 3343, + "id": 3397, "name": "context", "variant": "param", "kind": 32768, @@ -73163,7 +74489,7 @@ ] }, { - "id": 3344, + "id": 3398, "name": "getProductVariantPricing_", "variant": "declaration", "kind": 2048, @@ -73172,14 +74498,14 @@ }, "signatures": [ { - "id": 3345, + "id": 3399, "name": "getProductVariantPricing_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3346, + "id": 3400, "name": "data", "variant": "param", "kind": 32768, @@ -73189,14 +74515,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 3347, + "id": 3401, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3349, + "id": 3403, "name": "quantity", "variant": "declaration", "kind": 1024, @@ -73209,7 +74535,7 @@ } }, { - "id": 3348, + "id": 3402, "name": "variantId", "variant": "declaration", "kind": 1024, @@ -73224,8 +74550,8 @@ { "title": "Properties", "children": [ - 3349, - 3348 + 3403, + 3402 ] } ] @@ -73234,7 +74560,7 @@ } }, { - "id": 3350, + "id": 3404, "name": "context", "variant": "param", "kind": 32768, @@ -73289,14 +74615,14 @@ ] }, { - "id": 3359, + "id": 3413, "name": "getProductVariantsPricing", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3360, + "id": 3414, "name": "getProductVariantsPricing", "variant": "signature", "kind": 4096, @@ -73322,7 +74648,7 @@ }, "parameters": [ { - "id": 3361, + "id": 3415, "name": "data", "variant": "param", "kind": 32768, @@ -73332,14 +74658,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 3362, + "id": 3416, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3364, + "id": 3418, "name": "quantity", "variant": "declaration", "kind": 1024, @@ -73352,7 +74678,7 @@ } }, { - "id": 3363, + "id": 3417, "name": "variantId", "variant": "declaration", "kind": 1024, @@ -73367,8 +74693,8 @@ { "title": "Properties", "children": [ - 3364, - 3363 + 3418, + 3417 ] } ] @@ -73377,7 +74703,7 @@ } }, { - "id": 3365, + "id": 3419, "name": "context", "variant": "param", "kind": 32768, @@ -73425,20 +74751,20 @@ { "type": "reflection", "declaration": { - "id": 3366, + "id": 3420, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 3367, + "id": 3421, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 3368, + "id": 3422, "name": "variant_id", "variant": "param", "kind": 32768, @@ -73469,14 +74795,14 @@ ] }, { - "id": 3402, + "id": 3456, "name": "getShippingOptionPricing", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3403, + "id": 3457, "name": "getShippingOptionPricing", "variant": "signature", "kind": 4096, @@ -73502,7 +74828,7 @@ }, "parameters": [ { - "id": 3404, + "id": 3458, "name": "shippingOption", "variant": "param", "kind": 32768, @@ -73526,7 +74852,7 @@ } }, { - "id": 3405, + "id": 3459, "name": "context", "variant": "param", "kind": 32768, @@ -73588,21 +74914,21 @@ ] }, { - "id": 3399, + "id": 3453, "name": "setAdminProductPricing", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3400, + "id": 3454, "name": "setAdminProductPricing", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3401, + "id": 3455, "name": "products", "variant": "param", "kind": 32768, @@ -73662,21 +74988,21 @@ ] }, { - "id": 3395, + "id": 3449, "name": "setAdminVariantPricing", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3396, + "id": 3450, "name": "setAdminVariantPricing", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3397, + "id": 3451, "name": "variants", "variant": "param", "kind": 32768, @@ -73695,7 +75021,7 @@ } }, { - "id": 3398, + "id": 3452, "name": "context", "variant": "param", "kind": 32768, @@ -73739,14 +75065,14 @@ ] }, { - "id": 3388, + "id": 3442, "name": "setProductPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3389, + "id": 3443, "name": "setProductPrices", "variant": "signature", "kind": 4096, @@ -73772,7 +75098,7 @@ }, "parameters": [ { - "id": 3390, + "id": 3444, "name": "products", "variant": "param", "kind": 32768, @@ -73799,7 +75125,7 @@ } }, { - "id": 3391, + "id": 3445, "name": "context", "variant": "param", "kind": 32768, @@ -73865,14 +75191,14 @@ ] }, { - "id": 3406, + "id": 3460, "name": "setShippingOptionPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3407, + "id": 3461, "name": "setShippingOptionPrices", "variant": "signature", "kind": 4096, @@ -73898,7 +75224,7 @@ }, "parameters": [ { - "id": 3408, + "id": 3462, "name": "shippingOptions", "variant": "param", "kind": 32768, @@ -73925,7 +75251,7 @@ } }, { - "id": 3409, + "id": 3463, "name": "context", "variant": "param", "kind": 32768, @@ -73992,14 +75318,14 @@ ] }, { - "id": 3384, + "id": 3438, "name": "setVariantPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3385, + "id": 3439, "name": "setVariantPrices", "variant": "signature", "kind": 4096, @@ -74025,7 +75351,7 @@ }, "parameters": [ { - "id": 3386, + "id": 3440, "name": "variants", "variant": "param", "kind": 32768, @@ -74044,7 +75370,7 @@ } }, { - "id": 3387, + "id": 3441, "name": "context", "variant": "param", "kind": 32768, @@ -74096,7 +75422,7 @@ ] }, { - "id": 3420, + "id": 3474, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -74105,14 +75431,14 @@ }, "signatures": [ { - "id": 3421, + "id": 3475, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3422, + "id": 3476, "name": "err", "variant": "param", "kind": 32768, @@ -74142,14 +75468,14 @@ { "type": "reflection", "declaration": { - "id": 3423, + "id": 3477, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3424, + "id": 3478, "name": "code", "variant": "declaration", "kind": 1024, @@ -74164,7 +75490,7 @@ { "title": "Properties", "children": [ - 3424 + 3478 ] } ] @@ -74192,21 +75518,21 @@ } }, { - "id": 3417, + "id": 3471, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3418, + "id": 3472, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3419, + "id": 3473, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -74226,7 +75552,7 @@ ], "type": { "type": "reference", - "target": 3316, + "target": 3370, "name": "PricingService", "package": "@medusajs/medusa" }, @@ -74248,56 +75574,56 @@ { "title": "Constructors", "children": [ - 3317 + 3371 ] }, { "title": "Properties", "children": [ - 3415, - 3414, - 3416, - 3322, - 3325, - 3410, - 3323, - 3324, - 3320, - 3321, - 3411 + 3469, + 3468, + 3470, + 3376, + 3379, + 3464, + 3377, + 3378, + 3374, + 3375, + 3465 ] }, { "title": "Accessors", "children": [ - 3412, - 3326, - 3328 + 3466, + 3380, + 3382 ] }, { "title": "Methods", "children": [ - 3425, - 3333, - 3330, - 3392, - 3376, - 3380, - 3369, - 3351, - 3355, - 3337, - 3344, - 3359, - 3402, - 3399, - 3395, - 3388, - 3406, + 3479, + 3387, 3384, - 3420, - 3417 + 3446, + 3430, + 3434, + 3423, + 3405, + 3409, + 3391, + 3398, + 3413, + 3456, + 3453, + 3449, + 3442, + 3460, + 3438, + 3474, + 3471 ] } ], @@ -74314,7 +75640,7 @@ ] }, { - "id": 3699, + "id": 3766, "name": "ProductCategoryService", "variant": "declaration", "kind": 128, @@ -74329,21 +75655,21 @@ }, "children": [ { - "id": 3705, + "id": 3772, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 3706, + "id": 3773, "name": "new ProductCategoryService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 3707, + "id": 3774, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -74361,7 +75687,7 @@ ], "type": { "type": "reference", - "target": 3699, + "target": 3766, "name": "ProductCategoryService", "package": "@medusajs/medusa" }, @@ -74379,7 +75705,7 @@ } }, { - "id": 3828, + "id": 3895, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -74414,7 +75740,7 @@ } }, { - "id": 3827, + "id": 3894, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -74433,7 +75759,7 @@ } }, { - "id": 3829, + "id": 3896, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -74468,7 +75794,7 @@ } }, { - "id": 3728, + "id": 3795, "name": "eventBusService_", "variant": "declaration", "kind": 1024, @@ -74478,13 +75804,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 3823, + "id": 3890, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -74507,7 +75833,7 @@ } }, { - "id": 3708, + "id": 3775, "name": "productCategoryRepo_", "variant": "declaration", "kind": 1024, @@ -74541,28 +75867,28 @@ { "type": "reflection", "declaration": { - "id": 3709, + "id": 3776, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3720, + "id": 3787, "name": "addProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3721, + "id": 3788, "name": "addProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3722, + "id": 3789, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -74573,7 +75899,7 @@ } }, { - "id": 3723, + "id": 3790, "name": "productIds", "variant": "param", "kind": 32768, @@ -74606,21 +75932,21 @@ ] }, { - "id": 3710, + "id": 3777, "name": "findOneWithDescendants", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3711, + "id": 3778, "name": "findOneWithDescendants", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3712, + "id": 3779, "name": "query", "variant": "param", "kind": 32768, @@ -74647,7 +75973,7 @@ } }, { - "id": 3713, + "id": 3780, "name": "treeScope", "variant": "param", "kind": 32768, @@ -74708,21 +76034,21 @@ ] }, { - "id": 3714, + "id": 3781, "name": "getFreeTextSearchResultsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3715, + "id": 3782, "name": "getFreeTextSearchResultsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3716, + "id": 3783, "name": "options", "variant": "param", "kind": 32768, @@ -74750,7 +76076,7 @@ "defaultValue": "..." }, { - "id": 3717, + "id": 3784, "name": "q", "variant": "param", "kind": 32768, @@ -74763,7 +76089,7 @@ } }, { - "id": 3718, + "id": 3785, "name": "treeScope", "variant": "param", "kind": 32768, @@ -74791,7 +76117,7 @@ "defaultValue": "{}" }, { - "id": 3719, + "id": 3786, "name": "includeTree", "variant": "param", "kind": 32768, @@ -74839,21 +76165,21 @@ ] }, { - "id": 3724, + "id": 3791, "name": "removeProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3725, + "id": 3792, "name": "removeProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3726, + "id": 3793, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -74864,7 +76190,7 @@ } }, { - "id": 3727, + "id": 3794, "name": "productIds", "variant": "param", "kind": 32768, @@ -74906,10 +76232,10 @@ { "title": "Methods", "children": [ - 3720, - 3710, - 3714, - 3724 + 3787, + 3777, + 3781, + 3791 ] } ] @@ -74919,7 +76245,7 @@ } }, { - "id": 3824, + "id": 3891, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -74951,7 +76277,7 @@ } }, { - "id": 3700, + "id": 3767, "name": "Events", "variant": "declaration", "kind": 1024, @@ -74961,14 +76287,14 @@ "type": { "type": "reflection", "declaration": { - "id": 3701, + "id": 3768, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3702, + "id": 3769, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -74980,7 +76306,7 @@ "defaultValue": "\"product-category.created\"" }, { - "id": 3704, + "id": 3771, "name": "DELETED", "variant": "declaration", "kind": 1024, @@ -74992,7 +76318,7 @@ "defaultValue": "\"product-category.deleted\"" }, { - "id": 3703, + "id": 3770, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -75008,9 +76334,9 @@ { "title": "Properties", "children": [ - 3702, - 3704, - 3703 + 3769, + 3771, + 3770 ] } ] @@ -75019,7 +76345,7 @@ "defaultValue": "..." }, { - "id": 3825, + "id": 3892, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -75027,7 +76353,7 @@ "isProtected": true }, "getSignature": { - "id": 3826, + "id": 3893, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -75054,14 +76380,14 @@ } }, { - "id": 3761, + "id": 3828, "name": "addProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3762, + "id": 3829, "name": "addProducts", "variant": "signature", "kind": 4096, @@ -75087,7 +76413,7 @@ }, "parameters": [ { - "id": 3763, + "id": 3830, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -75106,7 +76432,7 @@ } }, { - "id": 3764, + "id": 3831, "name": "productIds", "variant": "param", "kind": 32768, @@ -75147,7 +76473,7 @@ ] }, { - "id": 3838, + "id": 3905, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -75156,7 +76482,7 @@ }, "signatures": [ { - "id": 3839, + "id": 3906, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -75182,14 +76508,14 @@ }, "typeParameter": [ { - "id": 3840, + "id": 3907, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 3841, + "id": 3908, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -75198,7 +76524,7 @@ ], "parameters": [ { - "id": 3842, + "id": 3909, "name": "work", "variant": "param", "kind": 32768, @@ -75214,21 +76540,21 @@ "type": { "type": "reflection", "declaration": { - "id": 3843, + "id": 3910, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3844, + "id": 3911, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3845, + "id": 3912, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -75267,7 +76593,7 @@ } }, { - "id": 3846, + "id": 3913, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -75297,21 +76623,21 @@ { "type": "reflection", "declaration": { - "id": 3847, + "id": 3914, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3848, + "id": 3915, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3849, + "id": 3916, "name": "error", "variant": "param", "kind": 32768, @@ -75358,7 +76684,7 @@ } }, { - "id": 3850, + "id": 3917, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -75376,21 +76702,21 @@ "type": { "type": "reflection", "declaration": { - "id": 3851, + "id": 3918, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3852, + "id": 3919, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3853, + "id": 3920, "name": "error", "variant": "param", "kind": 32768, @@ -75466,14 +76792,14 @@ } }, { - "id": 3751, + "id": 3818, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3752, + "id": 3819, "name": "create", "variant": "signature", "kind": 4096, @@ -75499,7 +76825,7 @@ }, "parameters": [ { - "id": 3753, + "id": 3820, "name": "productCategoryInput", "variant": "param", "kind": 32768, @@ -75547,14 +76873,14 @@ ] }, { - "id": 3758, + "id": 3825, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3759, + "id": 3826, "name": "delete", "variant": "signature", "kind": 4096, @@ -75580,7 +76906,7 @@ }, "parameters": [ { - "id": 3760, + "id": 3827, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -75618,7 +76944,7 @@ ] }, { - "id": 3769, + "id": 3836, "name": "fetchReorderConditions", "variant": "declaration", "kind": 2048, @@ -75627,14 +76953,14 @@ }, "signatures": [ { - "id": 3770, + "id": 3837, "name": "fetchReorderConditions", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3771, + "id": 3838, "name": "productCategory", "variant": "param", "kind": 32768, @@ -75650,7 +76976,7 @@ } }, { - "id": 3772, + "id": 3839, "name": "input", "variant": "param", "kind": 32768, @@ -75666,7 +76992,7 @@ } }, { - "id": 3773, + "id": 3840, "name": "shouldDeleteElement", "variant": "param", "kind": 32768, @@ -75691,14 +77017,14 @@ ] }, { - "id": 3729, + "id": 3796, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3730, + "id": 3797, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -75724,7 +77050,7 @@ }, "parameters": [ { - "id": 3731, + "id": 3798, "name": "selector", "variant": "param", "kind": 32768, @@ -75759,7 +77085,7 @@ } }, { - "id": 3732, + "id": 3799, "name": "config", "variant": "param", "kind": 32768, @@ -75795,7 +77121,7 @@ "defaultValue": "..." }, { - "id": 3733, + "id": 3800, "name": "treeSelector", "variant": "param", "kind": 32768, @@ -75867,7 +77193,7 @@ ] }, { - "id": 3774, + "id": 3841, "name": "performReordering", "variant": "declaration", "kind": 2048, @@ -75876,14 +77202,14 @@ }, "signatures": [ { - "id": 3775, + "id": 3842, "name": "performReordering", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3776, + "id": 3843, "name": "repository", "variant": "param", "kind": 32768, @@ -75914,28 +77240,28 @@ { "type": "reflection", "declaration": { - "id": 3777, + "id": 3844, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3788, + "id": 3855, "name": "addProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3789, + "id": 3856, "name": "addProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3790, + "id": 3857, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -75946,7 +77272,7 @@ } }, { - "id": 3791, + "id": 3858, "name": "productIds", "variant": "param", "kind": 32768, @@ -75979,21 +77305,21 @@ ] }, { - "id": 3778, + "id": 3845, "name": "findOneWithDescendants", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3779, + "id": 3846, "name": "findOneWithDescendants", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3780, + "id": 3847, "name": "query", "variant": "param", "kind": 32768, @@ -76020,7 +77346,7 @@ } }, { - "id": 3781, + "id": 3848, "name": "treeScope", "variant": "param", "kind": 32768, @@ -76081,21 +77407,21 @@ ] }, { - "id": 3782, + "id": 3849, "name": "getFreeTextSearchResultsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3783, + "id": 3850, "name": "getFreeTextSearchResultsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3784, + "id": 3851, "name": "options", "variant": "param", "kind": 32768, @@ -76123,7 +77449,7 @@ "defaultValue": "..." }, { - "id": 3785, + "id": 3852, "name": "q", "variant": "param", "kind": 32768, @@ -76136,7 +77462,7 @@ } }, { - "id": 3786, + "id": 3853, "name": "treeScope", "variant": "param", "kind": 32768, @@ -76164,7 +77490,7 @@ "defaultValue": "{}" }, { - "id": 3787, + "id": 3854, "name": "includeTree", "variant": "param", "kind": 32768, @@ -76212,21 +77538,21 @@ ] }, { - "id": 3792, + "id": 3859, "name": "removeProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3793, + "id": 3860, "name": "removeProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3794, + "id": 3861, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -76237,7 +77563,7 @@ } }, { - "id": 3795, + "id": 3862, "name": "productIds", "variant": "param", "kind": 32768, @@ -76279,10 +77605,10 @@ { "title": "Methods", "children": [ - 3788, - 3778, - 3782, - 3792 + 3855, + 3845, + 3849, + 3859 ] } ] @@ -76292,7 +77618,7 @@ } }, { - "id": 3796, + "id": 3863, "name": "conditions", "variant": "param", "kind": 32768, @@ -76327,14 +77653,14 @@ ] }, { - "id": 3765, + "id": 3832, "name": "removeProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3766, + "id": 3833, "name": "removeProducts", "variant": "signature", "kind": 4096, @@ -76360,7 +77686,7 @@ }, "parameters": [ { - "id": 3767, + "id": 3834, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -76379,7 +77705,7 @@ } }, { - "id": 3768, + "id": 3835, "name": "productIds", "variant": "param", "kind": 32768, @@ -76420,14 +77746,14 @@ ] }, { - "id": 3739, + "id": 3806, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3740, + "id": 3807, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -76453,7 +77779,7 @@ }, "parameters": [ { - "id": 3741, + "id": 3808, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -76472,7 +77798,7 @@ } }, { - "id": 3742, + "id": 3809, "name": "config", "variant": "param", "kind": 32768, @@ -76508,7 +77834,7 @@ "defaultValue": "{}" }, { - "id": 3743, + "id": 3810, "name": "selector", "variant": "param", "kind": 32768, @@ -76536,7 +77862,7 @@ "defaultValue": "{}" }, { - "id": 3744, + "id": 3811, "name": "treeSelector", "variant": "param", "kind": 32768, @@ -76588,14 +77914,14 @@ ] }, { - "id": 3745, + "id": 3812, "name": "retrieveByHandle", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3746, + "id": 3813, "name": "retrieveByHandle", "variant": "signature", "kind": 4096, @@ -76621,7 +77947,7 @@ }, "parameters": [ { - "id": 3747, + "id": 3814, "name": "handle", "variant": "param", "kind": 32768, @@ -76640,7 +77966,7 @@ } }, { - "id": 3748, + "id": 3815, "name": "config", "variant": "param", "kind": 32768, @@ -76676,7 +78002,7 @@ "defaultValue": "{}" }, { - "id": 3749, + "id": 3816, "name": "selector", "variant": "param", "kind": 32768, @@ -76704,7 +78030,7 @@ "defaultValue": "{}" }, { - "id": 3750, + "id": 3817, "name": "treeSelector", "variant": "param", "kind": 32768, @@ -76756,7 +78082,7 @@ ] }, { - "id": 3734, + "id": 3801, "name": "retrieve_", "variant": "declaration", "kind": 2048, @@ -76765,7 +78091,7 @@ }, "signatures": [ { - "id": 3735, + "id": 3802, "name": "retrieve_", "variant": "signature", "kind": 4096, @@ -76791,7 +78117,7 @@ }, "parameters": [ { - "id": 3736, + "id": 3803, "name": "config", "variant": "param", "kind": 32768, @@ -76827,7 +78153,7 @@ "defaultValue": "{}" }, { - "id": 3737, + "id": 3804, "name": "selector", "variant": "param", "kind": 32768, @@ -76855,7 +78181,7 @@ "defaultValue": "{}" }, { - "id": 3738, + "id": 3805, "name": "treeSelector", "variant": "param", "kind": 32768, @@ -76907,7 +78233,7 @@ ] }, { - "id": 3797, + "id": 3864, "name": "shiftSiblings", "variant": "declaration", "kind": 2048, @@ -76916,14 +78242,14 @@ }, "signatures": [ { - "id": 3798, + "id": 3865, "name": "shiftSiblings", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3799, + "id": 3866, "name": "repository", "variant": "param", "kind": 32768, @@ -76954,28 +78280,28 @@ { "type": "reflection", "declaration": { - "id": 3800, + "id": 3867, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3811, + "id": 3878, "name": "addProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3812, + "id": 3879, "name": "addProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3813, + "id": 3880, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -76986,7 +78312,7 @@ } }, { - "id": 3814, + "id": 3881, "name": "productIds", "variant": "param", "kind": 32768, @@ -77019,21 +78345,21 @@ ] }, { - "id": 3801, + "id": 3868, "name": "findOneWithDescendants", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3802, + "id": 3869, "name": "findOneWithDescendants", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3803, + "id": 3870, "name": "query", "variant": "param", "kind": 32768, @@ -77060,7 +78386,7 @@ } }, { - "id": 3804, + "id": 3871, "name": "treeScope", "variant": "param", "kind": 32768, @@ -77121,21 +78447,21 @@ ] }, { - "id": 3805, + "id": 3872, "name": "getFreeTextSearchResultsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3806, + "id": 3873, "name": "getFreeTextSearchResultsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3807, + "id": 3874, "name": "options", "variant": "param", "kind": 32768, @@ -77163,7 +78489,7 @@ "defaultValue": "..." }, { - "id": 3808, + "id": 3875, "name": "q", "variant": "param", "kind": 32768, @@ -77176,7 +78502,7 @@ } }, { - "id": 3809, + "id": 3876, "name": "treeScope", "variant": "param", "kind": 32768, @@ -77204,7 +78530,7 @@ "defaultValue": "{}" }, { - "id": 3810, + "id": 3877, "name": "includeTree", "variant": "param", "kind": 32768, @@ -77252,21 +78578,21 @@ ] }, { - "id": 3815, + "id": 3882, "name": "removeProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3816, + "id": 3883, "name": "removeProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3817, + "id": 3884, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -77277,7 +78603,7 @@ } }, { - "id": 3818, + "id": 3885, "name": "productIds", "variant": "param", "kind": 32768, @@ -77319,10 +78645,10 @@ { "title": "Methods", "children": [ - 3811, - 3801, - 3805, - 3815 + 3878, + 3868, + 3872, + 3882 ] } ] @@ -77332,7 +78658,7 @@ } }, { - "id": 3819, + "id": 3886, "name": "conditions", "variant": "param", "kind": 32768, @@ -77367,7 +78693,7 @@ ] }, { - "id": 3833, + "id": 3900, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -77376,14 +78702,14 @@ }, "signatures": [ { - "id": 3834, + "id": 3901, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3835, + "id": 3902, "name": "err", "variant": "param", "kind": 32768, @@ -77413,14 +78739,14 @@ { "type": "reflection", "declaration": { - "id": 3836, + "id": 3903, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3837, + "id": 3904, "name": "code", "variant": "declaration", "kind": 1024, @@ -77435,7 +78761,7 @@ { "title": "Properties", "children": [ - 3837 + 3904 ] } ] @@ -77463,7 +78789,7 @@ } }, { - "id": 3820, + "id": 3887, "name": "transformParentIdToEntity", "variant": "declaration", "kind": 2048, @@ -77472,7 +78798,7 @@ }, "signatures": [ { - "id": 3821, + "id": 3888, "name": "transformParentIdToEntity", "variant": "signature", "kind": 4096, @@ -77498,7 +78824,7 @@ }, "parameters": [ { - "id": 3822, + "id": 3889, "name": "productCategoryInput", "variant": "param", "kind": 32768, @@ -77574,14 +78900,14 @@ ] }, { - "id": 3754, + "id": 3821, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3755, + "id": 3822, "name": "update", "variant": "signature", "kind": 4096, @@ -77607,7 +78933,7 @@ }, "parameters": [ { - "id": 3756, + "id": 3823, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -77626,7 +78952,7 @@ } }, { - "id": 3757, + "id": 3824, "name": "productCategoryInput", "variant": "param", "kind": 32768, @@ -77674,21 +79000,21 @@ ] }, { - "id": 3830, + "id": 3897, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3831, + "id": 3898, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3832, + "id": 3899, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -77708,7 +79034,7 @@ ], "type": { "type": "reference", - "target": 3699, + "target": 3766, "name": "ProductCategoryService", "package": "@medusajs/medusa" }, @@ -77730,47 +79056,47 @@ { "title": "Constructors", "children": [ - 3705 + 3772 ] }, { "title": "Properties", "children": [ - 3828, - 3827, - 3829, - 3728, - 3823, - 3708, - 3824, - 3700 + 3895, + 3894, + 3896, + 3795, + 3890, + 3775, + 3891, + 3767 ] }, { "title": "Accessors", "children": [ - 3825 + 3892 ] }, { "title": "Methods", "children": [ - 3761, - 3838, - 3751, - 3758, - 3769, - 3729, - 3774, - 3765, - 3739, - 3745, - 3734, - 3797, - 3833, - 3820, - 3754, - 3830 + 3828, + 3905, + 3818, + 3825, + 3836, + 3796, + 3841, + 3832, + 3806, + 3812, + 3801, + 3864, + 3900, + 3887, + 3821, + 3897 ] } ], @@ -77787,7 +79113,7 @@ ] }, { - "id": 3854, + "id": 3921, "name": "ProductCollectionService", "variant": "declaration", "kind": 128, @@ -77802,21 +79128,21 @@ }, "children": [ { - "id": 3862, + "id": 3929, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 3863, + "id": 3930, "name": "new ProductCollectionService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 3864, + "id": 3931, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -77834,7 +79160,7 @@ ], "type": { "type": "reference", - "target": 3854, + "target": 3921, "name": "ProductCollectionService", "package": "@medusajs/medusa" }, @@ -77852,7 +79178,7 @@ } }, { - "id": 3988, + "id": 4060, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -77887,7 +79213,7 @@ } }, { - "id": 3987, + "id": 4059, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -77906,7 +79232,7 @@ } }, { - "id": 3989, + "id": 4061, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -77941,7 +79267,7 @@ } }, { - "id": 3865, + "id": 3932, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -77951,13 +79277,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 3983, + "id": 4055, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -77980,7 +79306,7 @@ } }, { - "id": 3866, + "id": 3933, "name": "productCollectionRepository_", "variant": "declaration", "kind": 1024, @@ -78014,28 +79340,28 @@ { "type": "reflection", "declaration": { - "id": 3867, + "id": 3934, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3868, + "id": 3935, "name": "findAndCountByDiscountConditionId", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3869, + "id": 3936, "name": "findAndCountByDiscountConditionId", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3870, + "id": 3937, "name": "conditionId", "variant": "param", "kind": 32768, @@ -78046,7 +79372,7 @@ } }, { - "id": 3871, + "id": 3938, "name": "query", "variant": "param", "kind": 32768, @@ -78113,7 +79439,7 @@ { "title": "Methods", "children": [ - 3868 + 3935 ] } ] @@ -78123,7 +79449,7 @@ } }, { - "id": 3872, + "id": 3939, "name": "productRepository_", "variant": "declaration", "kind": 1024, @@ -78157,28 +79483,28 @@ { "type": "reflection", "declaration": { - "id": 3873, + "id": 3940, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3939, + "id": 4006, "name": "_applyCategoriesQuery", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3940, + "id": 4007, "name": "_applyCategoriesQuery", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3941, + "id": 4008, "name": "qb", "variant": "param", "kind": 32768, @@ -78205,14 +79531,77 @@ } }, { - "id": 3942, + "id": 4009, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "Object" + "type": "reflection", + "declaration": { + "id": 4010, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4011, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4012, + "name": "categoryAlias", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4014, + "name": "joinName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4013, + "name": "where", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4011, + 4012, + 4014, + 4013 + ] + } + ] + } } } ], @@ -78240,21 +79629,21 @@ ] }, { - "id": 3927, + "id": 3994, "name": "_findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3928, + "id": 3995, "name": "_findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3929, + "id": 3996, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -78262,14 +79651,14 @@ "type": { "type": "reflection", "declaration": { - "id": 3930, + "id": 3997, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3932, + "id": 3999, "name": "idsOrOptionsWithoutRelations", "variant": "declaration", "kind": 1024, @@ -78297,7 +79686,7 @@ } }, { - "id": 3931, + "id": 3998, "name": "relations", "variant": "declaration", "kind": 1024, @@ -78311,7 +79700,7 @@ } }, { - "id": 3934, + "id": 4001, "name": "shouldCount", "variant": "declaration", "kind": 1024, @@ -78322,7 +79711,7 @@ } }, { - "id": 3933, + "id": 4000, "name": "withDeleted", "variant": "declaration", "kind": 1024, @@ -78337,10 +79726,10 @@ { "title": "Properties", "children": [ - 3932, - 3931, - 3934, - 3933 + 3999, + 3998, + 4001, + 4000 ] } ] @@ -78384,21 +79773,21 @@ ] }, { - "id": 3907, + "id": 3974, "name": "bulkAddToCollection", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3908, + "id": 3975, "name": "bulkAddToCollection", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3909, + "id": 3976, "name": "productIds", "variant": "param", "kind": 32768, @@ -78412,7 +79801,7 @@ } }, { - "id": 3910, + "id": 3977, "name": "collectionId", "variant": "param", "kind": 32768, @@ -78450,21 +79839,21 @@ ] }, { - "id": 3911, + "id": 3978, "name": "bulkRemoveFromCollection", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3912, + "id": 3979, "name": "bulkRemoveFromCollection", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3913, + "id": 3980, "name": "productIds", "variant": "param", "kind": 32768, @@ -78478,7 +79867,7 @@ } }, { - "id": 3914, + "id": 3981, "name": "collectionId", "variant": "param", "kind": 32768, @@ -78516,21 +79905,21 @@ ] }, { - "id": 3903, + "id": 3970, "name": "findOneWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3904, + "id": 3971, "name": "findOneWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3905, + "id": 3972, "name": "relations", "variant": "param", "kind": 32768, @@ -78545,7 +79934,7 @@ "defaultValue": "[]" }, { - "id": 3906, + "id": 3973, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -78586,21 +79975,21 @@ ] }, { - "id": 3898, + "id": 3965, "name": "findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3899, + "id": 3966, "name": "findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3900, + "id": 3967, "name": "relations", "variant": "param", "kind": 32768, @@ -78615,7 +80004,7 @@ "defaultValue": "[]" }, { - "id": 3901, + "id": 3968, "name": "idsOrOptionsWithoutRelations", "variant": "param", "kind": 32768, @@ -78644,7 +80033,7 @@ "defaultValue": "..." }, { - "id": 3902, + "id": 3969, "name": "withDeleted", "variant": "param", "kind": 32768, @@ -78683,21 +80072,21 @@ ] }, { - "id": 3894, + "id": 3961, "name": "findWithRelationsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3895, + "id": 3962, "name": "findWithRelationsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3896, + "id": 3963, "name": "relations", "variant": "param", "kind": 32768, @@ -78712,7 +80101,7 @@ "defaultValue": "[]" }, { - "id": 3897, + "id": 3964, "name": "idsOrOptionsWithoutRelations", "variant": "param", "kind": 32768, @@ -78765,21 +80154,21 @@ ] }, { - "id": 3920, + "id": 3987, "name": "getCategoryIdsFromInput", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3921, + "id": 3988, "name": "getCategoryIdsFromInput", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3922, + "id": 3989, "name": "categoryId", "variant": "param", "kind": 32768, @@ -78797,7 +80186,7 @@ } }, { - "id": 3923, + "id": 3990, "name": "includeCategoryChildren", "variant": "param", "kind": 32768, @@ -78831,21 +80220,21 @@ ] }, { - "id": 3924, + "id": 3991, "name": "getCategoryIdsRecursively", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3925, + "id": 3992, "name": "getCategoryIdsRecursively", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3926, + "id": 3993, "name": "productCategory", "variant": "param", "kind": 32768, @@ -78872,21 +80261,21 @@ ] }, { - "id": 3915, + "id": 3982, "name": "getFreeTextSearchResultsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3916, + "id": 3983, "name": "getFreeTextSearchResultsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3917, + "id": 3984, "name": "q", "variant": "param", "kind": 32768, @@ -78897,7 +80286,7 @@ } }, { - "id": 3918, + "id": 3985, "name": "options", "variant": "param", "kind": 32768, @@ -78914,7 +80303,7 @@ "defaultValue": "..." }, { - "id": 3919, + "id": 3986, "name": "relations", "variant": "param", "kind": 32768, @@ -78965,21 +80354,21 @@ ] }, { - "id": 3935, + "id": 4002, "name": "isProductInSalesChannels", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3936, + "id": 4003, "name": "isProductInSalesChannels", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3937, + "id": 4004, "name": "id", "variant": "param", "kind": 32768, @@ -78990,7 +80379,7 @@ } }, { - "id": 3938, + "id": 4005, "name": "salesChannelIds", "variant": "param", "kind": 32768, @@ -79023,21 +80412,21 @@ ] }, { - "id": 3874, + "id": 3941, "name": "queryProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3875, + "id": 3942, "name": "queryProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3876, + "id": 3943, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -79053,7 +80442,7 @@ } }, { - "id": 3877, + "id": 3944, "name": "shouldCount", "variant": "param", "kind": 32768, @@ -79101,21 +80490,21 @@ ] }, { - "id": 3878, + "id": 3945, "name": "queryProductsWithIds", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3879, + "id": 3946, "name": "queryProductsWithIds", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3880, + "id": 3947, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -79123,14 +80512,14 @@ "type": { "type": "reflection", "declaration": { - "id": 3881, + "id": 3948, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3882, + "id": 3949, "name": "entityIds", "variant": "declaration", "kind": 1024, @@ -79144,7 +80533,7 @@ } }, { - "id": 3883, + "id": 3950, "name": "groupedRelations", "variant": "declaration", "kind": 1024, @@ -79152,20 +80541,20 @@ "type": { "type": "reflection", "declaration": { - "id": 3884, + "id": 3951, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 3885, + "id": 3952, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 3886, + "id": 3953, "name": "toplevel", "variant": "param", "kind": 32768, @@ -79188,7 +80577,7 @@ } }, { - "id": 3889, + "id": 3956, "name": "order", "variant": "declaration", "kind": 1024, @@ -79198,20 +80587,20 @@ "type": { "type": "reflection", "declaration": { - "id": 3890, + "id": 3957, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 3891, + "id": 3958, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 3892, + "id": 3959, "name": "column", "variant": "param", "kind": 32768, @@ -79240,7 +80629,7 @@ } }, { - "id": 3888, + "id": 3955, "name": "select", "variant": "declaration", "kind": 1024, @@ -79265,7 +80654,7 @@ } }, { - "id": 3893, + "id": 3960, "name": "where", "variant": "declaration", "kind": 1024, @@ -79294,7 +80683,7 @@ } }, { - "id": 3887, + "id": 3954, "name": "withDeleted", "variant": "declaration", "kind": 1024, @@ -79311,12 +80700,12 @@ { "title": "Properties", "children": [ - 3882, - 3883, - 3889, - 3888, - 3893, - 3887 + 3949, + 3950, + 3956, + 3955, + 3960, + 3954 ] } ] @@ -79355,19 +80744,19 @@ { "title": "Methods", "children": [ - 3939, - 3927, - 3907, - 3911, - 3903, - 3898, - 3894, - 3920, - 3924, - 3915, - 3935, - 3874, - 3878 + 4006, + 3994, + 3974, + 3978, + 3970, + 3965, + 3961, + 3987, + 3991, + 3982, + 4002, + 3941, + 3945 ] } ] @@ -79377,7 +80766,7 @@ } }, { - "id": 3984, + "id": 4056, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -79409,7 +80798,7 @@ } }, { - "id": 3855, + "id": 3922, "name": "Events", "variant": "declaration", "kind": 1024, @@ -79420,14 +80809,14 @@ "type": { "type": "reflection", "declaration": { - "id": 3856, + "id": 3923, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3857, + "id": 3924, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -79439,7 +80828,7 @@ "defaultValue": "\"product-collection.created\"" }, { - "id": 3859, + "id": 3926, "name": "DELETED", "variant": "declaration", "kind": 1024, @@ -79451,7 +80840,7 @@ "defaultValue": "\"product-collection.deleted\"" }, { - "id": 3860, + "id": 3927, "name": "PRODUCTS_ADDED", "variant": "declaration", "kind": 1024, @@ -79463,7 +80852,7 @@ "defaultValue": "\"product-collection.products_added\"" }, { - "id": 3861, + "id": 3928, "name": "PRODUCTS_REMOVED", "variant": "declaration", "kind": 1024, @@ -79475,7 +80864,7 @@ "defaultValue": "\"product-collection.products_removed\"" }, { - "id": 3858, + "id": 3925, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -79491,11 +80880,11 @@ { "title": "Properties", "children": [ - 3857, - 3859, - 3860, - 3861, - 3858 + 3924, + 3926, + 3927, + 3928, + 3925 ] } ] @@ -79504,7 +80893,7 @@ "defaultValue": "..." }, { - "id": 3985, + "id": 4057, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -79512,7 +80901,7 @@ "isProtected": true }, "getSignature": { - "id": 3986, + "id": 4058, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -79539,21 +80928,21 @@ } }, { - "id": 3961, + "id": 4033, "name": "addProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3962, + "id": 4034, "name": "addProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3963, + "id": 4035, "name": "collectionId", "variant": "param", "kind": 32768, @@ -79564,7 +80953,7 @@ } }, { - "id": 3964, + "id": 4036, "name": "productIds", "variant": "param", "kind": 32768, @@ -79602,7 +80991,7 @@ ] }, { - "id": 3998, + "id": 4070, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -79611,7 +81000,7 @@ }, "signatures": [ { - "id": 3999, + "id": 4071, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -79637,14 +81026,14 @@ }, "typeParameter": [ { - "id": 4000, + "id": 4072, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 4001, + "id": 4073, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -79653,7 +81042,7 @@ ], "parameters": [ { - "id": 4002, + "id": 4074, "name": "work", "variant": "param", "kind": 32768, @@ -79669,21 +81058,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4003, + "id": 4075, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4004, + "id": 4076, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4005, + "id": 4077, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -79722,7 +81111,7 @@ } }, { - "id": 4006, + "id": 4078, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -79752,21 +81141,21 @@ { "type": "reflection", "declaration": { - "id": 4007, + "id": 4079, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4008, + "id": 4080, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4009, + "id": 4081, "name": "error", "variant": "param", "kind": 32768, @@ -79813,7 +81202,7 @@ } }, { - "id": 4010, + "id": 4082, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -79831,21 +81220,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4011, + "id": 4083, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4012, + "id": 4084, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4013, + "id": 4085, "name": "error", "variant": "param", "kind": 32768, @@ -79921,14 +81310,14 @@ } }, { - "id": 3951, + "id": 4023, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3952, + "id": 4024, "name": "create", "variant": "signature", "kind": 4096, @@ -79954,7 +81343,7 @@ }, "parameters": [ { - "id": 3953, + "id": 4025, "name": "collection", "variant": "param", "kind": 32768, @@ -80002,14 +81391,14 @@ ] }, { - "id": 3958, + "id": 4030, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3959, + "id": 4031, "name": "delete", "variant": "signature", "kind": 4096, @@ -80035,7 +81424,7 @@ }, "parameters": [ { - "id": 3960, + "id": 4032, "name": "collectionId", "variant": "param", "kind": 32768, @@ -80073,14 +81462,14 @@ ] }, { - "id": 3969, + "id": 4041, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3970, + "id": 4042, "name": "list", "variant": "signature", "kind": 4096, @@ -80106,7 +81495,7 @@ }, "parameters": [ { - "id": 3971, + "id": 4043, "name": "selector", "variant": "param", "kind": 32768, @@ -80120,81 +81509,56 @@ ] }, "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "Selector" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-collection.ts", - "qualifiedName": "ProductCollection" - }, - "name": "ProductCollection", - "package": "@medusajs/medusa" + "type": "reflection", + "declaration": { + "id": 4044, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4046, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" } - ], - "name": "Selector", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 3972, - "name": "__type", + }, + { + "id": 4045, + "name": "q", "variant": "declaration", - "kind": 65536, - "flags": {}, + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", "children": [ - { - "id": 3974, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3973, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3974, - 3973 - ] - } + 4046, + 4045 ] } - } - ] + ] + } }, "defaultValue": "{}" }, { - "id": 3975, + "id": 4047, "name": "config", "variant": "param", "kind": 32768, @@ -80210,14 +81574,14 @@ "type": { "type": "reflection", "declaration": { - "id": 3976, + "id": 4048, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3977, + "id": 4049, "name": "skip", "variant": "declaration", "kind": 1024, @@ -80229,7 +81593,7 @@ "defaultValue": "0" }, { - "id": 3978, + "id": 4050, "name": "take", "variant": "declaration", "kind": 1024, @@ -80245,8 +81609,8 @@ { "title": "Properties", "children": [ - 3977, - 3978 + 4049, + 4050 ] } ] @@ -80282,14 +81646,14 @@ ] }, { - "id": 3979, + "id": 4051, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3980, + "id": 4052, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -80315,7 +81679,7 @@ }, "parameters": [ { - "id": 3981, + "id": 4053, "name": "selector", "variant": "param", "kind": 32768, @@ -80340,7 +81704,7 @@ "defaultValue": "{}" }, { - "id": 3982, + "id": 4054, "name": "config", "variant": "param", "kind": 32768, @@ -80412,21 +81776,21 @@ ] }, { - "id": 3965, + "id": 4037, "name": "removeProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3966, + "id": 4038, "name": "removeProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3967, + "id": 4039, "name": "collectionId", "variant": "param", "kind": 32768, @@ -80437,7 +81801,7 @@ } }, { - "id": 3968, + "id": 4040, "name": "productIds", "variant": "param", "kind": 32768, @@ -80470,14 +81834,14 @@ ] }, { - "id": 3943, + "id": 4015, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3944, + "id": 4016, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -80503,7 +81867,7 @@ }, "parameters": [ { - "id": 3945, + "id": 4017, "name": "collectionId", "variant": "param", "kind": 32768, @@ -80522,7 +81886,7 @@ } }, { - "id": 3946, + "id": 4018, "name": "config", "variant": "param", "kind": 32768, @@ -80582,14 +81946,14 @@ ] }, { - "id": 3947, + "id": 4019, "name": "retrieveByHandle", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3948, + "id": 4020, "name": "retrieveByHandle", "variant": "signature", "kind": 4096, @@ -80615,7 +81979,7 @@ }, "parameters": [ { - "id": 3949, + "id": 4021, "name": "collectionHandle", "variant": "param", "kind": 32768, @@ -80634,7 +81998,7 @@ } }, { - "id": 3950, + "id": 4022, "name": "config", "variant": "param", "kind": 32768, @@ -80694,7 +82058,7 @@ ] }, { - "id": 3993, + "id": 4065, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -80703,14 +82067,14 @@ }, "signatures": [ { - "id": 3994, + "id": 4066, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3995, + "id": 4067, "name": "err", "variant": "param", "kind": 32768, @@ -80740,14 +82104,14 @@ { "type": "reflection", "declaration": { - "id": 3996, + "id": 4068, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3997, + "id": 4069, "name": "code", "variant": "declaration", "kind": 1024, @@ -80762,7 +82126,7 @@ { "title": "Properties", "children": [ - 3997 + 4069 ] } ] @@ -80790,14 +82154,14 @@ } }, { - "id": 3954, + "id": 4026, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3955, + "id": 4027, "name": "update", "variant": "signature", "kind": 4096, @@ -80823,7 +82187,7 @@ }, "parameters": [ { - "id": 3956, + "id": 4028, "name": "collectionId", "variant": "param", "kind": 32768, @@ -80842,7 +82206,7 @@ } }, { - "id": 3957, + "id": 4029, "name": "update", "variant": "param", "kind": 32768, @@ -80890,21 +82254,21 @@ ] }, { - "id": 3990, + "id": 4062, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3991, + "id": 4063, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3992, + "id": 4064, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -80924,7 +82288,7 @@ ], "type": { "type": "reference", - "target": 3854, + "target": 3921, "name": "ProductCollectionService", "package": "@medusajs/medusa" }, @@ -80946,44 +82310,44 @@ { "title": "Constructors", "children": [ - 3862 + 3929 ] }, { "title": "Properties", "children": [ - 3988, - 3987, - 3989, - 3865, - 3983, - 3866, - 3872, - 3984, - 3855 + 4060, + 4059, + 4061, + 3932, + 4055, + 3933, + 3939, + 4056, + 3922 ] }, { "title": "Accessors", "children": [ - 3985 + 4057 ] }, { "title": "Methods", "children": [ - 3961, - 3998, - 3951, - 3958, - 3969, - 3979, - 3965, - 3943, - 3947, - 3993, - 3954, - 3990 + 4033, + 4070, + 4023, + 4030, + 4041, + 4051, + 4037, + 4015, + 4019, + 4065, + 4026, + 4062 ] } ], @@ -81000,28 +82364,28 @@ ] }, { - "id": 3441, + "id": 3495, "name": "ProductService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 3448, + "id": 3502, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 3449, + "id": 3503, "name": "new ProductService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 3450, + "id": 3504, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -81039,7 +82403,7 @@ ], "type": { "type": "reference", - "target": 3441, + "target": 3495, "name": "ProductService", "package": "@medusajs/medusa" }, @@ -81057,7 +82421,7 @@ } }, { - "id": 3673, + "id": 3740, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -81092,7 +82456,7 @@ } }, { - "id": 3672, + "id": 3739, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -81111,7 +82475,7 @@ } }, { - "id": 3674, + "id": 3741, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -81146,7 +82510,7 @@ } }, { - "id": 3578, + "id": 3638, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -81156,13 +82520,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 3579, + "id": 3639, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -81181,7 +82545,7 @@ } }, { - "id": 3548, + "id": 3607, "name": "imageRepository_", "variant": "declaration", "kind": 1024, @@ -81215,28 +82579,28 @@ { "type": "reflection", "declaration": { - "id": 3549, + "id": 3608, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3550, + "id": 3609, "name": "insertBulk", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3551, + "id": 3610, "name": "insertBulk", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3552, + "id": 3611, "name": "data", "variant": "param", "kind": 32768, @@ -81293,21 +82657,21 @@ ] }, { - "id": 3553, + "id": 3612, "name": "upsertImages", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3554, + "id": 3613, "name": "upsertImages", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3555, + "id": 3614, "name": "imageUrls", "variant": "param", "kind": 32768, @@ -81352,8 +82716,8 @@ { "title": "Methods", "children": [ - 3550, - 3553 + 3609, + 3612 ] } ] @@ -81363,7 +82727,7 @@ } }, { - "id": 3668, + "id": 3735, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -81386,7 +82750,7 @@ } }, { - "id": 3556, + "id": 3615, "name": "productCategoryRepository_", "variant": "declaration", "kind": 1024, @@ -81420,28 +82784,28 @@ { "type": "reflection", "declaration": { - "id": 3557, + "id": 3616, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3568, + "id": 3627, "name": "addProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3569, + "id": 3628, "name": "addProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3570, + "id": 3629, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -81452,7 +82816,7 @@ } }, { - "id": 3571, + "id": 3630, "name": "productIds", "variant": "param", "kind": 32768, @@ -81485,21 +82849,21 @@ ] }, { - "id": 3558, + "id": 3617, "name": "findOneWithDescendants", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3559, + "id": 3618, "name": "findOneWithDescendants", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3560, + "id": 3619, "name": "query", "variant": "param", "kind": 32768, @@ -81526,7 +82890,7 @@ } }, { - "id": 3561, + "id": 3620, "name": "treeScope", "variant": "param", "kind": 32768, @@ -81587,21 +82951,21 @@ ] }, { - "id": 3562, + "id": 3621, "name": "getFreeTextSearchResultsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3563, + "id": 3622, "name": "getFreeTextSearchResultsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3564, + "id": 3623, "name": "options", "variant": "param", "kind": 32768, @@ -81629,7 +82993,7 @@ "defaultValue": "..." }, { - "id": 3565, + "id": 3624, "name": "q", "variant": "param", "kind": 32768, @@ -81642,7 +83006,7 @@ } }, { - "id": 3566, + "id": 3625, "name": "treeScope", "variant": "param", "kind": 32768, @@ -81670,7 +83034,7 @@ "defaultValue": "{}" }, { - "id": 3567, + "id": 3626, "name": "includeTree", "variant": "param", "kind": 32768, @@ -81718,21 +83082,21 @@ ] }, { - "id": 3572, + "id": 3631, "name": "removeProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3573, + "id": 3632, "name": "removeProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3574, + "id": 3633, "name": "productCategoryId", "variant": "param", "kind": 32768, @@ -81743,7 +83107,7 @@ } }, { - "id": 3575, + "id": 3634, "name": "productIds", "variant": "param", "kind": 32768, @@ -81785,10 +83149,10 @@ { "title": "Methods", "children": [ - 3568, - 3558, - 3562, - 3572 + 3627, + 3617, + 3621, + 3631 ] } ] @@ -81798,7 +83162,7 @@ } }, { - "id": 3451, + "id": 3505, "name": "productOptionRepository_", "variant": "declaration", "kind": 1024, @@ -81828,7 +83192,7 @@ } }, { - "id": 3452, + "id": 3506, "name": "productRepository_", "variant": "declaration", "kind": 1024, @@ -81862,28 +83226,28 @@ { "type": "reflection", "declaration": { - "id": 3453, + "id": 3507, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3519, + "id": 3573, "name": "_applyCategoriesQuery", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3520, + "id": 3574, "name": "_applyCategoriesQuery", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3521, + "id": 3575, "name": "qb", "variant": "param", "kind": 32768, @@ -81910,14 +83274,77 @@ } }, { - "id": 3522, + "id": 3576, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "Object" + "type": "reflection", + "declaration": { + "id": 3577, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3578, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 3579, + "name": "categoryAlias", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 3581, + "name": "joinName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 3580, + "name": "where", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3578, + 3579, + 3581, + 3580 + ] + } + ] + } } } ], @@ -81945,21 +83372,21 @@ ] }, { - "id": 3507, + "id": 3561, "name": "_findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3508, + "id": 3562, "name": "_findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3509, + "id": 3563, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -81967,14 +83394,14 @@ "type": { "type": "reflection", "declaration": { - "id": 3510, + "id": 3564, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3512, + "id": 3566, "name": "idsOrOptionsWithoutRelations", "variant": "declaration", "kind": 1024, @@ -82002,7 +83429,7 @@ } }, { - "id": 3511, + "id": 3565, "name": "relations", "variant": "declaration", "kind": 1024, @@ -82016,7 +83443,7 @@ } }, { - "id": 3514, + "id": 3568, "name": "shouldCount", "variant": "declaration", "kind": 1024, @@ -82027,7 +83454,7 @@ } }, { - "id": 3513, + "id": 3567, "name": "withDeleted", "variant": "declaration", "kind": 1024, @@ -82042,10 +83469,10 @@ { "title": "Properties", "children": [ - 3512, - 3511, - 3514, - 3513 + 3566, + 3565, + 3568, + 3567 ] } ] @@ -82089,21 +83516,21 @@ ] }, { - "id": 3487, + "id": 3541, "name": "bulkAddToCollection", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3488, + "id": 3542, "name": "bulkAddToCollection", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3489, + "id": 3543, "name": "productIds", "variant": "param", "kind": 32768, @@ -82117,7 +83544,7 @@ } }, { - "id": 3490, + "id": 3544, "name": "collectionId", "variant": "param", "kind": 32768, @@ -82155,21 +83582,21 @@ ] }, { - "id": 3491, + "id": 3545, "name": "bulkRemoveFromCollection", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3492, + "id": 3546, "name": "bulkRemoveFromCollection", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3493, + "id": 3547, "name": "productIds", "variant": "param", "kind": 32768, @@ -82183,7 +83610,7 @@ } }, { - "id": 3494, + "id": 3548, "name": "collectionId", "variant": "param", "kind": 32768, @@ -82221,21 +83648,21 @@ ] }, { - "id": 3483, + "id": 3537, "name": "findOneWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3484, + "id": 3538, "name": "findOneWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3485, + "id": 3539, "name": "relations", "variant": "param", "kind": 32768, @@ -82250,7 +83677,7 @@ "defaultValue": "[]" }, { - "id": 3486, + "id": 3540, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -82291,21 +83718,21 @@ ] }, { - "id": 3478, + "id": 3532, "name": "findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3479, + "id": 3533, "name": "findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3480, + "id": 3534, "name": "relations", "variant": "param", "kind": 32768, @@ -82320,7 +83747,7 @@ "defaultValue": "[]" }, { - "id": 3481, + "id": 3535, "name": "idsOrOptionsWithoutRelations", "variant": "param", "kind": 32768, @@ -82349,7 +83776,7 @@ "defaultValue": "..." }, { - "id": 3482, + "id": 3536, "name": "withDeleted", "variant": "param", "kind": 32768, @@ -82388,21 +83815,21 @@ ] }, { - "id": 3474, + "id": 3528, "name": "findWithRelationsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3475, + "id": 3529, "name": "findWithRelationsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3476, + "id": 3530, "name": "relations", "variant": "param", "kind": 32768, @@ -82417,7 +83844,7 @@ "defaultValue": "[]" }, { - "id": 3477, + "id": 3531, "name": "idsOrOptionsWithoutRelations", "variant": "param", "kind": 32768, @@ -82470,21 +83897,21 @@ ] }, { - "id": 3500, + "id": 3554, "name": "getCategoryIdsFromInput", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3501, + "id": 3555, "name": "getCategoryIdsFromInput", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3502, + "id": 3556, "name": "categoryId", "variant": "param", "kind": 32768, @@ -82502,7 +83929,7 @@ } }, { - "id": 3503, + "id": 3557, "name": "includeCategoryChildren", "variant": "param", "kind": 32768, @@ -82536,21 +83963,21 @@ ] }, { - "id": 3504, + "id": 3558, "name": "getCategoryIdsRecursively", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3505, + "id": 3559, "name": "getCategoryIdsRecursively", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3506, + "id": 3560, "name": "productCategory", "variant": "param", "kind": 32768, @@ -82577,21 +84004,21 @@ ] }, { - "id": 3495, + "id": 3549, "name": "getFreeTextSearchResultsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3496, + "id": 3550, "name": "getFreeTextSearchResultsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3497, + "id": 3551, "name": "q", "variant": "param", "kind": 32768, @@ -82602,7 +84029,7 @@ } }, { - "id": 3498, + "id": 3552, "name": "options", "variant": "param", "kind": 32768, @@ -82619,7 +84046,7 @@ "defaultValue": "..." }, { - "id": 3499, + "id": 3553, "name": "relations", "variant": "param", "kind": 32768, @@ -82670,21 +84097,21 @@ ] }, { - "id": 3515, + "id": 3569, "name": "isProductInSalesChannels", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3516, + "id": 3570, "name": "isProductInSalesChannels", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3517, + "id": 3571, "name": "id", "variant": "param", "kind": 32768, @@ -82695,7 +84122,7 @@ } }, { - "id": 3518, + "id": 3572, "name": "salesChannelIds", "variant": "param", "kind": 32768, @@ -82728,21 +84155,21 @@ ] }, { - "id": 3454, + "id": 3508, "name": "queryProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3455, + "id": 3509, "name": "queryProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3456, + "id": 3510, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -82758,7 +84185,7 @@ } }, { - "id": 3457, + "id": 3511, "name": "shouldCount", "variant": "param", "kind": 32768, @@ -82806,21 +84233,21 @@ ] }, { - "id": 3458, + "id": 3512, "name": "queryProductsWithIds", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3459, + "id": 3513, "name": "queryProductsWithIds", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3460, + "id": 3514, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -82828,14 +84255,14 @@ "type": { "type": "reflection", "declaration": { - "id": 3461, + "id": 3515, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3462, + "id": 3516, "name": "entityIds", "variant": "declaration", "kind": 1024, @@ -82849,7 +84276,7 @@ } }, { - "id": 3463, + "id": 3517, "name": "groupedRelations", "variant": "declaration", "kind": 1024, @@ -82857,20 +84284,20 @@ "type": { "type": "reflection", "declaration": { - "id": 3464, + "id": 3518, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 3465, + "id": 3519, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 3466, + "id": 3520, "name": "toplevel", "variant": "param", "kind": 32768, @@ -82893,7 +84320,7 @@ } }, { - "id": 3469, + "id": 3523, "name": "order", "variant": "declaration", "kind": 1024, @@ -82903,20 +84330,20 @@ "type": { "type": "reflection", "declaration": { - "id": 3470, + "id": 3524, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 3471, + "id": 3525, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 3472, + "id": 3526, "name": "column", "variant": "param", "kind": 32768, @@ -82945,7 +84372,7 @@ } }, { - "id": 3468, + "id": 3522, "name": "select", "variant": "declaration", "kind": 1024, @@ -82970,7 +84397,7 @@ } }, { - "id": 3473, + "id": 3527, "name": "where", "variant": "declaration", "kind": 1024, @@ -82999,7 +84426,7 @@ } }, { - "id": 3467, + "id": 3521, "name": "withDeleted", "variant": "declaration", "kind": 1024, @@ -83016,12 +84443,12 @@ { "title": "Properties", "children": [ - 3462, - 3463, - 3469, - 3468, - 3473, - 3467 + 3516, + 3517, + 3523, + 3522, + 3527, + 3521 ] } ] @@ -83060,19 +84487,19 @@ { "title": "Methods", "children": [ - 3519, - 3507, - 3487, - 3491, - 3483, - 3478, - 3474, - 3500, - 3504, - 3495, - 3515, - 3454, - 3458 + 3573, + 3561, + 3541, + 3545, + 3537, + 3532, + 3528, + 3554, + 3558, + 3549, + 3569, + 3508, + 3512 ] } ] @@ -83082,7 +84509,7 @@ } }, { - "id": 3533, + "id": 3592, "name": "productTagRepository_", "variant": "declaration", "kind": 1024, @@ -83116,28 +84543,28 @@ { "type": "reflection", "declaration": { - "id": 3534, + "id": 3593, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3544, + "id": 3603, "name": "findAndCountByDiscountConditionId", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3545, + "id": 3604, "name": "findAndCountByDiscountConditionId", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3546, + "id": 3605, "name": "conditionId", "variant": "param", "kind": 32768, @@ -83148,7 +84575,7 @@ } }, { - "id": 3547, + "id": 3606, "name": "query", "variant": "param", "kind": 32768, @@ -83211,21 +84638,21 @@ ] }, { - "id": 3535, + "id": 3594, "name": "insertBulk", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3536, + "id": 3595, "name": "insertBulk", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3537, + "id": 3596, "name": "data", "variant": "param", "kind": 32768, @@ -83282,21 +84709,21 @@ ] }, { - "id": 3538, + "id": 3597, "name": "listTagsByUsage", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3539, + "id": 3598, "name": "listTagsByUsage", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3540, + "id": 3599, "name": "take", "variant": "param", "kind": 32768, @@ -83335,21 +84762,21 @@ ] }, { - "id": 3541, + "id": 3600, "name": "upsertTags", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3542, + "id": 3601, "name": "upsertTags", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3543, + "id": 3602, "name": "tags", "variant": "param", "kind": 32768, @@ -83396,10 +84823,10 @@ { "title": "Methods", "children": [ - 3544, - 3535, - 3538, - 3541 + 3603, + 3594, + 3597, + 3600 ] } ] @@ -83409,7 +84836,7 @@ } }, { - "id": 3524, + "id": 3583, "name": "productTypeRepository_", "variant": "declaration", "kind": 1024, @@ -83443,28 +84870,28 @@ { "type": "reflection", "declaration": { - "id": 3525, + "id": 3584, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3529, + "id": 3588, "name": "findAndCountByDiscountConditionId", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3530, + "id": 3589, "name": "findAndCountByDiscountConditionId", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3531, + "id": 3590, "name": "conditionId", "variant": "param", "kind": 32768, @@ -83475,7 +84902,7 @@ } }, { - "id": 3532, + "id": 3591, "name": "query", "variant": "param", "kind": 32768, @@ -83538,21 +84965,21 @@ ] }, { - "id": 3526, + "id": 3585, "name": "upsertType", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3527, + "id": 3586, "name": "upsertType", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3528, + "id": 3587, "name": "type", "variant": "param", "kind": 32768, @@ -83607,8 +85034,8 @@ { "title": "Methods", "children": [ - 3529, - 3526 + 3588, + 3585 ] } ] @@ -83618,7 +85045,7 @@ } }, { - "id": 3523, + "id": 3582, "name": "productVariantRepository_", "variant": "declaration", "kind": 1024, @@ -83648,7 +85075,7 @@ } }, { - "id": 3576, + "id": 3635, "name": "productVariantService_", "variant": "declaration", "kind": 1024, @@ -83658,13 +85085,47 @@ }, "type": { "type": "reference", - "target": 4076, + "target": 4150, "name": "ProductVariantService", "package": "@medusajs/medusa" } }, { - "id": 3577, + "id": 3640, + "name": "remoteQuery_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/dist/modules-sdk/index.d.ts", + "qualifiedName": "RemoteQueryFunction" + }, + "name": "RemoteQueryFunction", + "package": "@medusajs/types" + } + }, + { + "id": 3637, + "name": "salesChannelService_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": 4897, + "name": "SalesChannelService", + "package": "@medusajs/medusa" + } + }, + { + "id": 3636, "name": "searchService_", "variant": "declaration", "kind": 1024, @@ -83674,13 +85135,13 @@ }, "type": { "type": "reference", - "target": 5011, + "target": 5118, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 3669, + "id": 3736, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -83712,7 +85173,7 @@ } }, { - "id": 3443, + "id": 3497, "name": "Events", "variant": "declaration", "kind": 1024, @@ -83723,14 +85184,14 @@ "type": { "type": "reflection", "declaration": { - "id": 3444, + "id": 3498, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3446, + "id": 3500, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -83742,7 +85203,7 @@ "defaultValue": "\"product.created\"" }, { - "id": 3447, + "id": 3501, "name": "DELETED", "variant": "declaration", "kind": 1024, @@ -83754,7 +85215,7 @@ "defaultValue": "\"product.deleted\"" }, { - "id": 3445, + "id": 3499, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -83770,9 +85231,9 @@ { "title": "Properties", "children": [ - 3446, - 3447, - 3445 + 3500, + 3501, + 3499 ] } ] @@ -83781,7 +85242,7 @@ "defaultValue": "..." }, { - "id": 3442, + "id": 3496, "name": "IndexName", "variant": "declaration", "kind": 1024, @@ -83796,7 +85257,7 @@ "defaultValue": "..." }, { - "id": 3670, + "id": 3737, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -83804,7 +85265,7 @@ "isProtected": true }, "getSignature": { - "id": 3671, + "id": 3738, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -83831,14 +85292,14 @@ } }, { - "id": 3635, + "id": 3696, "name": "addOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3636, + "id": 3697, "name": "addOption", "variant": "signature", "kind": 4096, @@ -83864,7 +85325,7 @@ }, "parameters": [ { - "id": 3637, + "id": 3698, "name": "productId", "variant": "param", "kind": 32768, @@ -83883,7 +85344,7 @@ } }, { - "id": 3638, + "id": 3699, "name": "optionTitle", "variant": "param", "kind": 32768, @@ -83926,7 +85387,7 @@ ] }, { - "id": 3683, + "id": 3750, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -83935,7 +85396,7 @@ }, "signatures": [ { - "id": 3684, + "id": 3751, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -83961,14 +85422,14 @@ }, "typeParameter": [ { - "id": 3685, + "id": 3752, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 3686, + "id": 3753, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -83977,7 +85438,7 @@ ], "parameters": [ { - "id": 3687, + "id": 3754, "name": "work", "variant": "param", "kind": 32768, @@ -83993,21 +85454,21 @@ "type": { "type": "reflection", "declaration": { - "id": 3688, + "id": 3755, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3689, + "id": 3756, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3690, + "id": 3757, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -84046,7 +85507,7 @@ } }, { - "id": 3691, + "id": 3758, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -84076,21 +85537,21 @@ { "type": "reflection", "declaration": { - "id": 3692, + "id": 3759, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3693, + "id": 3760, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3694, + "id": 3761, "name": "error", "variant": "param", "kind": 32768, @@ -84137,7 +85598,7 @@ } }, { - "id": 3695, + "id": 3762, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -84155,21 +85616,21 @@ "type": { "type": "reflection", "declaration": { - "id": 3696, + "id": 3763, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 3697, + "id": 3764, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3698, + "id": 3765, "name": "error", "variant": "param", "kind": 32768, @@ -84245,14 +85706,14 @@ } }, { - "id": 3588, + "id": 3649, "name": "count", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3589, + "id": 3650, "name": "count", "variant": "signature", "kind": 4096, @@ -84278,7 +85739,7 @@ }, "parameters": [ { - "id": 3590, + "id": 3651, "name": "selector", "variant": "param", "kind": 32768, @@ -84333,14 +85794,14 @@ ] }, { - "id": 3625, + "id": 3686, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3626, + "id": 3687, "name": "create", "variant": "signature", "kind": 4096, @@ -84366,7 +85827,7 @@ }, "parameters": [ { - "id": 3627, + "id": 3688, "name": "productObject", "variant": "param", "kind": 32768, @@ -84414,14 +85875,86 @@ ] }, { - "id": 3632, + "id": 3729, + "name": "decorateProductsWithSalesChannels", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPrivate": true + }, + "signatures": [ + { + "id": 3730, + "name": "decorateProductsWithSalesChannels", + "variant": "signature", + "kind": 4096, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Temporary method to join sales channels of a product using RemoteQuery while\nMedusaV2 FF is on." + } + ] + }, + "parameters": [ + { + "id": 3731, + "name": "products", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "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/models/product.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3693, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3633, + "id": 3694, "name": "delete", "variant": "signature", "kind": 4096, @@ -84447,7 +85980,7 @@ }, "parameters": [ { - "id": 3634, + "id": 3695, "name": "productId", "variant": "param", "kind": 32768, @@ -84485,14 +86018,14 @@ ] }, { - "id": 3652, + "id": 3713, "name": "deleteOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3653, + "id": 3714, "name": "deleteOption", "variant": "signature", "kind": 4096, @@ -84518,7 +86051,7 @@ }, "parameters": [ { - "id": 3654, + "id": 3715, "name": "productId", "variant": "param", "kind": 32768, @@ -84537,7 +86070,7 @@ } }, { - "id": 3655, + "id": 3716, "name": "optionId", "variant": "param", "kind": 32768, @@ -84589,21 +86122,21 @@ ] }, { - "id": 3611, + "id": 3672, "name": "filterProductsBySalesChannel", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3612, + "id": 3673, "name": "filterProductsBySalesChannel", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3613, + "id": 3674, "name": "productIds", "variant": "param", "kind": 32768, @@ -84617,7 +86150,7 @@ } }, { - "id": 3614, + "id": 3675, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -84628,7 +86161,7 @@ } }, { - "id": 3615, + "id": 3676, "name": "config", "variant": "param", "kind": 32768, @@ -84672,14 +86205,96 @@ ] }, { - "id": 3621, + "id": 3732, + "name": "getSalesChannelModuleChannels", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPrivate": true + }, + "signatures": [ + { + "id": 3733, + "name": "getSalesChannelModuleChannels", + "variant": "signature", + "kind": 4096, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Temporary method to fetch sales channels of a product using RemoteQuery while\nMedusaV2 FF is on." + } + ] + }, + "parameters": [ + { + "id": 3734, + "name": "productIds", + "variant": "param", + "kind": 32768, + "flags": {}, + "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": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3682, "name": "isProductInSalesChannels", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3622, + "id": 3683, "name": "isProductInSalesChannels", "variant": "signature", "kind": 4096, @@ -84694,7 +86309,7 @@ }, "parameters": [ { - "id": 3623, + "id": 3684, "name": "id", "variant": "param", "kind": 32768, @@ -84713,7 +86328,7 @@ } }, { - "id": 3624, + "id": 3685, "name": "salesChannelIds", "variant": "param", "kind": 32768, @@ -84754,14 +86369,14 @@ ] }, { - "id": 3580, + "id": 3641, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3581, + "id": 3642, "name": "list", "variant": "signature", "kind": 4096, @@ -84787,7 +86402,7 @@ }, "parameters": [ { - "id": 3582, + "id": 3643, "name": "selector", "variant": "param", "kind": 32768, @@ -84811,7 +86426,7 @@ } }, { - "id": 3583, + "id": 3644, "name": "config", "variant": "param", "kind": 32768, @@ -84863,14 +86478,14 @@ ] }, { - "id": 3584, + "id": 3645, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3585, + "id": 3646, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -84896,7 +86511,7 @@ }, "parameters": [ { - "id": 3586, + "id": 3647, "name": "selector", "variant": "param", "kind": 32768, @@ -84920,7 +86535,7 @@ } }, { - "id": 3587, + "id": 3648, "name": "config", "variant": "param", "kind": 32768, @@ -84981,21 +86596,21 @@ ] }, { - "id": 3618, + "id": 3679, "name": "listTagsByUsage", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3619, + "id": 3680, "name": "listTagsByUsage", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3620, + "id": 3681, "name": "take", "variant": "param", "kind": 32768, @@ -85034,14 +86649,14 @@ ] }, { - "id": 3616, + "id": 3677, "name": "listTypes", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3617, + "id": 3678, "name": "listTypes", "variant": "signature", "kind": 4096, @@ -85073,7 +86688,7 @@ ] }, { - "id": 3660, + "id": 3721, "name": "prepareListQuery_", "variant": "declaration", "kind": 2048, @@ -85082,7 +86697,7 @@ }, "signatures": [ { - "id": 3661, + "id": 3722, "name": "prepareListQuery_", "variant": "signature", "kind": 4096, @@ -85099,7 +86714,7 @@ }, "parameters": [ { - "id": 3662, + "id": 3723, "name": "selector", "variant": "param", "kind": 32768, @@ -85140,7 +86755,7 @@ } }, { - "id": 3663, + "id": 3724, "name": "config", "variant": "param", "kind": 32768, @@ -85159,14 +86774,14 @@ "type": { "type": "reflection", "declaration": { - "id": 3664, + "id": 3725, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3665, + "id": 3726, "name": "q", "variant": "declaration", "kind": 1024, @@ -85177,7 +86792,7 @@ } }, { - "id": 3667, + "id": 3728, "name": "query", "variant": "declaration", "kind": 1024, @@ -85193,7 +86808,7 @@ } }, { - "id": 3666, + "id": 3727, "name": "relations", "variant": "declaration", "kind": 1024, @@ -85220,9 +86835,9 @@ { "title": "Properties", "children": [ - 3665, - 3667, - 3666 + 3726, + 3728, + 3727 ] } ] @@ -85232,21 +86847,21 @@ ] }, { - "id": 3639, + "id": 3700, "name": "reorderVariants", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3640, + "id": 3701, "name": "reorderVariants", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3641, + "id": 3702, "name": "productId", "variant": "param", "kind": 32768, @@ -85257,7 +86872,7 @@ } }, { - "id": 3642, + "id": 3703, "name": "variantOrder", "variant": "param", "kind": 32768, @@ -85295,14 +86910,14 @@ ] }, { - "id": 3591, + "id": 3652, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3592, + "id": 3653, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -85328,7 +86943,7 @@ }, "parameters": [ { - "id": 3593, + "id": 3654, "name": "productId", "variant": "param", "kind": 32768, @@ -85347,7 +86962,7 @@ } }, { - "id": 3594, + "id": 3655, "name": "config", "variant": "param", "kind": 32768, @@ -85396,14 +87011,14 @@ ] }, { - "id": 3599, + "id": 3660, "name": "retrieveByExternalId", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3600, + "id": 3661, "name": "retrieveByExternalId", "variant": "signature", "kind": 4096, @@ -85429,7 +87044,7 @@ }, "parameters": [ { - "id": 3601, + "id": 3662, "name": "externalId", "variant": "param", "kind": 32768, @@ -85448,7 +87063,7 @@ } }, { - "id": 3602, + "id": 3663, "name": "config", "variant": "param", "kind": 32768, @@ -85497,14 +87112,14 @@ ] }, { - "id": 3595, + "id": 3656, "name": "retrieveByHandle", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3596, + "id": 3657, "name": "retrieveByHandle", "variant": "signature", "kind": 4096, @@ -85530,7 +87145,7 @@ }, "parameters": [ { - "id": 3597, + "id": 3658, "name": "productHandle", "variant": "param", "kind": 32768, @@ -85549,7 +87164,7 @@ } }, { - "id": 3598, + "id": 3659, "name": "config", "variant": "param", "kind": 32768, @@ -85598,14 +87213,14 @@ ] }, { - "id": 3648, + "id": 3709, "name": "retrieveOptionByTitle", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3649, + "id": 3710, "name": "retrieveOptionByTitle", "variant": "signature", "kind": 4096, @@ -85631,7 +87246,7 @@ }, "parameters": [ { - "id": 3650, + "id": 3711, "name": "title", "variant": "param", "kind": 32768, @@ -85650,7 +87265,7 @@ } }, { - "id": 3651, + "id": 3712, "name": "productId", "variant": "param", "kind": 32768, @@ -85702,14 +87317,14 @@ ] }, { - "id": 3607, + "id": 3668, "name": "retrieveVariants", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3608, + "id": 3669, "name": "retrieveVariants", "variant": "signature", "kind": 4096, @@ -85735,7 +87350,7 @@ }, "parameters": [ { - "id": 3609, + "id": 3670, "name": "productId", "variant": "param", "kind": 32768, @@ -85754,7 +87369,7 @@ } }, { - "id": 3610, + "id": 3671, "name": "config", "variant": "param", "kind": 32768, @@ -85806,14 +87421,14 @@ ] }, { - "id": 3603, + "id": 3664, "name": "retrieve_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3604, + "id": 3665, "name": "retrieve_", "variant": "signature", "kind": 4096, @@ -85839,7 +87454,7 @@ }, "parameters": [ { - "id": 3605, + "id": 3666, "name": "selector", "variant": "param", "kind": 32768, @@ -85874,7 +87489,7 @@ } }, { - "id": 3606, + "id": 3667, "name": "config", "variant": "param", "kind": 32768, @@ -85923,7 +87538,7 @@ ] }, { - "id": 3678, + "id": 3745, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -85932,14 +87547,14 @@ }, "signatures": [ { - "id": 3679, + "id": 3746, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3680, + "id": 3747, "name": "err", "variant": "param", "kind": 32768, @@ -85969,14 +87584,14 @@ { "type": "reflection", "declaration": { - "id": 3681, + "id": 3748, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 3682, + "id": 3749, "name": "code", "variant": "declaration", "kind": 1024, @@ -85991,7 +87606,7 @@ { "title": "Properties", "children": [ - 3682 + 3749 ] } ] @@ -86019,14 +87634,14 @@ } }, { - "id": 3628, + "id": 3689, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3629, + "id": 3690, "name": "update", "variant": "signature", "kind": 4096, @@ -86060,7 +87675,7 @@ }, "parameters": [ { - "id": 3630, + "id": 3691, "name": "productId", "variant": "param", "kind": 32768, @@ -86079,7 +87694,7 @@ } }, { - "id": 3631, + "id": 3692, "name": "update", "variant": "param", "kind": 32768, @@ -86127,14 +87742,14 @@ ] }, { - "id": 3643, + "id": 3704, "name": "updateOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3644, + "id": 3705, "name": "updateOption", "variant": "signature", "kind": 4096, @@ -86160,7 +87775,7 @@ }, "parameters": [ { - "id": 3645, + "id": 3706, "name": "productId", "variant": "param", "kind": 32768, @@ -86179,7 +87794,7 @@ } }, { - "id": 3646, + "id": 3707, "name": "optionId", "variant": "param", "kind": 32768, @@ -86198,7 +87813,7 @@ } }, { - "id": 3647, + "id": 3708, "name": "data", "variant": "param", "kind": 32768, @@ -86246,14 +87861,14 @@ ] }, { - "id": 3656, + "id": 3717, "name": "updateShippingProfile", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3657, + "id": 3718, "name": "updateShippingProfile", "variant": "signature", "kind": 4096, @@ -86279,7 +87894,7 @@ }, "parameters": [ { - "id": 3658, + "id": 3719, "name": "productIds", "variant": "param", "kind": 32768, @@ -86310,7 +87925,7 @@ } }, { - "id": 3659, + "id": 3720, "name": "profileId", "variant": "param", "kind": 32768, @@ -86365,21 +87980,21 @@ ] }, { - "id": 3675, + "id": 3742, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 3676, + "id": 3743, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 3677, + "id": 3744, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -86399,7 +88014,7 @@ ], "type": { "type": "reference", - "target": 3441, + "target": 3495, "name": "ProductService", "package": "@medusajs/medusa" }, @@ -86421,66 +88036,70 @@ { "title": "Constructors", "children": [ - 3448 + 3502 ] }, { "title": "Properties", "children": [ - 3673, - 3672, - 3674, - 3578, - 3579, - 3548, - 3668, - 3556, - 3451, - 3452, - 3533, - 3524, - 3523, - 3576, - 3577, - 3669, - 3443, - 3442 + 3740, + 3739, + 3741, + 3638, + 3639, + 3607, + 3735, + 3615, + 3505, + 3506, + 3592, + 3583, + 3582, + 3635, + 3640, + 3637, + 3636, + 3736, + 3497, + 3496 ] }, { "title": "Accessors", "children": [ - 3670 + 3737 ] }, { "title": "Methods", "children": [ - 3635, - 3683, - 3588, - 3625, - 3632, + 3696, + 3750, + 3649, + 3686, + 3729, + 3693, + 3713, + 3672, + 3732, + 3682, + 3641, + 3645, + 3679, + 3677, + 3721, + 3700, 3652, - 3611, - 3621, - 3580, - 3584, - 3618, - 3616, 3660, - 3639, - 3591, - 3599, - 3595, - 3648, - 3607, - 3603, - 3678, - 3628, - 3643, 3656, - 3675 + 3709, + 3668, + 3664, + 3745, + 3689, + 3704, + 3717, + 3742 ] } ], @@ -86497,41 +88116,68 @@ ] }, { - "id": 4014, + "id": 4086, "name": "ProductTypeService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 4015, + "id": 4087, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 4016, + "id": 4088, "name": "new ProductTypeService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 4017, + "id": 4089, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "Object" + "type": "reflection", + "declaration": { + "id": 4090, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4091, + "name": "productTypeRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4091 + ] + } + ] + } } } ], "type": { "type": "reference", - "target": 4014, + "target": 4086, "name": "ProductTypeService", "package": "@medusajs/medusa" }, @@ -86549,7 +88195,7 @@ } }, { - "id": 4050, + "id": 4124, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -86584,7 +88230,7 @@ } }, { - "id": 4049, + "id": 4123, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -86603,7 +88249,7 @@ } }, { - "id": 4051, + "id": 4125, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -86638,7 +88284,7 @@ } }, { - "id": 4045, + "id": 4119, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -86661,7 +88307,7 @@ } }, { - "id": 4046, + "id": 4120, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -86693,7 +88339,7 @@ } }, { - "id": 4018, + "id": 4092, "name": "typeRepository_", "variant": "declaration", "kind": 1024, @@ -86727,28 +88373,28 @@ { "type": "reflection", "declaration": { - "id": 4019, + "id": 4093, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4023, + "id": 4097, "name": "findAndCountByDiscountConditionId", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4024, + "id": 4098, "name": "findAndCountByDiscountConditionId", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4025, + "id": 4099, "name": "conditionId", "variant": "param", "kind": 32768, @@ -86759,7 +88405,7 @@ } }, { - "id": 4026, + "id": 4100, "name": "query", "variant": "param", "kind": 32768, @@ -86822,21 +88468,21 @@ ] }, { - "id": 4020, + "id": 4094, "name": "upsertType", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4021, + "id": 4095, "name": "upsertType", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4022, + "id": 4096, "name": "type", "variant": "param", "kind": 32768, @@ -86891,8 +88537,8 @@ { "title": "Methods", "children": [ - 4023, - 4020 + 4097, + 4094 ] } ] @@ -86902,7 +88548,7 @@ } }, { - "id": 4047, + "id": 4121, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -86910,7 +88556,7 @@ "isProtected": true }, "getSignature": { - "id": 4048, + "id": 4122, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -86937,7 +88583,7 @@ } }, { - "id": 4060, + "id": 4134, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -86946,7 +88592,7 @@ }, "signatures": [ { - "id": 4061, + "id": 4135, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -86972,14 +88618,14 @@ }, "typeParameter": [ { - "id": 4062, + "id": 4136, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 4063, + "id": 4137, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -86988,7 +88634,7 @@ ], "parameters": [ { - "id": 4064, + "id": 4138, "name": "work", "variant": "param", "kind": 32768, @@ -87004,21 +88650,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4065, + "id": 4139, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4066, + "id": 4140, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4067, + "id": 4141, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -87057,7 +88703,7 @@ } }, { - "id": 4068, + "id": 4142, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -87087,21 +88733,21 @@ { "type": "reflection", "declaration": { - "id": 4069, + "id": 4143, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4070, + "id": 4144, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4071, + "id": 4145, "name": "error", "variant": "param", "kind": 32768, @@ -87148,7 +88794,7 @@ } }, { - "id": 4072, + "id": 4146, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -87166,21 +88812,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4073, + "id": 4147, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4074, + "id": 4148, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4075, + "id": 4149, "name": "error", "variant": "param", "kind": 32768, @@ -87256,14 +88902,14 @@ } }, { - "id": 4031, + "id": 4105, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4032, + "id": 4106, "name": "list", "variant": "signature", "kind": 4096, @@ -87289,7 +88935,7 @@ }, "parameters": [ { - "id": 4033, + "id": 4107, "name": "selector", "variant": "param", "kind": 32768, @@ -87303,81 +88949,56 @@ ] }, "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "Selector" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-type.ts", - "qualifiedName": "ProductType" - }, - "name": "ProductType", - "package": "@medusajs/medusa" + "type": "reflection", + "declaration": { + "id": 4108, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4110, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" } - ], - "name": "Selector", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 4034, - "name": "__type", + }, + { + "id": 4109, + "name": "q", "variant": "declaration", - "kind": 65536, - "flags": {}, + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", "children": [ - { - "id": 4036, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4035, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4036, - 4035 - ] - } + 4110, + 4109 ] } - } - ] + ] + } }, "defaultValue": "{}" }, { - "id": 4037, + "id": 4111, "name": "config", "variant": "param", "kind": 32768, @@ -87440,14 +89061,14 @@ ] }, { - "id": 4038, + "id": 4112, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4039, + "id": 4113, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -87473,7 +89094,7 @@ }, "parameters": [ { - "id": 4040, + "id": 4114, "name": "selector", "variant": "param", "kind": 32768, @@ -87487,81 +89108,56 @@ ] }, "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "Selector" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-type.ts", - "qualifiedName": "ProductType" - }, - "name": "ProductType", - "package": "@medusajs/medusa" + "type": "reflection", + "declaration": { + "id": 4115, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4117, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" } - ], - "name": "Selector", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 4041, - "name": "__type", + }, + { + "id": 4116, + "name": "q", "variant": "declaration", - "kind": 65536, - "flags": {}, + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", "children": [ - { - "id": 4043, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4042, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4043, - 4042 - ] - } + 4117, + 4116 ] } - } - ] + ] + } }, "defaultValue": "{}" }, { - "id": 4044, + "id": 4118, "name": "config", "variant": "param", "kind": 32768, @@ -87633,14 +89229,14 @@ ] }, { - "id": 4027, + "id": 4101, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4028, + "id": 4102, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -87666,7 +89262,7 @@ }, "parameters": [ { - "id": 4029, + "id": 4103, "name": "id", "variant": "param", "kind": 32768, @@ -87685,7 +89281,7 @@ } }, { - "id": 4030, + "id": 4104, "name": "config", "variant": "param", "kind": 32768, @@ -87745,7 +89341,7 @@ ] }, { - "id": 4055, + "id": 4129, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -87754,14 +89350,14 @@ }, "signatures": [ { - "id": 4056, + "id": 4130, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4057, + "id": 4131, "name": "err", "variant": "param", "kind": 32768, @@ -87791,14 +89387,14 @@ { "type": "reflection", "declaration": { - "id": 4058, + "id": 4132, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4059, + "id": 4133, "name": "code", "variant": "declaration", "kind": 1024, @@ -87813,7 +89409,7 @@ { "title": "Properties", "children": [ - 4059 + 4133 ] } ] @@ -87841,21 +89437,21 @@ } }, { - "id": 4052, + "id": 4126, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4053, + "id": 4127, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4054, + "id": 4128, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -87875,7 +89471,7 @@ ], "type": { "type": "reference", - "target": 4014, + "target": 4086, "name": "ProductTypeService", "package": "@medusajs/medusa" }, @@ -87897,35 +89493,35 @@ { "title": "Constructors", "children": [ - 4015 + 4087 ] }, { "title": "Properties", "children": [ - 4050, - 4049, - 4051, - 4045, - 4046, - 4018 + 4124, + 4123, + 4125, + 4119, + 4120, + 4092 ] }, { "title": "Accessors", "children": [ - 4047 + 4121 ] }, { "title": "Methods", "children": [ - 4060, - 4031, - 4038, - 4027, - 4055, - 4052 + 4134, + 4105, + 4112, + 4101, + 4129, + 4126 ] } ], @@ -87942,28 +89538,28 @@ ] }, { - "id": 4409, + "id": 4497, "name": "ProductVariantInventoryService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 4410, + "id": 4498, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 4411, + "id": 4499, "name": "new ProductVariantInventoryService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 4412, + "id": 4500, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -87981,7 +89577,7 @@ ], "type": { "type": "reference", - "target": 4409, + "target": 4497, "name": "ProductVariantInventoryService", "package": "@medusajs/medusa" }, @@ -87999,7 +89595,7 @@ } }, { - "id": 4507, + "id": 4595, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -88034,7 +89630,7 @@ } }, { - "id": 4506, + "id": 4594, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -88053,7 +89649,7 @@ } }, { - "id": 4508, + "id": 4596, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -88088,7 +89684,7 @@ } }, { - "id": 4418, + "id": 4506, "name": "eventBusService_", "variant": "declaration", "kind": 1024, @@ -88107,7 +89703,7 @@ } }, { - "id": 4413, + "id": 4501, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -88130,7 +89726,7 @@ } }, { - "id": 4417, + "id": 4505, "name": "productVariantService_", "variant": "declaration", "kind": 1024, @@ -88140,13 +89736,13 @@ }, "type": { "type": "reference", - "target": 4076, + "target": 4150, "name": "ProductVariantService", "package": "@medusajs/medusa" } }, { - "id": 4416, + "id": 4504, "name": "salesChannelInventoryService_", "variant": "declaration", "kind": 1024, @@ -88156,13 +89752,13 @@ }, "type": { "type": "reference", - "target": 4915, + "target": 5022, "name": "SalesChannelInventoryService", "package": "@medusajs/medusa" } }, { - "id": 4415, + "id": 4503, "name": "salesChannelLocationService_", "variant": "declaration", "kind": 1024, @@ -88172,13 +89768,13 @@ }, "type": { "type": "reference", - "target": 4958, + "target": 5065, "name": "SalesChannelLocationService", "package": "@medusajs/medusa" } }, { - "id": 4414, + "id": 4502, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -88210,7 +89806,7 @@ } }, { - "id": 4504, + "id": 4592, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -88218,7 +89814,7 @@ "isProtected": true }, "getSignature": { - "id": 4505, + "id": 4593, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -88245,7 +89841,7 @@ } }, { - "id": 4419, + "id": 4507, "name": "inventoryService_", "variant": "declaration", "kind": 262144, @@ -88253,7 +89849,7 @@ "isProtected": true }, "getSignature": { - "id": 4420, + "id": 4508, "name": "inventoryService_", "variant": "signature", "kind": 524288, @@ -88270,7 +89866,7 @@ } }, { - "id": 4421, + "id": 4509, "name": "stockLocationService_", "variant": "declaration", "kind": 262144, @@ -88278,7 +89874,7 @@ "isProtected": true }, "getSignature": { - "id": 4422, + "id": 4510, "name": "stockLocationService_", "variant": "signature", "kind": 524288, @@ -88295,14 +89891,14 @@ } }, { - "id": 4481, + "id": 4569, "name": "adjustInventory", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4482, + "id": 4570, "name": "adjustInventory", "variant": "signature", "kind": 4096, @@ -88317,7 +89913,7 @@ }, "parameters": [ { - "id": 4483, + "id": 4571, "name": "variantId", "variant": "param", "kind": 32768, @@ -88336,7 +89932,7 @@ } }, { - "id": 4484, + "id": 4572, "name": "locationId", "variant": "param", "kind": 32768, @@ -88355,7 +89951,7 @@ } }, { - "id": 4485, + "id": 4573, "name": "quantity", "variant": "param", "kind": 32768, @@ -88393,14 +89989,14 @@ ] }, { - "id": 4466, + "id": 4554, "name": "adjustReservationsQuantityByLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4467, + "id": 4555, "name": "adjustReservationsQuantityByLineItem", "variant": "signature", "kind": 4096, @@ -88415,7 +90011,7 @@ }, "parameters": [ { - "id": 4468, + "id": 4556, "name": "lineItemId", "variant": "param", "kind": 32768, @@ -88434,7 +90030,7 @@ } }, { - "id": 4469, + "id": 4557, "name": "variantId", "variant": "param", "kind": 32768, @@ -88453,7 +90049,7 @@ } }, { - "id": 4470, + "id": 4558, "name": "locationId", "variant": "param", "kind": 32768, @@ -88472,7 +90068,7 @@ } }, { - "id": 4471, + "id": 4559, "name": "quantity", "variant": "param", "kind": 32768, @@ -88510,7 +90106,7 @@ ] }, { - "id": 4517, + "id": 4605, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -88519,7 +90115,7 @@ }, "signatures": [ { - "id": 4518, + "id": 4606, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -88545,14 +90141,14 @@ }, "typeParameter": [ { - "id": 4519, + "id": 4607, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 4520, + "id": 4608, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -88561,7 +90157,7 @@ ], "parameters": [ { - "id": 4521, + "id": 4609, "name": "work", "variant": "param", "kind": 32768, @@ -88577,21 +90173,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4522, + "id": 4610, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4523, + "id": 4611, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4524, + "id": 4612, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -88630,7 +90226,7 @@ } }, { - "id": 4525, + "id": 4613, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -88660,21 +90256,21 @@ { "type": "reflection", "declaration": { - "id": 4526, + "id": 4614, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4527, + "id": 4615, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4528, + "id": 4616, "name": "error", "variant": "param", "kind": 32768, @@ -88721,7 +90317,7 @@ } }, { - "id": 4529, + "id": 4617, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -88739,21 +90335,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4530, + "id": 4618, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4531, + "id": 4619, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4532, + "id": 4620, "name": "error", "variant": "param", "kind": 32768, @@ -88829,14 +90425,14 @@ } }, { - "id": 4446, + "id": 4534, "name": "attachInventoryItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4447, + "id": 4535, "name": "attachInventoryItem", "variant": "signature", "kind": 4096, @@ -88862,7 +90458,7 @@ }, "parameters": [ { - "id": 4448, + "id": 4536, "name": "attachments", "variant": "param", "kind": 32768, @@ -88872,14 +90468,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 4449, + "id": 4537, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4451, + "id": 4539, "name": "inventoryItemId", "variant": "declaration", "kind": 1024, @@ -88890,7 +90486,7 @@ } }, { - "id": 4452, + "id": 4540, "name": "requiredQuantity", "variant": "declaration", "kind": 1024, @@ -88903,7 +90499,7 @@ } }, { - "id": 4450, + "id": 4538, "name": "variantId", "variant": "declaration", "kind": 1024, @@ -88918,9 +90514,9 @@ { "title": "Properties", "children": [ - 4451, - 4452, - 4450 + 4539, + 4540, + 4538 ] } ] @@ -88954,14 +90550,14 @@ } }, { - "id": 4453, + "id": 4541, "name": "attachInventoryItem", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4454, + "id": 4542, "name": "variantId", "variant": "param", "kind": 32768, @@ -88972,7 +90568,7 @@ } }, { - "id": 4455, + "id": 4543, "name": "inventoryItemId", "variant": "param", "kind": 32768, @@ -88983,7 +90579,7 @@ } }, { - "id": 4456, + "id": 4544, "name": "requiredQuantity", "variant": "param", "kind": 32768, @@ -89023,14 +90619,14 @@ ] }, { - "id": 4423, + "id": 4511, "name": "confirmInventory", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4424, + "id": 4512, "name": "confirmInventory", "variant": "signature", "kind": 4096, @@ -89056,7 +90652,7 @@ }, "parameters": [ { - "id": 4425, + "id": 4513, "name": "variantId", "variant": "param", "kind": 32768, @@ -89075,7 +90671,7 @@ } }, { - "id": 4426, + "id": 4514, "name": "quantity", "variant": "param", "kind": 32768, @@ -89094,7 +90690,7 @@ } }, { - "id": 4427, + "id": 4515, "name": "context", "variant": "param", "kind": 32768, @@ -89110,14 +90706,14 @@ "type": { "type": "reflection", "declaration": { - "id": 4428, + "id": 4516, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4429, + "id": 4517, "name": "salesChannelId", "variant": "declaration", "kind": 1024, @@ -89143,7 +90739,7 @@ { "title": "Properties", "children": [ - 4429 + 4517 ] } ] @@ -89176,14 +90772,14 @@ ] }, { - "id": 4476, + "id": 4564, "name": "deleteReservationsByLineItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4477, + "id": 4565, "name": "deleteReservationsByLineItem", "variant": "signature", "kind": 4096, @@ -89198,7 +90794,7 @@ }, "parameters": [ { - "id": 4478, + "id": 4566, "name": "lineItemId", "variant": "param", "kind": 32768, @@ -89229,7 +90825,7 @@ } }, { - "id": 4479, + "id": 4567, "name": "variantId", "variant": "param", "kind": 32768, @@ -89248,7 +90844,7 @@ } }, { - "id": 4480, + "id": 4568, "name": "quantity", "variant": "param", "kind": 32768, @@ -89286,14 +90882,14 @@ ] }, { - "id": 4457, + "id": 4545, "name": "detachInventoryItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4458, + "id": 4546, "name": "detachInventoryItem", "variant": "signature", "kind": 4096, @@ -89308,7 +90904,7 @@ }, "parameters": [ { - "id": 4459, + "id": 4547, "name": "inventoryItemId", "variant": "param", "kind": 32768, @@ -89327,7 +90923,7 @@ } }, { - "id": 4460, + "id": 4548, "name": "variantId", "variant": "param", "kind": 32768, @@ -89367,7 +90963,7 @@ ] }, { - "id": 4491, + "id": 4579, "name": "getAvailabilityContext", "variant": "declaration", "kind": 2048, @@ -89376,14 +90972,14 @@ }, "signatures": [ { - "id": 4492, + "id": 4580, "name": "getAvailabilityContext", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4493, + "id": 4581, "name": "variants", "variant": "param", "kind": 32768, @@ -89397,7 +90993,7 @@ } }, { - "id": 4494, + "id": 4582, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -89424,7 +91020,7 @@ } }, { - "id": 4495, + "id": 4583, "name": "existingContext", "variant": "param", "kind": 32768, @@ -89476,14 +91072,14 @@ ] }, { - "id": 4500, + "id": 4588, "name": "getVariantQuantityFromVariantInventoryItems", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4501, + "id": 4589, "name": "getVariantQuantityFromVariantInventoryItems", "variant": "signature", "kind": 4096, @@ -89509,7 +91105,7 @@ }, "parameters": [ { - "id": 4502, + "id": 4590, "name": "variantInventoryItems", "variant": "param", "kind": 32768, @@ -89536,7 +91132,7 @@ } }, { - "id": 4503, + "id": 4591, "name": "channelId", "variant": "param", "kind": 32768, @@ -89574,14 +91170,14 @@ ] }, { - "id": 4434, + "id": 4522, "name": "listByItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4435, + "id": 4523, "name": "listByItem", "variant": "signature", "kind": 4096, @@ -89607,7 +91203,7 @@ }, "parameters": [ { - "id": 4436, + "id": 4524, "name": "itemIds", "variant": "param", "kind": 32768, @@ -89656,7 +91252,7 @@ ] }, { - "id": 4437, + "id": 4525, "name": "listByVariant", "variant": "declaration", "kind": 2048, @@ -89665,7 +91261,7 @@ }, "signatures": [ { - "id": 4438, + "id": 4526, "name": "listByVariant", "variant": "signature", "kind": 4096, @@ -89691,7 +91287,7 @@ }, "parameters": [ { - "id": 4439, + "id": 4527, "name": "variantId", "variant": "param", "kind": 32768, @@ -89749,14 +91345,14 @@ ] }, { - "id": 4443, + "id": 4531, "name": "listInventoryItemsByVariant", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4444, + "id": 4532, "name": "listInventoryItemsByVariant", "variant": "signature", "kind": 4096, @@ -89782,7 +91378,7 @@ }, "parameters": [ { - "id": 4445, + "id": 4533, "name": "variantId", "variant": "param", "kind": 32768, @@ -89828,14 +91424,14 @@ ] }, { - "id": 4440, + "id": 4528, "name": "listVariantsByItem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4441, + "id": 4529, "name": "listVariantsByItem", "variant": "signature", "kind": 4096, @@ -89861,7 +91457,7 @@ }, "parameters": [ { - "id": 4442, + "id": 4530, "name": "itemId", "variant": "param", "kind": 32768, @@ -89907,14 +91503,14 @@ ] }, { - "id": 4461, + "id": 4549, "name": "reserveQuantity", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4462, + "id": 4550, "name": "reserveQuantity", "variant": "signature", "kind": 4096, @@ -89929,7 +91525,7 @@ }, "parameters": [ { - "id": 4463, + "id": 4551, "name": "variantId", "variant": "param", "kind": 32768, @@ -89948,7 +91544,7 @@ } }, { - "id": 4464, + "id": 4552, "name": "quantity", "variant": "param", "kind": 32768, @@ -89967,7 +91563,7 @@ } }, { - "id": 4465, + "id": 4553, "name": "context", "variant": "param", "kind": 32768, @@ -90028,14 +91624,14 @@ ] }, { - "id": 4430, + "id": 4518, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4431, + "id": 4519, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -90061,7 +91657,7 @@ }, "parameters": [ { - "id": 4432, + "id": 4520, "name": "inventoryItemId", "variant": "param", "kind": 32768, @@ -90080,7 +91676,7 @@ } }, { - "id": 4433, + "id": 4521, "name": "variantId", "variant": "param", "kind": 32768, @@ -90123,21 +91719,21 @@ ] }, { - "id": 4496, + "id": 4584, "name": "setProductAvailability", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4497, + "id": 4585, "name": "setProductAvailability", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4498, + "id": 4586, "name": "products", "variant": "param", "kind": 32768, @@ -90170,7 +91766,7 @@ } }, { - "id": 4499, + "id": 4587, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -90238,21 +91834,21 @@ ] }, { - "id": 4486, + "id": 4574, "name": "setVariantAvailability", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4487, + "id": 4575, "name": "setVariantAvailability", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4488, + "id": 4576, "name": "variants", "variant": "param", "kind": 32768, @@ -90288,7 +91884,7 @@ } }, { - "id": 4489, + "id": 4577, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -90315,7 +91911,7 @@ } }, { - "id": 4490, + "id": 4578, "name": "availabilityContext", "variant": "param", "kind": 32768, @@ -90376,7 +91972,7 @@ ] }, { - "id": 4512, + "id": 4600, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -90385,14 +91981,14 @@ }, "signatures": [ { - "id": 4513, + "id": 4601, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4514, + "id": 4602, "name": "err", "variant": "param", "kind": 32768, @@ -90422,14 +92018,14 @@ { "type": "reflection", "declaration": { - "id": 4515, + "id": 4603, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4516, + "id": 4604, "name": "code", "variant": "declaration", "kind": 1024, @@ -90444,7 +92040,7 @@ { "title": "Properties", "children": [ - 4516 + 4604 ] } ] @@ -90472,14 +92068,14 @@ } }, { - "id": 4472, + "id": 4560, "name": "validateInventoryAtLocation", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4473, + "id": 4561, "name": "validateInventoryAtLocation", "variant": "signature", "kind": 4096, @@ -90505,7 +92101,7 @@ }, "parameters": [ { - "id": 4474, + "id": 4562, "name": "items", "variant": "param", "kind": 32768, @@ -90547,7 +92143,7 @@ } }, { - "id": 4475, + "id": 4563, "name": "locationId", "variant": "param", "kind": 32768, @@ -90585,21 +92181,21 @@ ] }, { - "id": 4509, + "id": 4597, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4510, + "id": 4598, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4511, + "id": 4599, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -90619,7 +92215,7 @@ ], "type": { "type": "reference", - "target": 4409, + "target": 4497, "name": "ProductVariantInventoryService", "package": "@medusajs/medusa" }, @@ -90641,54 +92237,54 @@ { "title": "Constructors", "children": [ - 4410 + 4498 ] }, { "title": "Properties", "children": [ - 4507, + 4595, + 4594, + 4596, 4506, - 4508, - 4418, - 4413, - 4417, - 4416, - 4415, - 4414 + 4501, + 4505, + 4504, + 4503, + 4502 ] }, { "title": "Accessors", "children": [ - 4504, - 4419, - 4421 + 4592, + 4507, + 4509 ] }, { "title": "Methods", "children": [ - 4481, - 4466, - 4517, - 4446, - 4423, - 4476, - 4457, - 4491, - 4500, - 4434, - 4437, - 4443, - 4440, - 4461, - 4430, - 4496, - 4486, - 4512, - 4472, - 4509 + 4569, + 4554, + 4605, + 4534, + 4511, + 4564, + 4545, + 4579, + 4588, + 4522, + 4525, + 4531, + 4528, + 4549, + 4518, + 4584, + 4574, + 4600, + 4560, + 4597 ] } ], @@ -90705,41 +92301,152 @@ ] }, { - "id": 4076, + "id": 4150, "name": "ProductVariantService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 4082, + "id": 4156, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 4083, + "id": 4157, "name": "new ProductVariantService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 4084, + "id": 4158, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "Object" + "type": "reflection", + "declaration": { + "id": 4159, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4166, + "name": "cartRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4162, + "name": "eventBusService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4164, + "name": "moneyAmountRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4167, + "name": "priceSelectionStrategy", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4165, + "name": "productOptionValueRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4161, + "name": "productRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4160, + "name": "productVariantRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4163, + "name": "regionService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4166, + 4162, + 4164, + 4167, + 4165, + 4161, + 4160, + 4163 + ] + } + ] + } } } ], "type": { "type": "reference", - "target": 4076, + "target": 4150, "name": "ProductVariantService", "package": "@medusajs/medusa" }, @@ -90757,7 +92464,7 @@ } }, { - "id": 4383, + "id": 4471, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -90792,7 +92499,7 @@ } }, { - "id": 4382, + "id": 4470, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -90811,7 +92518,7 @@ } }, { - "id": 4384, + "id": 4472, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -90846,7 +92553,7 @@ } }, { - "id": 4271, + "id": 4359, "name": "cartRepository_", "variant": "declaration", "kind": 1024, @@ -90880,28 +92587,28 @@ { "type": "reflection", "declaration": { - "id": 4272, + "id": 4360, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4277, + "id": 4365, "name": "findOneWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4278, + "id": 4366, "name": "findOneWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4279, + "id": 4367, "name": "relations", "variant": "param", "kind": 32768, @@ -90929,7 +92636,7 @@ "defaultValue": "{}" }, { - "id": 4280, + "id": 4368, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -90996,21 +92703,21 @@ ] }, { - "id": 4273, + "id": 4361, "name": "findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4274, + "id": 4362, "name": "findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4275, + "id": 4363, "name": "relations", "variant": "param", "kind": 32768, @@ -91038,7 +92745,7 @@ "defaultValue": "{}" }, { - "id": 4276, + "id": 4364, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -91112,8 +92819,8 @@ { "title": "Methods", "children": [ - 4277, - 4273 + 4365, + 4361 ] } ] @@ -91123,7 +92830,7 @@ } }, { - "id": 4157, + "id": 4245, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -91133,13 +92840,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 4378, + "id": 4466, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -91162,7 +92869,7 @@ } }, { - "id": 4160, + "id": 4248, "name": "moneyAmountRepository_", "variant": "declaration", "kind": 1024, @@ -91196,28 +92903,28 @@ { "type": "reflection", "declaration": { - "id": 4161, + "id": 4249, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4180, + "id": 4268, "name": "addPriceListPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4181, + "id": 4269, "name": "addPriceListPrices", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4182, + "id": 4270, "name": "priceListId", "variant": "param", "kind": 32768, @@ -91228,7 +92935,7 @@ } }, { - "id": 4183, + "id": 4271, "name": "prices", "variant": "param", "kind": 32768, @@ -91247,7 +92954,7 @@ } }, { - "id": 4184, + "id": 4272, "name": "overrideExisting", "variant": "param", "kind": 32768, @@ -91286,21 +92993,21 @@ ] }, { - "id": 4264, + "id": 4352, "name": "createProductVariantMoneyAmounts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4265, + "id": 4353, "name": "createProductVariantMoneyAmounts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4266, + "id": 4354, "name": "toCreate", "variant": "param", "kind": 32768, @@ -91310,14 +93017,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 4267, + "id": 4355, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4269, + "id": 4357, "name": "money_amount_id", "variant": "declaration", "kind": 1024, @@ -91328,7 +93035,7 @@ } }, { - "id": 4268, + "id": 4356, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -91343,8 +93050,8 @@ { "title": "Properties", "children": [ - 4269, - 4268 + 4357, + 4356 ] } ] @@ -91377,21 +93084,21 @@ ] }, { - "id": 4185, + "id": 4273, "name": "deletePriceListPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4186, + "id": 4274, "name": "deletePriceListPrices", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4187, + "id": 4275, "name": "priceListId", "variant": "param", "kind": 32768, @@ -91402,7 +93109,7 @@ } }, { - "id": 4188, + "id": 4276, "name": "moneyAmountIds", "variant": "param", "kind": 32768, @@ -91435,21 +93142,21 @@ ] }, { - "id": 4169, + "id": 4257, "name": "deleteVariantPricesNotIn", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4170, + "id": 4258, "name": "deleteVariantPricesNotIn", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4171, + "id": 4259, "name": "variantIdOrData", "variant": "param", "kind": 32768, @@ -91466,14 +93173,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 4172, + "id": 4260, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4174, + "id": 4262, "name": "prices", "variant": "declaration", "kind": 1024, @@ -91492,7 +93199,7 @@ } }, { - "id": 4173, + "id": 4261, "name": "variantId", "variant": "declaration", "kind": 1024, @@ -91507,8 +93214,8 @@ { "title": "Properties", "children": [ - 4174, - 4173 + 4262, + 4261 ] } ] @@ -91519,7 +93226,7 @@ } }, { - "id": 4175, + "id": 4263, "name": "prices", "variant": "param", "kind": 32768, @@ -91559,21 +93266,21 @@ ] }, { - "id": 4202, + "id": 4290, "name": "findCurrencyMoneyAmounts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4203, + "id": 4291, "name": "findCurrencyMoneyAmounts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4204, + "id": 4292, "name": "where", "variant": "param", "kind": 32768, @@ -91583,14 +93290,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 4205, + "id": 4293, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4207, + "id": 4295, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -91601,7 +93308,7 @@ } }, { - "id": 4206, + "id": 4294, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -91616,8 +93323,8 @@ { "title": "Properties", "children": [ - 4207, - 4206 + 4295, + 4294 ] } ] @@ -91638,14 +93345,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 4208, + "id": 4296, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4212, + "id": 4300, "name": "amount", "variant": "declaration", "kind": 1024, @@ -91656,7 +93363,7 @@ } }, { - "id": 4223, + "id": 4311, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -91672,7 +93379,7 @@ } }, { - "id": 4211, + "id": 4299, "name": "currency", "variant": "declaration", "kind": 1024, @@ -91690,7 +93397,7 @@ } }, { - "id": 4210, + "id": 4298, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -91701,7 +93408,7 @@ } }, { - "id": 4221, + "id": 4309, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -91726,7 +93433,7 @@ } }, { - "id": 4222, + "id": 4310, "name": "id", "variant": "declaration", "kind": 1024, @@ -91737,7 +93444,7 @@ } }, { - "id": 4214, + "id": 4302, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -91757,7 +93464,7 @@ } }, { - "id": 4213, + "id": 4301, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -91777,7 +93484,7 @@ } }, { - "id": 4216, + "id": 4304, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -91802,7 +93509,7 @@ } }, { - "id": 4215, + "id": 4303, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -91822,7 +93529,7 @@ } }, { - "id": 4220, + "id": 4308, "name": "region", "variant": "declaration", "kind": 1024, @@ -91840,7 +93547,7 @@ } }, { - "id": 4219, + "id": 4307, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -91860,7 +93567,7 @@ } }, { - "id": 4224, + "id": 4312, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -91876,7 +93583,7 @@ } }, { - "id": 4218, + "id": 4306, "name": "variant", "variant": "declaration", "kind": 1024, @@ -91892,7 +93599,7 @@ } }, { - "id": 4209, + "id": 4297, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -91904,7 +93611,7 @@ "defaultValue": "..." }, { - "id": 4217, + "id": 4305, "name": "variants", "variant": "declaration", "kind": 1024, @@ -91927,22 +93634,22 @@ { "title": "Properties", "children": [ - 4212, - 4223, - 4211, - 4210, - 4221, - 4222, - 4214, - 4213, - 4216, - 4215, - 4220, - 4219, - 4224, - 4218, - 4209, - 4217 + 4300, + 4311, + 4299, + 4298, + 4309, + 4310, + 4302, + 4301, + 4304, + 4303, + 4308, + 4307, + 4312, + 4306, + 4297, + 4305 ] } ] @@ -91957,21 +93664,21 @@ ] }, { - "id": 4189, + "id": 4277, "name": "findManyForVariantInPriceList", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4190, + "id": 4278, "name": "findManyForVariantInPriceList", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4191, + "id": 4279, "name": "variant_id", "variant": "param", "kind": 32768, @@ -91982,7 +93689,7 @@ } }, { - "id": 4192, + "id": 4280, "name": "price_list_id", "variant": "param", "kind": 32768, @@ -91993,7 +93700,7 @@ } }, { - "id": 4193, + "id": 4281, "name": "requiresPriceList", "variant": "param", "kind": 32768, @@ -92041,14 +93748,14 @@ ] }, { - "id": 4194, + "id": 4282, "name": "findManyForVariantInRegion", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4195, + "id": 4283, "name": "findManyForVariantInRegion", "variant": "signature", "kind": 4096, @@ -92067,7 +93774,7 @@ "kind": "inline-tag", "tag": "@link", "text": "findManyForVariantsInRegion", - "target": 4248 + "target": 4336 } ] } @@ -92075,7 +93782,7 @@ }, "parameters": [ { - "id": 4196, + "id": 4284, "name": "variant_id", "variant": "param", "kind": 32768, @@ -92086,7 +93793,7 @@ } }, { - "id": 4197, + "id": 4285, "name": "region_id", "variant": "param", "kind": 32768, @@ -92099,7 +93806,7 @@ } }, { - "id": 4198, + "id": 4286, "name": "currency_code", "variant": "param", "kind": 32768, @@ -92112,7 +93819,7 @@ } }, { - "id": 4199, + "id": 4287, "name": "customer_id", "variant": "param", "kind": 32768, @@ -92125,7 +93832,7 @@ } }, { - "id": 4200, + "id": 4288, "name": "include_discount_prices", "variant": "param", "kind": 32768, @@ -92138,7 +93845,7 @@ } }, { - "id": 4201, + "id": 4289, "name": "include_tax_inclusive_pricing", "variant": "param", "kind": 32768, @@ -92186,21 +93893,21 @@ ] }, { - "id": 4248, + "id": 4336, "name": "findManyForVariantsInRegion", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4249, + "id": 4337, "name": "findManyForVariantsInRegion", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4250, + "id": 4338, "name": "variant_ids", "variant": "param", "kind": 32768, @@ -92223,7 +93930,7 @@ } }, { - "id": 4251, + "id": 4339, "name": "region_id", "variant": "param", "kind": 32768, @@ -92236,7 +93943,7 @@ } }, { - "id": 4252, + "id": 4340, "name": "currency_code", "variant": "param", "kind": 32768, @@ -92249,7 +93956,7 @@ } }, { - "id": 4253, + "id": 4341, "name": "customer_id", "variant": "param", "kind": 32768, @@ -92262,7 +93969,7 @@ } }, { - "id": 4254, + "id": 4342, "name": "include_discount_prices", "variant": "param", "kind": 32768, @@ -92275,7 +93982,7 @@ } }, { - "id": 4255, + "id": 4343, "name": "include_tax_inclusive_pricing", "variant": "param", "kind": 32768, @@ -92338,21 +94045,21 @@ ] }, { - "id": 4225, + "id": 4313, "name": "findRegionMoneyAmounts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4226, + "id": 4314, "name": "findRegionMoneyAmounts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4227, + "id": 4315, "name": "where", "variant": "param", "kind": 32768, @@ -92362,14 +94069,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 4228, + "id": 4316, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4230, + "id": 4318, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -92380,7 +94087,7 @@ } }, { - "id": 4229, + "id": 4317, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -92395,8 +94102,8 @@ { "title": "Properties", "children": [ - 4230, - 4229 + 4318, + 4317 ] } ] @@ -92417,14 +94124,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 4231, + "id": 4319, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4235, + "id": 4323, "name": "amount", "variant": "declaration", "kind": 1024, @@ -92435,7 +94142,7 @@ } }, { - "id": 4246, + "id": 4334, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -92451,7 +94158,7 @@ } }, { - "id": 4234, + "id": 4322, "name": "currency", "variant": "declaration", "kind": 1024, @@ -92469,7 +94176,7 @@ } }, { - "id": 4233, + "id": 4321, "name": "currency_code", "variant": "declaration", "kind": 1024, @@ -92480,7 +94187,7 @@ } }, { - "id": 4244, + "id": 4332, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -92505,7 +94212,7 @@ } }, { - "id": 4245, + "id": 4333, "name": "id", "variant": "declaration", "kind": 1024, @@ -92516,7 +94223,7 @@ } }, { - "id": 4237, + "id": 4325, "name": "max_quantity", "variant": "declaration", "kind": 1024, @@ -92536,7 +94243,7 @@ } }, { - "id": 4236, + "id": 4324, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -92556,7 +94263,7 @@ } }, { - "id": 4239, + "id": 4327, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -92581,7 +94288,7 @@ } }, { - "id": 4238, + "id": 4326, "name": "price_list_id", "variant": "declaration", "kind": 1024, @@ -92601,7 +94308,7 @@ } }, { - "id": 4243, + "id": 4331, "name": "region", "variant": "declaration", "kind": 1024, @@ -92619,7 +94326,7 @@ } }, { - "id": 4242, + "id": 4330, "name": "region_id", "variant": "declaration", "kind": 1024, @@ -92639,7 +94346,7 @@ } }, { - "id": 4247, + "id": 4335, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -92655,7 +94362,7 @@ } }, { - "id": 4241, + "id": 4329, "name": "variant", "variant": "declaration", "kind": 1024, @@ -92671,7 +94378,7 @@ } }, { - "id": 4232, + "id": 4320, "name": "variant_id", "variant": "declaration", "kind": 1024, @@ -92683,7 +94390,7 @@ "defaultValue": "..." }, { - "id": 4240, + "id": 4328, "name": "variants", "variant": "declaration", "kind": 1024, @@ -92706,22 +94413,22 @@ { "title": "Properties", "children": [ - 4235, - 4246, - 4234, - 4233, - 4244, - 4245, - 4237, - 4236, - 4239, - 4238, - 4243, - 4242, - 4247, - 4241, - 4232, - 4240 + 4323, + 4334, + 4322, + 4321, + 4332, + 4333, + 4325, + 4324, + 4327, + 4326, + 4331, + 4330, + 4335, + 4329, + 4320, + 4328 ] } ] @@ -92736,14 +94443,14 @@ ] }, { - "id": 4165, + "id": 4253, "name": "findVariantPricesNotIn", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4166, + "id": 4254, "name": "findVariantPricesNotIn", "variant": "signature", "kind": 4096, @@ -92772,7 +94479,7 @@ }, "parameters": [ { - "id": 4167, + "id": 4255, "name": "variantId", "variant": "param", "kind": 32768, @@ -92783,7 +94490,7 @@ } }, { - "id": 4168, + "id": 4256, "name": "prices", "variant": "param", "kind": 32768, @@ -92829,21 +94536,21 @@ ] }, { - "id": 4260, + "id": 4348, "name": "getPricesForVariantInRegion", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4261, + "id": 4349, "name": "getPricesForVariantInRegion", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4262, + "id": 4350, "name": "variantId", "variant": "param", "kind": 32768, @@ -92854,7 +94561,7 @@ } }, { - "id": 4263, + "id": 4351, "name": "regionId", "variant": "param", "kind": 32768, @@ -92901,21 +94608,21 @@ ] }, { - "id": 4162, + "id": 4250, "name": "insertBulk", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4163, + "id": 4251, "name": "insertBulk", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4164, + "id": 4252, "name": "data", "variant": "param", "kind": 32768, @@ -92972,21 +94679,21 @@ ] }, { - "id": 4256, + "id": 4344, "name": "updatePriceListPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4257, + "id": 4345, "name": "updatePriceListPrices", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4258, + "id": 4346, "name": "priceListId", "variant": "param", "kind": 32768, @@ -92997,7 +94704,7 @@ } }, { - "id": 4259, + "id": 4347, "name": "updates", "variant": "param", "kind": 32768, @@ -93043,21 +94750,21 @@ ] }, { - "id": 4176, + "id": 4264, "name": "upsertVariantCurrencyPrice", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4177, + "id": 4265, "name": "upsertVariantCurrencyPrice", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4178, + "id": 4266, "name": "variantId", "variant": "param", "kind": 32768, @@ -93068,7 +94775,7 @@ } }, { - "id": 4179, + "id": 4267, "name": "price", "variant": "param", "kind": 32768, @@ -93112,20 +94819,20 @@ { "title": "Methods", "children": [ - 4180, - 4264, - 4185, - 4169, - 4202, - 4189, - 4194, - 4248, - 4225, - 4165, - 4260, - 4162, - 4256, - 4176 + 4268, + 4352, + 4273, + 4257, + 4290, + 4277, + 4282, + 4336, + 4313, + 4253, + 4348, + 4250, + 4344, + 4264 ] } ] @@ -93135,7 +94842,7 @@ } }, { - "id": 4159, + "id": 4247, "name": "priceSelectionStrategy_", "variant": "declaration", "kind": 1024, @@ -93154,7 +94861,7 @@ } }, { - "id": 4270, + "id": 4358, "name": "productOptionValueRepository_", "variant": "declaration", "kind": 1024, @@ -93184,7 +94891,7 @@ } }, { - "id": 4086, + "id": 4169, "name": "productRepository_", "variant": "declaration", "kind": 1024, @@ -93218,28 +94925,28 @@ { "type": "reflection", "declaration": { - "id": 4087, + "id": 4170, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4153, + "id": 4236, "name": "_applyCategoriesQuery", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4154, + "id": 4237, "name": "_applyCategoriesQuery", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4155, + "id": 4238, "name": "qb", "variant": "param", "kind": 32768, @@ -93266,14 +94973,77 @@ } }, { - "id": 4156, + "id": 4239, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "Object" + "type": "reflection", + "declaration": { + "id": 4240, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4241, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4242, + "name": "categoryAlias", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4244, + "name": "joinName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4243, + "name": "where", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4241, + 4242, + 4244, + 4243 + ] + } + ] + } } } ], @@ -93301,21 +95071,21 @@ ] }, { - "id": 4141, + "id": 4224, "name": "_findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4142, + "id": 4225, "name": "_findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4143, + "id": 4226, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -93323,14 +95093,14 @@ "type": { "type": "reflection", "declaration": { - "id": 4144, + "id": 4227, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4146, + "id": 4229, "name": "idsOrOptionsWithoutRelations", "variant": "declaration", "kind": 1024, @@ -93358,7 +95128,7 @@ } }, { - "id": 4145, + "id": 4228, "name": "relations", "variant": "declaration", "kind": 1024, @@ -93372,7 +95142,7 @@ } }, { - "id": 4148, + "id": 4231, "name": "shouldCount", "variant": "declaration", "kind": 1024, @@ -93383,7 +95153,7 @@ } }, { - "id": 4147, + "id": 4230, "name": "withDeleted", "variant": "declaration", "kind": 1024, @@ -93398,10 +95168,10 @@ { "title": "Properties", "children": [ - 4146, - 4145, - 4148, - 4147 + 4229, + 4228, + 4231, + 4230 ] } ] @@ -93445,21 +95215,21 @@ ] }, { - "id": 4121, + "id": 4204, "name": "bulkAddToCollection", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4122, + "id": 4205, "name": "bulkAddToCollection", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4123, + "id": 4206, "name": "productIds", "variant": "param", "kind": 32768, @@ -93473,7 +95243,7 @@ } }, { - "id": 4124, + "id": 4207, "name": "collectionId", "variant": "param", "kind": 32768, @@ -93511,21 +95281,21 @@ ] }, { - "id": 4125, + "id": 4208, "name": "bulkRemoveFromCollection", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4126, + "id": 4209, "name": "bulkRemoveFromCollection", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4127, + "id": 4210, "name": "productIds", "variant": "param", "kind": 32768, @@ -93539,7 +95309,7 @@ } }, { - "id": 4128, + "id": 4211, "name": "collectionId", "variant": "param", "kind": 32768, @@ -93577,21 +95347,21 @@ ] }, { - "id": 4117, + "id": 4200, "name": "findOneWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4118, + "id": 4201, "name": "findOneWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4119, + "id": 4202, "name": "relations", "variant": "param", "kind": 32768, @@ -93606,7 +95376,7 @@ "defaultValue": "[]" }, { - "id": 4120, + "id": 4203, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -93647,21 +95417,21 @@ ] }, { - "id": 4112, + "id": 4195, "name": "findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4113, + "id": 4196, "name": "findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4114, + "id": 4197, "name": "relations", "variant": "param", "kind": 32768, @@ -93676,7 +95446,7 @@ "defaultValue": "[]" }, { - "id": 4115, + "id": 4198, "name": "idsOrOptionsWithoutRelations", "variant": "param", "kind": 32768, @@ -93705,7 +95475,7 @@ "defaultValue": "..." }, { - "id": 4116, + "id": 4199, "name": "withDeleted", "variant": "param", "kind": 32768, @@ -93744,21 +95514,21 @@ ] }, { - "id": 4108, + "id": 4191, "name": "findWithRelationsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4109, + "id": 4192, "name": "findWithRelationsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4110, + "id": 4193, "name": "relations", "variant": "param", "kind": 32768, @@ -93773,7 +95543,7 @@ "defaultValue": "[]" }, { - "id": 4111, + "id": 4194, "name": "idsOrOptionsWithoutRelations", "variant": "param", "kind": 32768, @@ -93826,21 +95596,21 @@ ] }, { - "id": 4134, + "id": 4217, "name": "getCategoryIdsFromInput", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4135, + "id": 4218, "name": "getCategoryIdsFromInput", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4136, + "id": 4219, "name": "categoryId", "variant": "param", "kind": 32768, @@ -93858,7 +95628,7 @@ } }, { - "id": 4137, + "id": 4220, "name": "includeCategoryChildren", "variant": "param", "kind": 32768, @@ -93892,21 +95662,21 @@ ] }, { - "id": 4138, + "id": 4221, "name": "getCategoryIdsRecursively", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4139, + "id": 4222, "name": "getCategoryIdsRecursively", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4140, + "id": 4223, "name": "productCategory", "variant": "param", "kind": 32768, @@ -93933,21 +95703,21 @@ ] }, { - "id": 4129, + "id": 4212, "name": "getFreeTextSearchResultsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4130, + "id": 4213, "name": "getFreeTextSearchResultsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4131, + "id": 4214, "name": "q", "variant": "param", "kind": 32768, @@ -93958,7 +95728,7 @@ } }, { - "id": 4132, + "id": 4215, "name": "options", "variant": "param", "kind": 32768, @@ -93975,7 +95745,7 @@ "defaultValue": "..." }, { - "id": 4133, + "id": 4216, "name": "relations", "variant": "param", "kind": 32768, @@ -94026,21 +95796,21 @@ ] }, { - "id": 4149, + "id": 4232, "name": "isProductInSalesChannels", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4150, + "id": 4233, "name": "isProductInSalesChannels", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4151, + "id": 4234, "name": "id", "variant": "param", "kind": 32768, @@ -94051,7 +95821,7 @@ } }, { - "id": 4152, + "id": 4235, "name": "salesChannelIds", "variant": "param", "kind": 32768, @@ -94084,21 +95854,21 @@ ] }, { - "id": 4088, + "id": 4171, "name": "queryProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4089, + "id": 4172, "name": "queryProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4090, + "id": 4173, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -94114,7 +95884,7 @@ } }, { - "id": 4091, + "id": 4174, "name": "shouldCount", "variant": "param", "kind": 32768, @@ -94162,21 +95932,21 @@ ] }, { - "id": 4092, + "id": 4175, "name": "queryProductsWithIds", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4093, + "id": 4176, "name": "queryProductsWithIds", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4094, + "id": 4177, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -94184,14 +95954,14 @@ "type": { "type": "reflection", "declaration": { - "id": 4095, + "id": 4178, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4096, + "id": 4179, "name": "entityIds", "variant": "declaration", "kind": 1024, @@ -94205,7 +95975,7 @@ } }, { - "id": 4097, + "id": 4180, "name": "groupedRelations", "variant": "declaration", "kind": 1024, @@ -94213,20 +95983,20 @@ "type": { "type": "reflection", "declaration": { - "id": 4098, + "id": 4181, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 4099, + "id": 4182, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 4100, + "id": 4183, "name": "toplevel", "variant": "param", "kind": 32768, @@ -94249,7 +96019,7 @@ } }, { - "id": 4103, + "id": 4186, "name": "order", "variant": "declaration", "kind": 1024, @@ -94259,20 +96029,20 @@ "type": { "type": "reflection", "declaration": { - "id": 4104, + "id": 4187, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 4105, + "id": 4188, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 4106, + "id": 4189, "name": "column", "variant": "param", "kind": 32768, @@ -94301,7 +96071,7 @@ } }, { - "id": 4102, + "id": 4185, "name": "select", "variant": "declaration", "kind": 1024, @@ -94326,7 +96096,7 @@ } }, { - "id": 4107, + "id": 4190, "name": "where", "variant": "declaration", "kind": 1024, @@ -94355,7 +96125,7 @@ } }, { - "id": 4101, + "id": 4184, "name": "withDeleted", "variant": "declaration", "kind": 1024, @@ -94372,12 +96142,12 @@ { "title": "Properties", "children": [ - 4096, - 4097, - 4103, - 4102, - 4107, - 4101 + 4179, + 4180, + 4186, + 4185, + 4190, + 4184 ] } ] @@ -94416,19 +96186,19 @@ { "title": "Methods", "children": [ - 4153, - 4141, - 4121, - 4125, - 4117, - 4112, - 4108, - 4134, - 4138, - 4129, - 4149, - 4088, - 4092 + 4236, + 4224, + 4204, + 4208, + 4200, + 4195, + 4191, + 4217, + 4221, + 4212, + 4232, + 4171, + 4175 ] } ] @@ -94438,7 +96208,7 @@ } }, { - "id": 4085, + "id": 4168, "name": "productVariantRepository_", "variant": "declaration", "kind": 1024, @@ -94468,7 +96238,7 @@ } }, { - "id": 4158, + "id": 4246, "name": "regionService_", "variant": "declaration", "kind": 1024, @@ -94478,13 +96248,13 @@ }, "type": { "type": "reference", - "target": 4533, + "target": 4621, "name": "RegionService", "package": "@medusajs/medusa" } }, { - "id": 4379, + "id": 4467, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -94516,7 +96286,7 @@ } }, { - "id": 4077, + "id": 4151, "name": "Events", "variant": "declaration", "kind": 1024, @@ -94526,14 +96296,14 @@ "type": { "type": "reflection", "declaration": { - "id": 4078, + "id": 4152, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4080, + "id": 4154, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -94545,7 +96315,7 @@ "defaultValue": "\"product-variant.created\"" }, { - "id": 4081, + "id": 4155, "name": "DELETED", "variant": "declaration", "kind": 1024, @@ -94557,7 +96327,7 @@ "defaultValue": "\"product-variant.deleted\"" }, { - "id": 4079, + "id": 4153, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -94573,9 +96343,9 @@ { "title": "Properties", "children": [ - 4080, - 4081, - 4079 + 4154, + 4155, + 4153 ] } ] @@ -94584,7 +96354,7 @@ "defaultValue": "..." }, { - "id": 4380, + "id": 4468, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -94592,7 +96362,7 @@ "isProtected": true }, "getSignature": { - "id": 4381, + "id": 4469, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -94619,14 +96389,14 @@ } }, { - "id": 4345, + "id": 4433, "name": "addOptionValue", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4346, + "id": 4434, "name": "addOptionValue", "variant": "signature", "kind": 4096, @@ -94652,7 +96422,7 @@ }, "parameters": [ { - "id": 4347, + "id": 4435, "name": "variantId", "variant": "param", "kind": 32768, @@ -94671,7 +96441,7 @@ } }, { - "id": 4348, + "id": 4436, "name": "optionId", "variant": "param", "kind": 32768, @@ -94690,7 +96460,7 @@ } }, { - "id": 4349, + "id": 4437, "name": "optionValue", "variant": "param", "kind": 32768, @@ -94733,7 +96503,7 @@ ] }, { - "id": 4393, + "id": 4481, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -94742,7 +96512,7 @@ }, "signatures": [ { - "id": 4394, + "id": 4482, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -94768,14 +96538,14 @@ }, "typeParameter": [ { - "id": 4395, + "id": 4483, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 4396, + "id": 4484, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -94784,7 +96554,7 @@ ], "parameters": [ { - "id": 4397, + "id": 4485, "name": "work", "variant": "param", "kind": 32768, @@ -94800,21 +96570,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4398, + "id": 4486, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4399, + "id": 4487, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4400, + "id": 4488, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -94853,7 +96623,7 @@ } }, { - "id": 4401, + "id": 4489, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -94883,21 +96653,21 @@ { "type": "reflection", "declaration": { - "id": 4402, + "id": 4490, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4403, + "id": 4491, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4404, + "id": 4492, "name": "error", "variant": "param", "kind": 32768, @@ -94944,7 +96714,7 @@ } }, { - "id": 4405, + "id": 4493, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -94962,21 +96732,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4406, + "id": 4494, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4407, + "id": 4495, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4408, + "id": 4496, "name": "error", "variant": "param", "kind": 32768, @@ -95052,14 +96822,14 @@ } }, { - "id": 4289, + "id": 4377, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4290, + "id": 4378, "name": "create", "variant": "signature", "kind": 4096, @@ -95085,7 +96855,7 @@ }, "typeParameter": [ { - "id": 4291, + "id": 4379, "name": "TVariants", "variant": "typeParam", "kind": 131072, @@ -95118,7 +96888,7 @@ } }, { - "id": 4292, + "id": 4380, "name": "TOutput", "variant": "typeParam", "kind": 131072, @@ -95169,7 +96939,7 @@ ], "parameters": [ { - "id": 4293, + "id": 4381, "name": "productOrProductId", "variant": "param", "kind": 32768, @@ -95202,7 +96972,7 @@ } }, { - "id": 4294, + "id": 4382, "name": "variants", "variant": "param", "kind": 32768, @@ -95256,14 +97026,14 @@ ] }, { - "id": 4362, + "id": 4450, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4363, + "id": 4451, "name": "delete", "variant": "signature", "kind": 4096, @@ -95289,7 +97059,7 @@ }, "parameters": [ { - "id": 4364, + "id": 4452, "name": "variantIds", "variant": "param", "kind": 32768, @@ -95339,14 +97109,14 @@ ] }, { - "id": 4350, + "id": 4438, "name": "deleteOptionValue", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4351, + "id": 4439, "name": "deleteOptionValue", "variant": "signature", "kind": 4096, @@ -95372,7 +97142,7 @@ }, "parameters": [ { - "id": 4352, + "id": 4440, "name": "variantId", "variant": "param", "kind": 32768, @@ -95391,7 +97161,7 @@ } }, { - "id": 4353, + "id": 4441, "name": "optionId", "variant": "param", "kind": 32768, @@ -95429,14 +97199,14 @@ ] }, { - "id": 4369, + "id": 4457, "name": "getFreeTextQueryBuilder_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4370, + "id": 4458, "name": "getFreeTextQueryBuilder_", "variant": "signature", "kind": 4096, @@ -95462,7 +97232,7 @@ }, "parameters": [ { - "id": 4371, + "id": 4459, "name": "variantRepo", "variant": "param", "kind": 32768, @@ -95497,7 +97267,7 @@ } }, { - "id": 4372, + "id": 4460, "name": "query", "variant": "param", "kind": 32768, @@ -95521,7 +97291,7 @@ } }, { - "id": 4373, + "id": 4461, "name": "q", "variant": "param", "kind": 32768, @@ -95566,14 +97336,14 @@ ] }, { - "id": 4328, + "id": 4416, "name": "getRegionPrice", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4329, + "id": 4417, "name": "getRegionPrice", "variant": "signature", "kind": 4096, @@ -95599,7 +97369,7 @@ }, "parameters": [ { - "id": 4330, + "id": 4418, "name": "variantId", "variant": "param", "kind": 32768, @@ -95618,7 +97388,7 @@ } }, { - "id": 4331, + "id": 4419, "name": "context", "variant": "param", "kind": 32768, @@ -95670,14 +97440,14 @@ ] }, { - "id": 4365, + "id": 4453, "name": "isVariantInSalesChannels", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4366, + "id": 4454, "name": "isVariantInSalesChannels", "variant": "signature", "kind": 4096, @@ -95692,7 +97462,7 @@ }, "parameters": [ { - "id": 4367, + "id": 4455, "name": "id", "variant": "param", "kind": 32768, @@ -95711,7 +97481,7 @@ } }, { - "id": 4368, + "id": 4456, "name": "salesChannelIds", "variant": "param", "kind": 32768, @@ -95752,14 +97522,14 @@ ] }, { - "id": 4358, + "id": 4446, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4359, + "id": 4447, "name": "list", "variant": "signature", "kind": 4096, @@ -95780,7 +97550,7 @@ }, "parameters": [ { - "id": 4360, + "id": 4448, "name": "selector", "variant": "param", "kind": 32768, @@ -95804,7 +97574,7 @@ } }, { - "id": 4361, + "id": 4449, "name": "config", "variant": "param", "kind": 32768, @@ -95881,14 +97651,14 @@ ] }, { - "id": 4354, + "id": 4442, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4355, + "id": 4443, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -95909,7 +97679,7 @@ }, "parameters": [ { - "id": 4356, + "id": 4444, "name": "selector", "variant": "param", "kind": 32768, @@ -95933,7 +97703,7 @@ } }, { - "id": 4357, + "id": 4445, "name": "config", "variant": "param", "kind": 32768, @@ -96019,14 +97789,14 @@ ] }, { - "id": 4281, + "id": 4369, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4282, + "id": 4370, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -96052,7 +97822,7 @@ }, "parameters": [ { - "id": 4283, + "id": 4371, "name": "variantId", "variant": "param", "kind": 32768, @@ -96071,7 +97841,7 @@ } }, { - "id": 4284, + "id": 4372, "name": "config", "variant": "param", "kind": 32768, @@ -96145,14 +97915,14 @@ ] }, { - "id": 4285, + "id": 4373, "name": "retrieveBySKU", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4286, + "id": 4374, "name": "retrieveBySKU", "variant": "signature", "kind": 4096, @@ -96178,7 +97948,7 @@ }, "parameters": [ { - "id": 4287, + "id": 4375, "name": "sku", "variant": "param", "kind": 32768, @@ -96197,7 +97967,7 @@ } }, { - "id": 4288, + "id": 4376, "name": "config", "variant": "param", "kind": 32768, @@ -96271,14 +98041,14 @@ ] }, { - "id": 4336, + "id": 4424, "name": "setCurrencyPrice", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4337, + "id": 4425, "name": "setCurrencyPrice", "variant": "signature", "kind": 4096, @@ -96308,7 +98078,7 @@ }, "parameters": [ { - "id": 4338, + "id": 4426, "name": "variantId", "variant": "param", "kind": 32768, @@ -96327,7 +98097,7 @@ } }, { - "id": 4339, + "id": 4427, "name": "price", "variant": "param", "kind": 32768, @@ -96375,14 +98145,14 @@ ] }, { - "id": 4332, + "id": 4420, "name": "setRegionPrice", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4333, + "id": 4421, "name": "setRegionPrice", "variant": "signature", "kind": 4096, @@ -96412,7 +98182,7 @@ }, "parameters": [ { - "id": 4334, + "id": 4422, "name": "variantId", "variant": "param", "kind": 32768, @@ -96431,7 +98201,7 @@ } }, { - "id": 4335, + "id": 4423, "name": "price", "variant": "param", "kind": 32768, @@ -96479,7 +98249,7 @@ ] }, { - "id": 4388, + "id": 4476, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -96488,14 +98258,14 @@ }, "signatures": [ { - "id": 4389, + "id": 4477, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4390, + "id": 4478, "name": "err", "variant": "param", "kind": 32768, @@ -96525,14 +98295,14 @@ { "type": "reflection", "declaration": { - "id": 4391, + "id": 4479, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4392, + "id": 4480, "name": "code", "variant": "declaration", "kind": 1024, @@ -96547,7 +98317,7 @@ { "title": "Properties", "children": [ - 4392 + 4480 ] } ] @@ -96575,14 +98345,14 @@ } }, { - "id": 4295, + "id": 4383, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4296, + "id": 4384, "name": "update", "variant": "signature", "kind": 4096, @@ -96608,7 +98378,7 @@ }, "parameters": [ { - "id": 4297, + "id": 4385, "name": "variantData", "variant": "param", "kind": 32768, @@ -96626,14 +98396,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 4298, + "id": 4386, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4300, + "id": 4388, "name": "updateData", "variant": "declaration", "kind": 1024, @@ -96649,7 +98419,7 @@ } }, { - "id": 4299, + "id": 4387, "name": "variant", "variant": "declaration", "kind": 1024, @@ -96669,8 +98439,8 @@ { "title": "Properties", "children": [ - 4300, - 4299 + 4388, + 4387 ] } ] @@ -96704,7 +98474,7 @@ } }, { - "id": 4301, + "id": 4389, "name": "update", "variant": "signature", "kind": 4096, @@ -96730,7 +98500,7 @@ }, "parameters": [ { - "id": 4302, + "id": 4390, "name": "variantOrVariantId", "variant": "param", "kind": 32768, @@ -96774,7 +98544,7 @@ } }, { - "id": 4303, + "id": 4391, "name": "update", "variant": "param", "kind": 32768, @@ -96820,14 +98590,14 @@ } }, { - "id": 4304, + "id": 4392, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4305, + "id": 4393, "name": "variantOrVariantId", "variant": "param", "kind": 32768, @@ -96863,7 +98633,7 @@ } }, { - "id": 4306, + "id": 4394, "name": "update", "variant": "param", "kind": 32768, @@ -96903,7 +98673,7 @@ ] }, { - "id": 4307, + "id": 4395, "name": "updateBatch", "variant": "declaration", "kind": 2048, @@ -96912,14 +98682,14 @@ }, "signatures": [ { - "id": 4308, + "id": 4396, "name": "updateBatch", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4309, + "id": 4397, "name": "variantData", "variant": "param", "kind": 32768, @@ -96965,14 +98735,14 @@ ] }, { - "id": 4340, + "id": 4428, "name": "updateOptionValue", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4341, + "id": 4429, "name": "updateOptionValue", "variant": "signature", "kind": 4096, @@ -96998,7 +98768,7 @@ }, "parameters": [ { - "id": 4342, + "id": 4430, "name": "variantId", "variant": "param", "kind": 32768, @@ -97017,7 +98787,7 @@ } }, { - "id": 4343, + "id": 4431, "name": "optionId", "variant": "param", "kind": 32768, @@ -97036,7 +98806,7 @@ } }, { - "id": 4344, + "id": 4432, "name": "optionValue", "variant": "param", "kind": 32768, @@ -97079,14 +98849,14 @@ ] }, { - "id": 4310, + "id": 4398, "name": "updateVariantPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4311, + "id": 4399, "name": "updateVariantPrices", "variant": "signature", "kind": 4096, @@ -97112,7 +98882,7 @@ }, "parameters": [ { - "id": 4312, + "id": 4400, "name": "data", "variant": "param", "kind": 32768, @@ -97148,7 +98918,7 @@ } }, { - "id": 4313, + "id": 4401, "name": "updateVariantPrices", "variant": "signature", "kind": 4096, @@ -97174,7 +98944,7 @@ }, "parameters": [ { - "id": 4314, + "id": 4402, "name": "variantId", "variant": "param", "kind": 32768, @@ -97193,7 +98963,7 @@ } }, { - "id": 4315, + "id": 4403, "name": "prices", "variant": "param", "kind": 32768, @@ -97239,7 +99009,7 @@ ] }, { - "id": 4316, + "id": 4404, "name": "updateVariantPricesBatch", "variant": "declaration", "kind": 2048, @@ -97248,14 +99018,14 @@ }, "signatures": [ { - "id": 4317, + "id": 4405, "name": "updateVariantPricesBatch", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4318, + "id": 4406, "name": "data", "variant": "param", "kind": 32768, @@ -97293,21 +99063,21 @@ ] }, { - "id": 4322, + "id": 4410, "name": "upsertCurrencyPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4323, + "id": 4411, "name": "upsertCurrencyPrices", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4324, + "id": 4412, "name": "data", "variant": "param", "kind": 32768, @@ -97317,14 +99087,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 4325, + "id": 4413, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4327, + "id": 4415, "name": "price", "variant": "declaration", "kind": 1024, @@ -97355,7 +99125,7 @@ } }, { - "id": 4326, + "id": 4414, "name": "variantId", "variant": "declaration", "kind": 1024, @@ -97370,8 +99140,8 @@ { "title": "Properties", "children": [ - 4327, - 4326 + 4415, + 4414 ] } ] @@ -97399,21 +99169,21 @@ ] }, { - "id": 4319, + "id": 4407, "name": "upsertRegionPrices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4320, + "id": 4408, "name": "upsertRegionPrices", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4321, + "id": 4409, "name": "data", "variant": "param", "kind": 32768, @@ -97451,7 +99221,7 @@ ] }, { - "id": 4374, + "id": 4462, "name": "validateVariantsToCreate_", "variant": "declaration", "kind": 2048, @@ -97460,14 +99230,14 @@ }, "signatures": [ { - "id": 4375, + "id": 4463, "name": "validateVariantsToCreate_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4376, + "id": 4464, "name": "product", "variant": "param", "kind": 32768, @@ -97483,7 +99253,7 @@ } }, { - "id": 4377, + "id": 4465, "name": "variants", "variant": "param", "kind": 32768, @@ -97510,21 +99280,21 @@ ] }, { - "id": 4385, + "id": 4473, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4386, + "id": 4474, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4387, + "id": 4475, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -97544,7 +99314,7 @@ ], "type": { "type": "reference", - "target": 4076, + "target": 4150, "name": "ProductVariantService", "package": "@medusajs/medusa" }, @@ -97566,61 +99336,61 @@ { "title": "Constructors", "children": [ - 4082 + 4156 ] }, { "title": "Properties", "children": [ - 4383, - 4382, - 4384, - 4271, - 4157, - 4378, - 4160, - 4159, - 4270, - 4086, - 4085, - 4158, - 4379, - 4077 + 4471, + 4470, + 4472, + 4359, + 4245, + 4466, + 4248, + 4247, + 4358, + 4169, + 4168, + 4246, + 4467, + 4151 ] }, { "title": "Accessors", "children": [ - 4380 + 4468 ] }, { "title": "Methods", "children": [ - 4345, - 4393, - 4289, - 4362, - 4350, + 4433, + 4481, + 4377, + 4450, + 4438, + 4457, + 4416, + 4453, + 4446, + 4442, 4369, - 4328, - 4365, - 4358, - 4354, - 4281, - 4285, - 4336, - 4332, - 4388, - 4295, - 4307, - 4340, - 4310, - 4316, - 4322, - 4319, - 4374, - 4385 + 4373, + 4424, + 4420, + 4476, + 4383, + 4395, + 4428, + 4398, + 4404, + 4410, + 4407, + 4462, + 4473 ] } ], @@ -97637,7 +99407,7 @@ ] }, { - "id": 4533, + "id": 4621, "name": "RegionService", "variant": "declaration", "kind": 128, @@ -97652,21 +99422,21 @@ }, "children": [ { - "id": 4539, + "id": 4627, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 4540, + "id": 4628, "name": "new RegionService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 4541, + "id": 4629, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -97684,7 +99454,7 @@ ], "type": { "type": "reference", - "target": 4533, + "target": 4621, "name": "RegionService", "package": "@medusajs/medusa" }, @@ -97702,7 +99472,7 @@ } }, { - "id": 4626, + "id": 4714, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -97737,7 +99507,7 @@ } }, { - "id": 4625, + "id": 4713, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -97756,7 +99526,7 @@ } }, { - "id": 4627, + "id": 4715, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -97791,7 +99561,7 @@ } }, { - "id": 4548, + "id": 4636, "name": "countryRepository_", "variant": "declaration", "kind": 1024, @@ -97821,7 +99591,7 @@ } }, { - "id": 4549, + "id": 4637, "name": "currencyRepository_", "variant": "declaration", "kind": 1024, @@ -97851,7 +99621,7 @@ } }, { - "id": 4543, + "id": 4631, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -97861,13 +99631,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 4542, + "id": 4630, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -97885,7 +99655,7 @@ } }, { - "id": 4551, + "id": 4639, "name": "fulfillmentProviderRepository_", "variant": "declaration", "kind": 1024, @@ -97915,7 +99685,7 @@ } }, { - "id": 4546, + "id": 4634, "name": "fulfillmentProviderService_", "variant": "declaration", "kind": 1024, @@ -97925,13 +99695,13 @@ }, "type": { "type": "reference", - "target": 1484, + "target": 1538, "name": "FulfillmentProviderService", "package": "@medusajs/medusa" } }, { - "id": 4621, + "id": 4709, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -97954,7 +99724,7 @@ } }, { - "id": 4550, + "id": 4638, "name": "paymentProviderRepository_", "variant": "declaration", "kind": 1024, @@ -97984,7 +99754,7 @@ } }, { - "id": 4545, + "id": 4633, "name": "paymentProviderService_", "variant": "declaration", "kind": 1024, @@ -97994,13 +99764,13 @@ }, "type": { "type": "reference", - "target": 2919, + "target": 2973, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 4547, + "id": 4635, "name": "regionRepository_", "variant": "declaration", "kind": 1024, @@ -98030,7 +99800,7 @@ } }, { - "id": 4544, + "id": 4632, "name": "storeService_", "variant": "declaration", "kind": 1024, @@ -98040,13 +99810,13 @@ }, "type": { "type": "reference", - "target": 5392, + "target": 5504, "name": "StoreService", "package": "@medusajs/medusa" } }, { - "id": 4552, + "id": 4640, "name": "taxProviderRepository_", "variant": "declaration", "kind": 1024, @@ -98076,7 +99846,7 @@ } }, { - "id": 4622, + "id": 4710, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -98108,7 +99878,7 @@ } }, { - "id": 4534, + "id": 4622, "name": "Events", "variant": "declaration", "kind": 1024, @@ -98118,14 +99888,14 @@ "type": { "type": "reflection", "declaration": { - "id": 4535, + "id": 4623, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4537, + "id": 4625, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -98137,7 +99907,7 @@ "defaultValue": "\"region.created\"" }, { - "id": 4538, + "id": 4626, "name": "DELETED", "variant": "declaration", "kind": 1024, @@ -98149,7 +99919,7 @@ "defaultValue": "\"region.deleted\"" }, { - "id": 4536, + "id": 4624, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -98165,9 +99935,9 @@ { "title": "Properties", "children": [ - 4537, - 4538, - 4536 + 4625, + 4626, + 4624 ] } ] @@ -98176,7 +99946,7 @@ "defaultValue": "..." }, { - "id": 4623, + "id": 4711, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -98184,7 +99954,7 @@ "isProtected": true }, "getSignature": { - "id": 4624, + "id": 4712, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -98211,14 +99981,14 @@ } }, { - "id": 4597, + "id": 4685, "name": "addCountry", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4598, + "id": 4686, "name": "addCountry", "variant": "signature", "kind": 4096, @@ -98244,7 +100014,7 @@ }, "parameters": [ { - "id": 4599, + "id": 4687, "name": "regionId", "variant": "param", "kind": 32768, @@ -98263,7 +100033,7 @@ } }, { - "id": 4600, + "id": 4688, "name": "code", "variant": "param", "kind": 32768, @@ -98306,14 +100076,14 @@ ] }, { - "id": 4609, + "id": 4697, "name": "addFulfillmentProvider", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4610, + "id": 4698, "name": "addFulfillmentProvider", "variant": "signature", "kind": 4096, @@ -98339,7 +100109,7 @@ }, "parameters": [ { - "id": 4611, + "id": 4699, "name": "regionId", "variant": "param", "kind": 32768, @@ -98358,7 +100128,7 @@ } }, { - "id": 4612, + "id": 4700, "name": "providerId", "variant": "param", "kind": 32768, @@ -98401,14 +100171,14 @@ ] }, { - "id": 4605, + "id": 4693, "name": "addPaymentProvider", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4606, + "id": 4694, "name": "addPaymentProvider", "variant": "signature", "kind": 4096, @@ -98434,7 +100204,7 @@ }, "parameters": [ { - "id": 4607, + "id": 4695, "name": "regionId", "variant": "param", "kind": 32768, @@ -98453,7 +100223,7 @@ } }, { - "id": 4608, + "id": 4696, "name": "providerId", "variant": "param", "kind": 32768, @@ -98496,7 +100266,7 @@ ] }, { - "id": 4636, + "id": 4724, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -98505,7 +100275,7 @@ }, "signatures": [ { - "id": 4637, + "id": 4725, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -98531,14 +100301,14 @@ }, "typeParameter": [ { - "id": 4638, + "id": 4726, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 4639, + "id": 4727, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -98547,7 +100317,7 @@ ], "parameters": [ { - "id": 4640, + "id": 4728, "name": "work", "variant": "param", "kind": 32768, @@ -98563,21 +100333,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4641, + "id": 4729, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4642, + "id": 4730, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4643, + "id": 4731, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -98616,7 +100386,7 @@ } }, { - "id": 4644, + "id": 4732, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -98646,21 +100416,21 @@ { "type": "reflection", "declaration": { - "id": 4645, + "id": 4733, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4646, + "id": 4734, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4647, + "id": 4735, "name": "error", "variant": "param", "kind": 32768, @@ -98707,7 +100477,7 @@ } }, { - "id": 4648, + "id": 4736, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -98725,21 +100495,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4649, + "id": 4737, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4650, + "id": 4738, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4651, + "id": 4739, "name": "error", "variant": "param", "kind": 32768, @@ -98815,14 +100585,14 @@ } }, { - "id": 4553, + "id": 4641, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4554, + "id": 4642, "name": "create", "variant": "signature", "kind": 4096, @@ -98848,7 +100618,7 @@ }, "parameters": [ { - "id": 4555, + "id": 4643, "name": "data", "variant": "param", "kind": 32768, @@ -98896,14 +100666,14 @@ ] }, { - "id": 4594, + "id": 4682, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4595, + "id": 4683, "name": "delete", "variant": "signature", "kind": 4096, @@ -98929,7 +100699,7 @@ }, "parameters": [ { - "id": 4596, + "id": 4684, "name": "regionId", "variant": "param", "kind": 32768, @@ -98967,14 +100737,14 @@ ] }, { - "id": 4586, + "id": 4674, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4587, + "id": 4675, "name": "list", "variant": "signature", "kind": 4096, @@ -99000,7 +100770,7 @@ }, "parameters": [ { - "id": 4588, + "id": 4676, "name": "selector", "variant": "param", "kind": 32768, @@ -99036,7 +100806,7 @@ "defaultValue": "{}" }, { - "id": 4589, + "id": 4677, "name": "config", "variant": "param", "kind": 32768, @@ -99099,14 +100869,14 @@ ] }, { - "id": 4590, + "id": 4678, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4591, + "id": 4679, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -99132,7 +100902,7 @@ }, "parameters": [ { - "id": 4592, + "id": 4680, "name": "selector", "variant": "param", "kind": 32768, @@ -99168,7 +100938,7 @@ "defaultValue": "{}" }, { - "id": 4593, + "id": 4681, "name": "config", "variant": "param", "kind": 32768, @@ -99240,14 +101010,14 @@ ] }, { - "id": 4601, + "id": 4689, "name": "removeCountry", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4602, + "id": 4690, "name": "removeCountry", "variant": "signature", "kind": 4096, @@ -99273,7 +101043,7 @@ }, "parameters": [ { - "id": 4603, + "id": 4691, "name": "regionId", "variant": "param", "kind": 32768, @@ -99292,7 +101062,7 @@ } }, { - "id": 4604, + "id": 4692, "name": "code", "variant": "param", "kind": 32768, @@ -99335,14 +101105,14 @@ ] }, { - "id": 4617, + "id": 4705, "name": "removeFulfillmentProvider", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4618, + "id": 4706, "name": "removeFulfillmentProvider", "variant": "signature", "kind": 4096, @@ -99368,7 +101138,7 @@ }, "parameters": [ { - "id": 4619, + "id": 4707, "name": "regionId", "variant": "param", "kind": 32768, @@ -99387,7 +101157,7 @@ } }, { - "id": 4620, + "id": 4708, "name": "providerId", "variant": "param", "kind": 32768, @@ -99430,14 +101200,14 @@ ] }, { - "id": 4613, + "id": 4701, "name": "removePaymentProvider", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4614, + "id": 4702, "name": "removePaymentProvider", "variant": "signature", "kind": 4096, @@ -99463,7 +101233,7 @@ }, "parameters": [ { - "id": 4615, + "id": 4703, "name": "regionId", "variant": "param", "kind": 32768, @@ -99482,7 +101252,7 @@ } }, { - "id": 4616, + "id": 4704, "name": "providerId", "variant": "param", "kind": 32768, @@ -99525,14 +101295,14 @@ ] }, { - "id": 4582, + "id": 4670, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4583, + "id": 4671, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -99558,7 +101328,7 @@ }, "parameters": [ { - "id": 4584, + "id": 4672, "name": "regionId", "variant": "param", "kind": 32768, @@ -99577,7 +101347,7 @@ } }, { - "id": 4585, + "id": 4673, "name": "config", "variant": "param", "kind": 32768, @@ -99637,14 +101407,14 @@ ] }, { - "id": 4575, + "id": 4663, "name": "retrieveByCountryCode", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4576, + "id": 4664, "name": "retrieveByCountryCode", "variant": "signature", "kind": 4096, @@ -99670,7 +101440,7 @@ }, "parameters": [ { - "id": 4577, + "id": 4665, "name": "code", "variant": "param", "kind": 32768, @@ -99689,7 +101459,7 @@ } }, { - "id": 4578, + "id": 4666, "name": "config", "variant": "param", "kind": 32768, @@ -99749,14 +101519,14 @@ ] }, { - "id": 4579, + "id": 4667, "name": "retrieveByName", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4580, + "id": 4668, "name": "retrieveByName", "variant": "signature", "kind": 4096, @@ -99782,7 +101552,7 @@ }, "parameters": [ { - "id": 4581, + "id": 4669, "name": "name", "variant": "param", "kind": 32768, @@ -99825,7 +101595,7 @@ ] }, { - "id": 4631, + "id": 4719, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -99834,14 +101604,14 @@ }, "signatures": [ { - "id": 4632, + "id": 4720, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4633, + "id": 4721, "name": "err", "variant": "param", "kind": 32768, @@ -99871,14 +101641,14 @@ { "type": "reflection", "declaration": { - "id": 4634, + "id": 4722, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4635, + "id": 4723, "name": "code", "variant": "declaration", "kind": 1024, @@ -99893,7 +101663,7 @@ { "title": "Properties", "children": [ - 4635 + 4723 ] } ] @@ -99921,14 +101691,14 @@ } }, { - "id": 4556, + "id": 4644, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4557, + "id": 4645, "name": "update", "variant": "signature", "kind": 4096, @@ -99954,7 +101724,7 @@ }, "parameters": [ { - "id": 4558, + "id": 4646, "name": "regionId", "variant": "param", "kind": 32768, @@ -99973,7 +101743,7 @@ } }, { - "id": 4559, + "id": 4647, "name": "update", "variant": "param", "kind": 32768, @@ -100021,7 +101791,7 @@ ] }, { - "id": 4571, + "id": 4659, "name": "validateCountry", "variant": "declaration", "kind": 2048, @@ -100030,7 +101800,7 @@ }, "signatures": [ { - "id": 4572, + "id": 4660, "name": "validateCountry", "variant": "signature", "kind": 4096, @@ -100056,7 +101826,7 @@ }, "parameters": [ { - "id": 4573, + "id": 4661, "name": "code", "variant": "param", "kind": 32768, @@ -100075,7 +101845,7 @@ } }, { - "id": 4574, + "id": 4662, "name": "regionId", "variant": "param", "kind": 32768, @@ -100118,7 +101888,7 @@ ] }, { - "id": 4568, + "id": 4656, "name": "validateCurrency", "variant": "declaration", "kind": 2048, @@ -100127,7 +101897,7 @@ }, "signatures": [ { - "id": 4569, + "id": 4657, "name": "validateCurrency", "variant": "signature", "kind": 4096, @@ -100162,7 +101932,7 @@ }, "parameters": [ { - "id": 4570, + "id": 4658, "name": "currencyCode", "variant": "param", "kind": 32768, @@ -100200,7 +101970,7 @@ ] }, { - "id": 4560, + "id": 4648, "name": "validateFields", "variant": "declaration", "kind": 2048, @@ -100209,7 +101979,7 @@ }, "signatures": [ { - "id": 4561, + "id": 4649, "name": "validateFields", "variant": "signature", "kind": 4096, @@ -100235,7 +102005,7 @@ }, "typeParameter": [ { - "id": 4562, + "id": 4650, "name": "T", "variant": "typeParam", "kind": 131072, @@ -100267,7 +102037,7 @@ ], "parameters": [ { - "id": 4563, + "id": 4651, "name": "regionData", "variant": "param", "kind": 32768, @@ -100312,7 +102082,7 @@ } }, { - "id": 4564, + "id": 4652, "name": "id", "variant": "param", "kind": 32768, @@ -100390,7 +102160,7 @@ ] }, { - "id": 4565, + "id": 4653, "name": "validateTaxRate", "variant": "declaration", "kind": 2048, @@ -100399,7 +102169,7 @@ }, "signatures": [ { - "id": 4566, + "id": 4654, "name": "validateTaxRate", "variant": "signature", "kind": 4096, @@ -100434,7 +102204,7 @@ }, "parameters": [ { - "id": 4567, + "id": 4655, "name": "taxRate", "variant": "param", "kind": 32768, @@ -100461,21 +102231,21 @@ ] }, { - "id": 4628, + "id": 4716, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4629, + "id": 4717, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4630, + "id": 4718, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -100495,7 +102265,7 @@ ], "type": { "type": "reference", - "target": 4533, + "target": 4621, "name": "RegionService", "package": "@medusajs/medusa" }, @@ -100517,61 +102287,61 @@ { "title": "Constructors", "children": [ - 4539 + 4627 ] }, { "title": "Properties", "children": [ - 4626, - 4625, - 4627, - 4548, - 4549, - 4543, - 4542, - 4551, - 4546, - 4621, - 4550, - 4545, - 4547, - 4544, - 4552, - 4622, - 4534 + 4714, + 4713, + 4715, + 4636, + 4637, + 4631, + 4630, + 4639, + 4634, + 4709, + 4638, + 4633, + 4635, + 4632, + 4640, + 4710, + 4622 ] }, { "title": "Accessors", "children": [ - 4623 + 4711 ] }, { "title": "Methods", "children": [ - 4597, - 4609, - 4605, - 4636, - 4553, - 4594, - 4586, - 4590, - 4601, - 4617, - 4613, - 4582, - 4575, - 4579, - 4631, - 4556, - 4571, - 4568, - 4560, - 4565, - 4628 + 4685, + 4697, + 4693, + 4724, + 4641, + 4682, + 4674, + 4678, + 4689, + 4705, + 4701, + 4670, + 4663, + 4667, + 4719, + 4644, + 4659, + 4656, + 4648, + 4653, + 4716 ] } ], @@ -100588,28 +102358,28 @@ ] }, { - "id": 4755, + "id": 4843, "name": "ReturnReasonService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 4756, + "id": 4844, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 4757, + "id": 4845, "name": "new ReturnReasonService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 4758, + "id": 4846, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -100627,7 +102397,7 @@ ], "type": { "type": "reference", - "target": 4755, + "target": 4843, "name": "ReturnReasonService", "package": "@medusajs/medusa" }, @@ -100645,7 +102415,7 @@ } }, { - "id": 4783, + "id": 4871, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -100680,7 +102450,7 @@ } }, { - "id": 4782, + "id": 4870, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -100699,7 +102469,7 @@ } }, { - "id": 4784, + "id": 4872, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -100734,7 +102504,7 @@ } }, { - "id": 4778, + "id": 4866, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -100757,7 +102527,7 @@ } }, { - "id": 4759, + "id": 4847, "name": "retReasonRepo_", "variant": "declaration", "kind": 1024, @@ -100787,7 +102557,7 @@ } }, { - "id": 4779, + "id": 4867, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -100819,7 +102589,7 @@ } }, { - "id": 4780, + "id": 4868, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -100827,7 +102597,7 @@ "isProtected": true }, "getSignature": { - "id": 4781, + "id": 4869, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -100854,7 +102624,7 @@ } }, { - "id": 4793, + "id": 4881, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -100863,7 +102633,7 @@ }, "signatures": [ { - "id": 4794, + "id": 4882, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -100889,14 +102659,14 @@ }, "typeParameter": [ { - "id": 4795, + "id": 4883, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 4796, + "id": 4884, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -100905,7 +102675,7 @@ ], "parameters": [ { - "id": 4797, + "id": 4885, "name": "work", "variant": "param", "kind": 32768, @@ -100921,21 +102691,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4798, + "id": 4886, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4799, + "id": 4887, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4800, + "id": 4888, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -100974,7 +102744,7 @@ } }, { - "id": 4801, + "id": 4889, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -101004,21 +102774,21 @@ { "type": "reflection", "declaration": { - "id": 4802, + "id": 4890, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4803, + "id": 4891, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4804, + "id": 4892, "name": "error", "variant": "param", "kind": 32768, @@ -101065,7 +102835,7 @@ } }, { - "id": 4805, + "id": 4893, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -101083,21 +102853,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4806, + "id": 4894, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4807, + "id": 4895, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4808, + "id": 4896, "name": "error", "variant": "param", "kind": 32768, @@ -101173,21 +102943,21 @@ } }, { - "id": 4760, + "id": 4848, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4761, + "id": 4849, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4762, + "id": 4850, "name": "data", "variant": "param", "kind": 32768, @@ -101227,21 +102997,21 @@ ] }, { - "id": 4775, + "id": 4863, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4776, + "id": 4864, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4777, + "id": 4865, "name": "returnReasonId", "variant": "param", "kind": 32768, @@ -101271,14 +103041,14 @@ ] }, { - "id": 4767, + "id": 4855, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4768, + "id": 4856, "name": "list", "variant": "signature", "kind": 4096, @@ -101299,7 +103069,7 @@ }, "parameters": [ { - "id": 4769, + "id": 4857, "name": "selector", "variant": "param", "kind": 32768, @@ -101334,7 +103104,7 @@ } }, { - "id": 4770, + "id": 4858, "name": "config", "variant": "param", "kind": 32768, @@ -101397,14 +103167,14 @@ ] }, { - "id": 4771, + "id": 4859, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4772, + "id": 4860, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -101430,7 +103200,7 @@ }, "parameters": [ { - "id": 4773, + "id": 4861, "name": "returnReasonId", "variant": "param", "kind": 32768, @@ -101449,7 +103219,7 @@ } }, { - "id": 4774, + "id": 4862, "name": "config", "variant": "param", "kind": 32768, @@ -101509,7 +103279,7 @@ ] }, { - "id": 4788, + "id": 4876, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -101518,14 +103288,14 @@ }, "signatures": [ { - "id": 4789, + "id": 4877, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4790, + "id": 4878, "name": "err", "variant": "param", "kind": 32768, @@ -101555,14 +103325,14 @@ { "type": "reflection", "declaration": { - "id": 4791, + "id": 4879, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4792, + "id": 4880, "name": "code", "variant": "declaration", "kind": 1024, @@ -101577,7 +103347,7 @@ { "title": "Properties", "children": [ - 4792 + 4880 ] } ] @@ -101605,21 +103375,21 @@ } }, { - "id": 4763, + "id": 4851, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4764, + "id": 4852, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4765, + "id": 4853, "name": "id", "variant": "param", "kind": 32768, @@ -101630,7 +103400,7 @@ } }, { - "id": 4766, + "id": 4854, "name": "data", "variant": "param", "kind": 32768, @@ -101670,21 +103440,21 @@ ] }, { - "id": 4785, + "id": 4873, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4786, + "id": 4874, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4787, + "id": 4875, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -101704,7 +103474,7 @@ ], "type": { "type": "reference", - "target": 4755, + "target": 4843, "name": "ReturnReasonService", "package": "@medusajs/medusa" }, @@ -101726,37 +103496,37 @@ { "title": "Constructors", "children": [ - 4756 + 4844 ] }, { "title": "Properties", "children": [ - 4783, - 4782, - 4784, - 4778, - 4759, - 4779 + 4871, + 4870, + 4872, + 4866, + 4847, + 4867 ] }, { "title": "Accessors", "children": [ - 4780 + 4868 ] }, { "title": "Methods", "children": [ - 4793, - 4760, - 4775, - 4767, - 4771, - 4788, - 4763, - 4785 + 4881, + 4848, + 4863, + 4855, + 4859, + 4876, + 4851, + 4873 ] } ], @@ -101773,28 +103543,28 @@ ] }, { - "id": 4652, + "id": 4740, "name": "ReturnService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 4653, + "id": 4741, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 4654, + "id": 4742, "name": "new ReturnService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 4655, + "id": 4743, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -101812,7 +103582,7 @@ ], "type": { "type": "reference", - "target": 4652, + "target": 4740, "name": "ReturnService", "package": "@medusajs/medusa" }, @@ -101830,7 +103600,7 @@ } }, { - "id": 4729, + "id": 4817, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -101865,7 +103635,7 @@ } }, { - "id": 4728, + "id": 4816, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -101884,7 +103654,7 @@ } }, { - "id": 4730, + "id": 4818, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -101919,7 +103689,7 @@ } }, { - "id": 4666, + "id": 4754, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -101938,7 +103708,7 @@ } }, { - "id": 4662, + "id": 4750, "name": "fulfillmentProviderService_", "variant": "declaration", "kind": 1024, @@ -101948,13 +103718,13 @@ }, "type": { "type": "reference", - "target": 1484, + "target": 1538, "name": "FulfillmentProviderService", "package": "@medusajs/medusa" } }, { - "id": 4659, + "id": 4747, "name": "lineItemService_", "variant": "declaration", "kind": 1024, @@ -101964,13 +103734,13 @@ }, "type": { "type": "reference", - "target": 1713, + "target": 1767, "name": "LineItemService", "package": "@medusajs/medusa" } }, { - "id": 4724, + "id": 4812, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -101993,7 +103763,7 @@ } }, { - "id": 4664, + "id": 4752, "name": "orderService_", "variant": "declaration", "kind": 1024, @@ -102003,13 +103773,13 @@ }, "type": { "type": "reference", - "target": 2331, + "target": 2385, "name": "OrderService", "package": "@medusajs/medusa" } }, { - "id": 4665, + "id": 4753, "name": "productVariantInventoryService_", "variant": "declaration", "kind": 1024, @@ -102019,13 +103789,13 @@ }, "type": { "type": "reference", - "target": 4409, + "target": 4497, "name": "ProductVariantInventoryService", "package": "@medusajs/medusa" } }, { - "id": 4658, + "id": 4746, "name": "returnItemRepository_", "variant": "declaration", "kind": 1024, @@ -102055,7 +103825,7 @@ } }, { - "id": 4663, + "id": 4751, "name": "returnReasonService_", "variant": "declaration", "kind": 1024, @@ -102065,13 +103835,13 @@ }, "type": { "type": "reference", - "target": 4755, + "target": 4843, "name": "ReturnReasonService", "package": "@medusajs/medusa" } }, { - "id": 4657, + "id": 4745, "name": "returnRepository_", "variant": "declaration", "kind": 1024, @@ -102101,7 +103871,7 @@ } }, { - "id": 4661, + "id": 4749, "name": "shippingOptionService_", "variant": "declaration", "kind": 1024, @@ -102111,13 +103881,13 @@ }, "type": { "type": "reference", - "target": 5056, + "target": 5163, "name": "ShippingOptionService", "package": "@medusajs/medusa" } }, { - "id": 4660, + "id": 4748, "name": "taxProviderService_", "variant": "declaration", "kind": 1024, @@ -102127,13 +103897,13 @@ }, "type": { "type": "reference", - "target": 5702, + "target": 5814, "name": "TaxProviderService", "package": "@medusajs/medusa" } }, { - "id": 4656, + "id": 4744, "name": "totalsService_", "variant": "declaration", "kind": 1024, @@ -102143,13 +103913,13 @@ }, "type": { "type": "reference", - "target": 5964, + "target": 6081, "name": "TotalsService", "package": "@medusajs/medusa" } }, { - "id": 4725, + "id": 4813, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -102181,7 +103951,7 @@ } }, { - "id": 4726, + "id": 4814, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -102189,7 +103959,7 @@ "isProtected": true }, "getSignature": { - "id": 4727, + "id": 4815, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -102216,7 +103986,7 @@ } }, { - "id": 4739, + "id": 4827, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -102225,7 +103995,7 @@ }, "signatures": [ { - "id": 4740, + "id": 4828, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -102251,14 +104021,14 @@ }, "typeParameter": [ { - "id": 4741, + "id": 4829, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 4742, + "id": 4830, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -102267,7 +104037,7 @@ ], "parameters": [ { - "id": 4743, + "id": 4831, "name": "work", "variant": "param", "kind": 32768, @@ -102283,21 +104053,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4744, + "id": 4832, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4745, + "id": 4833, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4746, + "id": 4834, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -102336,7 +104106,7 @@ } }, { - "id": 4747, + "id": 4835, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -102366,21 +104136,21 @@ { "type": "reflection", "declaration": { - "id": 4748, + "id": 4836, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4749, + "id": 4837, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4750, + "id": 4838, "name": "error", "variant": "param", "kind": 32768, @@ -102427,7 +104197,7 @@ } }, { - "id": 4751, + "id": 4839, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -102445,21 +104215,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4752, + "id": 4840, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4753, + "id": 4841, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4754, + "id": 4842, "name": "error", "variant": "param", "kind": 32768, @@ -102535,14 +104305,14 @@ } }, { - "id": 4683, + "id": 4771, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4684, + "id": 4772, "name": "cancel", "variant": "signature", "kind": 4096, @@ -102568,7 +104338,7 @@ }, "parameters": [ { - "id": 4685, + "id": 4773, "name": "returnId", "variant": "param", "kind": 32768, @@ -102611,14 +104381,14 @@ ] }, { - "id": 4709, + "id": 4797, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4710, + "id": 4798, "name": "create", "variant": "signature", "kind": 4096, @@ -102644,7 +104414,7 @@ }, "parameters": [ { - "id": 4711, + "id": 4799, "name": "data", "variant": "param", "kind": 32768, @@ -102692,21 +104462,21 @@ ] }, { - "id": 4712, + "id": 4800, "name": "fulfill", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4713, + "id": 4801, "name": "fulfill", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4714, + "id": 4802, "name": "returnId", "variant": "param", "kind": 32768, @@ -102741,7 +104511,7 @@ ] }, { - "id": 4667, + "id": 4755, "name": "getFulfillmentItems", "variant": "declaration", "kind": 2048, @@ -102750,7 +104520,7 @@ }, "signatures": [ { - "id": 4668, + "id": 4756, "name": "getFulfillmentItems", "variant": "signature", "kind": 4096, @@ -102776,7 +104546,7 @@ }, "parameters": [ { - "id": 4669, + "id": 4757, "name": "order", "variant": "param", "kind": 32768, @@ -102800,7 +104570,7 @@ } }, { - "id": 4670, + "id": 4758, "name": "items", "variant": "param", "kind": 32768, @@ -102827,7 +104597,7 @@ } }, { - "id": 4671, + "id": 4759, "name": "transformer", "variant": "param", "kind": 32768, @@ -102875,14 +104645,14 @@ { "type": "reflection", "declaration": { - "id": 4672, + "id": 4760, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4674, + "id": 4762, "name": "note", "variant": "declaration", "kind": 1024, @@ -102895,7 +104665,7 @@ } }, { - "id": 4673, + "id": 4761, "name": "reason_id", "variant": "declaration", "kind": 1024, @@ -102912,8 +104682,8 @@ { "title": "Properties", "children": [ - 4674, - 4673 + 4762, + 4761 ] } ] @@ -102930,14 +104700,14 @@ ] }, { - "id": 4675, + "id": 4763, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4676, + "id": 4764, "name": "list", "variant": "signature", "kind": 4096, @@ -102958,7 +104728,7 @@ }, "parameters": [ { - "id": 4677, + "id": 4765, "name": "selector", "variant": "param", "kind": 32768, @@ -102993,7 +104763,7 @@ } }, { - "id": 4678, + "id": 4766, "name": "config", "variant": "param", "kind": 32768, @@ -103056,14 +104826,14 @@ ] }, { - "id": 4679, + "id": 4767, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4680, + "id": 4768, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -103084,7 +104854,7 @@ }, "parameters": [ { - "id": 4681, + "id": 4769, "name": "selector", "variant": "param", "kind": 32768, @@ -103119,7 +104889,7 @@ } }, { - "id": 4682, + "id": 4770, "name": "config", "variant": "param", "kind": 32768, @@ -103191,14 +104961,14 @@ ] }, { - "id": 4715, + "id": 4803, "name": "receive", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4716, + "id": 4804, "name": "receive", "variant": "signature", "kind": 4096, @@ -103224,7 +104994,7 @@ }, "parameters": [ { - "id": 4717, + "id": 4805, "name": "returnId", "variant": "param", "kind": 32768, @@ -103243,7 +105013,7 @@ } }, { - "id": 4718, + "id": 4806, "name": "receivedItems", "variant": "param", "kind": 32768, @@ -103270,7 +105040,7 @@ } }, { - "id": 4719, + "id": 4807, "name": "refundAmount", "variant": "param", "kind": 32768, @@ -103291,7 +105061,7 @@ } }, { - "id": 4720, + "id": 4808, "name": "allowMismatch", "variant": "param", "kind": 32768, @@ -103311,7 +105081,7 @@ "defaultValue": "false" }, { - "id": 4721, + "id": 4809, "name": "context", "variant": "param", "kind": 32768, @@ -103319,14 +105089,14 @@ "type": { "type": "reflection", "declaration": { - "id": 4722, + "id": 4810, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4723, + "id": 4811, "name": "locationId", "variant": "declaration", "kind": 1024, @@ -103343,7 +105113,7 @@ { "title": "Properties", "children": [ - 4723 + 4811 ] } ] @@ -103376,14 +105146,14 @@ ] }, { - "id": 4697, + "id": 4785, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4698, + "id": 4786, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -103409,7 +105179,7 @@ }, "parameters": [ { - "id": 4699, + "id": 4787, "name": "returnId", "variant": "param", "kind": 32768, @@ -103428,7 +105198,7 @@ } }, { - "id": 4700, + "id": 4788, "name": "config", "variant": "param", "kind": 32768, @@ -103488,21 +105258,21 @@ ] }, { - "id": 4701, + "id": 4789, "name": "retrieveBySwap", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4702, + "id": 4790, "name": "retrieveBySwap", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4703, + "id": 4791, "name": "swapId", "variant": "param", "kind": 32768, @@ -103513,7 +105283,7 @@ } }, { - "id": 4704, + "id": 4792, "name": "relations", "variant": "param", "kind": 32768, @@ -103552,7 +105322,7 @@ ] }, { - "id": 4734, + "id": 4822, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -103561,14 +105331,14 @@ }, "signatures": [ { - "id": 4735, + "id": 4823, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4736, + "id": 4824, "name": "err", "variant": "param", "kind": 32768, @@ -103598,14 +105368,14 @@ { "type": "reflection", "declaration": { - "id": 4737, + "id": 4825, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4738, + "id": 4826, "name": "code", "variant": "declaration", "kind": 1024, @@ -103620,7 +105390,7 @@ { "title": "Properties", "children": [ - 4738 + 4826 ] } ] @@ -103648,21 +105418,21 @@ } }, { - "id": 4705, + "id": 4793, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4706, + "id": 4794, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4707, + "id": 4795, "name": "returnId", "variant": "param", "kind": 32768, @@ -103673,7 +105443,7 @@ } }, { - "id": 4708, + "id": 4796, "name": "update", "variant": "param", "kind": 32768, @@ -103713,7 +105483,7 @@ ] }, { - "id": 4689, + "id": 4777, "name": "validateReturnLineItem", "variant": "declaration", "kind": 2048, @@ -103722,7 +105492,7 @@ }, "signatures": [ { - "id": 4690, + "id": 4778, "name": "validateReturnLineItem", "variant": "signature", "kind": 4096, @@ -103748,7 +105518,7 @@ }, "parameters": [ { - "id": 4691, + "id": 4779, "name": "item", "variant": "param", "kind": 32768, @@ -103774,7 +105544,7 @@ } }, { - "id": 4692, + "id": 4780, "name": "quantity", "variant": "param", "kind": 32768, @@ -103794,7 +105564,7 @@ "defaultValue": "0" }, { - "id": 4693, + "id": 4781, "name": "additional", "variant": "param", "kind": 32768, @@ -103810,14 +105580,14 @@ "type": { "type": "reflection", "declaration": { - "id": 4694, + "id": 4782, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4696, + "id": 4784, "name": "note", "variant": "declaration", "kind": 1024, @@ -103830,7 +105600,7 @@ } }, { - "id": 4695, + "id": 4783, "name": "reason_id", "variant": "declaration", "kind": 1024, @@ -103847,8 +105617,8 @@ { "title": "Properties", "children": [ - 4696, - 4695 + 4784, + 4783 ] } ] @@ -103881,7 +105651,7 @@ ] }, { - "id": 4686, + "id": 4774, "name": "validateReturnStatuses", "variant": "declaration", "kind": 2048, @@ -103890,7 +105660,7 @@ }, "signatures": [ { - "id": 4687, + "id": 4775, "name": "validateReturnStatuses", "variant": "signature", "kind": 4096, @@ -103916,7 +105686,7 @@ }, "parameters": [ { - "id": 4688, + "id": 4776, "name": "order", "variant": "param", "kind": 32768, @@ -103948,21 +105718,21 @@ ] }, { - "id": 4731, + "id": 4819, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4732, + "id": 4820, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4733, + "id": 4821, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -103982,7 +105752,7 @@ ], "type": { "type": "reference", - "target": 4652, + "target": 4740, "name": "ReturnService", "package": "@medusajs/medusa" }, @@ -104004,54 +105774,54 @@ { "title": "Constructors", "children": [ - 4653 + 4741 ] }, { "title": "Properties", "children": [ - 4729, - 4728, - 4730, - 4666, - 4662, - 4659, - 4724, - 4664, - 4665, - 4658, - 4663, - 4657, - 4661, - 4660, - 4656, - 4725 + 4817, + 4816, + 4818, + 4754, + 4750, + 4747, + 4812, + 4752, + 4753, + 4746, + 4751, + 4745, + 4749, + 4748, + 4744, + 4813 ] }, { "title": "Accessors", "children": [ - 4726 + 4814 ] }, { "title": "Methods", "children": [ - 4739, - 4683, - 4709, - 4712, - 4667, - 4675, - 4679, - 4715, - 4697, - 4701, - 4734, - 4705, - 4689, - 4686, - 4731 + 4827, + 4771, + 4797, + 4800, + 4755, + 4763, + 4767, + 4803, + 4785, + 4789, + 4822, + 4793, + 4777, + 4774, + 4819 ] } ], @@ -104068,28 +105838,28 @@ ] }, { - "id": 4915, + "id": 5022, "name": "SalesChannelInventoryService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 4916, + "id": 5023, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 4917, + "id": 5024, "name": "new SalesChannelInventoryService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 4918, + "id": 5025, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -104107,7 +105877,7 @@ ], "type": { "type": "reference", - "target": 4915, + "target": 5022, "name": "SalesChannelInventoryService", "package": "@medusajs/medusa" }, @@ -104125,7 +105895,7 @@ } }, { - "id": 4932, + "id": 5039, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -104160,7 +105930,7 @@ } }, { - "id": 4931, + "id": 5038, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -104179,7 +105949,7 @@ } }, { - "id": 4933, + "id": 5040, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -104214,7 +105984,7 @@ } }, { - "id": 4920, + "id": 5027, "name": "eventBusService_", "variant": "declaration", "kind": 1024, @@ -104233,7 +106003,7 @@ } }, { - "id": 4927, + "id": 5034, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -104256,7 +106026,7 @@ } }, { - "id": 4919, + "id": 5026, "name": "salesChannelLocationService_", "variant": "declaration", "kind": 1024, @@ -104266,13 +106036,13 @@ }, "type": { "type": "reference", - "target": 4958, + "target": 5065, "name": "SalesChannelLocationService", "package": "@medusajs/medusa" } }, { - "id": 4928, + "id": 5035, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -104304,7 +106074,7 @@ } }, { - "id": 4929, + "id": 5036, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -104312,7 +106082,7 @@ "isProtected": true }, "getSignature": { - "id": 4930, + "id": 5037, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -104339,7 +106109,7 @@ } }, { - "id": 4921, + "id": 5028, "name": "inventoryService_", "variant": "declaration", "kind": 262144, @@ -104347,7 +106117,7 @@ "isProtected": true }, "getSignature": { - "id": 4922, + "id": 5029, "name": "inventoryService_", "variant": "signature", "kind": 524288, @@ -104364,7 +106134,7 @@ } }, { - "id": 4942, + "id": 5049, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -104373,7 +106143,7 @@ }, "signatures": [ { - "id": 4943, + "id": 5050, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -104399,14 +106169,14 @@ }, "typeParameter": [ { - "id": 4944, + "id": 5051, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 4945, + "id": 5052, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -104415,7 +106185,7 @@ ], "parameters": [ { - "id": 4946, + "id": 5053, "name": "work", "variant": "param", "kind": 32768, @@ -104431,21 +106201,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4947, + "id": 5054, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4948, + "id": 5055, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4949, + "id": 5056, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -104484,7 +106254,7 @@ } }, { - "id": 4950, + "id": 5057, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -104514,21 +106284,21 @@ { "type": "reflection", "declaration": { - "id": 4951, + "id": 5058, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4952, + "id": 5059, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4953, + "id": 5060, "name": "error", "variant": "param", "kind": 32768, @@ -104575,7 +106345,7 @@ } }, { - "id": 4954, + "id": 5061, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -104593,21 +106363,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4955, + "id": 5062, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4956, + "id": 5063, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4957, + "id": 5064, "name": "error", "variant": "param", "kind": 32768, @@ -104683,14 +106453,14 @@ } }, { - "id": 4923, + "id": 5030, "name": "retrieveAvailableItemQuantity", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4924, + "id": 5031, "name": "retrieveAvailableItemQuantity", "variant": "signature", "kind": 4096, @@ -104716,7 +106486,7 @@ }, "parameters": [ { - "id": 4925, + "id": 5032, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -104735,7 +106505,7 @@ } }, { - "id": 4926, + "id": 5033, "name": "inventoryItemId", "variant": "param", "kind": 32768, @@ -104773,7 +106543,7 @@ ] }, { - "id": 4937, + "id": 5044, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -104782,14 +106552,14 @@ }, "signatures": [ { - "id": 4938, + "id": 5045, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4939, + "id": 5046, "name": "err", "variant": "param", "kind": 32768, @@ -104819,14 +106589,14 @@ { "type": "reflection", "declaration": { - "id": 4940, + "id": 5047, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4941, + "id": 5048, "name": "code", "variant": "declaration", "kind": 1024, @@ -104841,7 +106611,7 @@ { "title": "Properties", "children": [ - 4941 + 5048 ] } ] @@ -104869,21 +106639,21 @@ } }, { - "id": 4934, + "id": 5041, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4935, + "id": 5042, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4936, + "id": 5043, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -104903,7 +106673,7 @@ ], "type": { "type": "reference", - "target": 4915, + "target": 5022, "name": "SalesChannelInventoryService", "package": "@medusajs/medusa" }, @@ -104925,35 +106695,35 @@ { "title": "Constructors", "children": [ - 4916 + 5023 ] }, { "title": "Properties", "children": [ - 4932, - 4931, - 4933, - 4920, - 4927, - 4919, - 4928 + 5039, + 5038, + 5040, + 5027, + 5034, + 5026, + 5035 ] }, { "title": "Accessors", "children": [ - 4929, - 4921 + 5036, + 5028 ] }, { "title": "Methods", "children": [ - 4942, - 4923, - 4937, - 4934 + 5049, + 5030, + 5044, + 5041 ] } ], @@ -104970,7 +106740,7 @@ ] }, { - "id": 4958, + "id": 5065, "name": "SalesChannelLocationService", "variant": "declaration", "kind": 128, @@ -104985,21 +106755,21 @@ }, "children": [ { - "id": 4959, + "id": 5066, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 4960, + "id": 5067, "name": "new SalesChannelLocationService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 4961, + "id": 5068, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -105017,7 +106787,7 @@ ], "type": { "type": "reference", - "target": 4958, + "target": 5065, "name": "SalesChannelLocationService", "package": "@medusajs/medusa" }, @@ -105035,7 +106805,7 @@ } }, { - "id": 4985, + "id": 5092, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -105070,7 +106840,7 @@ } }, { - "id": 4984, + "id": 5091, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -105089,7 +106859,7 @@ } }, { - "id": 4986, + "id": 5093, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -105124,7 +106894,7 @@ } }, { - "id": 4963, + "id": 5070, "name": "eventBusService_", "variant": "declaration", "kind": 1024, @@ -105143,7 +106913,7 @@ } }, { - "id": 4980, + "id": 5087, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -105166,7 +106936,7 @@ } }, { - "id": 4962, + "id": 5069, "name": "salesChannelService_", "variant": "declaration", "kind": 1024, @@ -105176,13 +106946,13 @@ }, "type": { "type": "reference", - "target": 4809, + "target": 4897, "name": "SalesChannelService", "package": "@medusajs/medusa" } }, { - "id": 4981, + "id": 5088, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -105214,7 +106984,7 @@ } }, { - "id": 4982, + "id": 5089, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -105222,7 +106992,7 @@ "isProtected": true }, "getSignature": { - "id": 4983, + "id": 5090, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -105249,7 +107019,7 @@ } }, { - "id": 4964, + "id": 5071, "name": "stockLocationService_", "variant": "declaration", "kind": 262144, @@ -105257,7 +107027,7 @@ "isProtected": true }, "getSignature": { - "id": 4965, + "id": 5072, "name": "stockLocationService_", "variant": "signature", "kind": 524288, @@ -105274,14 +107044,14 @@ } }, { - "id": 4970, + "id": 5077, "name": "associateLocation", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4971, + "id": 5078, "name": "associateLocation", "variant": "signature", "kind": 4096, @@ -105307,7 +107077,7 @@ }, "parameters": [ { - "id": 4972, + "id": 5079, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -105326,7 +107096,7 @@ } }, { - "id": 4973, + "id": 5080, "name": "locationId", "variant": "param", "kind": 32768, @@ -105364,7 +107134,7 @@ ] }, { - "id": 4995, + "id": 5102, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -105373,7 +107143,7 @@ }, "signatures": [ { - "id": 4996, + "id": 5103, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -105399,14 +107169,14 @@ }, "typeParameter": [ { - "id": 4997, + "id": 5104, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 4998, + "id": 5105, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -105415,7 +107185,7 @@ ], "parameters": [ { - "id": 4999, + "id": 5106, "name": "work", "variant": "param", "kind": 32768, @@ -105431,21 +107201,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5000, + "id": 5107, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5001, + "id": 5108, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5002, + "id": 5109, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -105484,7 +107254,7 @@ } }, { - "id": 5003, + "id": 5110, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -105514,21 +107284,21 @@ { "type": "reflection", "declaration": { - "id": 5004, + "id": 5111, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5005, + "id": 5112, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5006, + "id": 5113, "name": "error", "variant": "param", "kind": 32768, @@ -105575,7 +107345,7 @@ } }, { - "id": 5007, + "id": 5114, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -105593,21 +107363,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5008, + "id": 5115, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5009, + "id": 5116, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5010, + "id": 5117, "name": "error", "variant": "param", "kind": 32768, @@ -105683,14 +107453,14 @@ } }, { - "id": 4974, + "id": 5081, "name": "listLocationIds", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4975, + "id": 5082, "name": "listLocationIds", "variant": "signature", "kind": 4096, @@ -105716,7 +107486,7 @@ }, "parameters": [ { - "id": 4976, + "id": 5083, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -105769,14 +107539,14 @@ ] }, { - "id": 4977, + "id": 5084, "name": "listSalesChannelIds", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4978, + "id": 5085, "name": "listSalesChannelIds", "variant": "signature", "kind": 4096, @@ -105802,7 +107572,7 @@ }, "parameters": [ { - "id": 4979, + "id": 5086, "name": "locationId", "variant": "param", "kind": 32768, @@ -105835,14 +107605,14 @@ ] }, { - "id": 4966, + "id": 5073, "name": "removeLocation", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4967, + "id": 5074, "name": "removeLocation", "variant": "signature", "kind": 4096, @@ -105868,7 +107638,7 @@ }, "parameters": [ { - "id": 4968, + "id": 5075, "name": "locationId", "variant": "param", "kind": 32768, @@ -105887,7 +107657,7 @@ } }, { - "id": 4969, + "id": 5076, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -105927,7 +107697,7 @@ ] }, { - "id": 4990, + "id": 5097, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -105936,14 +107706,14 @@ }, "signatures": [ { - "id": 4991, + "id": 5098, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4992, + "id": 5099, "name": "err", "variant": "param", "kind": 32768, @@ -105973,14 +107743,14 @@ { "type": "reflection", "declaration": { - "id": 4993, + "id": 5100, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4994, + "id": 5101, "name": "code", "variant": "declaration", "kind": 1024, @@ -105995,7 +107765,7 @@ { "title": "Properties", "children": [ - 4994 + 5101 ] } ] @@ -106023,21 +107793,21 @@ } }, { - "id": 4987, + "id": 5094, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4988, + "id": 5095, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4989, + "id": 5096, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -106057,7 +107827,7 @@ ], "type": { "type": "reference", - "target": 4958, + "target": 5065, "name": "SalesChannelLocationService", "package": "@medusajs/medusa" }, @@ -106079,38 +107849,38 @@ { "title": "Constructors", "children": [ - 4959 + 5066 ] }, { "title": "Properties", "children": [ - 4985, - 4984, - 4986, - 4963, - 4980, - 4962, - 4981 + 5092, + 5091, + 5093, + 5070, + 5087, + 5069, + 5088 ] }, { "title": "Accessors", "children": [ - 4982, - 4964 + 5089, + 5071 ] }, { "title": "Methods", "children": [ - 4970, - 4995, - 4974, - 4977, - 4966, - 4990, - 4987 + 5077, + 5102, + 5081, + 5084, + 5073, + 5097, + 5094 ] } ], @@ -106127,28 +107897,28 @@ ] }, { - "id": 4809, + "id": 4897, "name": "SalesChannelService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 4815, + "id": 4903, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 4816, + "id": 4904, "name": "new SalesChannelService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 4817, + "id": 4905, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -106166,7 +107936,7 @@ ], "type": { "type": "reference", - "target": 4809, + "target": 4897, "name": "SalesChannelService", "package": "@medusajs/medusa" }, @@ -106184,7 +107954,7 @@ } }, { - "id": 4889, + "id": 4996, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -106219,7 +107989,7 @@ } }, { - "id": 4888, + "id": 4995, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -106238,7 +108008,7 @@ } }, { - "id": 4890, + "id": 4997, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -106273,7 +108043,7 @@ } }, { - "id": 4838, + "id": 4940, "name": "eventBusService_", "variant": "declaration", "kind": 1024, @@ -106283,13 +108053,32 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 4884, + "id": 4942, + "name": "featureFlagRouter_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/utils/dist/feature-flags/utils/flag-router.d.ts", + "qualifiedName": "FlagRouter" + }, + "name": "FlagRouter", + "package": "@medusajs/utils" + } + }, + { + "id": 4991, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -106312,7 +108101,7 @@ } }, { - "id": 4818, + "id": 4906, "name": "salesChannelRepository_", "variant": "declaration", "kind": 1024, @@ -106346,28 +108135,28 @@ { "type": "reflection", "declaration": { - "id": 4819, + "id": 4907, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4828, + "id": 4929, "name": "addProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4829, + "id": 4930, "name": "addProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4830, + "id": 4931, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -106378,7 +108167,7 @@ } }, { - "id": 4831, + "id": 4932, "name": "productIds", "variant": "param", "kind": 32768, @@ -106390,6 +108179,19 @@ "name": "string" } } + }, + { + "id": 4933, + "name": "isMedusaV2Enabled", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "type": { @@ -106411,21 +108213,101 @@ ] }, { - "id": 4820, + "id": 4921, + "name": "getFreeTextSearchResults", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 4922, + "name": "getFreeTextSearchResults", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4923, + "name": "q", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4924, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "ExtendedFindConfig" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + ], + "name": "ExtendedFindConfig", + "package": "@medusajs/medusa" + }, + "defaultValue": "..." + } + ], + "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/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 4917, "name": "getFreeTextSearchResultsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4821, + "id": 4918, "name": "getFreeTextSearchResultsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4822, + "id": 4919, "name": "q", "variant": "param", "kind": 32768, @@ -106436,7 +108318,7 @@ } }, { - "id": 4823, + "id": 4920, "name": "options", "variant": "param", "kind": 32768, @@ -106500,21 +108382,256 @@ ] }, { - "id": 4832, + "id": 4908, + "name": "getFreeTextSearchResults_", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 4909, + "name": "getFreeTextSearchResults_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4910, + "name": "q", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4911, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4912, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4914, + "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": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + ], + "name": "FindOptionsRelations", + "package": "typeorm" + } + }, + { + "id": 4913, + "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": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + ], + "name": "FindOptionsSelect", + "package": "typeorm" + } + }, + { + "id": 4915, + "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": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + ], + "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": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + } + } + ] + } + }, + { + "id": 4916, + "name": "withCount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4914, + 4913, + 4915, + 4916 + ] + } + ] + } + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + }, + { + "type": "tuple", + "elements": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 4934, "name": "listProductIdsBySalesChannelIds", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4833, + "id": 4935, "name": "listProductIdsBySalesChannelIds", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4834, + "id": 4936, "name": "salesChannelIds", "variant": "param", "kind": 32768, @@ -106547,20 +108664,20 @@ { "type": "reflection", "declaration": { - "id": 4835, + "id": 4937, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 4836, + "id": 4938, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 4837, + "id": 4939, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -106589,21 +108706,21 @@ ] }, { - "id": 4824, + "id": 4925, "name": "removeProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4825, + "id": 4926, "name": "removeProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4826, + "id": 4927, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -106614,7 +108731,7 @@ } }, { - "id": 4827, + "id": 4928, "name": "productIds", "variant": "param", "kind": 32768, @@ -106656,10 +108773,12 @@ { "title": "Methods", "children": [ - 4828, - 4820, - 4832, - 4824 + 4929, + 4921, + 4917, + 4908, + 4934, + 4925 ] } ] @@ -106669,7 +108788,7 @@ } }, { - "id": 4839, + "id": 4941, "name": "storeService_", "variant": "declaration", "kind": 1024, @@ -106679,13 +108798,13 @@ }, "type": { "type": "reference", - "target": 5392, + "target": 5504, "name": "StoreService", "package": "@medusajs/medusa" } }, { - "id": 4885, + "id": 4992, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -106717,7 +108836,7 @@ } }, { - "id": 4810, + "id": 4898, "name": "Events", "variant": "declaration", "kind": 1024, @@ -106727,14 +108846,14 @@ "type": { "type": "reflection", "declaration": { - "id": 4811, + "id": 4899, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4813, + "id": 4901, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -106746,7 +108865,7 @@ "defaultValue": "\"sales_channel.created\"" }, { - "id": 4814, + "id": 4902, "name": "DELETED", "variant": "declaration", "kind": 1024, @@ -106758,7 +108877,7 @@ "defaultValue": "\"sales_channel.deleted\"" }, { - "id": 4812, + "id": 4900, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -106774,9 +108893,9 @@ { "title": "Properties", "children": [ - 4813, - 4814, - 4812 + 4901, + 4902, + 4900 ] } ] @@ -106785,7 +108904,7 @@ "defaultValue": "..." }, { - "id": 4886, + "id": 4993, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -106793,7 +108912,7 @@ "isProtected": true }, "getSignature": { - "id": 4887, + "id": 4994, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -106820,14 +108939,14 @@ } }, { - "id": 4880, + "id": 4987, "name": "addProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4881, + "id": 4988, "name": "addProducts", "variant": "signature", "kind": 4096, @@ -106853,7 +108972,7 @@ }, "parameters": [ { - "id": 4882, + "id": 4989, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -106872,7 +108991,7 @@ } }, { - "id": 4883, + "id": 4990, "name": "productIds", "variant": "param", "kind": 32768, @@ -106918,7 +109037,7 @@ ] }, { - "id": 4899, + "id": 5006, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -106927,7 +109046,7 @@ }, "signatures": [ { - "id": 4900, + "id": 5007, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -106953,14 +109072,14 @@ }, "typeParameter": [ { - "id": 4901, + "id": 5008, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 4902, + "id": 5009, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -106969,7 +109088,7 @@ ], "parameters": [ { - "id": 4903, + "id": 5010, "name": "work", "variant": "param", "kind": 32768, @@ -106985,21 +109104,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4904, + "id": 5011, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4905, + "id": 5012, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4906, + "id": 5013, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -107038,7 +109157,7 @@ } }, { - "id": 4907, + "id": 5014, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -107068,21 +109187,21 @@ { "type": "reflection", "declaration": { - "id": 4908, + "id": 5015, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4909, + "id": 5016, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4910, + "id": 5017, "name": "error", "variant": "param", "kind": 32768, @@ -107129,7 +109248,7 @@ } }, { - "id": 4911, + "id": 5018, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -107147,21 +109266,21 @@ "type": { "type": "reflection", "declaration": { - "id": 4912, + "id": 5019, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4913, + "id": 5020, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4914, + "id": 5021, "name": "error", "variant": "param", "kind": 32768, @@ -107237,14 +109356,14 @@ } }, { - "id": 4856, + "id": 4963, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4857, + "id": 4964, "name": "create", "variant": "signature", "kind": 4096, @@ -107273,7 +109392,7 @@ }, "parameters": [ { - "id": 4858, + "id": 4965, "name": "data", "variant": "param", "kind": 32768, @@ -107313,14 +109432,14 @@ ] }, { - "id": 4866, + "id": 4973, "name": "createDefault", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4867, + "id": 4974, "name": "createDefault", "variant": "signature", "kind": 4096, @@ -107368,14 +109487,14 @@ ] }, { - "id": 4863, + "id": 4970, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4864, + "id": 4971, "name": "delete", "variant": "signature", "kind": 4096, @@ -107393,7 +109512,7 @@ }, "parameters": [ { - "id": 4865, + "id": 4972, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -107431,14 +109550,129 @@ ] }, { - "id": 4852, + "id": 4959, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 4960, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Lists sales channels based on the provided parameters." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "an array containing the sales channels" + } + ] + } + ] + }, + "parameters": [ + { + "id": 4961, + "name": "selector", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "QuerySelector" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + ], + "name": "QuerySelector", + "package": "@medusajs/medusa" + } + }, + { + "id": 4962, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "FindConfig" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + ], + "name": "FindConfig", + "package": "@medusajs/medusa" + }, + "defaultValue": "..." + } + ], + "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/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 4955, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4853, + "id": 4956, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -107447,7 +109681,7 @@ "summary": [ { "kind": "text", - "text": "Lists sales channels based on the provided parameters and includes the count of\nsales channels that match the query." + "text": "Lists sales channels based on the provided parameters and include the count of\nsales channels that match the query." } ], "blockTags": [ @@ -107464,7 +109698,7 @@ }, "parameters": [ { - "id": 4854, + "id": 4957, "name": "selector", "variant": "param", "kind": 32768, @@ -107491,7 +109725,7 @@ } }, { - "id": 4855, + "id": 4958, "name": "config", "variant": "param", "kind": 32768, @@ -107555,14 +109789,14 @@ ] }, { - "id": 4870, + "id": 4977, "name": "listProductIdsBySalesChannelIds", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4871, + "id": 4978, "name": "listProductIdsBySalesChannelIds", "variant": "signature", "kind": 4096, @@ -107577,7 +109811,7 @@ }, "parameters": [ { - "id": 4872, + "id": 4979, "name": "salesChannelIds", "variant": "param", "kind": 32768, @@ -107610,20 +109844,20 @@ { "type": "reflection", "declaration": { - "id": 4873, + "id": 4980, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 4874, + "id": 4981, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 4875, + "id": 4982, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -107652,14 +109886,14 @@ ] }, { - "id": 4876, + "id": 4983, "name": "removeProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4877, + "id": 4984, "name": "removeProducts", "variant": "signature", "kind": 4096, @@ -107685,7 +109919,7 @@ }, "parameters": [ { - "id": 4878, + "id": 4985, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -107704,7 +109938,7 @@ } }, { - "id": 4879, + "id": 4986, "name": "productIds", "variant": "param", "kind": 32768, @@ -107750,14 +109984,14 @@ ] }, { - "id": 4844, + "id": 4947, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4845, + "id": 4948, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -107786,7 +110020,7 @@ }, "parameters": [ { - "id": 4846, + "id": 4949, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -107805,7 +110039,7 @@ } }, { - "id": 4847, + "id": 4950, "name": "config", "variant": "param", "kind": 32768, @@ -107865,14 +110099,14 @@ ] }, { - "id": 4848, + "id": 4951, "name": "retrieveByName", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4849, + "id": 4952, "name": "retrieveByName", "variant": "signature", "kind": 4096, @@ -107898,7 +110132,7 @@ }, "parameters": [ { - "id": 4850, + "id": 4953, "name": "name", "variant": "param", "kind": 32768, @@ -107917,7 +110151,7 @@ } }, { - "id": 4851, + "id": 4954, "name": "config", "variant": "param", "kind": 32768, @@ -107972,14 +110206,14 @@ ] }, { - "id": 4868, + "id": 4975, "name": "retrieveDefault", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4869, + "id": 4976, "name": "retrieveDefault", "variant": "signature", "kind": 4096, @@ -108027,7 +110261,7 @@ ] }, { - "id": 4840, + "id": 4943, "name": "retrieve_", "variant": "declaration", "kind": 2048, @@ -108036,7 +110270,7 @@ }, "signatures": [ { - "id": 4841, + "id": 4944, "name": "retrieve_", "variant": "signature", "kind": 4096, @@ -108062,7 +110296,7 @@ }, "parameters": [ { - "id": 4842, + "id": 4945, "name": "selector", "variant": "param", "kind": 32768, @@ -108097,7 +110331,7 @@ } }, { - "id": 4843, + "id": 4946, "name": "config", "variant": "param", "kind": 32768, @@ -108157,7 +110391,7 @@ ] }, { - "id": 4894, + "id": 5001, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -108166,14 +110400,14 @@ }, "signatures": [ { - "id": 4895, + "id": 5002, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4896, + "id": 5003, "name": "err", "variant": "param", "kind": 32768, @@ -108203,14 +110437,14 @@ { "type": "reflection", "declaration": { - "id": 4897, + "id": 5004, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4898, + "id": 5005, "name": "code", "variant": "declaration", "kind": 1024, @@ -108225,7 +110459,7 @@ { "title": "Properties", "children": [ - 4898 + 5005 ] } ] @@ -108253,21 +110487,21 @@ } }, { - "id": 4859, + "id": 4966, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4860, + "id": 4967, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4861, + "id": 4968, "name": "salesChannelId", "variant": "param", "kind": 32768, @@ -108278,7 +110512,7 @@ } }, { - "id": 4862, + "id": 4969, "name": "data", "variant": "param", "kind": 32768, @@ -108329,21 +110563,21 @@ ] }, { - "id": 4891, + "id": 4998, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 4892, + "id": 4999, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4893, + "id": 5000, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -108363,7 +110597,7 @@ ], "type": { "type": "reference", - "target": 4809, + "target": 4897, "name": "SalesChannelService", "package": "@medusajs/medusa" }, @@ -108385,47 +110619,49 @@ { "title": "Constructors", "children": [ - 4815 + 4903 ] }, { "title": "Properties", "children": [ - 4889, - 4888, - 4890, - 4838, - 4884, - 4818, - 4839, - 4885, - 4810 + 4996, + 4995, + 4997, + 4940, + 4942, + 4991, + 4906, + 4941, + 4992, + 4898 ] }, { "title": "Accessors", "children": [ - 4886 + 4993 ] }, { "title": "Methods", "children": [ - 4880, - 4899, - 4856, - 4866, - 4863, - 4852, - 4870, - 4876, - 4844, - 4848, - 4868, - 4840, - 4894, - 4859, - 4891 + 4987, + 5006, + 4963, + 4973, + 4970, + 4959, + 4955, + 4977, + 4983, + 4947, + 4951, + 4975, + 4943, + 5001, + 4966, + 4998 ] } ], @@ -108442,28 +110678,28 @@ ] }, { - "id": 5011, + "id": 5118, "name": "SearchService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 5012, + "id": 5119, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 5013, + "id": 5120, "name": "new SearchService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 5014, + "id": 5121, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -108479,7 +110715,7 @@ } }, { - "id": 5015, + "id": 5122, "name": "options", "variant": "param", "kind": 32768, @@ -108492,7 +110728,7 @@ ], "type": { "type": "reference", - "target": 5011, + "target": 5118, "name": "default", "package": "@medusajs/medusa" }, @@ -108510,7 +110746,7 @@ } }, { - "id": 5016, + "id": 5123, "name": "isDefault", "variant": "declaration", "kind": 1024, @@ -108527,7 +110763,7 @@ } }, { - "id": 5017, + "id": 5124, "name": "logger_", "variant": "declaration", "kind": 1024, @@ -108546,7 +110782,7 @@ } }, { - "id": 5018, + "id": 5125, "name": "options_", "variant": "declaration", "kind": 1024, @@ -108580,13 +110816,13 @@ } }, { - "id": 5054, + "id": 5161, "name": "options", "variant": "declaration", "kind": 262144, "flags": {}, "getSignature": { - "id": 5055, + "id": 5162, "name": "options", "variant": "signature", "kind": 524288, @@ -108623,21 +110859,21 @@ } }, { - "id": 5026, + "id": 5133, "name": "addDocuments", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5027, + "id": 5134, "name": "addDocuments", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5028, + "id": 5135, "name": "indexName", "variant": "param", "kind": 32768, @@ -108648,7 +110884,7 @@ } }, { - "id": 5029, + "id": 5136, "name": "documents", "variant": "param", "kind": 32768, @@ -108659,7 +110895,7 @@ } }, { - "id": 5030, + "id": 5137, "name": "type", "variant": "param", "kind": 32768, @@ -108699,21 +110935,21 @@ } }, { - "id": 5019, + "id": 5126, "name": "createIndex", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5020, + "id": 5127, "name": "createIndex", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5021, + "id": 5128, "name": "indexName", "variant": "param", "kind": 32768, @@ -108724,7 +110960,7 @@ } }, { - "id": 5022, + "id": 5129, "name": "options", "variant": "param", "kind": 32768, @@ -108764,21 +111000,21 @@ } }, { - "id": 5040, + "id": 5147, "name": "deleteAllDocuments", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5041, + "id": 5148, "name": "deleteAllDocuments", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5042, + "id": 5149, "name": "indexName", "variant": "param", "kind": 32768, @@ -108818,21 +111054,21 @@ } }, { - "id": 5036, + "id": 5143, "name": "deleteDocument", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5037, + "id": 5144, "name": "deleteDocument", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5038, + "id": 5145, "name": "indexName", "variant": "param", "kind": 32768, @@ -108843,7 +111079,7 @@ } }, { - "id": 5039, + "id": 5146, "name": "document_id", "variant": "param", "kind": 32768, @@ -108892,21 +111128,21 @@ } }, { - "id": 5023, + "id": 5130, "name": "getIndex", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5024, + "id": 5131, "name": "getIndex", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5025, + "id": 5132, "name": "indexName", "variant": "param", "kind": 32768, @@ -108946,21 +111182,21 @@ } }, { - "id": 5031, + "id": 5138, "name": "replaceDocuments", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5032, + "id": 5139, "name": "replaceDocuments", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5033, + "id": 5140, "name": "indexName", "variant": "param", "kind": 32768, @@ -108971,7 +111207,7 @@ } }, { - "id": 5034, + "id": 5141, "name": "documents", "variant": "param", "kind": 32768, @@ -108982,7 +111218,7 @@ } }, { - "id": 5035, + "id": 5142, "name": "type", "variant": "param", "kind": 32768, @@ -109022,21 +111258,21 @@ } }, { - "id": 5043, + "id": 5150, "name": "search", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5044, + "id": 5151, "name": "search", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5045, + "id": 5152, "name": "indexName", "variant": "param", "kind": 32768, @@ -109047,7 +111283,7 @@ } }, { - "id": 5046, + "id": 5153, "name": "query", "variant": "param", "kind": 32768, @@ -109058,7 +111294,7 @@ } }, { - "id": 5047, + "id": 5154, "name": "options", "variant": "param", "kind": 32768, @@ -109079,14 +111315,14 @@ { "type": "reflection", "declaration": { - "id": 5048, + "id": 5155, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5049, + "id": 5156, "name": "hits", "variant": "declaration", "kind": 1024, @@ -109104,7 +111340,7 @@ { "title": "Properties", "children": [ - 5049 + 5156 ] } ] @@ -109128,21 +111364,21 @@ } }, { - "id": 5050, + "id": 5157, "name": "updateSettings", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5051, + "id": 5158, "name": "updateSettings", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5052, + "id": 5159, "name": "indexName", "variant": "param", "kind": 32768, @@ -109153,7 +111389,7 @@ } }, { - "id": 5053, + "id": 5160, "name": "settings", "variant": "param", "kind": 32768, @@ -109197,34 +111433,34 @@ { "title": "Constructors", "children": [ - 5012 + 5119 ] }, { "title": "Properties", "children": [ - 5016, - 5017, - 5018 + 5123, + 5124, + 5125 ] }, { "title": "Accessors", "children": [ - 5054 + 5161 ] }, { "title": "Methods", "children": [ - 5026, - 5019, - 5040, - 5036, - 5023, - 5031, - 5043, - 5050 + 5133, + 5126, + 5147, + 5143, + 5130, + 5138, + 5150, + 5157 ] } ], @@ -109241,7 +111477,7 @@ ] }, { - "id": 5056, + "id": 5163, "name": "ShippingOptionService", "variant": "declaration", "kind": 128, @@ -109256,21 +111492,21 @@ }, "children": [ { - "id": 5057, + "id": 5164, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 5058, + "id": 5165, "name": "new ShippingOptionService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 5059, + "id": 5166, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -109288,7 +111524,7 @@ ], "type": { "type": "reference", - "target": 5056, + "target": 5163, "name": "ShippingOptionService", "package": "@medusajs/medusa" }, @@ -109306,7 +111542,7 @@ } }, { - "id": 5142, + "id": 5249, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -109341,7 +111577,7 @@ } }, { - "id": 5141, + "id": 5248, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -109360,7 +111596,7 @@ } }, { - "id": 5143, + "id": 5250, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -109395,7 +111631,7 @@ } }, { - "id": 5070, + "id": 5177, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -109414,7 +111650,7 @@ } }, { - "id": 5137, + "id": 5244, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -109437,7 +111673,7 @@ } }, { - "id": 5069, + "id": 5176, "name": "methodRepository_", "variant": "declaration", "kind": 1024, @@ -109467,7 +111703,7 @@ } }, { - "id": 5063, + "id": 5170, "name": "optionRepository_", "variant": "declaration", "kind": 1024, @@ -109501,28 +111737,28 @@ { "type": "reflection", "declaration": { - "id": 5064, + "id": 5171, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5065, + "id": 5172, "name": "upsertShippingProfile", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5066, + "id": 5173, "name": "upsertShippingProfile", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5067, + "id": 5174, "name": "shippingOptionIds", "variant": "param", "kind": 32768, @@ -109536,7 +111772,7 @@ } }, { - "id": 5068, + "id": 5175, "name": "shippingProfileId", "variant": "param", "kind": 32768, @@ -109578,7 +111814,7 @@ { "title": "Methods", "children": [ - 5065 + 5172 ] } ] @@ -109588,7 +111824,7 @@ } }, { - "id": 5060, + "id": 5167, "name": "providerService_", "variant": "declaration", "kind": 1024, @@ -109598,13 +111834,13 @@ }, "type": { "type": "reference", - "target": 1484, + "target": 1538, "name": "FulfillmentProviderService", "package": "@medusajs/medusa" } }, { - "id": 5061, + "id": 5168, "name": "regionService_", "variant": "declaration", "kind": 1024, @@ -109614,13 +111850,13 @@ }, "type": { "type": "reference", - "target": 4533, + "target": 4621, "name": "RegionService", "package": "@medusajs/medusa" } }, { - "id": 5062, + "id": 5169, "name": "requirementRepository_", "variant": "declaration", "kind": 1024, @@ -109650,7 +111886,7 @@ } }, { - "id": 5138, + "id": 5245, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -109682,7 +111918,7 @@ } }, { - "id": 5139, + "id": 5246, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -109690,7 +111926,7 @@ "isProtected": true }, "getSignature": { - "id": 5140, + "id": 5247, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -109717,14 +111953,14 @@ } }, { - "id": 5121, + "id": 5228, "name": "addRequirement", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5122, + "id": 5229, "name": "addRequirement", "variant": "signature", "kind": 4096, @@ -109750,7 +111986,7 @@ }, "parameters": [ { - "id": 5123, + "id": 5230, "name": "optionId", "variant": "param", "kind": 32768, @@ -109769,7 +112005,7 @@ } }, { - "id": 5124, + "id": 5231, "name": "requirement", "variant": "param", "kind": 32768, @@ -109817,7 +112053,7 @@ ] }, { - "id": 5152, + "id": 5259, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -109826,7 +112062,7 @@ }, "signatures": [ { - "id": 5153, + "id": 5260, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -109852,14 +112088,14 @@ }, "typeParameter": [ { - "id": 5154, + "id": 5261, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 5155, + "id": 5262, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -109868,7 +112104,7 @@ ], "parameters": [ { - "id": 5156, + "id": 5263, "name": "work", "variant": "param", "kind": 32768, @@ -109884,21 +112120,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5157, + "id": 5264, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5158, + "id": 5265, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5159, + "id": 5266, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -109937,7 +112173,7 @@ } }, { - "id": 5160, + "id": 5267, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -109967,21 +112203,21 @@ { "type": "reflection", "declaration": { - "id": 5161, + "id": 5268, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5162, + "id": 5269, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5163, + "id": 5270, "name": "error", "variant": "param", "kind": 32768, @@ -110028,7 +112264,7 @@ } }, { - "id": 5164, + "id": 5271, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -110046,21 +112282,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5165, + "id": 5272, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5166, + "id": 5273, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5167, + "id": 5274, "name": "error", "variant": "param", "kind": 32768, @@ -110136,14 +112372,14 @@ } }, { - "id": 5107, + "id": 5214, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5108, + "id": 5215, "name": "create", "variant": "signature", "kind": 4096, @@ -110177,7 +112413,7 @@ }, "parameters": [ { - "id": 5109, + "id": 5216, "name": "data", "variant": "param", "kind": 32768, @@ -110225,14 +112461,14 @@ ] }, { - "id": 5094, + "id": 5201, "name": "createShippingMethod", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5095, + "id": 5202, "name": "createShippingMethod", "variant": "signature", "kind": 4096, @@ -110258,7 +112494,7 @@ }, "parameters": [ { - "id": 5096, + "id": 5203, "name": "optionId", "variant": "param", "kind": 32768, @@ -110277,7 +112513,7 @@ } }, { - "id": 5097, + "id": 5204, "name": "data", "variant": "param", "kind": 32768, @@ -110311,7 +112547,7 @@ } }, { - "id": 5098, + "id": 5205, "name": "config", "variant": "param", "kind": 32768, @@ -110359,14 +112595,14 @@ ] }, { - "id": 5118, + "id": 5225, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5119, + "id": 5226, "name": "delete", "variant": "signature", "kind": 4096, @@ -110392,7 +112628,7 @@ }, "parameters": [ { - "id": 5120, + "id": 5227, "name": "optionId", "variant": "param", "kind": 32768, @@ -110444,14 +112680,14 @@ ] }, { - "id": 5091, + "id": 5198, "name": "deleteShippingMethods", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5092, + "id": 5199, "name": "deleteShippingMethods", "variant": "signature", "kind": 4096, @@ -110477,7 +112713,7 @@ }, "parameters": [ { - "id": 5093, + "id": 5200, "name": "shippingMethods", "variant": "param", "kind": 32768, @@ -110545,14 +112781,14 @@ ] }, { - "id": 5132, + "id": 5239, "name": "getPrice_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5133, + "id": 5240, "name": "getPrice_", "variant": "signature", "kind": 4096, @@ -110578,7 +112814,7 @@ }, "parameters": [ { - "id": 5134, + "id": 5241, "name": "option", "variant": "param", "kind": 32768, @@ -110602,7 +112838,7 @@ } }, { - "id": 5135, + "id": 5242, "name": "data", "variant": "param", "kind": 32768, @@ -110636,7 +112872,7 @@ } }, { - "id": 5136, + "id": 5243, "name": "cart", "variant": "param", "kind": 32768, @@ -110697,14 +112933,14 @@ ] }, { - "id": 5075, + "id": 5182, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5076, + "id": 5183, "name": "list", "variant": "signature", "kind": 4096, @@ -110725,7 +112961,7 @@ }, "parameters": [ { - "id": 5077, + "id": 5184, "name": "selector", "variant": "param", "kind": 32768, @@ -110760,7 +112996,7 @@ } }, { - "id": 5078, + "id": 5185, "name": "config", "variant": "param", "kind": 32768, @@ -110823,14 +113059,14 @@ ] }, { - "id": 5079, + "id": 5186, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5080, + "id": 5187, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -110851,7 +113087,7 @@ }, "parameters": [ { - "id": 5081, + "id": 5188, "name": "selector", "variant": "param", "kind": 32768, @@ -110886,7 +113122,7 @@ } }, { - "id": 5082, + "id": 5189, "name": "config", "variant": "param", "kind": 32768, @@ -110958,14 +113194,14 @@ ] }, { - "id": 5125, + "id": 5232, "name": "removeRequirement", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5126, + "id": 5233, "name": "removeRequirement", "variant": "signature", "kind": 4096, @@ -110991,7 +113227,7 @@ }, "parameters": [ { - "id": 5127, + "id": 5234, "name": "requirementId", "variant": "param", "kind": 32768, @@ -111043,14 +113279,14 @@ ] }, { - "id": 5083, + "id": 5190, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5084, + "id": 5191, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -111076,7 +113312,7 @@ }, "parameters": [ { - "id": 5085, + "id": 5192, "name": "optionId", "variant": "param", "kind": 32768, @@ -111095,7 +113331,7 @@ } }, { - "id": 5086, + "id": 5193, "name": "options", "variant": "param", "kind": 32768, @@ -111155,7 +113391,7 @@ ] }, { - "id": 5147, + "id": 5254, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -111164,14 +113400,14 @@ }, "signatures": [ { - "id": 5148, + "id": 5255, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5149, + "id": 5256, "name": "err", "variant": "param", "kind": 32768, @@ -111201,14 +113437,14 @@ { "type": "reflection", "declaration": { - "id": 5150, + "id": 5257, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5151, + "id": 5258, "name": "code", "variant": "declaration", "kind": 1024, @@ -111223,7 +113459,7 @@ { "title": "Properties", "children": [ - 5151 + 5258 ] } ] @@ -111251,14 +113487,14 @@ } }, { - "id": 5114, + "id": 5221, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5115, + "id": 5222, "name": "update", "variant": "signature", "kind": 4096, @@ -111292,7 +113528,7 @@ }, "parameters": [ { - "id": 5116, + "id": 5223, "name": "optionId", "variant": "param", "kind": 32768, @@ -111311,7 +113547,7 @@ } }, { - "id": 5117, + "id": 5224, "name": "update", "variant": "param", "kind": 32768, @@ -111359,14 +113595,14 @@ ] }, { - "id": 5087, + "id": 5194, "name": "updateShippingMethod", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5088, + "id": 5195, "name": "updateShippingMethod", "variant": "signature", "kind": 4096, @@ -111392,7 +113628,7 @@ }, "parameters": [ { - "id": 5089, + "id": 5196, "name": "id", "variant": "param", "kind": 32768, @@ -111411,7 +113647,7 @@ } }, { - "id": 5090, + "id": 5197, "name": "update", "variant": "param", "kind": 32768, @@ -111468,14 +113704,14 @@ ] }, { - "id": 5128, + "id": 5235, "name": "updateShippingProfile", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5129, + "id": 5236, "name": "updateShippingProfile", "variant": "signature", "kind": 4096, @@ -111496,7 +113732,7 @@ }, "parameters": [ { - "id": 5130, + "id": 5237, "name": "optionIds", "variant": "param", "kind": 32768, @@ -111527,7 +113763,7 @@ } }, { - "id": 5131, + "id": 5238, "name": "profileId", "variant": "param", "kind": 32768, @@ -111573,7 +113809,7 @@ ] }, { - "id": 5103, + "id": 5210, "name": "validateAndMutatePrice", "variant": "declaration", "kind": 2048, @@ -111582,14 +113818,14 @@ }, "signatures": [ { - "id": 5104, + "id": 5211, "name": "validateAndMutatePrice", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5105, + "id": 5212, "name": "option", "variant": "param", "kind": 32768, @@ -111619,7 +113855,7 @@ } }, { - "id": 5106, + "id": 5213, "name": "priceInput", "variant": "param", "kind": 32768, @@ -111688,14 +113924,14 @@ ] }, { - "id": 5099, + "id": 5206, "name": "validateCartOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5100, + "id": 5207, "name": "validateCartOption", "variant": "signature", "kind": 4096, @@ -111721,7 +113957,7 @@ }, "parameters": [ { - "id": 5101, + "id": 5208, "name": "option", "variant": "param", "kind": 32768, @@ -111745,7 +113981,7 @@ } }, { - "id": 5102, + "id": 5209, "name": "cart", "variant": "param", "kind": 32768, @@ -111802,14 +114038,14 @@ ] }, { - "id": 5110, + "id": 5217, "name": "validatePriceType_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5111, + "id": 5218, "name": "validatePriceType_", "variant": "signature", "kind": 4096, @@ -111835,7 +114071,7 @@ }, "parameters": [ { - "id": 5112, + "id": 5219, "name": "priceType", "variant": "param", "kind": 32768, @@ -111859,7 +114095,7 @@ } }, { - "id": 5113, + "id": 5220, "name": "option", "variant": "param", "kind": 32768, @@ -111907,14 +114143,14 @@ ] }, { - "id": 5071, + "id": 5178, "name": "validateRequirement_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5072, + "id": 5179, "name": "validateRequirement_", "variant": "signature", "kind": 4096, @@ -111940,7 +114176,7 @@ }, "parameters": [ { - "id": 5073, + "id": 5180, "name": "requirement", "variant": "param", "kind": 32768, @@ -111956,15 +114192,15 @@ "type": { "type": "reference", "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", - "qualifiedName": "ShippingOptionRequirement" + "sourceFileName": "../../../packages/medusa/src/types/shipping-options.ts", + "qualifiedName": "ValidateRequirementTypeInput" }, - "name": "ShippingOptionRequirement", + "name": "ValidateRequirementTypeInput", "package": "@medusajs/medusa" } }, { - "id": 5074, + "id": 5181, "name": "optionId", "variant": "param", "kind": 32768, @@ -112017,21 +114253,21 @@ ] }, { - "id": 5144, + "id": 5251, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5145, + "id": 5252, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5146, + "id": 5253, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -112051,7 +114287,7 @@ ], "type": { "type": "reference", - "target": 5056, + "target": 5163, "name": "ShippingOptionService", "package": "@medusajs/medusa" }, @@ -112073,54 +114309,54 @@ { "title": "Constructors", "children": [ - 5057 + 5164 ] }, { "title": "Properties", "children": [ - 5142, - 5141, - 5143, - 5070, - 5137, - 5069, - 5063, - 5060, - 5061, - 5062, - 5138 + 5249, + 5248, + 5250, + 5177, + 5244, + 5176, + 5170, + 5167, + 5168, + 5169, + 5245 ] }, { "title": "Accessors", "children": [ - 5139 + 5246 ] }, { "title": "Methods", "children": [ - 5121, - 5152, - 5107, - 5094, - 5118, - 5091, - 5132, - 5075, - 5079, - 5125, - 5083, - 5147, - 5114, - 5087, - 5128, - 5103, - 5099, - 5110, - 5071, - 5144 + 5228, + 5259, + 5214, + 5201, + 5225, + 5198, + 5239, + 5182, + 5186, + 5232, + 5190, + 5254, + 5221, + 5194, + 5235, + 5210, + 5206, + 5217, + 5178, + 5251 ] } ], @@ -112137,7 +114373,7 @@ ] }, { - "id": 5168, + "id": 5275, "name": "ShippingProfileService", "variant": "declaration", "kind": 128, @@ -112158,21 +114394,21 @@ }, "children": [ { - "id": 5169, + "id": 5276, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 5170, + "id": 5277, "name": "new ShippingProfileService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 5171, + "id": 5278, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -112190,7 +114426,7 @@ ], "type": { "type": "reference", - "target": 5168, + "target": 5275, "name": "ShippingProfileService", "package": "@medusajs/medusa" }, @@ -112208,7 +114444,7 @@ } }, { - "id": 5317, + "id": 5429, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -112243,7 +114479,7 @@ } }, { - "id": 5316, + "id": 5428, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -112262,7 +114498,7 @@ } }, { - "id": 5318, + "id": 5430, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -112297,7 +114533,7 @@ } }, { - "id": 5174, + "id": 5281, "name": "customShippingOptionService_", "variant": "declaration", "kind": 1024, @@ -112307,13 +114543,13 @@ }, "type": { "type": "reference", - "target": 689, + "target": 696, "name": "CustomShippingOptionService", "package": "@medusajs/medusa" } }, { - "id": 5254, + "id": 5366, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -112332,7 +114568,7 @@ } }, { - "id": 5312, + "id": 5424, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -112355,7 +114591,7 @@ } }, { - "id": 5183, + "id": 5290, "name": "productRepository_", "variant": "declaration", "kind": 1024, @@ -112389,28 +114625,28 @@ { "type": "reflection", "declaration": { - "id": 5184, + "id": 5291, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5250, + "id": 5357, "name": "_applyCategoriesQuery", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5251, + "id": 5358, "name": "_applyCategoriesQuery", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5252, + "id": 5359, "name": "qb", "variant": "param", "kind": 32768, @@ -112437,14 +114673,77 @@ } }, { - "id": 5253, + "id": 5360, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "Object" + "type": "reflection", + "declaration": { + "id": 5361, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5362, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 5363, + "name": "categoryAlias", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 5365, + "name": "joinName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 5364, + "name": "where", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5362, + 5363, + 5365, + 5364 + ] + } + ] + } } } ], @@ -112472,21 +114771,21 @@ ] }, { - "id": 5238, + "id": 5345, "name": "_findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5239, + "id": 5346, "name": "_findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5240, + "id": 5347, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -112494,14 +114793,14 @@ "type": { "type": "reflection", "declaration": { - "id": 5241, + "id": 5348, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5243, + "id": 5350, "name": "idsOrOptionsWithoutRelations", "variant": "declaration", "kind": 1024, @@ -112529,7 +114828,7 @@ } }, { - "id": 5242, + "id": 5349, "name": "relations", "variant": "declaration", "kind": 1024, @@ -112543,7 +114842,7 @@ } }, { - "id": 5245, + "id": 5352, "name": "shouldCount", "variant": "declaration", "kind": 1024, @@ -112554,7 +114853,7 @@ } }, { - "id": 5244, + "id": 5351, "name": "withDeleted", "variant": "declaration", "kind": 1024, @@ -112569,10 +114868,10 @@ { "title": "Properties", "children": [ - 5243, - 5242, - 5245, - 5244 + 5350, + 5349, + 5352, + 5351 ] } ] @@ -112616,21 +114915,21 @@ ] }, { - "id": 5218, + "id": 5325, "name": "bulkAddToCollection", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5219, + "id": 5326, "name": "bulkAddToCollection", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5220, + "id": 5327, "name": "productIds", "variant": "param", "kind": 32768, @@ -112644,7 +114943,7 @@ } }, { - "id": 5221, + "id": 5328, "name": "collectionId", "variant": "param", "kind": 32768, @@ -112682,21 +114981,21 @@ ] }, { - "id": 5222, + "id": 5329, "name": "bulkRemoveFromCollection", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5223, + "id": 5330, "name": "bulkRemoveFromCollection", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5224, + "id": 5331, "name": "productIds", "variant": "param", "kind": 32768, @@ -112710,7 +115009,7 @@ } }, { - "id": 5225, + "id": 5332, "name": "collectionId", "variant": "param", "kind": 32768, @@ -112748,21 +115047,21 @@ ] }, { - "id": 5214, + "id": 5321, "name": "findOneWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5215, + "id": 5322, "name": "findOneWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5216, + "id": 5323, "name": "relations", "variant": "param", "kind": 32768, @@ -112777,7 +115076,7 @@ "defaultValue": "[]" }, { - "id": 5217, + "id": 5324, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -112818,21 +115117,21 @@ ] }, { - "id": 5209, + "id": 5316, "name": "findWithRelations", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5210, + "id": 5317, "name": "findWithRelations", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5211, + "id": 5318, "name": "relations", "variant": "param", "kind": 32768, @@ -112847,7 +115146,7 @@ "defaultValue": "[]" }, { - "id": 5212, + "id": 5319, "name": "idsOrOptionsWithoutRelations", "variant": "param", "kind": 32768, @@ -112876,7 +115175,7 @@ "defaultValue": "..." }, { - "id": 5213, + "id": 5320, "name": "withDeleted", "variant": "param", "kind": 32768, @@ -112915,21 +115214,21 @@ ] }, { - "id": 5205, + "id": 5312, "name": "findWithRelationsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5206, + "id": 5313, "name": "findWithRelationsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5207, + "id": 5314, "name": "relations", "variant": "param", "kind": 32768, @@ -112944,7 +115243,7 @@ "defaultValue": "[]" }, { - "id": 5208, + "id": 5315, "name": "idsOrOptionsWithoutRelations", "variant": "param", "kind": 32768, @@ -112997,21 +115296,21 @@ ] }, { - "id": 5231, + "id": 5338, "name": "getCategoryIdsFromInput", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5232, + "id": 5339, "name": "getCategoryIdsFromInput", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5233, + "id": 5340, "name": "categoryId", "variant": "param", "kind": 32768, @@ -113029,7 +115328,7 @@ } }, { - "id": 5234, + "id": 5341, "name": "includeCategoryChildren", "variant": "param", "kind": 32768, @@ -113063,21 +115362,21 @@ ] }, { - "id": 5235, + "id": 5342, "name": "getCategoryIdsRecursively", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5236, + "id": 5343, "name": "getCategoryIdsRecursively", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5237, + "id": 5344, "name": "productCategory", "variant": "param", "kind": 32768, @@ -113104,21 +115403,21 @@ ] }, { - "id": 5226, + "id": 5333, "name": "getFreeTextSearchResultsAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5227, + "id": 5334, "name": "getFreeTextSearchResultsAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5228, + "id": 5335, "name": "q", "variant": "param", "kind": 32768, @@ -113129,7 +115428,7 @@ } }, { - "id": 5229, + "id": 5336, "name": "options", "variant": "param", "kind": 32768, @@ -113146,7 +115445,7 @@ "defaultValue": "..." }, { - "id": 5230, + "id": 5337, "name": "relations", "variant": "param", "kind": 32768, @@ -113197,21 +115496,21 @@ ] }, { - "id": 5246, + "id": 5353, "name": "isProductInSalesChannels", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5247, + "id": 5354, "name": "isProductInSalesChannels", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5248, + "id": 5355, "name": "id", "variant": "param", "kind": 32768, @@ -113222,7 +115521,7 @@ } }, { - "id": 5249, + "id": 5356, "name": "salesChannelIds", "variant": "param", "kind": 32768, @@ -113255,21 +115554,21 @@ ] }, { - "id": 5185, + "id": 5292, "name": "queryProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5186, + "id": 5293, "name": "queryProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5187, + "id": 5294, "name": "optionsWithoutRelations", "variant": "param", "kind": 32768, @@ -113285,7 +115584,7 @@ } }, { - "id": 5188, + "id": 5295, "name": "shouldCount", "variant": "param", "kind": 32768, @@ -113333,21 +115632,21 @@ ] }, { - "id": 5189, + "id": 5296, "name": "queryProductsWithIds", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5190, + "id": 5297, "name": "queryProductsWithIds", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5191, + "id": 5298, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -113355,14 +115654,14 @@ "type": { "type": "reflection", "declaration": { - "id": 5192, + "id": 5299, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5193, + "id": 5300, "name": "entityIds", "variant": "declaration", "kind": 1024, @@ -113376,7 +115675,7 @@ } }, { - "id": 5194, + "id": 5301, "name": "groupedRelations", "variant": "declaration", "kind": 1024, @@ -113384,20 +115683,20 @@ "type": { "type": "reflection", "declaration": { - "id": 5195, + "id": 5302, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 5196, + "id": 5303, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 5197, + "id": 5304, "name": "toplevel", "variant": "param", "kind": 32768, @@ -113420,7 +115719,7 @@ } }, { - "id": 5200, + "id": 5307, "name": "order", "variant": "declaration", "kind": 1024, @@ -113430,20 +115729,20 @@ "type": { "type": "reflection", "declaration": { - "id": 5201, + "id": 5308, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 5202, + "id": 5309, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 5203, + "id": 5310, "name": "column", "variant": "param", "kind": 32768, @@ -113472,7 +115771,7 @@ } }, { - "id": 5199, + "id": 5306, "name": "select", "variant": "declaration", "kind": 1024, @@ -113497,7 +115796,7 @@ } }, { - "id": 5204, + "id": 5311, "name": "where", "variant": "declaration", "kind": 1024, @@ -113526,7 +115825,7 @@ } }, { - "id": 5198, + "id": 5305, "name": "withDeleted", "variant": "declaration", "kind": 1024, @@ -113543,12 +115842,12 @@ { "title": "Properties", "children": [ - 5193, - 5194, - 5200, - 5199, - 5204, - 5198 + 5300, + 5301, + 5307, + 5306, + 5311, + 5305 ] } ] @@ -113587,19 +115886,19 @@ { "title": "Methods", "children": [ - 5250, - 5238, - 5218, - 5222, - 5214, - 5209, - 5205, - 5231, - 5235, - 5226, - 5246, - 5185, - 5189 + 5357, + 5345, + 5325, + 5329, + 5321, + 5316, + 5312, + 5338, + 5342, + 5333, + 5353, + 5292, + 5296 ] } ] @@ -113609,7 +115908,7 @@ } }, { - "id": 5172, + "id": 5279, "name": "productService_", "variant": "declaration", "kind": 1024, @@ -113619,13 +115918,13 @@ }, "type": { "type": "reference", - "target": 3441, + "target": 3495, "name": "ProductService", "package": "@medusajs/medusa" } }, { - "id": 5173, + "id": 5280, "name": "shippingOptionService_", "variant": "declaration", "kind": 1024, @@ -113635,13 +115934,13 @@ }, "type": { "type": "reference", - "target": 5056, + "target": 5163, "name": "ShippingOptionService", "package": "@medusajs/medusa" } }, { - "id": 5175, + "id": 5282, "name": "shippingProfileRepository_", "variant": "declaration", "kind": 1024, @@ -113675,28 +115974,28 @@ { "type": "reflection", "declaration": { - "id": 5176, + "id": 5283, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5177, + "id": 5284, "name": "findByProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5178, + "id": 5285, "name": "findByProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5179, + "id": 5286, "name": "productIds", "variant": "param", "kind": 32768, @@ -113729,20 +116028,20 @@ { "type": "reflection", "declaration": { - "id": 5180, + "id": 5287, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 5181, + "id": 5288, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 5182, + "id": 5289, "name": "product_id", "variant": "param", "kind": 32768, @@ -113780,7 +116079,7 @@ { "title": "Methods", "children": [ - 5177 + 5284 ] } ] @@ -113790,7 +116089,7 @@ } }, { - "id": 5313, + "id": 5425, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -113822,7 +116121,7 @@ } }, { - "id": 5314, + "id": 5426, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -113830,7 +116129,7 @@ "isProtected": true }, "getSignature": { - "id": 5315, + "id": 5427, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -113857,14 +116156,14 @@ } }, { - "id": 5290, + "id": 5402, "name": "addProduct", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5291, + "id": 5403, "name": "addProduct", "variant": "signature", "kind": 4096, @@ -113883,7 +116182,7 @@ "kind": "inline-tag", "tag": "@link", "text": "addProducts", - "target": 5294, + "target": 5406, "tsLinkText": "" }, { @@ -113896,7 +116195,7 @@ }, "parameters": [ { - "id": 5292, + "id": 5404, "name": "profileId", "variant": "param", "kind": 32768, @@ -113907,7 +116206,7 @@ } }, { - "id": 5293, + "id": 5405, "name": "productId", "variant": "param", "kind": 32768, @@ -113954,14 +116253,14 @@ ] }, { - "id": 5294, + "id": 5406, "name": "addProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5295, + "id": 5407, "name": "addProducts", "variant": "signature", "kind": 4096, @@ -113987,7 +116286,7 @@ }, "parameters": [ { - "id": 5296, + "id": 5408, "name": "profileId", "variant": "param", "kind": 32768, @@ -114006,7 +116305,7 @@ } }, { - "id": 5297, + "id": 5409, "name": "productId", "variant": "param", "kind": 32768, @@ -114061,14 +116360,14 @@ ] }, { - "id": 5302, + "id": 5414, "name": "addShippingOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5303, + "id": 5415, "name": "addShippingOption", "variant": "signature", "kind": 4096, @@ -114094,7 +116393,7 @@ }, "parameters": [ { - "id": 5304, + "id": 5416, "name": "profileId", "variant": "param", "kind": 32768, @@ -114113,7 +116412,7 @@ } }, { - "id": 5305, + "id": 5417, "name": "optionId", "variant": "param", "kind": 32768, @@ -114168,7 +116467,7 @@ ] }, { - "id": 5327, + "id": 5439, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -114177,7 +116476,7 @@ }, "signatures": [ { - "id": 5328, + "id": 5440, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -114203,14 +116502,14 @@ }, "typeParameter": [ { - "id": 5329, + "id": 5441, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 5330, + "id": 5442, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -114219,7 +116518,7 @@ ], "parameters": [ { - "id": 5331, + "id": 5443, "name": "work", "variant": "param", "kind": 32768, @@ -114235,21 +116534,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5332, + "id": 5444, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5333, + "id": 5445, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5334, + "id": 5446, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -114288,7 +116587,7 @@ } }, { - "id": 5335, + "id": 5447, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -114318,21 +116617,21 @@ { "type": "reflection", "declaration": { - "id": 5336, + "id": 5448, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5337, + "id": 5449, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5338, + "id": 5450, "name": "error", "variant": "param", "kind": 32768, @@ -114379,7 +116678,7 @@ } }, { - "id": 5339, + "id": 5451, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -114397,21 +116696,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5340, + "id": 5452, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5341, + "id": 5453, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5342, + "id": 5454, "name": "error", "variant": "param", "kind": 32768, @@ -114487,14 +116786,14 @@ } }, { - "id": 5280, + "id": 5392, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5281, + "id": 5393, "name": "create", "variant": "signature", "kind": 4096, @@ -114520,7 +116819,7 @@ }, "parameters": [ { - "id": 5282, + "id": 5394, "name": "profile", "variant": "param", "kind": 32768, @@ -114568,14 +116867,14 @@ ] }, { - "id": 5274, + "id": 5386, "name": "createDefault", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5275, + "id": 5387, "name": "createDefault", "variant": "signature", "kind": 4096, @@ -114623,14 +116922,14 @@ ] }, { - "id": 5278, + "id": 5390, "name": "createGiftCardDefault", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5279, + "id": 5391, "name": "createGiftCardDefault", "variant": "signature", "kind": 4096, @@ -114678,14 +116977,14 @@ ] }, { - "id": 5287, + "id": 5399, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5288, + "id": 5400, "name": "delete", "variant": "signature", "kind": 4096, @@ -114711,7 +117010,7 @@ }, "parameters": [ { - "id": 5289, + "id": 5401, "name": "profileId", "variant": "param", "kind": 32768, @@ -114749,14 +117048,14 @@ ] }, { - "id": 5306, + "id": 5418, "name": "fetchCartOptions", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5307, + "id": 5419, "name": "fetchCartOptions", "variant": "signature", "kind": 4096, @@ -114782,7 +117081,7 @@ }, "parameters": [ { - "id": 5308, + "id": 5420, "name": "cart", "variant": "param", "kind": 32768, @@ -114828,21 +117127,21 @@ ] }, { - "id": 5259, + "id": 5371, "name": "getMapProfileIdsByProductIds", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5260, + "id": 5372, "name": "getMapProfileIdsByProductIds", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5261, + "id": 5373, "name": "productIds", "variant": "param", "kind": 32768, @@ -114890,7 +117189,7 @@ ] }, { - "id": 5309, + "id": 5421, "name": "getProfilesInCart", "variant": "declaration", "kind": 2048, @@ -114899,7 +117198,7 @@ }, "signatures": [ { - "id": 5310, + "id": 5422, "name": "getProfilesInCart", "variant": "signature", "kind": 4096, @@ -114925,7 +117224,7 @@ }, "parameters": [ { - "id": 5311, + "id": 5423, "name": "cart", "variant": "param", "kind": 32768, @@ -114971,14 +117270,14 @@ ] }, { - "id": 5255, + "id": 5367, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5256, + "id": 5368, "name": "list", "variant": "signature", "kind": 4096, @@ -114999,7 +117298,7 @@ }, "parameters": [ { - "id": 5257, + "id": 5369, "name": "selector", "variant": "param", "kind": 32768, @@ -115035,7 +117334,7 @@ "defaultValue": "{}" }, { - "id": 5258, + "id": 5370, "name": "config", "variant": "param", "kind": 32768, @@ -115098,14 +117397,14 @@ ] }, { - "id": 5298, + "id": 5410, "name": "removeProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5299, + "id": 5411, "name": "removeProducts", "variant": "signature", "kind": 4096, @@ -115131,7 +117430,7 @@ }, "parameters": [ { - "id": 5300, + "id": 5412, "name": "profileId", "variant": "param", "kind": 32768, @@ -115159,7 +117458,7 @@ } }, { - "id": 5301, + "id": 5413, "name": "productId", "variant": "param", "kind": 32768, @@ -115223,14 +117522,14 @@ ] }, { - "id": 5262, + "id": 5374, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5263, + "id": 5375, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -115256,7 +117555,7 @@ }, "parameters": [ { - "id": 5264, + "id": 5376, "name": "profileId", "variant": "param", "kind": 32768, @@ -115275,7 +117574,7 @@ } }, { - "id": 5265, + "id": 5377, "name": "options", "variant": "param", "kind": 32768, @@ -115335,14 +117634,14 @@ ] }, { - "id": 5272, + "id": 5384, "name": "retrieveDefault", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5273, + "id": 5385, "name": "retrieveDefault", "variant": "signature", "kind": 4096, @@ -115380,21 +117679,21 @@ ] }, { - "id": 5266, + "id": 5378, "name": "retrieveForProducts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5267, + "id": 5379, "name": "retrieveForProducts", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5268, + "id": 5380, "name": "productIds", "variant": "param", "kind": 32768, @@ -115427,20 +117726,20 @@ { "type": "reflection", "declaration": { - "id": 5269, + "id": 5381, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 5270, + "id": 5382, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 5271, + "id": 5383, "name": "product_id", "variant": "param", "kind": 32768, @@ -115474,14 +117773,14 @@ ] }, { - "id": 5276, + "id": 5388, "name": "retrieveGiftCardDefault", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5277, + "id": 5389, "name": "retrieveGiftCardDefault", "variant": "signature", "kind": 4096, @@ -115538,7 +117837,7 @@ ] }, { - "id": 5322, + "id": 5434, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -115547,14 +117846,14 @@ }, "signatures": [ { - "id": 5323, + "id": 5435, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5324, + "id": 5436, "name": "err", "variant": "param", "kind": 32768, @@ -115584,14 +117883,14 @@ { "type": "reflection", "declaration": { - "id": 5325, + "id": 5437, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5326, + "id": 5438, "name": "code", "variant": "declaration", "kind": 1024, @@ -115606,7 +117905,7 @@ { "title": "Properties", "children": [ - 5326 + 5438 ] } ] @@ -115634,14 +117933,14 @@ } }, { - "id": 5283, + "id": 5395, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5284, + "id": 5396, "name": "update", "variant": "signature", "kind": 4096, @@ -115683,7 +117982,7 @@ }, "parameters": [ { - "id": 5285, + "id": 5397, "name": "profileId", "variant": "param", "kind": 32768, @@ -115702,7 +118001,7 @@ } }, { - "id": 5286, + "id": 5398, "name": "update", "variant": "param", "kind": 32768, @@ -115750,21 +118049,21 @@ ] }, { - "id": 5319, + "id": 5431, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5320, + "id": 5432, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5321, + "id": 5433, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -115784,7 +118083,7 @@ ], "type": { "type": "reference", - "target": 5168, + "target": 5275, "name": "ShippingProfileService", "package": "@medusajs/medusa" }, @@ -115806,54 +118105,54 @@ { "title": "Constructors", "children": [ - 5169 + 5276 ] }, { "title": "Properties", "children": [ - 5317, - 5316, - 5318, - 5174, - 5254, - 5312, - 5183, - 5172, - 5173, - 5175, - 5313 + 5429, + 5428, + 5430, + 5281, + 5366, + 5424, + 5290, + 5279, + 5280, + 5282, + 5425 ] }, { "title": "Accessors", "children": [ - 5314 + 5426 ] }, { "title": "Methods", "children": [ - 5290, - 5294, - 5302, - 5327, - 5280, - 5274, - 5278, - 5287, - 5306, - 5259, - 5309, - 5255, - 5298, - 5262, - 5272, - 5266, - 5276, - 5322, - 5283, - 5319 + 5402, + 5406, + 5414, + 5439, + 5392, + 5386, + 5390, + 5399, + 5418, + 5371, + 5421, + 5367, + 5410, + 5374, + 5384, + 5378, + 5388, + 5434, + 5395, + 5431 ] } ], @@ -115870,7 +118169,7 @@ ] }, { - "id": 5343, + "id": 5455, "name": "StagedJobService", "variant": "declaration", "kind": 128, @@ -115885,21 +118184,21 @@ }, "children": [ { - "id": 5344, + "id": 5456, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 5345, + "id": 5457, "name": "new StagedJobService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 5346, + "id": 5458, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -115917,7 +118216,7 @@ ], "type": { "type": "reference", - "target": 5343, + "target": 5455, "name": "StagedJobService", "package": "@medusajs/medusa" }, @@ -115935,7 +118234,7 @@ } }, { - "id": 5366, + "id": 5478, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -115970,7 +118269,7 @@ } }, { - "id": 5365, + "id": 5477, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -115989,7 +118288,7 @@ } }, { - "id": 5367, + "id": 5479, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -116024,7 +118323,7 @@ } }, { - "id": 5361, + "id": 5473, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -116047,7 +118346,7 @@ } }, { - "id": 5347, + "id": 5459, "name": "stagedJobRepository_", "variant": "declaration", "kind": 1024, @@ -116080,28 +118379,28 @@ { "type": "reflection", "declaration": { - "id": 5348, + "id": 5460, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5349, + "id": 5461, "name": "insertBulk", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5350, + "id": 5462, "name": "insertBulk", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5351, + "id": 5463, "name": "jobToCreates", "variant": "param", "kind": 32768, @@ -116162,7 +118461,7 @@ { "title": "Methods", "children": [ - 5349 + 5461 ] } ] @@ -116172,7 +118471,7 @@ } }, { - "id": 5362, + "id": 5474, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -116204,7 +118503,7 @@ } }, { - "id": 5363, + "id": 5475, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -116212,7 +118511,7 @@ "isProtected": true }, "getSignature": { - "id": 5364, + "id": 5476, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -116239,7 +118538,7 @@ } }, { - "id": 5376, + "id": 5488, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -116248,7 +118547,7 @@ }, "signatures": [ { - "id": 5377, + "id": 5489, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -116274,14 +118573,14 @@ }, "typeParameter": [ { - "id": 5378, + "id": 5490, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 5379, + "id": 5491, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -116290,7 +118589,7 @@ ], "parameters": [ { - "id": 5380, + "id": 5492, "name": "work", "variant": "param", "kind": 32768, @@ -116306,21 +118605,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5381, + "id": 5493, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5382, + "id": 5494, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5383, + "id": 5495, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -116359,7 +118658,7 @@ } }, { - "id": 5384, + "id": 5496, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -116389,21 +118688,21 @@ { "type": "reflection", "declaration": { - "id": 5385, + "id": 5497, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5386, + "id": 5498, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5387, + "id": 5499, "name": "error", "variant": "param", "kind": 32768, @@ -116450,7 +118749,7 @@ } }, { - "id": 5388, + "id": 5500, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -116468,21 +118767,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5389, + "id": 5501, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5390, + "id": 5502, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5391, + "id": 5503, "name": "error", "variant": "param", "kind": 32768, @@ -116558,21 +118857,21 @@ } }, { - "id": 5358, + "id": 5470, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5359, + "id": 5471, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5360, + "id": 5472, "name": "data", "variant": "param", "kind": 32768, @@ -116644,21 +118943,21 @@ ] }, { - "id": 5355, + "id": 5467, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5356, + "id": 5468, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5357, + "id": 5469, "name": "stagedJobIds", "variant": "param", "kind": 32768, @@ -116700,21 +118999,21 @@ ] }, { - "id": 5352, + "id": 5464, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5353, + "id": 5465, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5354, + "id": 5466, "name": "config", "variant": "param", "kind": 32768, @@ -116768,7 +119067,7 @@ ] }, { - "id": 5371, + "id": 5483, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -116777,14 +119076,14 @@ }, "signatures": [ { - "id": 5372, + "id": 5484, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5373, + "id": 5485, "name": "err", "variant": "param", "kind": 32768, @@ -116814,14 +119113,14 @@ { "type": "reflection", "declaration": { - "id": 5374, + "id": 5486, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5375, + "id": 5487, "name": "code", "variant": "declaration", "kind": 1024, @@ -116836,7 +119135,7 @@ { "title": "Properties", "children": [ - 5375 + 5487 ] } ] @@ -116864,21 +119163,21 @@ } }, { - "id": 5368, + "id": 5480, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5369, + "id": 5481, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5370, + "id": 5482, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -116898,7 +119197,7 @@ ], "type": { "type": "reference", - "target": 5343, + "target": 5455, "name": "StagedJobService", "package": "@medusajs/medusa" }, @@ -116920,35 +119219,35 @@ { "title": "Constructors", "children": [ - 5344 + 5456 ] }, { "title": "Properties", "children": [ - 5366, - 5365, - 5367, - 5361, - 5347, - 5362 + 5478, + 5477, + 5479, + 5473, + 5459, + 5474 ] }, { "title": "Accessors", "children": [ - 5363 + 5475 ] }, { "title": "Methods", "children": [ - 5376, - 5358, - 5355, - 5352, - 5371, - 5368 + 5488, + 5470, + 5467, + 5464, + 5483, + 5480 ] } ], @@ -116965,7 +119264,7 @@ ] }, { - "id": 5392, + "id": 5504, "name": "StoreService", "variant": "declaration", "kind": 128, @@ -116980,21 +119279,21 @@ }, "children": [ { - "id": 5393, + "id": 5505, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 5394, + "id": 5506, "name": "new StoreService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 5395, + "id": 5507, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -117012,7 +119311,7 @@ ], "type": { "type": "reference", - "target": 5392, + "target": 5504, "name": "StoreService", "package": "@medusajs/medusa" }, @@ -117030,7 +119329,7 @@ } }, { - "id": 5421, + "id": 5533, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -117065,7 +119364,7 @@ } }, { - "id": 5420, + "id": 5532, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -117084,7 +119383,7 @@ } }, { - "id": 5422, + "id": 5534, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -117119,7 +119418,7 @@ } }, { - "id": 5397, + "id": 5509, "name": "currencyRepository_", "variant": "declaration", "kind": 1024, @@ -117149,7 +119448,7 @@ } }, { - "id": 5398, + "id": 5510, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -117159,13 +119458,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 5416, + "id": 5528, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -117188,7 +119487,7 @@ } }, { - "id": 5396, + "id": 5508, "name": "storeRepository_", "variant": "declaration", "kind": 1024, @@ -117218,7 +119517,7 @@ } }, { - "id": 5417, + "id": 5529, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -117250,7 +119549,7 @@ } }, { - "id": 5418, + "id": 5530, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -117258,7 +119557,7 @@ "isProtected": true }, "getSignature": { - "id": 5419, + "id": 5531, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -117285,14 +119584,14 @@ } }, { - "id": 5410, + "id": 5522, "name": "addCurrency", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5411, + "id": 5523, "name": "addCurrency", "variant": "signature", "kind": 4096, @@ -117318,7 +119617,7 @@ }, "parameters": [ { - "id": 5412, + "id": 5524, "name": "code", "variant": "param", "kind": 32768, @@ -117361,7 +119660,7 @@ ] }, { - "id": 5431, + "id": 5543, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -117370,7 +119669,7 @@ }, "signatures": [ { - "id": 5432, + "id": 5544, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -117396,14 +119695,14 @@ }, "typeParameter": [ { - "id": 5433, + "id": 5545, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 5434, + "id": 5546, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -117412,7 +119711,7 @@ ], "parameters": [ { - "id": 5435, + "id": 5547, "name": "work", "variant": "param", "kind": 32768, @@ -117428,21 +119727,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5436, + "id": 5548, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5437, + "id": 5549, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5438, + "id": 5550, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -117481,7 +119780,7 @@ } }, { - "id": 5439, + "id": 5551, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -117511,21 +119810,21 @@ { "type": "reflection", "declaration": { - "id": 5440, + "id": 5552, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5441, + "id": 5553, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5442, + "id": 5554, "name": "error", "variant": "param", "kind": 32768, @@ -117572,7 +119871,7 @@ } }, { - "id": 5443, + "id": 5555, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -117590,21 +119889,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5444, + "id": 5556, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5445, + "id": 5557, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5446, + "id": 5558, "name": "error", "variant": "param", "kind": 32768, @@ -117680,14 +119979,14 @@ } }, { - "id": 5399, + "id": 5511, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5400, + "id": 5512, "name": "create", "variant": "signature", "kind": 4096, @@ -117735,7 +120034,7 @@ ] }, { - "id": 5404, + "id": 5516, "name": "getDefaultCurrency_", "variant": "declaration", "kind": 2048, @@ -117744,14 +120043,14 @@ }, "signatures": [ { - "id": 5405, + "id": 5517, "name": "getDefaultCurrency_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5406, + "id": 5518, "name": "code", "variant": "param", "kind": 32768, @@ -117786,14 +120085,14 @@ ] }, { - "id": 5413, + "id": 5525, "name": "removeCurrency", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5414, + "id": 5526, "name": "removeCurrency", "variant": "signature", "kind": 4096, @@ -117819,7 +120118,7 @@ }, "parameters": [ { - "id": 5415, + "id": 5527, "name": "code", "variant": "param", "kind": 32768, @@ -117857,14 +120156,14 @@ ] }, { - "id": 5401, + "id": 5513, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5402, + "id": 5514, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -117890,7 +120189,7 @@ }, "parameters": [ { - "id": 5403, + "id": 5515, "name": "config", "variant": "param", "kind": 32768, @@ -117950,7 +120249,7 @@ ] }, { - "id": 5426, + "id": 5538, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -117959,14 +120258,14 @@ }, "signatures": [ { - "id": 5427, + "id": 5539, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5428, + "id": 5540, "name": "err", "variant": "param", "kind": 32768, @@ -117996,14 +120295,14 @@ { "type": "reflection", "declaration": { - "id": 5429, + "id": 5541, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5430, + "id": 5542, "name": "code", "variant": "declaration", "kind": 1024, @@ -118018,7 +120317,7 @@ { "title": "Properties", "children": [ - 5430 + 5542 ] } ] @@ -118046,14 +120345,14 @@ } }, { - "id": 5407, + "id": 5519, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5408, + "id": 5520, "name": "update", "variant": "signature", "kind": 4096, @@ -118079,7 +120378,7 @@ }, "parameters": [ { - "id": 5409, + "id": 5521, "name": "data", "variant": "param", "kind": 32768, @@ -118127,21 +120426,21 @@ ] }, { - "id": 5423, + "id": 5535, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5424, + "id": 5536, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5425, + "id": 5537, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -118161,7 +120460,7 @@ ], "type": { "type": "reference", - "target": 5392, + "target": 5504, "name": "StoreService", "package": "@medusajs/medusa" }, @@ -118183,40 +120482,40 @@ { "title": "Constructors", "children": [ - 5393 + 5505 ] }, { "title": "Properties", "children": [ - 5421, - 5420, - 5422, - 5397, - 5398, - 5416, - 5396, - 5417 + 5533, + 5532, + 5534, + 5509, + 5510, + 5528, + 5508, + 5529 ] }, { "title": "Accessors", "children": [ - 5418 + 5530 ] }, { "title": "Methods", "children": [ - 5410, - 5431, - 5399, - 5404, - 5413, - 5401, - 5426, - 5407, - 5423 + 5522, + 5543, + 5511, + 5516, + 5525, + 5513, + 5538, + 5519, + 5535 ] } ], @@ -118233,28 +120532,28 @@ ] }, { - "id": 5447, + "id": 5559, "name": "StrategyResolverService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 5448, + "id": 5560, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 5449, + "id": 5561, "name": "new StrategyResolverService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 5450, + "id": 5562, "name": "container", "variant": "param", "kind": 32768, @@ -118272,7 +120571,7 @@ ], "type": { "type": "reference", - "target": 5447, + "target": 5559, "name": "default", "package": "@medusajs/medusa" }, @@ -118290,7 +120589,7 @@ } }, { - "id": 5460, + "id": 5572, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -118325,7 +120624,7 @@ } }, { - "id": 5459, + "id": 5571, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -118344,7 +120643,7 @@ } }, { - "id": 5461, + "id": 5573, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -118379,7 +120678,7 @@ } }, { - "id": 5451, + "id": 5563, "name": "container", "variant": "declaration", "kind": 1024, @@ -118398,7 +120697,7 @@ } }, { - "id": 5455, + "id": 5567, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -118421,7 +120720,7 @@ } }, { - "id": 5456, + "id": 5568, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -118453,7 +120752,7 @@ } }, { - "id": 5457, + "id": 5569, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -118461,7 +120760,7 @@ "isProtected": true }, "getSignature": { - "id": 5458, + "id": 5570, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -118488,7 +120787,7 @@ } }, { - "id": 5470, + "id": 5582, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -118497,7 +120796,7 @@ }, "signatures": [ { - "id": 5471, + "id": 5583, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -118523,14 +120822,14 @@ }, "typeParameter": [ { - "id": 5472, + "id": 5584, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 5473, + "id": 5585, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -118539,7 +120838,7 @@ ], "parameters": [ { - "id": 5474, + "id": 5586, "name": "work", "variant": "param", "kind": 32768, @@ -118555,21 +120854,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5475, + "id": 5587, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5476, + "id": 5588, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5477, + "id": 5589, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -118608,7 +120907,7 @@ } }, { - "id": 5478, + "id": 5590, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -118638,21 +120937,21 @@ { "type": "reflection", "declaration": { - "id": 5479, + "id": 5591, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5480, + "id": 5592, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5481, + "id": 5593, "name": "error", "variant": "param", "kind": 32768, @@ -118699,7 +120998,7 @@ } }, { - "id": 5482, + "id": 5594, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -118717,21 +121016,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5483, + "id": 5595, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5484, + "id": 5596, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5485, + "id": 5597, "name": "error", "variant": "param", "kind": 32768, @@ -118807,21 +121106,21 @@ } }, { - "id": 5452, + "id": 5564, "name": "resolveBatchJobByType", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5453, + "id": 5565, "name": "resolveBatchJobByType", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5454, + "id": 5566, "name": "type", "variant": "param", "kind": 32768, @@ -118845,7 +121144,7 @@ ] }, { - "id": 5465, + "id": 5577, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -118854,14 +121153,14 @@ }, "signatures": [ { - "id": 5466, + "id": 5578, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5467, + "id": 5579, "name": "err", "variant": "param", "kind": 32768, @@ -118891,14 +121190,14 @@ { "type": "reflection", "declaration": { - "id": 5468, + "id": 5580, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5469, + "id": 5581, "name": "code", "variant": "declaration", "kind": 1024, @@ -118913,7 +121212,7 @@ { "title": "Properties", "children": [ - 5469 + 5581 ] } ] @@ -118941,21 +121240,21 @@ } }, { - "id": 5462, + "id": 5574, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5463, + "id": 5575, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5464, + "id": 5576, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -118975,7 +121274,7 @@ ], "type": { "type": "reference", - "target": 5447, + "target": 5559, "name": "default", "package": "@medusajs/medusa" }, @@ -118997,33 +121296,33 @@ { "title": "Constructors", "children": [ - 5448 + 5560 ] }, { "title": "Properties", "children": [ - 5460, - 5459, - 5461, - 5451, - 5455, - 5456 + 5572, + 5571, + 5573, + 5563, + 5567, + 5568 ] }, { "title": "Accessors", "children": [ - 5457 + 5569 ] }, { "title": "Methods", "children": [ - 5470, - 5452, - 5465, - 5462 + 5582, + 5564, + 5577, + 5574 ] } ], @@ -119040,7 +121339,7 @@ ] }, { - "id": 5486, + "id": 5598, "name": "SwapService", "variant": "declaration", "kind": 128, @@ -119055,21 +121354,21 @@ }, "children": [ { - "id": 5498, + "id": 5610, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 5499, + "id": 5611, "name": "new SwapService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 5500, + "id": 5612, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -119087,7 +121386,7 @@ ], "type": { "type": "reference", - "target": 5486, + "target": 5598, "name": "SwapService", "package": "@medusajs/medusa" }, @@ -119105,7 +121404,7 @@ } }, { - "id": 5610, + "id": 5722, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -119140,7 +121439,7 @@ } }, { - "id": 5609, + "id": 5721, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -119159,7 +121458,7 @@ } }, { - "id": 5611, + "id": 5723, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -119194,7 +121493,7 @@ } }, { - "id": 5502, + "id": 5614, "name": "cartService_", "variant": "declaration", "kind": 1024, @@ -119204,13 +121503,13 @@ }, "type": { "type": "reference", - "target": 198, + "target": 199, "name": "CartService", "package": "@medusajs/medusa" } }, { - "id": 5512, + "id": 5624, "name": "customShippingOptionService_", "variant": "declaration", "kind": 1024, @@ -119220,13 +121519,13 @@ }, "type": { "type": "reference", - "target": 689, + "target": 696, "name": "CustomShippingOptionService", "package": "@medusajs/medusa" } }, { - "id": 5503, + "id": 5615, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -119236,13 +121535,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 5508, + "id": 5620, "name": "fulfillmentService_", "variant": "declaration", "kind": 1024, @@ -119252,13 +121551,13 @@ }, "type": { "type": "reference", - "target": 1404, + "target": 1458, "name": "FulfillmentService", "package": "@medusajs/medusa" } }, { - "id": 5511, + "id": 5623, "name": "lineItemAdjustmentService_", "variant": "declaration", "kind": 1024, @@ -119268,13 +121567,13 @@ }, "type": { "type": "reference", - "target": 1850, + "target": 1904, "name": "LineItemAdjustmentService", "package": "@medusajs/medusa" } }, { - "id": 5507, + "id": 5619, "name": "lineItemService_", "variant": "declaration", "kind": 1024, @@ -119284,13 +121583,13 @@ }, "type": { "type": "reference", - "target": 1713, + "target": 1767, "name": "LineItemService", "package": "@medusajs/medusa" } }, { - "id": 5605, + "id": 5717, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -119313,7 +121612,7 @@ } }, { - "id": 5504, + "id": 5616, "name": "orderService_", "variant": "declaration", "kind": 1024, @@ -119323,13 +121622,13 @@ }, "type": { "type": "reference", - "target": 2331, + "target": 2385, "name": "OrderService", "package": "@medusajs/medusa" } }, { - "id": 5510, + "id": 5622, "name": "paymentProviderService_", "variant": "declaration", "kind": 1024, @@ -119339,13 +121638,13 @@ }, "type": { "type": "reference", - "target": 2919, + "target": 2973, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 5513, + "id": 5625, "name": "productVariantInventoryService_", "variant": "declaration", "kind": 1024, @@ -119355,13 +121654,13 @@ }, "type": { "type": "reference", - "target": 4409, + "target": 4497, "name": "ProductVariantInventoryService", "package": "@medusajs/medusa" } }, { - "id": 5505, + "id": 5617, "name": "returnService_", "variant": "declaration", "kind": 1024, @@ -119371,13 +121670,13 @@ }, "type": { "type": "reference", - "target": 4652, + "target": 4740, "name": "ReturnService", "package": "@medusajs/medusa" } }, { - "id": 5509, + "id": 5621, "name": "shippingOptionService_", "variant": "declaration", "kind": 1024, @@ -119387,13 +121686,13 @@ }, "type": { "type": "reference", - "target": 5056, + "target": 5163, "name": "ShippingOptionService", "package": "@medusajs/medusa" } }, { - "id": 5501, + "id": 5613, "name": "swapRepository_", "variant": "declaration", "kind": 1024, @@ -119423,7 +121722,7 @@ } }, { - "id": 5506, + "id": 5618, "name": "totalsService_", "variant": "declaration", "kind": 1024, @@ -119433,13 +121732,13 @@ }, "type": { "type": "reference", - "target": 5964, + "target": 6081, "name": "TotalsService", "package": "@medusajs/medusa" } }, { - "id": 5606, + "id": 5718, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -119471,7 +121770,7 @@ } }, { - "id": 5487, + "id": 5599, "name": "Events", "variant": "declaration", "kind": 1024, @@ -119481,14 +121780,14 @@ "type": { "type": "reflection", "declaration": { - "id": 5488, + "id": 5600, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5489, + "id": 5601, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -119500,7 +121799,7 @@ "defaultValue": "\"swap.created\"" }, { - "id": 5497, + "id": 5609, "name": "FULFILLMENT_CREATED", "variant": "declaration", "kind": 1024, @@ -119512,7 +121811,7 @@ "defaultValue": "\"swap.fulfillment_created\"" }, { - "id": 5493, + "id": 5605, "name": "PAYMENT_CAPTURED", "variant": "declaration", "kind": 1024, @@ -119524,7 +121823,7 @@ "defaultValue": "\"swap.payment_captured\"" }, { - "id": 5494, + "id": 5606, "name": "PAYMENT_CAPTURE_FAILED", "variant": "declaration", "kind": 1024, @@ -119536,7 +121835,7 @@ "defaultValue": "\"swap.payment_capture_failed\"" }, { - "id": 5492, + "id": 5604, "name": "PAYMENT_COMPLETED", "variant": "declaration", "kind": 1024, @@ -119548,7 +121847,7 @@ "defaultValue": "\"swap.payment_completed\"" }, { - "id": 5495, + "id": 5607, "name": "PROCESS_REFUND_FAILED", "variant": "declaration", "kind": 1024, @@ -119560,7 +121859,7 @@ "defaultValue": "\"swap.process_refund_failed\"" }, { - "id": 5490, + "id": 5602, "name": "RECEIVED", "variant": "declaration", "kind": 1024, @@ -119572,7 +121871,7 @@ "defaultValue": "\"swap.received\"" }, { - "id": 5496, + "id": 5608, "name": "REFUND_PROCESSED", "variant": "declaration", "kind": 1024, @@ -119584,7 +121883,7 @@ "defaultValue": "\"swap.refund_processed\"" }, { - "id": 5491, + "id": 5603, "name": "SHIPMENT_CREATED", "variant": "declaration", "kind": 1024, @@ -119600,15 +121899,15 @@ { "title": "Properties", "children": [ - 5489, - 5497, - 5493, - 5494, - 5492, - 5495, - 5490, - 5496, - 5491 + 5601, + 5609, + 5605, + 5606, + 5604, + 5607, + 5602, + 5608, + 5603 ] } ] @@ -119617,7 +121916,7 @@ "defaultValue": "..." }, { - "id": 5607, + "id": 5719, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -119625,7 +121924,7 @@ "isProtected": true }, "getSignature": { - "id": 5608, + "id": 5720, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -119652,7 +121951,7 @@ } }, { - "id": 5602, + "id": 5714, "name": "areReturnItemsValid", "variant": "declaration", "kind": 2048, @@ -119661,14 +121960,14 @@ }, "signatures": [ { - "id": 5603, + "id": 5715, "name": "areReturnItemsValid", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5604, + "id": 5716, "name": "returnItems", "variant": "param", "kind": 32768, @@ -119732,7 +122031,7 @@ ] }, { - "id": 5620, + "id": 5732, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -119741,7 +122040,7 @@ }, "signatures": [ { - "id": 5621, + "id": 5733, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -119767,14 +122066,14 @@ }, "typeParameter": [ { - "id": 5622, + "id": 5734, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 5623, + "id": 5735, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -119783,7 +122082,7 @@ ], "parameters": [ { - "id": 5624, + "id": 5736, "name": "work", "variant": "param", "kind": 32768, @@ -119799,21 +122098,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5625, + "id": 5737, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5626, + "id": 5738, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5627, + "id": 5739, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -119852,7 +122151,7 @@ } }, { - "id": 5628, + "id": 5740, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -119882,21 +122181,21 @@ { "type": "reflection", "declaration": { - "id": 5629, + "id": 5741, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5630, + "id": 5742, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5631, + "id": 5743, "name": "error", "variant": "param", "kind": 32768, @@ -119943,7 +122242,7 @@ } }, { - "id": 5632, + "id": 5744, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -119961,21 +122260,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5633, + "id": 5745, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5634, + "id": 5746, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5635, + "id": 5747, "name": "error", "variant": "param", "kind": 32768, @@ -120051,14 +122350,14 @@ } }, { - "id": 5577, + "id": 5689, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5578, + "id": 5690, "name": "cancel", "variant": "signature", "kind": 4096, @@ -120084,7 +122383,7 @@ }, "parameters": [ { - "id": 5579, + "id": 5691, "name": "swapId", "variant": "param", "kind": 32768, @@ -120127,14 +122426,14 @@ ] }, { - "id": 5584, + "id": 5696, "name": "cancelFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5585, + "id": 5697, "name": "cancelFulfillment", "variant": "signature", "kind": 4096, @@ -120160,7 +122459,7 @@ }, "parameters": [ { - "id": 5586, + "id": 5698, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -120203,14 +122502,14 @@ ] }, { - "id": 5542, + "id": 5654, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5543, + "id": 5655, "name": "create", "variant": "signature", "kind": 4096, @@ -120236,7 +122535,7 @@ }, "parameters": [ { - "id": 5544, + "id": 5656, "name": "order", "variant": "param", "kind": 32768, @@ -120260,7 +122559,7 @@ } }, { - "id": 5545, + "id": 5657, "name": "returnItems", "variant": "param", "kind": 32768, @@ -120313,7 +122612,7 @@ } }, { - "id": 5546, + "id": 5658, "name": "additionalItems", "variant": "param", "kind": 32768, @@ -120366,7 +122665,7 @@ } }, { - "id": 5547, + "id": 5659, "name": "returnShipping", "variant": "param", "kind": 32768, @@ -120384,14 +122683,14 @@ "type": { "type": "reflection", "declaration": { - "id": 5548, + "id": 5660, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5549, + "id": 5661, "name": "option_id", "variant": "declaration", "kind": 1024, @@ -120402,7 +122701,7 @@ } }, { - "id": 5550, + "id": 5662, "name": "price", "variant": "declaration", "kind": 1024, @@ -120419,8 +122718,8 @@ { "title": "Properties", "children": [ - 5549, - 5550 + 5661, + 5662 ] } ] @@ -120428,7 +122727,7 @@ } }, { - "id": 5551, + "id": 5663, "name": "custom", "variant": "param", "kind": 32768, @@ -120444,14 +122743,14 @@ "type": { "type": "reflection", "declaration": { - "id": 5552, + "id": 5664, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5555, + "id": 5667, "name": "allow_backorder", "variant": "declaration", "kind": 1024, @@ -120464,7 +122763,7 @@ } }, { - "id": 5554, + "id": 5666, "name": "idempotency_key", "variant": "declaration", "kind": 1024, @@ -120477,7 +122776,7 @@ } }, { - "id": 5556, + "id": 5668, "name": "location_id", "variant": "declaration", "kind": 1024, @@ -120490,7 +122789,7 @@ } }, { - "id": 5553, + "id": 5665, "name": "no_notification", "variant": "declaration", "kind": 1024, @@ -120507,10 +122806,10 @@ { "title": "Properties", "children": [ - 5555, - 5554, - 5556, - 5553 + 5667, + 5666, + 5668, + 5665 ] } ] @@ -120543,14 +122842,14 @@ ] }, { - "id": 5564, + "id": 5676, "name": "createCart", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5565, + "id": 5677, "name": "createCart", "variant": "signature", "kind": 4096, @@ -120576,7 +122875,7 @@ }, "parameters": [ { - "id": 5566, + "id": 5678, "name": "swapId", "variant": "param", "kind": 32768, @@ -120595,7 +122894,7 @@ } }, { - "id": 5567, + "id": 5679, "name": "customShippingOptions", "variant": "param", "kind": 32768, @@ -120613,14 +122912,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 5568, + "id": 5680, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5569, + "id": 5681, "name": "option_id", "variant": "declaration", "kind": 1024, @@ -120631,7 +122930,7 @@ } }, { - "id": 5570, + "id": 5682, "name": "price", "variant": "declaration", "kind": 1024, @@ -120646,8 +122945,8 @@ { "title": "Properties", "children": [ - 5569, - 5570 + 5681, + 5682 ] } ] @@ -120657,7 +122956,7 @@ "defaultValue": "[]" }, { - "id": 5571, + "id": 5683, "name": "context", "variant": "param", "kind": 32768, @@ -120665,14 +122964,14 @@ "type": { "type": "reflection", "declaration": { - "id": 5572, + "id": 5684, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5573, + "id": 5685, "name": "sales_channel_id", "variant": "declaration", "kind": 1024, @@ -120689,7 +122988,7 @@ { "title": "Properties", "children": [ - 5573 + 5685 ] } ] @@ -120722,14 +123021,14 @@ ] }, { - "id": 5580, + "id": 5692, "name": "createFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5581, + "id": 5693, "name": "createFulfillment", "variant": "signature", "kind": 4096, @@ -120755,7 +123054,7 @@ }, "parameters": [ { - "id": 5582, + "id": 5694, "name": "swapId", "variant": "param", "kind": 32768, @@ -120774,7 +123073,7 @@ } }, { - "id": 5583, + "id": 5695, "name": "config", "variant": "param", "kind": 32768, @@ -120823,14 +123122,14 @@ ] }, { - "id": 5587, + "id": 5699, "name": "createShipment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5588, + "id": 5700, "name": "createShipment", "variant": "signature", "kind": 4096, @@ -120856,7 +123155,7 @@ }, "parameters": [ { - "id": 5589, + "id": 5701, "name": "swapId", "variant": "param", "kind": 32768, @@ -120875,7 +123174,7 @@ } }, { - "id": 5590, + "id": 5702, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -120894,7 +123193,7 @@ } }, { - "id": 5591, + "id": 5703, "name": "trackingLinks", "variant": "param", "kind": 32768, @@ -120914,14 +123213,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 5592, + "id": 5704, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5593, + "id": 5705, "name": "tracking_number", "variant": "declaration", "kind": 1024, @@ -120936,7 +123235,7 @@ { "title": "Properties", "children": [ - 5593 + 5705 ] } ] @@ -120945,7 +123244,7 @@ } }, { - "id": 5594, + "id": 5706, "name": "config", "variant": "param", "kind": 32768, @@ -120994,14 +123293,14 @@ ] }, { - "id": 5595, + "id": 5707, "name": "deleteMetadata", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5596, + "id": 5708, "name": "deleteMetadata", "variant": "signature", "kind": 4096, @@ -121027,7 +123326,7 @@ }, "parameters": [ { - "id": 5597, + "id": 5709, "name": "swapId", "variant": "param", "kind": 32768, @@ -121046,7 +123345,7 @@ } }, { - "id": 5598, + "id": 5710, "name": "key", "variant": "param", "kind": 32768, @@ -121089,14 +123388,14 @@ ] }, { - "id": 5534, + "id": 5646, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5535, + "id": 5647, "name": "list", "variant": "signature", "kind": 4096, @@ -121122,7 +123421,7 @@ }, "parameters": [ { - "id": 5536, + "id": 5648, "name": "selector", "variant": "param", "kind": 32768, @@ -121157,7 +123456,7 @@ } }, { - "id": 5537, + "id": 5649, "name": "config", "variant": "param", "kind": 32768, @@ -121220,14 +123519,14 @@ ] }, { - "id": 5538, + "id": 5650, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5539, + "id": 5651, "name": "listAndCount", "variant": "signature", "kind": 4096, @@ -121253,7 +123552,7 @@ }, "parameters": [ { - "id": 5540, + "id": 5652, "name": "selector", "variant": "param", "kind": 32768, @@ -121288,7 +123587,7 @@ } }, { - "id": 5541, + "id": 5653, "name": "config", "variant": "param", "kind": 32768, @@ -121360,14 +123659,14 @@ ] }, { - "id": 5557, + "id": 5669, "name": "processDifference", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5558, + "id": 5670, "name": "processDifference", "variant": "signature", "kind": 4096, @@ -121393,7 +123692,7 @@ }, "parameters": [ { - "id": 5559, + "id": 5671, "name": "swapId", "variant": "param", "kind": 32768, @@ -121436,14 +123735,14 @@ ] }, { - "id": 5574, + "id": 5686, "name": "registerCartCompletion", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5575, + "id": 5687, "name": "registerCartCompletion", "variant": "signature", "kind": 4096, @@ -121469,7 +123768,7 @@ }, "parameters": [ { - "id": 5576, + "id": 5688, "name": "swapId", "variant": "param", "kind": 32768, @@ -121512,14 +123811,14 @@ ] }, { - "id": 5599, + "id": 5711, "name": "registerReceived", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5600, + "id": 5712, "name": "registerReceived", "variant": "signature", "kind": 4096, @@ -121545,7 +123844,7 @@ }, "parameters": [ { - "id": 5601, + "id": 5713, "name": "id", "variant": "param", "kind": 32768, @@ -121588,14 +123887,14 @@ ] }, { - "id": 5524, + "id": 5636, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5525, + "id": 5637, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -121621,7 +123920,7 @@ }, "parameters": [ { - "id": 5526, + "id": 5638, "name": "swapId", "variant": "param", "kind": 32768, @@ -121640,7 +123939,7 @@ } }, { - "id": 5527, + "id": 5639, "name": "config", "variant": "param", "kind": 32768, @@ -121694,14 +123993,14 @@ { "type": "reflection", "declaration": { - "id": 5528, + "id": 5640, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5529, + "id": 5641, "name": "select", "variant": "declaration", "kind": 1024, @@ -121721,7 +124020,7 @@ { "title": "Properties", "children": [ - 5529 + 5641 ] } ] @@ -121756,14 +124055,14 @@ ] }, { - "id": 5530, + "id": 5642, "name": "retrieveByCartId", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5531, + "id": 5643, "name": "retrieveByCartId", "variant": "signature", "kind": 4096, @@ -121789,7 +124088,7 @@ }, "parameters": [ { - "id": 5532, + "id": 5644, "name": "cartId", "variant": "param", "kind": 32768, @@ -121808,7 +124107,7 @@ } }, { - "id": 5533, + "id": 5645, "name": "relations", "variant": "param", "kind": 32768, @@ -121864,7 +124163,7 @@ ] }, { - "id": 5615, + "id": 5727, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -121873,14 +124172,14 @@ }, "signatures": [ { - "id": 5616, + "id": 5728, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5617, + "id": 5729, "name": "err", "variant": "param", "kind": 32768, @@ -121910,14 +124209,14 @@ { "type": "reflection", "declaration": { - "id": 5618, + "id": 5730, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5619, + "id": 5731, "name": "code", "variant": "declaration", "kind": 1024, @@ -121932,7 +124231,7 @@ { "title": "Properties", "children": [ - 5619 + 5731 ] } ] @@ -121960,7 +124259,7 @@ } }, { - "id": 5514, + "id": 5626, "name": "transformQueryForCart", "variant": "declaration", "kind": 2048, @@ -121969,7 +124268,7 @@ }, "signatures": [ { - "id": 5515, + "id": 5627, "name": "transformQueryForCart", "variant": "signature", "kind": 4096, @@ -121995,7 +124294,7 @@ }, "parameters": [ { - "id": 5516, + "id": 5628, "name": "config", "variant": "param", "kind": 32768, @@ -122049,14 +124348,14 @@ { "type": "reflection", "declaration": { - "id": 5517, + "id": 5629, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5518, + "id": 5630, "name": "select", "variant": "declaration", "kind": 1024, @@ -122076,7 +124375,7 @@ { "title": "Properties", "children": [ - 5518 + 5630 ] } ] @@ -122127,14 +124426,14 @@ { "type": "reflection", "declaration": { - "id": 5519, + "id": 5631, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5520, + "id": 5632, "name": "select", "variant": "declaration", "kind": 1024, @@ -122154,7 +124453,7 @@ { "title": "Properties", "children": [ - 5520 + 5632 ] } ] @@ -122163,14 +124462,14 @@ { "type": "reflection", "declaration": { - "id": 5521, + "id": 5633, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5523, + "id": 5635, "name": "cartRelations", "variant": "declaration", "kind": 1024, @@ -122193,7 +124492,7 @@ } }, { - "id": 5522, + "id": 5634, "name": "cartSelects", "variant": "declaration", "kind": 1024, @@ -122229,8 +124528,8 @@ { "title": "Properties", "children": [ - 5523, - 5522 + 5635, + 5634 ] } ] @@ -122242,14 +124541,14 @@ ] }, { - "id": 5560, + "id": 5672, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5561, + "id": 5673, "name": "update", "variant": "signature", "kind": 4096, @@ -122275,7 +124574,7 @@ }, "parameters": [ { - "id": 5562, + "id": 5674, "name": "swapId", "variant": "param", "kind": 32768, @@ -122294,7 +124593,7 @@ } }, { - "id": 5563, + "id": 5675, "name": "update", "variant": "param", "kind": 32768, @@ -122353,21 +124652,21 @@ ] }, { - "id": 5612, + "id": 5724, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5613, + "id": 5725, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5614, + "id": 5726, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -122387,7 +124686,7 @@ ], "type": { "type": "reference", - "target": 5486, + "target": 5598, "name": "SwapService", "package": "@medusajs/medusa" }, @@ -122409,62 +124708,62 @@ { "title": "Constructors", "children": [ - 5498 + 5610 ] }, { "title": "Properties", "children": [ - 5610, - 5609, - 5611, - 5502, - 5512, - 5503, - 5508, - 5511, - 5507, - 5605, - 5504, - 5510, - 5513, - 5505, - 5509, - 5501, - 5506, - 5606, - 5487 + 5722, + 5721, + 5723, + 5614, + 5624, + 5615, + 5620, + 5623, + 5619, + 5717, + 5616, + 5622, + 5625, + 5617, + 5621, + 5613, + 5618, + 5718, + 5599 ] }, { "title": "Accessors", "children": [ - 5607 + 5719 ] }, { "title": "Methods", "children": [ - 5602, - 5620, - 5577, - 5584, - 5542, - 5564, - 5580, - 5587, - 5595, - 5534, - 5538, - 5557, - 5574, - 5599, - 5524, - 5530, - 5615, - 5514, - 5560, - 5612 + 5714, + 5732, + 5689, + 5696, + 5654, + 5676, + 5692, + 5699, + 5707, + 5646, + 5650, + 5669, + 5686, + 5711, + 5636, + 5642, + 5727, + 5626, + 5672, + 5724 ] } ], @@ -122481,28 +124780,28 @@ ] }, { - "id": 5636, + "id": 5748, "name": "SystemPaymentProviderService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 5638, + "id": 5750, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 5639, + "id": 5751, "name": "new SystemPaymentProviderService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 5640, + "id": 5752, "name": "_", "variant": "param", "kind": 32768, @@ -122515,7 +124814,7 @@ ], "type": { "type": "reference", - "target": 5636, + "target": 5748, "name": "SystemProviderService", "package": "@medusajs/medusa" }, @@ -122533,7 +124832,7 @@ } }, { - "id": 5676, + "id": 5788, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -122568,7 +124867,7 @@ } }, { - "id": 5675, + "id": 5787, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -122587,7 +124886,7 @@ } }, { - "id": 5677, + "id": 5789, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -122622,7 +124921,7 @@ } }, { - "id": 5671, + "id": 5783, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -122645,7 +124944,7 @@ } }, { - "id": 5672, + "id": 5784, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -122677,7 +124976,7 @@ } }, { - "id": 5637, + "id": 5749, "name": "identifier", "variant": "declaration", "kind": 1024, @@ -122691,7 +124990,7 @@ "defaultValue": "\"system\"" }, { - "id": 5673, + "id": 5785, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -122699,7 +124998,7 @@ "isProtected": true }, "getSignature": { - "id": 5674, + "id": 5786, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -122726,7 +125025,7 @@ } }, { - "id": 5686, + "id": 5798, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -122735,7 +125034,7 @@ }, "signatures": [ { - "id": 5687, + "id": 5799, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -122761,14 +125060,14 @@ }, "typeParameter": [ { - "id": 5688, + "id": 5800, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 5689, + "id": 5801, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -122777,7 +125076,7 @@ ], "parameters": [ { - "id": 5690, + "id": 5802, "name": "work", "variant": "param", "kind": 32768, @@ -122793,21 +125092,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5691, + "id": 5803, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5692, + "id": 5804, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5693, + "id": 5805, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -122846,7 +125145,7 @@ } }, { - "id": 5694, + "id": 5806, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -122876,21 +125175,21 @@ { "type": "reflection", "declaration": { - "id": 5695, + "id": 5807, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5696, + "id": 5808, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5697, + "id": 5809, "name": "error", "variant": "param", "kind": 32768, @@ -122937,7 +125236,7 @@ } }, { - "id": 5698, + "id": 5810, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -122955,21 +125254,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5699, + "id": 5811, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5700, + "id": 5812, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5701, + "id": 5813, "name": "error", "variant": "param", "kind": 32768, @@ -123045,21 +125344,21 @@ } }, { - "id": 5650, + "id": 5762, "name": "authorizePayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5651, + "id": 5763, "name": "authorizePayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5652, + "id": 5764, "name": "_", "variant": "param", "kind": 32768, @@ -123104,21 +125403,21 @@ ] }, { - "id": 5668, + "id": 5780, "name": "cancelPayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5669, + "id": 5781, "name": "cancelPayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5670, + "id": 5782, "name": "_", "variant": "param", "kind": 32768, @@ -123163,21 +125462,21 @@ ] }, { - "id": 5662, + "id": 5774, "name": "capturePayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5663, + "id": 5775, "name": "capturePayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5664, + "id": 5776, "name": "_", "variant": "param", "kind": 32768, @@ -123222,21 +125521,21 @@ ] }, { - "id": 5641, + "id": 5753, "name": "createPayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5642, + "id": 5754, "name": "createPayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5643, + "id": 5755, "name": "_", "variant": "param", "kind": 32768, @@ -123281,21 +125580,21 @@ ] }, { - "id": 5659, + "id": 5771, "name": "deletePayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5660, + "id": 5772, "name": "deletePayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5661, + "id": 5773, "name": "_", "variant": "param", "kind": 32768, @@ -123340,21 +125639,21 @@ ] }, { - "id": 5647, + "id": 5759, "name": "getPaymentData", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5648, + "id": 5760, "name": "getPaymentData", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5649, + "id": 5761, "name": "_", "variant": "param", "kind": 32768, @@ -123399,21 +125698,21 @@ ] }, { - "id": 5644, + "id": 5756, "name": "getStatus", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5645, + "id": 5757, "name": "getStatus", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5646, + "id": 5758, "name": "_", "variant": "param", "kind": 32768, @@ -123443,21 +125742,21 @@ ] }, { - "id": 5665, + "id": 5777, "name": "refundPayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5666, + "id": 5778, "name": "refundPayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5667, + "id": 5779, "name": "_", "variant": "param", "kind": 32768, @@ -123502,7 +125801,7 @@ ] }, { - "id": 5681, + "id": 5793, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -123511,14 +125810,14 @@ }, "signatures": [ { - "id": 5682, + "id": 5794, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5683, + "id": 5795, "name": "err", "variant": "param", "kind": 32768, @@ -123548,14 +125847,14 @@ { "type": "reflection", "declaration": { - "id": 5684, + "id": 5796, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5685, + "id": 5797, "name": "code", "variant": "declaration", "kind": 1024, @@ -123570,7 +125869,7 @@ { "title": "Properties", "children": [ - 5685 + 5797 ] } ] @@ -123598,21 +125897,21 @@ } }, { - "id": 5656, + "id": 5768, "name": "updatePayment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5657, + "id": 5769, "name": "updatePayment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5658, + "id": 5770, "name": "_", "variant": "param", "kind": 32768, @@ -123657,21 +125956,21 @@ ] }, { - "id": 5653, + "id": 5765, "name": "updatePaymentData", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5654, + "id": 5766, "name": "updatePaymentData", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5655, + "id": 5767, "name": "_", "variant": "param", "kind": 32768, @@ -123716,21 +126015,21 @@ ] }, { - "id": 5678, + "id": 5790, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5679, + "id": 5791, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5680, + "id": 5792, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -123750,7 +126049,7 @@ ], "type": { "type": "reference", - "target": 5636, + "target": 5748, "name": "SystemProviderService", "package": "@medusajs/medusa" }, @@ -123772,42 +126071,42 @@ { "title": "Constructors", "children": [ - 5638 + 5750 ] }, { "title": "Properties", "children": [ - 5676, - 5675, - 5677, - 5671, - 5672, - 5637 + 5788, + 5787, + 5789, + 5783, + 5784, + 5749 ] }, { "title": "Accessors", "children": [ - 5673 + 5785 ] }, { "title": "Methods", "children": [ - 5686, - 5650, - 5668, - 5662, - 5641, - 5659, - 5647, - 5644, - 5665, - 5681, - 5656, - 5653, - 5678 + 5798, + 5762, + 5780, + 5774, + 5753, + 5771, + 5759, + 5756, + 5777, + 5793, + 5768, + 5765, + 5790 ] } ], @@ -123824,7 +126123,7 @@ ] }, { - "id": 5702, + "id": 5814, "name": "TaxProviderService", "variant": "declaration", "kind": 128, @@ -123839,21 +126138,21 @@ }, "children": [ { - "id": 5703, + "id": 5815, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 5704, + "id": 5816, "name": "new TaxProviderService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 5705, + "id": 5817, "name": "container", "variant": "param", "kind": 32768, @@ -123877,7 +126176,7 @@ ], "type": { "type": "reference", - "target": 5702, + "target": 5814, "name": "TaxProviderService", "package": "@medusajs/medusa" }, @@ -123895,7 +126194,7 @@ } }, { - "id": 5778, + "id": 5890, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -123930,7 +126229,7 @@ } }, { - "id": 5777, + "id": 5889, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -123949,7 +126248,7 @@ } }, { - "id": 5779, + "id": 5891, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -123984,7 +126283,7 @@ } }, { - "id": 5707, + "id": 5819, "name": "cacheService_", "variant": "declaration", "kind": 1024, @@ -124003,7 +126302,7 @@ } }, { - "id": 5706, + "id": 5818, "name": "container_", "variant": "declaration", "kind": 1024, @@ -124028,7 +126327,7 @@ } }, { - "id": 5726, + "id": 5838, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -124047,7 +126346,7 @@ } }, { - "id": 5773, + "id": 5885, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -124070,7 +126369,7 @@ } }, { - "id": 5717, + "id": 5829, "name": "smTaxLineRepo_", "variant": "declaration", "kind": 1024, @@ -124104,28 +126403,28 @@ { "type": "reflection", "declaration": { - "id": 5718, + "id": 5830, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5722, + "id": 5834, "name": "deleteForCart", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5723, + "id": 5835, "name": "deleteForCart", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5724, + "id": 5836, "name": "cartId", "variant": "param", "kind": 32768, @@ -124155,21 +126454,21 @@ ] }, { - "id": 5719, + "id": 5831, "name": "upsertLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5720, + "id": 5832, "name": "upsertLines", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5721, + "id": 5833, "name": "lines", "variant": "param", "kind": 32768, @@ -124219,8 +126518,8 @@ { "title": "Methods", "children": [ - 5722, - 5719 + 5834, + 5831 ] } ] @@ -124230,7 +126529,7 @@ } }, { - "id": 5709, + "id": 5821, "name": "taxLineRepo_", "variant": "declaration", "kind": 1024, @@ -124264,28 +126563,28 @@ { "type": "reflection", "declaration": { - "id": 5710, + "id": 5822, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5714, + "id": 5826, "name": "deleteForCart", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5715, + "id": 5827, "name": "deleteForCart", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5716, + "id": 5828, "name": "cartId", "variant": "param", "kind": 32768, @@ -124315,21 +126614,21 @@ ] }, { - "id": 5711, + "id": 5823, "name": "upsertLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5712, + "id": 5824, "name": "upsertLines", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5713, + "id": 5825, "name": "lines", "variant": "param", "kind": 32768, @@ -124379,8 +126678,8 @@ { "title": "Methods", "children": [ - 5714, - 5711 + 5826, + 5823 ] } ] @@ -124390,7 +126689,7 @@ } }, { - "id": 5725, + "id": 5837, "name": "taxProviderRepo_", "variant": "declaration", "kind": 1024, @@ -124420,7 +126719,7 @@ } }, { - "id": 5708, + "id": 5820, "name": "taxRateService_", "variant": "declaration", "kind": 1024, @@ -124430,13 +126729,13 @@ }, "type": { "type": "reference", - "target": 5804, + "target": 5916, "name": "TaxRateService", "package": "@medusajs/medusa" } }, { - "id": 5774, + "id": 5886, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -124468,7 +126767,7 @@ } }, { - "id": 5775, + "id": 5887, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -124476,7 +126775,7 @@ "isProtected": true }, "getSignature": { - "id": 5776, + "id": 5888, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -124503,7 +126802,7 @@ } }, { - "id": 5788, + "id": 5900, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -124512,7 +126811,7 @@ }, "signatures": [ { - "id": 5789, + "id": 5901, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -124538,14 +126837,14 @@ }, "typeParameter": [ { - "id": 5790, + "id": 5902, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 5791, + "id": 5903, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -124554,7 +126853,7 @@ ], "parameters": [ { - "id": 5792, + "id": 5904, "name": "work", "variant": "param", "kind": 32768, @@ -124570,21 +126869,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5793, + "id": 5905, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5794, + "id": 5906, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5795, + "id": 5907, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -124623,7 +126922,7 @@ } }, { - "id": 5796, + "id": 5908, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -124653,21 +126952,21 @@ { "type": "reflection", "declaration": { - "id": 5797, + "id": 5909, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5798, + "id": 5910, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5799, + "id": 5911, "name": "error", "variant": "param", "kind": 32768, @@ -124714,7 +127013,7 @@ } }, { - "id": 5800, + "id": 5912, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -124732,21 +127031,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5801, + "id": 5913, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5802, + "id": 5914, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5803, + "id": 5915, "name": "error", "variant": "param", "kind": 32768, @@ -124822,21 +127121,21 @@ } }, { - "id": 5732, + "id": 5844, "name": "clearLineItemsTaxLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5733, + "id": 5845, "name": "clearLineItemsTaxLines", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5734, + "id": 5846, "name": "itemIds", "variant": "param", "kind": 32768, @@ -124869,21 +127168,21 @@ ] }, { - "id": 5735, + "id": 5847, "name": "clearTaxLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5736, + "id": 5848, "name": "clearTaxLines", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5737, + "id": 5849, "name": "cartId", "variant": "param", "kind": 32768, @@ -124913,14 +127212,14 @@ ] }, { - "id": 5742, + "id": 5854, "name": "createShippingTaxLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5743, + "id": 5855, "name": "createShippingTaxLines", "variant": "signature", "kind": 4096, @@ -124946,7 +127245,7 @@ }, "parameters": [ { - "id": 5744, + "id": 5856, "name": "shippingMethod", "variant": "param", "kind": 32768, @@ -124970,7 +127269,7 @@ } }, { - "id": 5745, + "id": 5857, "name": "calculationContext", "variant": "param", "kind": 32768, @@ -125035,14 +127334,14 @@ ] }, { - "id": 5738, + "id": 5850, "name": "createTaxLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5739, + "id": 5851, "name": "createTaxLines", "variant": "signature", "kind": 4096, @@ -125068,7 +127367,7 @@ }, "parameters": [ { - "id": 5740, + "id": 5852, "name": "cartOrLineItems", "variant": "param", "kind": 32768, @@ -125109,7 +127408,7 @@ } }, { - "id": 5741, + "id": 5853, "name": "calculationContext", "variant": "param", "kind": 32768, @@ -125174,7 +127473,7 @@ ] }, { - "id": 5766, + "id": 5878, "name": "getCacheKey", "variant": "declaration", "kind": 2048, @@ -125183,7 +127482,7 @@ }, "signatures": [ { - "id": 5767, + "id": 5879, "name": "getCacheKey", "variant": "signature", "kind": 4096, @@ -125209,7 +127508,7 @@ }, "parameters": [ { - "id": 5768, + "id": 5880, "name": "id", "variant": "param", "kind": 32768, @@ -125228,7 +127527,7 @@ } }, { - "id": 5769, + "id": 5881, "name": "regionId", "variant": "param", "kind": 32768, @@ -125255,14 +127554,14 @@ ] }, { - "id": 5762, + "id": 5874, "name": "getRegionRatesForProduct", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5763, + "id": 5875, "name": "getRegionRatesForProduct", "variant": "signature", "kind": 4096, @@ -125288,7 +127587,7 @@ }, "parameters": [ { - "id": 5764, + "id": 5876, "name": "productIds", "variant": "param", "kind": 32768, @@ -125311,7 +127610,7 @@ } }, { - "id": 5765, + "id": 5877, "name": "region", "variant": "param", "kind": 32768, @@ -125377,14 +127676,14 @@ ] }, { - "id": 5758, + "id": 5870, "name": "getRegionRatesForShipping", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5759, + "id": 5871, "name": "getRegionRatesForShipping", "variant": "signature", "kind": 4096, @@ -125410,7 +127709,7 @@ }, "parameters": [ { - "id": 5760, + "id": 5872, "name": "optionId", "variant": "param", "kind": 32768, @@ -125429,7 +127728,7 @@ } }, { - "id": 5761, + "id": 5873, "name": "regionDetails", "variant": "param", "kind": 32768, @@ -125480,14 +127779,14 @@ ] }, { - "id": 5746, + "id": 5858, "name": "getShippingTaxLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5747, + "id": 5859, "name": "getShippingTaxLines", "variant": "signature", "kind": 4096, @@ -125513,7 +127812,7 @@ }, "parameters": [ { - "id": 5748, + "id": 5860, "name": "shippingMethod", "variant": "param", "kind": 32768, @@ -125537,7 +127836,7 @@ } }, { - "id": 5749, + "id": 5861, "name": "calculationContext", "variant": "param", "kind": 32768, @@ -125588,14 +127887,14 @@ ] }, { - "id": 5750, + "id": 5862, "name": "getTaxLines", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5751, + "id": 5863, "name": "getTaxLines", "variant": "signature", "kind": 4096, @@ -125621,7 +127920,7 @@ }, "parameters": [ { - "id": 5752, + "id": 5864, "name": "lineItems", "variant": "param", "kind": 32768, @@ -125648,7 +127947,7 @@ } }, { - "id": 5753, + "id": 5865, "name": "calculationContext", "variant": "param", "kind": 32768, @@ -125713,7 +128012,7 @@ ] }, { - "id": 5754, + "id": 5866, "name": "getTaxLinesMap", "variant": "declaration", "kind": 2048, @@ -125722,7 +128021,7 @@ }, "signatures": [ { - "id": 5755, + "id": 5867, "name": "getTaxLinesMap", "variant": "signature", "kind": 4096, @@ -125739,7 +128038,7 @@ }, "parameters": [ { - "id": 5756, + "id": 5868, "name": "items", "variant": "param", "kind": 32768, @@ -125758,7 +128057,7 @@ } }, { - "id": 5757, + "id": 5869, "name": "calculationContext", "variant": "param", "kind": 32768, @@ -125798,14 +128097,14 @@ ] }, { - "id": 5727, + "id": 5839, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5728, + "id": 5840, "name": "list", "variant": "signature", "kind": 4096, @@ -125837,21 +128136,21 @@ ] }, { - "id": 5770, + "id": 5882, "name": "registerInstalledProviders", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5771, + "id": 5883, "name": "registerInstalledProviders", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5772, + "id": 5884, "name": "providers", "variant": "param", "kind": 32768, @@ -125884,14 +128183,14 @@ ] }, { - "id": 5729, + "id": 5841, "name": "retrieveProvider", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5730, + "id": 5842, "name": "retrieveProvider", "variant": "signature", "kind": 4096, @@ -125917,7 +128216,7 @@ }, "parameters": [ { - "id": 5731, + "id": 5843, "name": "region", "variant": "param", "kind": 32768, @@ -125954,7 +128253,7 @@ ] }, { - "id": 5783, + "id": 5895, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -125963,14 +128262,14 @@ }, "signatures": [ { - "id": 5784, + "id": 5896, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5785, + "id": 5897, "name": "err", "variant": "param", "kind": 32768, @@ -126000,14 +128299,14 @@ { "type": "reflection", "declaration": { - "id": 5786, + "id": 5898, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5787, + "id": 5899, "name": "code", "variant": "declaration", "kind": 1024, @@ -126022,7 +128321,7 @@ { "title": "Properties", "children": [ - 5787 + 5899 ] } ] @@ -126050,21 +128349,21 @@ } }, { - "id": 5780, + "id": 5892, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5781, + "id": 5893, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5782, + "id": 5894, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -126084,7 +128383,7 @@ ], "type": { "type": "reference", - "target": 5702, + "target": 5814, "name": "TaxProviderService", "package": "@medusajs/medusa" }, @@ -126106,51 +128405,51 @@ { "title": "Constructors", "children": [ - 5703 + 5815 ] }, { "title": "Properties", "children": [ - 5778, - 5777, - 5779, - 5707, - 5706, - 5726, - 5773, - 5717, - 5709, - 5725, - 5708, - 5774 + 5890, + 5889, + 5891, + 5819, + 5818, + 5838, + 5885, + 5829, + 5821, + 5837, + 5820, + 5886 ] }, { "title": "Accessors", "children": [ - 5775 + 5887 ] }, { "title": "Methods", "children": [ - 5788, - 5732, - 5735, - 5742, - 5738, - 5766, - 5762, - 5758, - 5746, - 5750, - 5754, - 5727, - 5770, - 5729, - 5783, - 5780 + 5900, + 5844, + 5847, + 5854, + 5850, + 5878, + 5874, + 5870, + 5858, + 5862, + 5866, + 5839, + 5882, + 5841, + 5895, + 5892 ] } ], @@ -126167,41 +128466,104 @@ ] }, { - "id": 5804, + "id": 5916, "name": "TaxRateService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 5805, + "id": 5917, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 5806, + "id": 5918, "name": "new TaxRateService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 5807, + "id": 5919, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "Object" + "type": "reflection", + "declaration": { + "id": 5920, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5921, + "name": "productService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 5922, + "name": "productTypeService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 5923, + "name": "shippingOptionService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 5924, + "name": "taxRateRepository", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5921, + 5922, + 5923, + 5924 + ] + } + ] + } } } ], "type": { "type": "reference", - "target": 5804, + "target": 5916, "name": "TaxRateService", "package": "@medusajs/medusa" }, @@ -126219,7 +128581,7 @@ } }, { - "id": 5924, + "id": 6041, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -126254,7 +128616,7 @@ } }, { - "id": 5923, + "id": 6040, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -126273,7 +128635,7 @@ } }, { - "id": 5925, + "id": 6042, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -126308,7 +128670,7 @@ } }, { - "id": 5919, + "id": 6036, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -126331,7 +128693,7 @@ } }, { - "id": 5808, + "id": 5925, "name": "productService_", "variant": "declaration", "kind": 1024, @@ -126341,13 +128703,13 @@ }, "type": { "type": "reference", - "target": 3441, + "target": 3495, "name": "ProductService", "package": "@medusajs/medusa" } }, { - "id": 5809, + "id": 5926, "name": "productTypeService_", "variant": "declaration", "kind": 1024, @@ -126357,13 +128719,13 @@ }, "type": { "type": "reference", - "target": 4014, + "target": 4086, "name": "ProductTypeService", "package": "@medusajs/medusa" } }, { - "id": 5810, + "id": 5927, "name": "shippingOptionService_", "variant": "declaration", "kind": 1024, @@ -126373,13 +128735,13 @@ }, "type": { "type": "reference", - "target": 5056, + "target": 5163, "name": "ShippingOptionService", "package": "@medusajs/medusa" } }, { - "id": 5811, + "id": 5928, "name": "taxRateRepository_", "variant": "declaration", "kind": 1024, @@ -126413,28 +128775,28 @@ { "type": "reflection", "declaration": { - "id": 5812, + "id": 5929, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5833, + "id": 5950, "name": "addToProduct", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5834, + "id": 5951, "name": "addToProduct", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5835, + "id": 5952, "name": "id", "variant": "param", "kind": 32768, @@ -126445,7 +128807,7 @@ } }, { - "id": 5836, + "id": 5953, "name": "productIds", "variant": "param", "kind": 32768, @@ -126459,7 +128821,7 @@ } }, { - "id": 5837, + "id": 5954, "name": "overrideExisting", "variant": "param", "kind": 32768, @@ -126498,21 +128860,21 @@ ] }, { - "id": 5842, + "id": 5959, "name": "addToProductType", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5843, + "id": 5960, "name": "addToProductType", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5844, + "id": 5961, "name": "id", "variant": "param", "kind": 32768, @@ -126523,7 +128885,7 @@ } }, { - "id": 5845, + "id": 5962, "name": "productTypeIds", "variant": "param", "kind": 32768, @@ -126537,7 +128899,7 @@ } }, { - "id": 5846, + "id": 5963, "name": "overrideExisting", "variant": "param", "kind": 32768, @@ -126576,21 +128938,21 @@ ] }, { - "id": 5851, + "id": 5968, "name": "addToShippingOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5852, + "id": 5969, "name": "addToShippingOption", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5853, + "id": 5970, "name": "id", "variant": "param", "kind": 32768, @@ -126601,7 +128963,7 @@ } }, { - "id": 5854, + "id": 5971, "name": "optionIds", "variant": "param", "kind": 32768, @@ -126615,7 +128977,7 @@ } }, { - "id": 5855, + "id": 5972, "name": "overrideExisting", "variant": "param", "kind": 32768, @@ -126654,21 +129016,21 @@ ] }, { - "id": 5825, + "id": 5942, "name": "applyResolutionsToQueryBuilder", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5826, + "id": 5943, "name": "applyResolutionsToQueryBuilder", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5827, + "id": 5944, "name": "qb", "variant": "param", "kind": 32768, @@ -126695,7 +129057,7 @@ } }, { - "id": 5828, + "id": 5945, "name": "resolverFields", "variant": "param", "kind": 32768, @@ -126733,21 +129095,21 @@ ] }, { - "id": 5822, + "id": 5939, "name": "findAndCountWithResolution", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5823, + "id": 5940, "name": "findAndCountWithResolution", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5824, + "id": 5941, "name": "findOptions", "variant": "param", "kind": 32768, @@ -126810,21 +129172,21 @@ ] }, { - "id": 5819, + "id": 5936, "name": "findOneWithResolution", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5820, + "id": 5937, "name": "findOneWithResolution", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5821, + "id": 5938, "name": "findOptions", "variant": "param", "kind": 32768, @@ -126884,21 +129246,21 @@ ] }, { - "id": 5816, + "id": 5933, "name": "findWithResolution", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5817, + "id": 5934, "name": "findWithResolution", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5818, + "id": 5935, "name": "findOptions", "variant": "param", "kind": 32768, @@ -126952,21 +129314,21 @@ ] }, { - "id": 5813, + "id": 5930, "name": "getFindQueryBuilder", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5814, + "id": 5931, "name": "getFindQueryBuilder", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5815, + "id": 5932, "name": "findOptions", "variant": "param", "kind": 32768, @@ -127017,21 +129379,21 @@ ] }, { - "id": 5856, + "id": 5973, "name": "listByProduct", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5857, + "id": 5974, "name": "listByProduct", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5858, + "id": 5975, "name": "productId", "variant": "param", "kind": 32768, @@ -127042,7 +129404,7 @@ } }, { - "id": 5859, + "id": 5976, "name": "config", "variant": "param", "kind": 32768, @@ -127085,21 +129447,21 @@ ] }, { - "id": 5860, + "id": 5977, "name": "listByShippingOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5861, + "id": 5978, "name": "listByShippingOption", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5862, + "id": 5979, "name": "optionId", "variant": "param", "kind": 32768, @@ -127137,21 +129499,21 @@ ] }, { - "id": 5829, + "id": 5946, "name": "removeFromProduct", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5830, + "id": 5947, "name": "removeFromProduct", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5831, + "id": 5948, "name": "id", "variant": "param", "kind": 32768, @@ -127162,7 +129524,7 @@ } }, { - "id": 5832, + "id": 5949, "name": "productIds", "variant": "param", "kind": 32768, @@ -127200,21 +129562,21 @@ ] }, { - "id": 5838, + "id": 5955, "name": "removeFromProductType", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5839, + "id": 5956, "name": "removeFromProductType", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5840, + "id": 5957, "name": "id", "variant": "param", "kind": 32768, @@ -127225,7 +129587,7 @@ } }, { - "id": 5841, + "id": 5958, "name": "productTypeIds", "variant": "param", "kind": 32768, @@ -127263,21 +129625,21 @@ ] }, { - "id": 5847, + "id": 5964, "name": "removeFromShippingOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5848, + "id": 5965, "name": "removeFromShippingOption", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5849, + "id": 5966, "name": "id", "variant": "param", "kind": 32768, @@ -127288,7 +129650,7 @@ } }, { - "id": 5850, + "id": 5967, "name": "optionIds", "variant": "param", "kind": 32768, @@ -127330,19 +129692,19 @@ { "title": "Methods", "children": [ - 5833, - 5842, - 5851, - 5825, - 5822, - 5819, - 5816, - 5813, - 5856, - 5860, - 5829, - 5838, - 5847 + 5950, + 5959, + 5968, + 5942, + 5939, + 5936, + 5933, + 5930, + 5973, + 5977, + 5946, + 5955, + 5964 ] } ] @@ -127352,7 +129714,7 @@ } }, { - "id": 5920, + "id": 6037, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -127384,7 +129746,7 @@ } }, { - "id": 5921, + "id": 6038, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -127392,7 +129754,7 @@ "isProtected": true }, "getSignature": { - "id": 5922, + "id": 6039, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -127419,21 +129781,21 @@ } }, { - "id": 5897, + "id": 6014, "name": "addToProduct", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5898, + "id": 6015, "name": "addToProduct", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5899, + "id": 6016, "name": "id", "variant": "param", "kind": 32768, @@ -127444,7 +129806,7 @@ } }, { - "id": 5900, + "id": 6017, "name": "productIds", "variant": "param", "kind": 32768, @@ -127467,7 +129829,7 @@ } }, { - "id": 5901, + "id": 6018, "name": "replace", "variant": "param", "kind": 32768, @@ -127520,21 +129882,21 @@ ] }, { - "id": 5902, + "id": 6019, "name": "addToProductType", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5903, + "id": 6020, "name": "addToProductType", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5904, + "id": 6021, "name": "id", "variant": "param", "kind": 32768, @@ -127545,7 +129907,7 @@ } }, { - "id": 5905, + "id": 6022, "name": "productTypeIds", "variant": "param", "kind": 32768, @@ -127568,7 +129930,7 @@ } }, { - "id": 5906, + "id": 6023, "name": "replace", "variant": "param", "kind": 32768, @@ -127607,21 +129969,21 @@ ] }, { - "id": 5907, + "id": 6024, "name": "addToShippingOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5908, + "id": 6025, "name": "addToShippingOption", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5909, + "id": 6026, "name": "id", "variant": "param", "kind": 32768, @@ -127632,7 +129994,7 @@ } }, { - "id": 5910, + "id": 6027, "name": "optionIds", "variant": "param", "kind": 32768, @@ -127655,7 +130017,7 @@ } }, { - "id": 5911, + "id": 6028, "name": "replace", "variant": "param", "kind": 32768, @@ -127694,7 +130056,7 @@ ] }, { - "id": 5934, + "id": 6051, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -127703,7 +130065,7 @@ }, "signatures": [ { - "id": 5935, + "id": 6052, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -127729,14 +130091,14 @@ }, "typeParameter": [ { - "id": 5936, + "id": 6053, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 5937, + "id": 6054, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -127745,7 +130107,7 @@ ], "parameters": [ { - "id": 5938, + "id": 6055, "name": "work", "variant": "param", "kind": 32768, @@ -127761,21 +130123,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5939, + "id": 6056, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5940, + "id": 6057, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5941, + "id": 6058, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -127814,7 +130176,7 @@ } }, { - "id": 5942, + "id": 6059, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -127844,21 +130206,21 @@ { "type": "reflection", "declaration": { - "id": 5943, + "id": 6060, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5944, + "id": 6061, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5945, + "id": 6062, "name": "error", "variant": "param", "kind": 32768, @@ -127905,7 +130267,7 @@ } }, { - "id": 5946, + "id": 6063, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -127923,21 +130285,21 @@ "type": { "type": "reflection", "declaration": { - "id": 5947, + "id": 6064, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 5948, + "id": 6065, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5949, + "id": 6066, "name": "error", "variant": "param", "kind": 32768, @@ -128013,21 +130375,21 @@ } }, { - "id": 5875, + "id": 5992, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5876, + "id": 5993, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5877, + "id": 5994, "name": "data", "variant": "param", "kind": 32768, @@ -128067,21 +130429,21 @@ ] }, { - "id": 5882, + "id": 5999, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5883, + "id": 6000, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5884, + "id": 6001, "name": "id", "variant": "param", "kind": 32768, @@ -128123,21 +130485,21 @@ ] }, { - "id": 5863, + "id": 5980, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5864, + "id": 5981, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5865, + "id": 5982, "name": "selector", "variant": "param", "kind": 32768, @@ -128153,7 +130515,7 @@ } }, { - "id": 5866, + "id": 5983, "name": "config", "variant": "param", "kind": 32768, @@ -128208,21 +130570,21 @@ ] }, { - "id": 5867, + "id": 5984, "name": "listAndCount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5868, + "id": 5985, "name": "listAndCount", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5869, + "id": 5986, "name": "selector", "variant": "param", "kind": 32768, @@ -128238,7 +130600,7 @@ } }, { - "id": 5870, + "id": 5987, "name": "config", "variant": "param", "kind": 32768, @@ -128302,21 +130664,21 @@ ] }, { - "id": 5912, + "id": 6029, "name": "listByProduct", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5913, + "id": 6030, "name": "listByProduct", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5914, + "id": 6031, "name": "productId", "variant": "param", "kind": 32768, @@ -128327,7 +130689,7 @@ } }, { - "id": 5915, + "id": 6032, "name": "config", "variant": "param", "kind": 32768, @@ -128370,21 +130732,21 @@ ] }, { - "id": 5916, + "id": 6033, "name": "listByShippingOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5917, + "id": 6034, "name": "listByShippingOption", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5918, + "id": 6035, "name": "shippingOptionId", "variant": "param", "kind": 32768, @@ -128422,21 +130784,21 @@ ] }, { - "id": 5885, + "id": 6002, "name": "removeFromProduct", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5886, + "id": 6003, "name": "removeFromProduct", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5887, + "id": 6004, "name": "id", "variant": "param", "kind": 32768, @@ -128447,7 +130809,7 @@ } }, { - "id": 5888, + "id": 6005, "name": "productIds", "variant": "param", "kind": 32768, @@ -128489,21 +130851,21 @@ ] }, { - "id": 5889, + "id": 6006, "name": "removeFromProductType", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5890, + "id": 6007, "name": "removeFromProductType", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5891, + "id": 6008, "name": "id", "variant": "param", "kind": 32768, @@ -128514,7 +130876,7 @@ } }, { - "id": 5892, + "id": 6009, "name": "typeIds", "variant": "param", "kind": 32768, @@ -128556,21 +130918,21 @@ ] }, { - "id": 5893, + "id": 6010, "name": "removeFromShippingOption", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5894, + "id": 6011, "name": "removeFromShippingOption", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5895, + "id": 6012, "name": "id", "variant": "param", "kind": 32768, @@ -128581,7 +130943,7 @@ } }, { - "id": 5896, + "id": 6013, "name": "optionIds", "variant": "param", "kind": 32768, @@ -128623,21 +130985,21 @@ ] }, { - "id": 5871, + "id": 5988, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5872, + "id": 5989, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5873, + "id": 5990, "name": "taxRateId", "variant": "param", "kind": 32768, @@ -128648,7 +131010,7 @@ } }, { - "id": 5874, + "id": 5991, "name": "config", "variant": "param", "kind": 32768, @@ -128700,7 +131062,7 @@ ] }, { - "id": 5929, + "id": 6046, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -128709,14 +131071,14 @@ }, "signatures": [ { - "id": 5930, + "id": 6047, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5931, + "id": 6048, "name": "err", "variant": "param", "kind": 32768, @@ -128746,14 +131108,14 @@ { "type": "reflection", "declaration": { - "id": 5932, + "id": 6049, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5933, + "id": 6050, "name": "code", "variant": "declaration", "kind": 1024, @@ -128768,7 +131130,7 @@ { "title": "Properties", "children": [ - 5933 + 6050 ] } ] @@ -128796,21 +131158,21 @@ } }, { - "id": 5878, + "id": 5995, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5879, + "id": 5996, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5880, + "id": 5997, "name": "id", "variant": "param", "kind": 32768, @@ -128821,7 +131183,7 @@ } }, { - "id": 5881, + "id": 5998, "name": "data", "variant": "param", "kind": 32768, @@ -128861,21 +131223,21 @@ ] }, { - "id": 5926, + "id": 6043, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5927, + "id": 6044, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5928, + "id": 6045, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -128895,7 +131257,7 @@ ], "type": { "type": "reference", - "target": 5804, + "target": 5916, "name": "TaxRateService", "package": "@medusajs/medusa" }, @@ -128917,49 +131279,49 @@ { "title": "Constructors", "children": [ - 5805 + 5917 ] }, { "title": "Properties", "children": [ - 5924, - 5923, + 6041, + 6040, + 6042, + 6036, 5925, - 5919, - 5808, - 5809, - 5810, - 5811, - 5920 + 5926, + 5927, + 5928, + 6037 ] }, { "title": "Accessors", "children": [ - 5921 + 6038 ] }, { "title": "Methods", "children": [ - 5897, - 5902, - 5907, - 5934, - 5875, - 5882, - 5863, - 5867, - 5912, - 5916, - 5885, - 5889, - 5893, - 5871, - 5929, - 5878, - 5926 + 6014, + 6019, + 6024, + 6051, + 5992, + 5999, + 5980, + 5984, + 6029, + 6033, + 6002, + 6006, + 6010, + 5988, + 6046, + 5995, + 6043 ] } ], @@ -128976,28 +131338,28 @@ ] }, { - "id": 5950, + "id": 6067, "name": "TokenService", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 5952, + "id": 6069, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 5953, + "id": 6070, "name": "new TokenService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 5954, + "id": 6071, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -129015,7 +131377,7 @@ ], "type": { "type": "reference", - "target": 5950, + "target": 6067, "name": "TokenService", "package": "@medusajs/medusa" } @@ -129023,7 +131385,7 @@ ] }, { - "id": 5955, + "id": 6072, "name": "configModule_", "variant": "declaration", "kind": 1024, @@ -129042,7 +131404,7 @@ } }, { - "id": 5951, + "id": 6068, "name": "RESOLUTION_KEY", "variant": "declaration", "kind": 1024, @@ -129056,21 +131418,21 @@ "defaultValue": "..." }, { - "id": 5960, + "id": 6077, "name": "signToken", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5961, + "id": 6078, "name": "signToken", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5962, + "id": 6079, "name": "data", "variant": "param", "kind": 32768, @@ -129100,7 +131462,7 @@ } }, { - "id": 5963, + "id": 6080, "name": "options", "variant": "param", "kind": 32768, @@ -129126,21 +131488,21 @@ ] }, { - "id": 5956, + "id": 6073, "name": "verifyToken", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5957, + "id": 6074, "name": "verifyToken", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 5958, + "id": 6075, "name": "token", "variant": "param", "kind": 32768, @@ -129151,7 +131513,7 @@ } }, { - "id": 5959, + "id": 6076, "name": "options", "variant": "param", "kind": 32768, @@ -129204,27 +131566,27 @@ { "title": "Constructors", "children": [ - 5952 + 6069 ] }, { "title": "Properties", "children": [ - 5955, - 5951 + 6072, + 6068 ] }, { "title": "Methods", "children": [ - 5960, - 5956 + 6077, + 6073 ] } ] }, { - "id": 5964, + "id": 6081, "name": "TotalsService", "variant": "declaration", "kind": 128, @@ -129245,21 +131607,21 @@ }, "children": [ { - "id": 5965, + "id": 6082, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 5966, + "id": 6083, "name": "new TotalsService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 5967, + "id": 6084, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -129277,7 +131639,7 @@ ], "type": { "type": "reference", - "target": 5964, + "target": 6081, "name": "TotalsService", "package": "@medusajs/medusa" }, @@ -129295,7 +131657,7 @@ } }, { - "id": 6081, + "id": 6198, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -129330,7 +131692,7 @@ } }, { - "id": 6080, + "id": 6197, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -129349,7 +131711,7 @@ } }, { - "id": 6082, + "id": 6199, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -129384,7 +131746,7 @@ } }, { - "id": 5971, + "id": 6088, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -129403,7 +131765,7 @@ } }, { - "id": 6076, + "id": 6193, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -129426,7 +131788,7 @@ } }, { - "id": 5969, + "id": 6086, "name": "newTotalsService_", "variant": "declaration", "kind": 1024, @@ -129436,13 +131798,13 @@ }, "type": { "type": "reference", - "target": 1956, + "target": 2010, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 5970, + "id": 6087, "name": "taxCalculationStrategy_", "variant": "declaration", "kind": 1024, @@ -129461,7 +131823,7 @@ } }, { - "id": 5968, + "id": 6085, "name": "taxProviderService_", "variant": "declaration", "kind": 1024, @@ -129471,13 +131833,13 @@ }, "type": { "type": "reference", - "target": 5702, + "target": 5814, "name": "TaxProviderService", "package": "@medusajs/medusa" } }, { - "id": 6077, + "id": 6194, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -129509,7 +131871,7 @@ } }, { - "id": 6078, + "id": 6195, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -129517,7 +131879,7 @@ "isProtected": true }, "getSignature": { - "id": 6079, + "id": 6196, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -129544,7 +131906,7 @@ } }, { - "id": 6091, + "id": 6208, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -129553,7 +131915,7 @@ }, "signatures": [ { - "id": 6092, + "id": 6209, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -129579,14 +131941,14 @@ }, "typeParameter": [ { - "id": 6093, + "id": 6210, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 6094, + "id": 6211, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -129595,7 +131957,7 @@ ], "parameters": [ { - "id": 6095, + "id": 6212, "name": "work", "variant": "param", "kind": 32768, @@ -129611,21 +131973,21 @@ "type": { "type": "reflection", "declaration": { - "id": 6096, + "id": 6213, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 6097, + "id": 6214, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 6098, + "id": 6215, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -129664,7 +132026,7 @@ } }, { - "id": 6099, + "id": 6216, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -129694,21 +132056,21 @@ { "type": "reflection", "declaration": { - "id": 6100, + "id": 6217, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 6101, + "id": 6218, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 6102, + "id": 6219, "name": "error", "variant": "param", "kind": 32768, @@ -129755,7 +132117,7 @@ } }, { - "id": 6103, + "id": 6220, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -129773,21 +132135,21 @@ "type": { "type": "reflection", "declaration": { - "id": 6104, + "id": 6221, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 6105, + "id": 6222, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 6106, + "id": 6223, "name": "error", "variant": "param", "kind": 32768, @@ -129863,14 +132225,14 @@ } }, { - "id": 6018, + "id": 6135, "name": "calculateDiscount_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6019, + "id": 6136, "name": "calculateDiscount_", "variant": "signature", "kind": 4096, @@ -129905,7 +132267,7 @@ }, "parameters": [ { - "id": 6020, + "id": 6137, "name": "lineItem", "variant": "param", "kind": 32768, @@ -129929,7 +132291,7 @@ } }, { - "id": 6021, + "id": 6138, "name": "variant", "variant": "param", "kind": 32768, @@ -129948,7 +132310,7 @@ } }, { - "id": 6022, + "id": 6139, "name": "variantPrice", "variant": "param", "kind": 32768, @@ -129967,7 +132329,7 @@ } }, { - "id": 6023, + "id": 6140, "name": "value", "variant": "param", "kind": 32768, @@ -129986,7 +132348,7 @@ } }, { - "id": 6024, + "id": 6141, "name": "discountType", "variant": "param", "kind": 32768, @@ -130023,14 +132385,14 @@ ] }, { - "id": 6025, + "id": 6142, "name": "getAllocationItemDiscounts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6026, + "id": 6143, "name": "getAllocationItemDiscounts", "variant": "signature", "kind": 4096, @@ -130056,7 +132418,7 @@ }, "parameters": [ { - "id": 6027, + "id": 6144, "name": "discount", "variant": "param", "kind": 32768, @@ -130080,7 +132442,7 @@ } }, { - "id": 6028, + "id": 6145, "name": "cart", "variant": "param", "kind": 32768, @@ -130134,14 +132496,14 @@ ] }, { - "id": 5998, + "id": 6115, "name": "getAllocationMap", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5999, + "id": 6116, "name": "getAllocationMap", "variant": "signature", "kind": 4096, @@ -130167,7 +132529,7 @@ }, "parameters": [ { - "id": 6000, + "id": 6117, "name": "orderOrCart", "variant": "param", "kind": 32768, @@ -130183,14 +132545,14 @@ "type": { "type": "reflection", "declaration": { - "id": 6001, + "id": 6118, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 6005, + "id": 6122, "name": "claims", "variant": "declaration", "kind": 1024, @@ -130211,7 +132573,7 @@ } }, { - "id": 6002, + "id": 6119, "name": "discounts", "variant": "declaration", "kind": 1024, @@ -130232,7 +132594,7 @@ } }, { - "id": 6003, + "id": 6120, "name": "items", "variant": "declaration", "kind": 1024, @@ -130251,7 +132613,7 @@ } }, { - "id": 6004, + "id": 6121, "name": "swaps", "variant": "declaration", "kind": 1024, @@ -130276,10 +132638,10 @@ { "title": "Properties", "children": [ - 6005, - 6002, - 6003, - 6004 + 6122, + 6119, + 6120, + 6121 ] } ] @@ -130287,7 +132649,7 @@ } }, { - "id": 6006, + "id": 6123, "name": "options", "variant": "param", "kind": 32768, @@ -130336,14 +132698,14 @@ ] }, { - "id": 6069, + "id": 6186, "name": "getCalculationContext", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6070, + "id": 6187, "name": "getCalculationContext", "variant": "signature", "kind": 4096, @@ -130369,7 +132731,7 @@ }, "parameters": [ { - "id": 6071, + "id": 6188, "name": "calculationContextData", "variant": "param", "kind": 32768, @@ -130393,7 +132755,7 @@ } }, { - "id": 6072, + "id": 6189, "name": "options", "variant": "param", "kind": 32768, @@ -130442,14 +132804,14 @@ ] }, { - "id": 6066, + "id": 6183, "name": "getDiscountTotal", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6067, + "id": 6184, "name": "getDiscountTotal", "variant": "signature", "kind": 4096, @@ -130475,7 +132837,7 @@ }, "parameters": [ { - "id": 6068, + "id": 6185, "name": "cartOrOrder", "variant": "param", "kind": 32768, @@ -130532,14 +132894,14 @@ ] }, { - "id": 6057, + "id": 6174, "name": "getGiftCardTotal", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6058, + "id": 6175, "name": "getGiftCardTotal", "variant": "signature", "kind": 4096, @@ -130565,7 +132927,7 @@ }, "parameters": [ { - "id": 6059, + "id": 6176, "name": "cartOrOrder", "variant": "param", "kind": 32768, @@ -130603,7 +132965,7 @@ } }, { - "id": 6060, + "id": 6177, "name": "opts", "variant": "param", "kind": 32768, @@ -130611,14 +132973,14 @@ "type": { "type": "reflection", "declaration": { - "id": 6061, + "id": 6178, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 6062, + "id": 6179, "name": "gift_cardable", "variant": "declaration", "kind": 1024, @@ -130635,7 +132997,7 @@ { "title": "Properties", "children": [ - 6062 + 6179 ] } ] @@ -130654,14 +133016,14 @@ { "type": "reflection", "declaration": { - "id": 6063, + "id": 6180, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 6065, + "id": 6182, "name": "tax_total", "variant": "declaration", "kind": 1024, @@ -130672,7 +133034,7 @@ } }, { - "id": 6064, + "id": 6181, "name": "total", "variant": "declaration", "kind": 1024, @@ -130687,8 +133049,8 @@ { "title": "Properties", "children": [ - 6065, - 6064 + 6182, + 6181 ] } ] @@ -130702,14 +133064,14 @@ ] }, { - "id": 6054, + "id": 6171, "name": "getGiftCardableAmount", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6055, + "id": 6172, "name": "getGiftCardableAmount", "variant": "signature", "kind": 4096, @@ -130735,7 +133097,7 @@ }, "parameters": [ { - "id": 6056, + "id": 6173, "name": "cartOrOrder", "variant": "param", "kind": 32768, @@ -130792,14 +133154,14 @@ ] }, { - "id": 6036, + "id": 6153, "name": "getLineDiscounts", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6037, + "id": 6154, "name": "getLineDiscounts", "variant": "signature", "kind": 4096, @@ -130825,7 +133187,7 @@ }, "parameters": [ { - "id": 6038, + "id": 6155, "name": "cartOrOrder", "variant": "param", "kind": 32768, @@ -130841,14 +133203,14 @@ "type": { "type": "reflection", "declaration": { - "id": 6039, + "id": 6156, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 6042, + "id": 6159, "name": "claims", "variant": "declaration", "kind": 1024, @@ -130869,7 +133231,7 @@ } }, { - "id": 6040, + "id": 6157, "name": "items", "variant": "declaration", "kind": 1024, @@ -130888,7 +133250,7 @@ } }, { - "id": 6041, + "id": 6158, "name": "swaps", "variant": "declaration", "kind": 1024, @@ -130913,9 +133275,9 @@ { "title": "Properties", "children": [ - 6042, - 6040, - 6041 + 6159, + 6157, + 6158 ] } ] @@ -130923,7 +133285,7 @@ } }, { - "id": 6043, + "id": 6160, "name": "discount", "variant": "param", "kind": 32768, @@ -130965,21 +133327,21 @@ ] }, { - "id": 6033, + "id": 6150, "name": "getLineItemAdjustmentsTotal", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6034, + "id": 6151, "name": "getLineItemAdjustmentsTotal", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 6035, + "id": 6152, "name": "cartOrOrder", "variant": "param", "kind": 32768, @@ -131017,21 +133379,21 @@ ] }, { - "id": 6029, + "id": 6146, "name": "getLineItemDiscountAdjustment", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6030, + "id": 6147, "name": "getLineItemDiscountAdjustment", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 6031, + "id": 6148, "name": "lineItem", "variant": "param", "kind": 32768, @@ -131047,7 +133409,7 @@ } }, { - "id": 6032, + "id": 6149, "name": "discount", "variant": "param", "kind": 32768, @@ -131071,14 +133433,14 @@ ] }, { - "id": 6010, + "id": 6127, "name": "getLineItemRefund", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6011, + "id": 6128, "name": "getLineItemRefund", "variant": "signature", "kind": 4096, @@ -131104,7 +133466,7 @@ }, "parameters": [ { - "id": 6012, + "id": 6129, "name": "order", "variant": "param", "kind": 32768, @@ -131128,7 +133490,7 @@ } }, { - "id": 6013, + "id": 6130, "name": "lineItem", "variant": "param", "kind": 32768, @@ -131171,14 +133533,14 @@ ] }, { - "id": 6049, + "id": 6166, "name": "getLineItemTotal", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6050, + "id": 6167, "name": "getLineItemTotal", "variant": "signature", "kind": 4096, @@ -131204,7 +133566,7 @@ }, "parameters": [ { - "id": 6051, + "id": 6168, "name": "lineItem", "variant": "param", "kind": 32768, @@ -131228,7 +133590,7 @@ } }, { - "id": 6052, + "id": 6169, "name": "cartOrOrder", "variant": "param", "kind": 32768, @@ -131266,7 +133628,7 @@ } }, { - "id": 6053, + "id": 6170, "name": "options", "variant": "param", "kind": 32768, @@ -131310,14 +133672,14 @@ ] }, { - "id": 6044, + "id": 6161, "name": "getLineItemTotals", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6045, + "id": 6162, "name": "getLineItemTotals", "variant": "signature", "kind": 4096, @@ -131343,7 +133705,7 @@ }, "parameters": [ { - "id": 6046, + "id": 6163, "name": "lineItem", "variant": "param", "kind": 32768, @@ -131367,7 +133729,7 @@ } }, { - "id": 6047, + "id": 6164, "name": "cartOrOrder", "variant": "param", "kind": 32768, @@ -131405,7 +133767,7 @@ } }, { - "id": 6048, + "id": 6165, "name": "options", "variant": "param", "kind": 32768, @@ -131454,14 +133816,14 @@ ] }, { - "id": 5976, + "id": 6093, "name": "getPaidTotal", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5977, + "id": 6094, "name": "getPaidTotal", "variant": "signature", "kind": 4096, @@ -131487,7 +133849,7 @@ }, "parameters": [ { - "id": 5978, + "id": 6095, "name": "order", "variant": "param", "kind": 32768, @@ -131519,14 +133881,14 @@ ] }, { - "id": 6014, + "id": 6131, "name": "getRefundTotal", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6015, + "id": 6132, "name": "getRefundTotal", "variant": "signature", "kind": 4096, @@ -131552,7 +133914,7 @@ }, "parameters": [ { - "id": 6016, + "id": 6133, "name": "order", "variant": "param", "kind": 32768, @@ -131576,7 +133938,7 @@ } }, { - "id": 6017, + "id": 6134, "name": "lineItems", "variant": "param", "kind": 32768, @@ -131622,14 +133984,14 @@ ] }, { - "id": 6007, + "id": 6124, "name": "getRefundedTotal", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6008, + "id": 6125, "name": "getRefundedTotal", "variant": "signature", "kind": 4096, @@ -131655,7 +134017,7 @@ }, "parameters": [ { - "id": 6009, + "id": 6126, "name": "order", "variant": "param", "kind": 32768, @@ -131687,14 +134049,14 @@ ] }, { - "id": 5982, + "id": 6099, "name": "getShippingMethodTotals", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5983, + "id": 6100, "name": "getShippingMethodTotals", "variant": "signature", "kind": 4096, @@ -131720,7 +134082,7 @@ }, "parameters": [ { - "id": 5984, + "id": 6101, "name": "shippingMethod", "variant": "param", "kind": 32768, @@ -131744,7 +134106,7 @@ } }, { - "id": 5985, + "id": 6102, "name": "cartOrOrder", "variant": "param", "kind": 32768, @@ -131782,7 +134144,7 @@ } }, { - "id": 5986, + "id": 6103, "name": "opts", "variant": "param", "kind": 32768, @@ -131831,14 +134193,14 @@ ] }, { - "id": 5991, + "id": 6108, "name": "getShippingTotal", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5992, + "id": 6109, "name": "getShippingTotal", "variant": "signature", "kind": 4096, @@ -131864,7 +134226,7 @@ }, "parameters": [ { - "id": 5993, + "id": 6110, "name": "cartOrOrder", "variant": "param", "kind": 32768, @@ -131921,14 +134283,14 @@ ] }, { - "id": 5987, + "id": 6104, "name": "getSubtotal", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5988, + "id": 6105, "name": "getSubtotal", "variant": "signature", "kind": 4096, @@ -131954,7 +134316,7 @@ }, "parameters": [ { - "id": 5989, + "id": 6106, "name": "cartOrOrder", "variant": "param", "kind": 32768, @@ -131992,7 +134354,7 @@ } }, { - "id": 5990, + "id": 6107, "name": "opts", "variant": "param", "kind": 32768, @@ -132036,14 +134398,14 @@ ] }, { - "id": 5979, + "id": 6096, "name": "getSwapTotal", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5980, + "id": 6097, "name": "getSwapTotal", "variant": "signature", "kind": 4096, @@ -132069,7 +134431,7 @@ }, "parameters": [ { - "id": 5981, + "id": 6098, "name": "order", "variant": "param", "kind": 32768, @@ -132101,14 +134463,14 @@ ] }, { - "id": 5994, + "id": 6111, "name": "getTaxTotal", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5995, + "id": 6112, "name": "getTaxTotal", "variant": "signature", "kind": 4096, @@ -132134,7 +134496,7 @@ }, "parameters": [ { - "id": 5996, + "id": 6113, "name": "cartOrOrder", "variant": "param", "kind": 32768, @@ -132172,7 +134534,7 @@ } }, { - "id": 5997, + "id": 6114, "name": "forceTaxes", "variant": "param", "kind": 32768, @@ -132220,14 +134582,14 @@ ] }, { - "id": 5972, + "id": 6089, "name": "getTotal", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 5973, + "id": 6090, "name": "getTotal", "variant": "signature", "kind": 4096, @@ -132253,7 +134615,7 @@ }, "parameters": [ { - "id": 5974, + "id": 6091, "name": "cartOrOrder", "variant": "param", "kind": 32768, @@ -132291,7 +134653,7 @@ } }, { - "id": 5975, + "id": 6092, "name": "options", "variant": "param", "kind": 32768, @@ -132335,14 +134697,14 @@ ] }, { - "id": 6073, + "id": 6190, "name": "rounded", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6074, + "id": 6191, "name": "rounded", "variant": "signature", "kind": 4096, @@ -132368,7 +134730,7 @@ }, "parameters": [ { - "id": 6075, + "id": 6192, "name": "value", "variant": "param", "kind": 32768, @@ -132395,7 +134757,7 @@ ] }, { - "id": 6086, + "id": 6203, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -132404,14 +134766,14 @@ }, "signatures": [ { - "id": 6087, + "id": 6204, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 6088, + "id": 6205, "name": "err", "variant": "param", "kind": 32768, @@ -132441,14 +134803,14 @@ { "type": "reflection", "declaration": { - "id": 6089, + "id": 6206, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 6090, + "id": 6207, "name": "code", "variant": "declaration", "kind": 1024, @@ -132463,7 +134825,7 @@ { "title": "Properties", "children": [ - 6090 + 6207 ] } ] @@ -132491,21 +134853,21 @@ } }, { - "id": 6083, + "id": 6200, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6084, + "id": 6201, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 6085, + "id": 6202, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -132525,7 +134887,7 @@ ], "type": { "type": "reference", - "target": 5964, + "target": 6081, "name": "TotalsService", "package": "@medusajs/medusa" }, @@ -132547,58 +134909,58 @@ { "title": "Constructors", "children": [ - 5965 + 6082 ] }, { "title": "Properties", "children": [ - 6081, - 6080, - 6082, - 5971, - 6076, - 5969, - 5970, - 5968, - 6077 + 6198, + 6197, + 6199, + 6088, + 6193, + 6086, + 6087, + 6085, + 6194 ] }, { "title": "Accessors", "children": [ - 6078 + 6195 ] }, { "title": "Methods", "children": [ - 6091, - 6018, - 6025, - 5998, - 6069, - 6066, - 6057, - 6054, - 6036, - 6033, - 6029, - 6010, - 6049, - 6044, - 5976, - 6014, - 6007, - 5982, - 5991, - 5987, - 5979, - 5994, - 5972, - 6073, - 6086, - 6083 + 6208, + 6135, + 6142, + 6115, + 6186, + 6183, + 6174, + 6171, + 6153, + 6150, + 6146, + 6127, + 6166, + 6161, + 6093, + 6131, + 6124, + 6099, + 6108, + 6104, + 6096, + 6111, + 6089, + 6190, + 6203, + 6200 ] } ], @@ -132615,7 +134977,7 @@ ] }, { - "id": 6107, + "id": 6224, "name": "UserService", "variant": "declaration", "kind": 128, @@ -132630,21 +134992,21 @@ }, "children": [ { - "id": 6114, + "id": 6231, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 6115, + "id": 6232, "name": "new UserService", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 6116, + "id": 6233, "name": "__namedParameters", "variant": "param", "kind": 32768, @@ -132662,7 +135024,7 @@ ], "type": { "type": "reference", - "target": 6107, + "target": 6224, "name": "UserService", "package": "@medusajs/medusa" }, @@ -132680,7 +135042,7 @@ } }, { - "id": 6164, + "id": 6281, "name": "__configModule__", "variant": "declaration", "kind": 1024, @@ -132715,7 +135077,7 @@ } }, { - "id": 6163, + "id": 6280, "name": "__container__", "variant": "declaration", "kind": 1024, @@ -132734,7 +135096,7 @@ } }, { - "id": 6165, + "id": 6282, "name": "__moduleDeclaration__", "variant": "declaration", "kind": 1024, @@ -132769,7 +135131,7 @@ } }, { - "id": 6117, + "id": 6234, "name": "analyticsConfigService_", "variant": "declaration", "kind": 1024, @@ -132785,7 +135147,7 @@ } }, { - "id": 6119, + "id": 6236, "name": "eventBus_", "variant": "declaration", "kind": 1024, @@ -132795,13 +135157,13 @@ }, "type": { "type": "reference", - "target": 1332, + "target": 1386, "name": "default", "package": "@medusajs/medusa" } }, { - "id": 6120, + "id": 6237, "name": "featureFlagRouter_", "variant": "declaration", "kind": 1024, @@ -132820,7 +135182,7 @@ } }, { - "id": 6159, + "id": 6276, "name": "manager_", "variant": "declaration", "kind": 1024, @@ -132843,7 +135205,7 @@ } }, { - "id": 6160, + "id": 6277, "name": "transactionManager_", "variant": "declaration", "kind": 1024, @@ -132875,7 +135237,7 @@ } }, { - "id": 6118, + "id": 6235, "name": "userRepository_", "variant": "declaration", "kind": 1024, @@ -132905,7 +135267,7 @@ } }, { - "id": 6108, + "id": 6225, "name": "Events", "variant": "declaration", "kind": 1024, @@ -132915,14 +135277,14 @@ "type": { "type": "reflection", "declaration": { - "id": 6109, + "id": 6226, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 6111, + "id": 6228, "name": "CREATED", "variant": "declaration", "kind": 1024, @@ -132934,7 +135296,7 @@ "defaultValue": "\"user.created\"" }, { - "id": 6113, + "id": 6230, "name": "DELETED", "variant": "declaration", "kind": 1024, @@ -132946,7 +135308,7 @@ "defaultValue": "\"user.deleted\"" }, { - "id": 6110, + "id": 6227, "name": "PASSWORD_RESET", "variant": "declaration", "kind": 1024, @@ -132958,7 +135320,7 @@ "defaultValue": "\"user.password_reset\"" }, { - "id": 6112, + "id": 6229, "name": "UPDATED", "variant": "declaration", "kind": 1024, @@ -132974,10 +135336,10 @@ { "title": "Properties", "children": [ - 6111, - 6113, - 6110, - 6112 + 6228, + 6230, + 6227, + 6229 ] } ] @@ -132986,7 +135348,7 @@ "defaultValue": "..." }, { - "id": 6161, + "id": 6278, "name": "activeManager_", "variant": "declaration", "kind": 262144, @@ -132994,7 +135356,7 @@ "isProtected": true }, "getSignature": { - "id": 6162, + "id": 6279, "name": "activeManager_", "variant": "signature", "kind": 524288, @@ -133021,7 +135383,7 @@ } }, { - "id": 6174, + "id": 6291, "name": "atomicPhase_", "variant": "declaration", "kind": 2048, @@ -133030,7 +135392,7 @@ }, "signatures": [ { - "id": 6175, + "id": 6292, "name": "atomicPhase_", "variant": "signature", "kind": 4096, @@ -133056,14 +135418,14 @@ }, "typeParameter": [ { - "id": 6176, + "id": 6293, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 6177, + "id": 6294, "name": "TError", "variant": "typeParam", "kind": 131072, @@ -133072,7 +135434,7 @@ ], "parameters": [ { - "id": 6178, + "id": 6295, "name": "work", "variant": "param", "kind": 32768, @@ -133088,21 +135450,21 @@ "type": { "type": "reflection", "declaration": { - "id": 6179, + "id": 6296, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 6180, + "id": 6297, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 6181, + "id": 6298, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -133141,7 +135503,7 @@ } }, { - "id": 6182, + "id": 6299, "name": "isolationOrErrorHandler", "variant": "param", "kind": 32768, @@ -133171,21 +135533,21 @@ { "type": "reflection", "declaration": { - "id": 6183, + "id": 6300, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 6184, + "id": 6301, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 6185, + "id": 6302, "name": "error", "variant": "param", "kind": 32768, @@ -133232,7 +135594,7 @@ } }, { - "id": 6186, + "id": 6303, "name": "maybeErrorHandlerOrDontFail", "variant": "param", "kind": 32768, @@ -133250,21 +135612,21 @@ "type": { "type": "reflection", "declaration": { - "id": 6187, + "id": 6304, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 6188, + "id": 6305, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 6189, + "id": 6306, "name": "error", "variant": "param", "kind": 32768, @@ -133340,14 +135702,14 @@ } }, { - "id": 6141, + "id": 6258, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6142, + "id": 6259, "name": "create", "variant": "signature", "kind": 4096, @@ -133373,7 +135735,7 @@ }, "parameters": [ { - "id": 6143, + "id": 6260, "name": "user", "variant": "param", "kind": 32768, @@ -133397,7 +135759,7 @@ } }, { - "id": 6144, + "id": 6261, "name": "password", "variant": "param", "kind": 32768, @@ -133440,14 +135802,14 @@ ] }, { - "id": 6149, + "id": 6266, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6150, + "id": 6267, "name": "delete", "variant": "signature", "kind": 4096, @@ -133473,7 +135835,7 @@ }, "parameters": [ { - "id": 6151, + "id": 6268, "name": "userId", "variant": "param", "kind": 32768, @@ -133511,14 +135873,14 @@ ] }, { - "id": 6156, + "id": 6273, "name": "generateResetPasswordToken", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6157, + "id": 6274, "name": "generateResetPasswordToken", "variant": "signature", "kind": 4096, @@ -133544,7 +135906,7 @@ }, "parameters": [ { - "id": 6158, + "id": 6275, "name": "userId", "variant": "param", "kind": 32768, @@ -133582,14 +135944,14 @@ ] }, { - "id": 6138, + "id": 6255, "name": "hashPassword_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6139, + "id": 6256, "name": "hashPassword_", "variant": "signature", "kind": 4096, @@ -133615,7 +135977,7 @@ }, "parameters": [ { - "id": 6140, + "id": 6257, "name": "password", "variant": "param", "kind": 32768, @@ -133653,14 +136015,14 @@ ] }, { - "id": 6121, + "id": 6238, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6122, + "id": 6239, "name": "list", "variant": "signature", "kind": 4096, @@ -133681,7 +136043,7 @@ }, "parameters": [ { - "id": 6123, + "id": 6240, "name": "selector", "variant": "param", "kind": 32768, @@ -133705,7 +136067,7 @@ } }, { - "id": 6124, + "id": 6241, "name": "config", "variant": "param", "kind": 32768, @@ -133721,7 +136083,7 @@ "type": { "type": "reflection", "declaration": { - "id": 6125, + "id": 6242, "name": "__type", "variant": "declaration", "kind": 65536, @@ -133758,14 +136120,14 @@ ] }, { - "id": 6126, + "id": 6243, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6127, + "id": 6244, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -133791,7 +136153,7 @@ }, "parameters": [ { - "id": 6128, + "id": 6245, "name": "userId", "variant": "param", "kind": 32768, @@ -133810,7 +136172,7 @@ } }, { - "id": 6129, + "id": 6246, "name": "config", "variant": "param", "kind": 32768, @@ -133870,14 +136232,14 @@ ] }, { - "id": 6130, + "id": 6247, "name": "retrieveByApiToken", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6131, + "id": 6248, "name": "retrieveByApiToken", "variant": "signature", "kind": 4096, @@ -133903,7 +136265,7 @@ }, "parameters": [ { - "id": 6132, + "id": 6249, "name": "apiToken", "variant": "param", "kind": 32768, @@ -133922,7 +136284,7 @@ } }, { - "id": 6133, + "id": 6250, "name": "relations", "variant": "param", "kind": 32768, @@ -133969,14 +136331,14 @@ ] }, { - "id": 6134, + "id": 6251, "name": "retrieveByEmail", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6135, + "id": 6252, "name": "retrieveByEmail", "variant": "signature", "kind": 4096, @@ -134002,7 +136364,7 @@ }, "parameters": [ { - "id": 6136, + "id": 6253, "name": "email", "variant": "param", "kind": 32768, @@ -134021,7 +136383,7 @@ } }, { - "id": 6137, + "id": 6254, "name": "config", "variant": "param", "kind": 32768, @@ -134081,14 +136443,14 @@ ] }, { - "id": 6152, + "id": 6269, "name": "setPassword_", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6153, + "id": 6270, "name": "setPassword_", "variant": "signature", "kind": 4096, @@ -134114,7 +136476,7 @@ }, "parameters": [ { - "id": 6154, + "id": 6271, "name": "userId", "variant": "param", "kind": 32768, @@ -134133,7 +136495,7 @@ } }, { - "id": 6155, + "id": 6272, "name": "password", "variant": "param", "kind": 32768, @@ -134176,7 +136538,7 @@ ] }, { - "id": 6169, + "id": 6286, "name": "shouldRetryTransaction_", "variant": "declaration", "kind": 2048, @@ -134185,14 +136547,14 @@ }, "signatures": [ { - "id": 6170, + "id": 6287, "name": "shouldRetryTransaction_", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 6171, + "id": 6288, "name": "err", "variant": "param", "kind": 32768, @@ -134222,14 +136584,14 @@ { "type": "reflection", "declaration": { - "id": 6172, + "id": 6289, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 6173, + "id": 6290, "name": "code", "variant": "declaration", "kind": 1024, @@ -134244,7 +136606,7 @@ { "title": "Properties", "children": [ - 6173 + 6290 ] } ] @@ -134272,14 +136634,14 @@ } }, { - "id": 6145, + "id": 6262, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6146, + "id": 6263, "name": "update", "variant": "signature", "kind": 4096, @@ -134305,7 +136667,7 @@ }, "parameters": [ { - "id": 6147, + "id": 6264, "name": "userId", "variant": "param", "kind": 32768, @@ -134324,7 +136686,7 @@ } }, { - "id": 6148, + "id": 6265, "name": "update", "variant": "param", "kind": 32768, @@ -134372,21 +136734,21 @@ ] }, { - "id": 6166, + "id": 6283, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 6167, + "id": 6284, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 6168, + "id": 6285, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -134406,7 +136768,7 @@ ], "type": { "type": "reference", - "target": 6107, + "target": 6224, "name": "UserService", "package": "@medusajs/medusa" }, @@ -134428,46 +136790,46 @@ { "title": "Constructors", "children": [ - 6114 + 6231 ] }, { "title": "Properties", "children": [ - 6164, - 6163, - 6165, - 6117, - 6119, - 6120, - 6159, - 6160, - 6118, - 6108 + 6281, + 6280, + 6282, + 6234, + 6236, + 6237, + 6276, + 6277, + 6235, + 6225 ] }, { "title": "Accessors", "children": [ - 6161 + 6278 ] }, { "title": "Methods", "children": [ - 6174, - 6141, - 6149, - 6156, - 6138, - 6121, - 6126, - 6130, - 6134, - 6152, - 6169, - 6145, - 6166 + 6291, + 6258, + 6266, + 6273, + 6255, + 6238, + 6243, + 6247, + 6251, + 6269, + 6286, + 6262, + 6283 ] } ], @@ -134490,62 +136852,62 @@ "children": [ 1, 52, - 104, - 198, - 577, - 461, - 637, - 689, - 863, - 738, - 1139, - 955, - 1243, - 1332, - 1484, - 1404, - 1565, - 1651, - 1850, - 1713, - 1920, - 1956, - 2114, - 2181, - 2262, - 2698, - 2554, - 2331, - 2824, - 2919, - 2755, - 3083, - 3316, - 3699, - 3854, - 3441, - 4014, - 4409, - 4076, - 4533, - 4755, - 4652, - 4915, - 4958, - 4809, - 5011, - 5056, - 5168, - 5343, - 5392, - 5447, - 5486, - 5636, - 5702, - 5804, - 5950, - 5964, - 6107 + 105, + 199, + 578, + 462, + 644, + 696, + 893, + 745, + 1189, + 985, + 1297, + 1386, + 1538, + 1458, + 1619, + 1705, + 1904, + 1767, + 1974, + 2010, + 2168, + 2235, + 2316, + 2752, + 2608, + 2385, + 2878, + 2973, + 2809, + 3137, + 3370, + 3766, + 3921, + 3495, + 4086, + 4497, + 4150, + 4621, + 4843, + 4740, + 5022, + 5065, + 4897, + 5118, + 5163, + 5275, + 5455, + 5504, + 5559, + 5598, + 5748, + 5814, + 5916, + 6067, + 6081, + 6224 ] } ], @@ -134785,7 +137147,7 @@ }, "58": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", - "qualifiedName": "AuthService.comparePassword_" + "qualifiedName": "AuthService.logger_" }, "59": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", @@ -134793,15 +137155,15 @@ }, "60": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", - "qualifiedName": "password" + "qualifiedName": "AuthService.comparePassword_" }, "61": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", - "qualifiedName": "hash" + "qualifiedName": "password" }, "62": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", - "qualifiedName": "AuthService.authenticateAPIToken" + "qualifiedName": "hash" }, "63": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", @@ -134809,11 +137171,11 @@ }, "64": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", - "qualifiedName": "token" + "qualifiedName": "AuthService.authenticateAPIToken" }, "65": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", - "qualifiedName": "AuthService.authenticate" + "qualifiedName": "token" }, "66": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", @@ -134821,15 +137183,15 @@ }, "67": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", - "qualifiedName": "email" + "qualifiedName": "AuthService.authenticate" }, "68": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", - "qualifiedName": "password" + "qualifiedName": "email" }, "69": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", - "qualifiedName": "AuthService.authenticateCustomer" + "qualifiedName": "password" }, "70": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", @@ -134837,23 +137199,23 @@ }, "71": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", - "qualifiedName": "email" + "qualifiedName": "AuthService.authenticateCustomer" }, "72": { "sourceFileName": "../../../packages/medusa/src/services/auth.ts", - "qualifiedName": "password" + "qualifiedName": "email" }, "73": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.manager_" + "sourceFileName": "../../../packages/medusa/src/services/auth.ts", + "qualifiedName": "password" }, "74": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.transactionManager_" + "qualifiedName": "TransactionBaseService.manager_" }, "75": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" + "qualifiedName": "TransactionBaseService.transactionManager_" }, "76": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -134861,19 +137223,19 @@ }, "77": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__container__" + "qualifiedName": "TransactionBaseService.activeManager_" }, "78": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__configModule__" + "qualifiedName": "TransactionBaseService.__container__" }, "79": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + "qualifiedName": "TransactionBaseService.__configModule__" }, "80": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, "81": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -134881,11 +137243,11 @@ }, "82": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TransactionBaseService.withTransaction" }, "83": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + "qualifiedName": "transactionManager" }, "84": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -134893,19 +137255,19 @@ }, "85": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "err" + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, "86": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "err" }, "87": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type.code" + "qualifiedName": "__type" }, "88": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" + "qualifiedName": "__type.code" }, "89": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -134913,19 +137275,19 @@ }, "90": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TResult" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "91": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TError" + "qualifiedName": "TResult" }, "92": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "work" + "qualifiedName": "TError" }, "93": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "work" }, "94": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -134933,15 +137295,15 @@ }, "95": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "__type" }, "96": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" + "qualifiedName": "transactionManager" }, "97": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "isolationOrErrorHandler" }, "98": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -134949,15 +137311,15 @@ }, "99": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "100": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "maybeErrorHandlerOrDontFail" + "qualifiedName": "error" }, "101": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "maybeErrorHandlerOrDontFail" }, "102": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -134965,95 +137327,95 @@ }, "103": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "104": { - "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService" + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" }, "105": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.Events" + "qualifiedName": "BatchJobService" }, "106": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__object" + "qualifiedName": "BatchJobService.Events" }, "107": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__object.CREATED" + "qualifiedName": "__object" }, "108": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__object.UPDATED" + "qualifiedName": "__object.CREATED" }, "109": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__object.PRE_PROCESSED" + "qualifiedName": "__object.UPDATED" }, "110": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__object.CONFIRMED" + "qualifiedName": "__object.PRE_PROCESSED" }, "111": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__object.PROCESSING" + "qualifiedName": "__object.CONFIRMED" }, "112": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__object.COMPLETED" + "qualifiedName": "__object.PROCESSING" }, "113": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__object.CANCELED" + "qualifiedName": "__object.COMPLETED" }, "114": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__object.FAILED" + "qualifiedName": "__object.CANCELED" }, "115": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.__constructor" + "qualifiedName": "__object.FAILED" }, "116": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService" + "qualifiedName": "BatchJobService.__constructor" }, "117": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__0" + "qualifiedName": "BatchJobService" }, "118": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.batchJobRepository_" + "qualifiedName": "__0" }, "119": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.eventBus_" + "qualifiedName": "BatchJobService.batchJobRepository_" }, "120": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.strategyResolver_" + "qualifiedName": "BatchJobService.eventBus_" }, "121": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.batchJobStatusMapToProps" + "qualifiedName": "BatchJobService.strategyResolver_" }, "122": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__type" + "qualifiedName": "BatchJobService.batchJobStatusMapToProps" }, "123": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__type.entityColumnName" + "qualifiedName": "__type" }, "124": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "__type.eventType" + "qualifiedName": "__type.entityColumnName" }, "125": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.retrieve" + "qualifiedName": "__type.eventType" }, "126": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", @@ -135061,15 +137423,15 @@ }, "127": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "batchJobId" + "qualifiedName": "BatchJobService.retrieve" }, "128": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "config" + "qualifiedName": "batchJobId" }, "129": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.listAndCount" + "qualifiedName": "config" }, "130": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", @@ -135077,15 +137439,15 @@ }, "131": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "selector" + "qualifiedName": "BatchJobService.listAndCount" }, "132": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "config" + "qualifiedName": "selector" }, "133": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.create" + "qualifiedName": "config" }, "134": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", @@ -135093,11 +137455,11 @@ }, "135": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "data" + "qualifiedName": "BatchJobService.create" }, "136": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.update" + "qualifiedName": "data" }, "137": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", @@ -135105,15 +137467,15 @@ }, "138": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "batchJobOrId" + "qualifiedName": "BatchJobService.update" }, "139": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "data" + "qualifiedName": "batchJobOrId" }, "140": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.confirm" + "qualifiedName": "data" }, "141": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", @@ -135121,11 +137483,11 @@ }, "142": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "batchJobOrId" + "qualifiedName": "BatchJobService.confirm" }, "143": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.complete" + "qualifiedName": "batchJobOrId" }, "144": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", @@ -135133,11 +137495,11 @@ }, "145": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "batchJobOrId" + "qualifiedName": "BatchJobService.complete" }, "146": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.cancel" + "qualifiedName": "batchJobOrId" }, "147": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", @@ -135145,11 +137507,11 @@ }, "148": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "batchJobOrId" + "qualifiedName": "BatchJobService.cancel" }, "149": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.setPreProcessingDone" + "qualifiedName": "batchJobOrId" }, "150": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", @@ -135157,11 +137519,11 @@ }, "151": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "batchJobOrId" + "qualifiedName": "BatchJobService.setPreProcessingDone" }, "152": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.setProcessing" + "qualifiedName": "batchJobOrId" }, "153": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", @@ -135169,11 +137531,11 @@ }, "154": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "batchJobOrId" + "qualifiedName": "BatchJobService.setProcessing" }, "155": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.setFailed" + "qualifiedName": "batchJobOrId" }, "156": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", @@ -135181,15 +137543,15 @@ }, "157": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "batchJobOrId" + "qualifiedName": "BatchJobService.setFailed" }, "158": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "error" + "qualifiedName": "batchJobOrId" }, "159": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.prepareBatchJobForProcessing" + "qualifiedName": "error" }, "160": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", @@ -135197,15 +137559,15 @@ }, "161": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "data" + "qualifiedName": "BatchJobService.prepareBatchJobForProcessing" }, "162": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "req" + "qualifiedName": "data" }, "163": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService.updateStatus" + "qualifiedName": "req" }, "164": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", @@ -135213,23 +137575,23 @@ }, "165": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "batchJobOrId" + "qualifiedName": "BatchJobService.updateStatus" }, "166": { "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "status" + "qualifiedName": "batchJobOrId" }, "167": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.manager_" + "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", + "qualifiedName": "status" }, "168": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.transactionManager_" + "qualifiedName": "TransactionBaseService.manager_" }, "169": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" + "qualifiedName": "TransactionBaseService.transactionManager_" }, "170": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -135237,19 +137599,19 @@ }, "171": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__container__" + "qualifiedName": "TransactionBaseService.activeManager_" }, "172": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__configModule__" + "qualifiedName": "TransactionBaseService.__container__" }, "173": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + "qualifiedName": "TransactionBaseService.__configModule__" }, "174": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, "175": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -135257,11 +137619,11 @@ }, "176": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TransactionBaseService.withTransaction" }, "177": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + "qualifiedName": "transactionManager" }, "178": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -135269,19 +137631,19 @@ }, "179": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "err" + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, "180": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "err" }, "181": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type.code" + "qualifiedName": "__type" }, "182": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" + "qualifiedName": "__type.code" }, "183": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -135289,19 +137651,19 @@ }, "184": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TResult" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "185": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TError" + "qualifiedName": "TResult" }, "186": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "work" + "qualifiedName": "TError" }, "187": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "work" }, "188": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -135309,15 +137671,15 @@ }, "189": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "__type" }, "190": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" + "qualifiedName": "transactionManager" }, "191": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "isolationOrErrorHandler" }, "192": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -135325,15 +137687,15 @@ }, "193": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "194": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "maybeErrorHandlerOrDontFail" + "qualifiedName": "error" }, "195": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "maybeErrorHandlerOrDontFail" }, "196": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -135341,59 +137703,59 @@ }, "197": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "198": { - "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService" + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" }, "199": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.Events" + "qualifiedName": "CartService" }, "200": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__object" + "qualifiedName": "CartService.Events" }, "201": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__object.CUSTOMER_UPDATED" + "qualifiedName": "__object" }, "202": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__object.CREATED" + "qualifiedName": "__object.CUSTOMER_UPDATED" }, "203": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__object.UPDATED" + "qualifiedName": "__object.CREATED" }, "204": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.__constructor" + "qualifiedName": "__object.UPDATED" }, "205": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService" + "qualifiedName": "CartService.__constructor" }, "206": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__0" + "qualifiedName": "CartService" }, "207": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.shippingMethodRepository_" + "qualifiedName": "__0" }, "208": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.cartRepository_" + "qualifiedName": "CartService.shippingMethodRepository_" }, "209": { - "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", - "qualifiedName": "__object" + "sourceFileName": "../../../packages/medusa/src/services/cart.ts", + "qualifiedName": "CartService.cartRepository_" }, "210": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", - "qualifiedName": "__object.findWithRelations" + "qualifiedName": "__object" }, "211": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", @@ -135401,15 +137763,15 @@ }, "212": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", - "qualifiedName": "relations" + "qualifiedName": "__object.findWithRelations" }, "213": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", - "qualifiedName": "optionsWithoutRelations" + "qualifiedName": "relations" }, "214": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", - "qualifiedName": "__object.findOneWithRelations" + "qualifiedName": "optionsWithoutRelations" }, "215": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", @@ -135417,31 +137779,31 @@ }, "216": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", - "qualifiedName": "relations" + "qualifiedName": "__object.findOneWithRelations" }, "217": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", - "qualifiedName": "optionsWithoutRelations" + "qualifiedName": "relations" }, "218": { - "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.addressRepository_" + "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", + "qualifiedName": "optionsWithoutRelations" }, "219": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.paymentSessionRepository_" + "qualifiedName": "CartService.addressRepository_" }, "220": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.lineItemRepository_" + "qualifiedName": "CartService.paymentSessionRepository_" }, "221": { - "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", - "qualifiedName": "__object" + "sourceFileName": "../../../packages/medusa/src/services/cart.ts", + "qualifiedName": "CartService.lineItemRepository_" }, "222": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", - "qualifiedName": "__object.findByReturn" + "qualifiedName": "__object" }, "223": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", @@ -135449,107 +137811,107 @@ }, "224": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", - "qualifiedName": "returnId" + "qualifiedName": "__object.findByReturn" }, "225": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", - "qualifiedName": "__type" + "qualifiedName": "returnId" }, "226": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", - "qualifiedName": "__type.return_item" + "qualifiedName": "__type" }, "227": { - "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.eventBus_" + "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", + "qualifiedName": "__type.return_item" }, "228": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.productVariantService_" + "qualifiedName": "CartService.eventBus_" }, "229": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.productService_" + "qualifiedName": "CartService.productVariantService_" }, "230": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.storeService_" + "qualifiedName": "CartService.productService_" }, "231": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.salesChannelService_" + "qualifiedName": "CartService.storeService_" }, "232": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.regionService_" + "qualifiedName": "CartService.salesChannelService_" }, "233": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.lineItemService_" + "qualifiedName": "CartService.regionService_" }, "234": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.paymentProviderService_" + "qualifiedName": "CartService.lineItemService_" }, "235": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.customerService_" + "qualifiedName": "CartService.paymentProviderService_" }, "236": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.shippingOptionService_" + "qualifiedName": "CartService.customerService_" }, "237": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.shippingProfileService_" + "qualifiedName": "CartService.shippingOptionService_" }, "238": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.discountService_" + "qualifiedName": "CartService.shippingProfileService_" }, "239": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.giftCardService_" + "qualifiedName": "CartService.discountService_" }, "240": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.taxProviderService_" + "qualifiedName": "CartService.giftCardService_" }, "241": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.totalsService_" + "qualifiedName": "CartService.taxProviderService_" }, "242": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.newTotalsService_" + "qualifiedName": "CartService.totalsService_" }, "243": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.customShippingOptionService_" + "qualifiedName": "CartService.newTotalsService_" }, "244": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.priceSelectionStrategy_" + "qualifiedName": "CartService.customShippingOptionService_" }, "245": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.lineItemAdjustmentService_" + "qualifiedName": "CartService.priceSelectionStrategy_" }, "246": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.featureFlagRouter_" + "qualifiedName": "CartService.lineItemAdjustmentService_" }, "247": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.productVariantInventoryService_" + "qualifiedName": "CartService.featureFlagRouter_" }, "248": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.pricingService_" + "qualifiedName": "CartService.productVariantInventoryService_" }, "249": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.list" + "qualifiedName": "CartService.pricingService_" }, "250": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135557,15 +137919,15 @@ }, "251": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "selector" + "qualifiedName": "CartService.list" }, "252": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "config" + "qualifiedName": "selector" }, "253": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.retrieve" + "qualifiedName": "config" }, "254": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135573,19 +137935,19 @@ }, "255": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.retrieve" }, "256": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "options" + "qualifiedName": "cartId" }, "257": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "totalsConfig" + "qualifiedName": "options" }, "258": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.retrieveLegacy" + "qualifiedName": "totalsConfig" }, "259": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135593,19 +137955,19 @@ }, "260": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.retrieveLegacy" }, "261": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "options" + "qualifiedName": "cartId" }, "262": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "totalsConfig" + "qualifiedName": "options" }, "263": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.retrieveWithTotals" + "qualifiedName": "totalsConfig" }, "264": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135613,19 +137975,19 @@ }, "265": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.retrieveWithTotals" }, "266": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "options" + "qualifiedName": "cartId" }, "267": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "totalsConfig" + "qualifiedName": "options" }, "268": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.create" + "qualifiedName": "totalsConfig" }, "269": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135633,11 +137995,11 @@ }, "270": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "data" + "qualifiedName": "CartService.create" }, "271": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.getValidatedSalesChannel" + "qualifiedName": "data" }, "272": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135645,11 +138007,11 @@ }, "273": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "salesChannelId" + "qualifiedName": "CartService.getValidatedSalesChannel" }, "274": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.removeLineItem" + "qualifiedName": "salesChannelId" }, "275": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135657,15 +138019,15 @@ }, "276": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.removeLineItem" }, "277": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "lineItemId" + "qualifiedName": "cartId" }, "278": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.validateLineItemShipping_" + "qualifiedName": "lineItemId" }, "279": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135673,15 +138035,15 @@ }, "280": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "shippingMethods" + "qualifiedName": "CartService.validateLineItemShipping_" }, "281": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "lineItemShippingProfiledId" + "qualifiedName": "shippingMethods" }, "282": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.validateLineItem" + "qualifiedName": "lineItemShippingProfiledId" }, "283": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135689,23 +138051,23 @@ }, "284": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__0" + "qualifiedName": "CartService.validateLineItem" }, "285": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__type" + "qualifiedName": "__0" }, "286": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__type.sales_channel_id" + "qualifiedName": "__type" }, "287": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "lineItem" + "qualifiedName": "__type.sales_channel_id" }, "288": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.addLineItem" + "qualifiedName": "lineItem" }, "289": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135713,27 +138075,27 @@ }, "290": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.addLineItem" }, "291": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "lineItem" + "qualifiedName": "cartId" }, "292": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "config" + "qualifiedName": "lineItem" }, "293": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__object" + "qualifiedName": "config" }, "294": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__object.validateSalesChannels" + "qualifiedName": "__object" }, "295": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.addOrUpdateLineItems" + "qualifiedName": "__object.validateSalesChannels" }, "296": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135741,27 +138103,27 @@ }, "297": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.addOrUpdateLineItems" }, "298": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "lineItems" + "qualifiedName": "cartId" }, "299": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "config" + "qualifiedName": "lineItems" }, "300": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__object" + "qualifiedName": "config" }, "301": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__object.validateSalesChannels" + "qualifiedName": "__object" }, "302": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.updateLineItem" + "qualifiedName": "__object.validateSalesChannels" }, "303": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135769,19 +138131,19 @@ }, "304": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.updateLineItem" }, "305": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "lineItemId" + "qualifiedName": "cartId" }, "306": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "update" + "qualifiedName": "lineItemId" }, "307": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.adjustFreeShipping_" + "qualifiedName": "update" }, "308": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135789,15 +138151,15 @@ }, "309": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.adjustFreeShipping_" }, "310": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "shouldAdd" + "qualifiedName": "cart" }, "311": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.update" + "qualifiedName": "shouldAdd" }, "312": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135805,15 +138167,15 @@ }, "313": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartOrId" + "qualifiedName": "CartService.update" }, "314": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "data" + "qualifiedName": "cartOrId" }, "315": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.onSalesChannelChange" + "qualifiedName": "data" }, "316": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135821,15 +138183,15 @@ }, "317": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.onSalesChannelChange" }, "318": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "newSalesChannelId" + "qualifiedName": "cart" }, "319": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.updateCustomerId_" + "qualifiedName": "newSalesChannelId" }, "320": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135837,15 +138199,15 @@ }, "321": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.updateCustomerId_" }, "322": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "customerId" + "qualifiedName": "cart" }, "323": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.createOrFetchGuestCustomerFromEmail_" + "qualifiedName": "customerId" }, "324": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135853,11 +138215,11 @@ }, "325": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "email" + "qualifiedName": "CartService.createOrFetchGuestCustomerFromEmail_" }, "326": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.updateBillingAddress_" + "qualifiedName": "email" }, "327": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135865,19 +138227,19 @@ }, "328": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.updateBillingAddress_" }, "329": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "addressOrId" + "qualifiedName": "cart" }, "330": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "addrRepo" + "qualifiedName": "addressOrId" }, "331": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.updateShippingAddress_" + "qualifiedName": "addrRepo" }, "332": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135885,19 +138247,19 @@ }, "333": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.updateShippingAddress_" }, "334": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "addressOrId" + "qualifiedName": "cart" }, "335": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "addrRepo" + "qualifiedName": "addressOrId" }, "336": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.applyGiftCard_" + "qualifiedName": "addrRepo" }, "337": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135905,15 +138267,15 @@ }, "338": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.applyGiftCard_" }, "339": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "code" + "qualifiedName": "cart" }, "340": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.applyDiscount" + "qualifiedName": "code" }, "341": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135921,15 +138283,15 @@ }, "342": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.applyDiscount" }, "343": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "discountCode" + "qualifiedName": "cart" }, "344": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.applyDiscounts" + "qualifiedName": "discountCode" }, "345": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135937,15 +138299,15 @@ }, "346": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.applyDiscounts" }, "347": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "discountCodes" + "qualifiedName": "cart" }, "348": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.removeDiscount" + "qualifiedName": "discountCodes" }, "349": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135953,15 +138315,15 @@ }, "350": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.removeDiscount" }, "351": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "discountCode" + "qualifiedName": "cartId" }, "352": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.updatePaymentSession" + "qualifiedName": "discountCode" }, "353": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135969,15 +138331,15 @@ }, "354": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.updatePaymentSession" }, "355": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "update" + "qualifiedName": "cartId" }, "356": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.authorizePayment" + "qualifiedName": "update" }, "357": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -135985,23 +138347,23 @@ }, "358": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.authorizePayment" }, "359": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "context" + "qualifiedName": "cartId" }, "360": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__type" + "qualifiedName": "context" }, "361": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__type.cart_id" + "qualifiedName": "__type" }, "362": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.setPaymentSession" + "qualifiedName": "__type.cart_id" }, "363": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136009,15 +138371,15 @@ }, "364": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.setPaymentSession" }, "365": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "providerId" + "qualifiedName": "cartId" }, "366": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.setPaymentSessions" + "qualifiedName": "providerId" }, "367": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136025,11 +138387,11 @@ }, "368": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartOrCartId" + "qualifiedName": "CartService.setPaymentSessions" }, "369": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.deletePaymentSession" + "qualifiedName": "cartOrCartId" }, "370": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136037,15 +138399,15 @@ }, "371": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.deletePaymentSession" }, "372": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "providerId" + "qualifiedName": "cartId" }, "373": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.refreshPaymentSession" + "qualifiedName": "providerId" }, "374": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136053,15 +138415,15 @@ }, "375": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.refreshPaymentSession" }, "376": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "providerId" + "qualifiedName": "cartId" }, "377": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.addShippingMethod" + "qualifiedName": "providerId" }, "378": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136069,19 +138431,19 @@ }, "379": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartOrId" + "qualifiedName": "CartService.addShippingMethod" }, "380": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "optionId" + "qualifiedName": "cartOrId" }, "381": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "data" + "qualifiedName": "optionId" }, "382": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.findCustomShippingOption" + "qualifiedName": "data" }, "383": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136089,15 +138451,15 @@ }, "384": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartCustomShippingOptions" + "qualifiedName": "CartService.findCustomShippingOption" }, "385": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "optionId" + "qualifiedName": "cartCustomShippingOptions" }, "386": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.updateUnitPrices_" + "qualifiedName": "optionId" }, "387": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136105,19 +138467,19 @@ }, "388": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.updateUnitPrices_" }, "389": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "regionId" + "qualifiedName": "cart" }, "390": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "customer_id" + "qualifiedName": "regionId" }, "391": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.setRegion_" + "qualifiedName": "customer_id" }, "392": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136125,19 +138487,19 @@ }, "393": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.setRegion_" }, "394": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "regionId" + "qualifiedName": "cart" }, "395": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "countryCode" + "qualifiedName": "regionId" }, "396": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.delete" + "qualifiedName": "countryCode" }, "397": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136145,11 +138507,11 @@ }, "398": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.delete" }, "399": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.setMetadata" + "qualifiedName": "cartId" }, "400": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136157,19 +138519,19 @@ }, "401": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartId" + "qualifiedName": "CartService.setMetadata" }, "402": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "key" + "qualifiedName": "cartId" }, "403": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "value" + "qualifiedName": "key" }, "404": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.createTaxLines" + "qualifiedName": "value" }, "405": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136177,11 +138539,11 @@ }, "406": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cartOrId" + "qualifiedName": "CartService.createTaxLines" }, "407": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.deleteTaxLines" + "qualifiedName": "cartOrId" }, "408": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136189,11 +138551,11 @@ }, "409": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "id" + "qualifiedName": "CartService.deleteTaxLines" }, "410": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.decorateTotals" + "qualifiedName": "id" }, "411": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136201,15 +138563,15 @@ }, "412": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.decorateTotals" }, "413": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "totalsConfig" + "qualifiedName": "cart" }, "414": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.refreshAdjustments_" + "qualifiedName": "totalsConfig" }, "415": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136217,11 +138579,11 @@ }, "416": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.refreshAdjustments_" }, "417": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.transformQueryForTotals_" + "qualifiedName": "cart" }, "418": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136229,19 +138591,19 @@ }, "419": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "config" + "qualifiedName": "CartService.transformQueryForTotals_" }, "420": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__type" + "qualifiedName": "config" }, "421": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "__type.totalsToSelect" + "qualifiedName": "__type" }, "422": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.decorateTotals_" + "qualifiedName": "__type.totalsToSelect" }, "423": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136249,19 +138611,19 @@ }, "424": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "cart" + "qualifiedName": "CartService.decorateTotals_" }, "425": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "totalsToSelect" + "qualifiedName": "cart" }, "426": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "options" + "qualifiedName": "totalsToSelect" }, "427": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "CartService.getTotalsRelations" + "qualifiedName": "options" }, "428": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", @@ -136269,19 +138631,19 @@ }, "429": { "sourceFileName": "../../../packages/medusa/src/services/cart.ts", - "qualifiedName": "config" + "qualifiedName": "CartService.getTotalsRelations" }, "430": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.manager_" + "sourceFileName": "../../../packages/medusa/src/services/cart.ts", + "qualifiedName": "config" }, "431": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.transactionManager_" + "qualifiedName": "TransactionBaseService.manager_" }, "432": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" + "qualifiedName": "TransactionBaseService.transactionManager_" }, "433": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136289,19 +138651,19 @@ }, "434": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__container__" + "qualifiedName": "TransactionBaseService.activeManager_" }, "435": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__configModule__" + "qualifiedName": "TransactionBaseService.__container__" }, "436": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + "qualifiedName": "TransactionBaseService.__configModule__" }, "437": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, "438": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136309,11 +138671,11 @@ }, "439": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TransactionBaseService.withTransaction" }, "440": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + "qualifiedName": "transactionManager" }, "441": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136321,19 +138683,19 @@ }, "442": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "err" + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, "443": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "err" }, "444": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type.code" + "qualifiedName": "__type" }, "445": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" + "qualifiedName": "__type.code" }, "446": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136341,19 +138703,19 @@ }, "447": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TResult" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "448": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TError" + "qualifiedName": "TResult" }, "449": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "work" + "qualifiedName": "TError" }, "450": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "work" }, "451": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136361,15 +138723,15 @@ }, "452": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "__type" }, "453": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" + "qualifiedName": "transactionManager" }, "454": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "isolationOrErrorHandler" }, "455": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136377,15 +138739,15 @@ }, "456": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "457": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "maybeErrorHandlerOrDontFail" + "qualifiedName": "error" }, "458": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "maybeErrorHandlerOrDontFail" }, "459": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136393,79 +138755,79 @@ }, "460": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "461": { - "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default" + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" }, "462": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.Events" + "qualifiedName": "default" }, "463": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__object" + "qualifiedName": "default.Events" }, "464": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__object.CREATED" + "qualifiedName": "__object" }, "465": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__object.UPDATED" + "qualifiedName": "__object.CREATED" }, "466": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__object.CANCELED" + "qualifiedName": "__object.UPDATED" }, "467": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__object.FULFILLMENT_CREATED" + "qualifiedName": "__object.CANCELED" }, "468": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__object.SHIPMENT_CREATED" + "qualifiedName": "__object.FULFILLMENT_CREATED" }, "469": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__object.REFUND_PROCESSED" + "qualifiedName": "__object.SHIPMENT_CREATED" }, "470": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.__constructor" + "qualifiedName": "__object.REFUND_PROCESSED" }, "471": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default" + "qualifiedName": "default.__constructor" }, "472": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__0" + "qualifiedName": "default" }, "473": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.addressRepository_" + "qualifiedName": "__0" }, "474": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.claimRepository_" + "qualifiedName": "default.addressRepository_" }, "475": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.shippingMethodRepository_" + "qualifiedName": "default.claimRepository_" }, "476": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.lineItemRepository_" + "qualifiedName": "default.shippingMethodRepository_" }, "477": { - "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", - "qualifiedName": "__object" + "sourceFileName": "../../../packages/medusa/src/services/claim.ts", + "qualifiedName": "default.lineItemRepository_" }, "478": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", - "qualifiedName": "__object.findByReturn" + "qualifiedName": "__object" }, "479": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", @@ -136473,67 +138835,67 @@ }, "480": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", - "qualifiedName": "returnId" + "qualifiedName": "__object.findByReturn" }, "481": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", - "qualifiedName": "__type" + "qualifiedName": "returnId" }, "482": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", - "qualifiedName": "__type.return_item" + "qualifiedName": "__type" }, "483": { - "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.claimItemService_" + "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", + "qualifiedName": "__type.return_item" }, "484": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.eventBus_" + "qualifiedName": "default.claimItemService_" }, "485": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.fulfillmentProviderService_" + "qualifiedName": "default.eventBus_" }, "486": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.fulfillmentService_" + "qualifiedName": "default.fulfillmentProviderService_" }, "487": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.lineItemService_" + "qualifiedName": "default.fulfillmentService_" }, "488": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.paymentProviderService_" + "qualifiedName": "default.lineItemService_" }, "489": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.regionService_" + "qualifiedName": "default.paymentProviderService_" }, "490": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.returnService_" + "qualifiedName": "default.regionService_" }, "491": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.shippingOptionService_" + "qualifiedName": "default.returnService_" }, "492": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.taxProviderService_" + "qualifiedName": "default.shippingOptionService_" }, "493": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.totalsService_" + "qualifiedName": "default.taxProviderService_" }, "494": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.productVariantInventoryService_" + "qualifiedName": "default.totalsService_" }, "495": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.update" + "qualifiedName": "default.productVariantInventoryService_" }, "496": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", @@ -136541,15 +138903,15 @@ }, "497": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "id" + "qualifiedName": "default.update" }, "498": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "data" + "qualifiedName": "id" }, "499": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.validateCreateClaimInput" + "qualifiedName": "data" }, "500": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", @@ -136557,11 +138919,11 @@ }, "501": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "data" + "qualifiedName": "default.validateCreateClaimInput" }, "502": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.getRefundTotalForClaimLinesOnOrder" + "qualifiedName": "data" }, "503": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", @@ -136569,15 +138931,15 @@ }, "504": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "order" + "qualifiedName": "default.getRefundTotalForClaimLinesOnOrder" }, "505": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "claimItems" + "qualifiedName": "order" }, "506": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.create" + "qualifiedName": "claimItems" }, "507": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", @@ -136585,11 +138947,11 @@ }, "508": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "data" + "qualifiedName": "default.create" }, "509": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.createFulfillment" + "qualifiedName": "data" }, "510": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", @@ -136597,31 +138959,31 @@ }, "511": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "id" + "qualifiedName": "default.createFulfillment" }, "512": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "config" + "qualifiedName": "id" }, "513": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__type" + "qualifiedName": "config" }, "514": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__type.metadata" + "qualifiedName": "__type" }, "515": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__type.no_notification" + "qualifiedName": "__type.metadata" }, "516": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__type.location_id" + "qualifiedName": "__type.no_notification" }, "517": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.cancelFulfillment" + "qualifiedName": "__type.location_id" }, "518": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", @@ -136629,11 +138991,11 @@ }, "519": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "fulfillmentId" + "qualifiedName": "default.cancelFulfillment" }, "520": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.processRefund" + "qualifiedName": "fulfillmentId" }, "521": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", @@ -136641,11 +139003,11 @@ }, "522": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "id" + "qualifiedName": "default.processRefund" }, "523": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.createShipment" + "qualifiedName": "id" }, "524": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", @@ -136653,47 +139015,47 @@ }, "525": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "id" + "qualifiedName": "default.createShipment" }, "526": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "fulfillmentId" + "qualifiedName": "id" }, "527": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "trackingLinks" + "qualifiedName": "fulfillmentId" }, "528": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__type" + "qualifiedName": "trackingLinks" }, "529": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__type.tracking_number" + "qualifiedName": "__type" }, "530": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "config" + "qualifiedName": "__type.tracking_number" }, "531": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__object" + "qualifiedName": "config" }, "532": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__object.metadata" + "qualifiedName": "__object" }, "533": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__object" + "qualifiedName": "__object.metadata" }, "534": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "__object.no_notification" + "qualifiedName": "__object" }, "535": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.cancel" + "qualifiedName": "__object.no_notification" }, "536": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", @@ -136701,11 +139063,11 @@ }, "537": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "id" + "qualifiedName": "default.cancel" }, "538": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.list" + "qualifiedName": "id" }, "539": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", @@ -136713,15 +139075,15 @@ }, "540": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "selector" + "qualifiedName": "default.list" }, "541": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "config" + "qualifiedName": "selector" }, "542": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "default.retrieve" + "qualifiedName": "config" }, "543": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", @@ -136729,23 +139091,23 @@ }, "544": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "claimId" + "qualifiedName": "default.retrieve" }, "545": { "sourceFileName": "../../../packages/medusa/src/services/claim.ts", - "qualifiedName": "config" + "qualifiedName": "claimId" }, "546": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.manager_" + "sourceFileName": "../../../packages/medusa/src/services/claim.ts", + "qualifiedName": "config" }, "547": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.transactionManager_" + "qualifiedName": "TransactionBaseService.manager_" }, "548": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" + "qualifiedName": "TransactionBaseService.transactionManager_" }, "549": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136753,19 +139115,19 @@ }, "550": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__container__" + "qualifiedName": "TransactionBaseService.activeManager_" }, "551": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__configModule__" + "qualifiedName": "TransactionBaseService.__container__" }, "552": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + "qualifiedName": "TransactionBaseService.__configModule__" }, "553": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, "554": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136773,11 +139135,11 @@ }, "555": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TransactionBaseService.withTransaction" }, "556": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + "qualifiedName": "transactionManager" }, "557": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136785,19 +139147,19 @@ }, "558": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "err" + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, "559": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "err" }, "560": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type.code" + "qualifiedName": "__type" }, "561": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" + "qualifiedName": "__type.code" }, "562": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136805,19 +139167,19 @@ }, "563": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TResult" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "564": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TError" + "qualifiedName": "TResult" }, "565": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "work" + "qualifiedName": "TError" }, "566": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "work" }, "567": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136825,15 +139187,15 @@ }, "568": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "__type" }, "569": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" + "qualifiedName": "transactionManager" }, "570": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "isolationOrErrorHandler" }, "571": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136841,15 +139203,15 @@ }, "572": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "573": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "maybeErrorHandlerOrDontFail" + "qualifiedName": "error" }, "574": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "maybeErrorHandlerOrDontFail" }, "575": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -136857,22389 +139219,22761 @@ }, "576": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "577": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "578": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService" }, - "578": { + "579": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.Events" }, - "579": { + "580": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "__object" }, - "580": { + "581": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "__object.CREATED" }, - "581": { + "582": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "__object.UPDATED" }, - "582": { + "583": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "__object.CANCELED" }, - "583": { + "584": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.__constructor" }, - "584": { + "585": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService" }, - "585": { + "586": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "__0" }, - "586": { + "588": { + "sourceFileName": "", + "qualifiedName": "claimItemRepository" + }, + "589": { + "sourceFileName": "", + "qualifiedName": "claimTagRepository" + }, + "590": { + "sourceFileName": "", + "qualifiedName": "claimImageRepository" + }, + "591": { + "sourceFileName": "", + "qualifiedName": "lineItemService" + }, + "592": { + "sourceFileName": "", + "qualifiedName": "eventBusService" + }, + "593": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.lineItemService_" }, - "587": { + "594": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.eventBus_" }, - "588": { + "595": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.claimItemRepository_" }, - "589": { + "596": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.claimTagRepository_" }, - "590": { + "597": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.claimImageRepository_" }, - "591": { + "598": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.create" }, - "592": { + "599": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.create" }, - "593": { + "600": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "data" }, - "594": { + "601": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.update" }, - "595": { + "602": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.update" }, - "596": { + "603": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "id" }, - "597": { + "604": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "data" }, - "598": { + "605": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.list" }, - "599": { + "606": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.list" }, - "600": { + "607": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "selector" }, - "601": { + "608": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "config" }, - "602": { + "609": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.retrieve" }, - "603": { + "610": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "ClaimItemService.retrieve" }, - "604": { + "611": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "claimItemId" }, - "605": { + "612": { "sourceFileName": "../../../packages/medusa/src/services/claim-item.ts", "qualifiedName": "config" }, - "606": { + "613": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "607": { + "614": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "608": { + "615": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "609": { + "616": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "610": { + "617": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "611": { + "618": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "612": { + "619": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "613": { + "620": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "614": { + "621": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "615": { + "622": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "616": { + "623": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "617": { + "624": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "618": { + "625": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "619": { + "626": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "620": { + "627": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "621": { + "628": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "622": { + "629": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "623": { + "630": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "624": { + "631": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "625": { + "632": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "626": { + "633": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "627": { + "634": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "628": { + "635": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "629": { + "636": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "630": { + "637": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "631": { + "638": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "632": { + "639": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "633": { + "640": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "634": { + "641": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "635": { + "642": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "636": { + "643": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "637": { + "644": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default" }, - "638": { + "645": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default.Events" }, - "639": { + "646": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "__object" }, - "640": { + "647": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "__object.UPDATED" }, - "641": { + "648": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default.__constructor" }, - "642": { + "649": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default" }, - "643": { + "650": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "__0" }, - "644": { + "651": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default.currencyRepository_" }, - "645": { + "652": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default.eventBusService_" }, - "646": { + "653": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default.featureFlagRouter_" }, - "647": { + "654": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default.retrieveByCode" }, - "648": { + "655": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default.retrieveByCode" }, - "649": { + "656": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "code" }, - "650": { + "657": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default.listAndCount" }, - "651": { + "658": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default.listAndCount" }, - "652": { + "659": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "selector" }, - "653": { + "660": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "config" }, - "654": { + "661": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default.update" }, - "655": { + "662": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "default.update" }, - "656": { + "663": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "code" }, - "657": { + "664": { "sourceFileName": "../../../packages/medusa/src/services/currency.ts", "qualifiedName": "data" }, - "658": { + "665": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "659": { + "666": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "660": { + "667": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "661": { + "668": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "662": { + "669": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "663": { + "670": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "664": { + "671": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "665": { + "672": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "666": { + "673": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "667": { + "674": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "668": { + "675": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "669": { + "676": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "670": { + "677": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "671": { + "678": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "672": { + "679": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "673": { + "680": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "674": { + "681": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "675": { + "682": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "676": { + "683": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "677": { + "684": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "678": { + "685": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "679": { + "686": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "680": { + "687": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "681": { + "688": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "682": { + "689": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "683": { + "690": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "684": { + "691": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "685": { + "692": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "686": { + "693": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "687": { + "694": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "688": { + "695": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "689": { + "696": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "CustomShippingOptionService" }, - "690": { + "697": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "CustomShippingOptionService.__constructor" }, - "691": { + "698": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "CustomShippingOptionService" }, - "692": { + "699": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "__0" }, - "693": { + "700": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "CustomShippingOptionService.customShippingOptionRepository_" }, - "694": { + "701": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "CustomShippingOptionService.retrieve" }, - "695": { + "702": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "CustomShippingOptionService.retrieve" }, - "696": { + "703": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "id" }, - "697": { + "704": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "config" }, - "698": { + "705": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "CustomShippingOptionService.list" }, - "699": { + "706": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "CustomShippingOptionService.list" }, - "700": { + "707": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "selector" }, - "701": { + "708": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "config" }, - "702": { + "709": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "CustomShippingOptionService.create" }, - "703": { + "710": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "CustomShippingOptionService.create" }, - "704": { + "711": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "T" }, - "705": { + "712": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "TResult" }, - "706": { + "713": { "sourceFileName": "../../../packages/medusa/src/services/custom-shipping-option.ts", "qualifiedName": "data" }, - "707": { + "714": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "708": { + "715": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "709": { + "716": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "710": { + "717": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "711": { + "718": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "712": { + "719": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "713": { + "720": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "714": { + "721": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "715": { + "722": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "716": { + "723": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "717": { + "724": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "718": { + "725": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "719": { + "726": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "720": { + "727": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "721": { + "728": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "722": { + "729": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "723": { + "730": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "724": { + "731": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "725": { + "732": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "726": { + "733": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "727": { + "734": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "728": { + "735": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "729": { + "736": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "730": { + "737": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "731": { + "738": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "732": { + "739": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "733": { + "740": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "734": { + "741": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "735": { + "742": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "736": { + "743": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "737": { + "744": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "738": { + "745": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService" }, - "739": { + "746": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.Events" }, - "740": { + "747": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "__object" }, - "741": { + "748": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "__object.PASSWORD_RESET" }, - "742": { + "749": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "__object.CREATED" }, - "743": { + "750": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "__object.UPDATED" }, - "744": { + "751": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.__constructor" }, - "745": { + "752": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService" }, - "746": { + "753": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "__0" }, - "747": { + "754": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.customerRepository_" }, - "748": { + "755": { "sourceFileName": "../../../packages/medusa/src/repositories/customer.ts", "qualifiedName": "__object" }, - "749": { + "756": { "sourceFileName": "../../../packages/medusa/src/repositories/customer.ts", "qualifiedName": "__object.listAndCount" }, - "750": { + "757": { "sourceFileName": "../../../packages/medusa/src/repositories/customer.ts", "qualifiedName": "__object.listAndCount" }, - "751": { + "758": { "sourceFileName": "../../../packages/medusa/src/repositories/customer.ts", "qualifiedName": "query" }, - "752": { + "760": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "__type.select" + }, + "761": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "__type.relations" + }, + "762": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "where" + }, + "764": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "email" + }, + "765": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "first_name" + }, + "766": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "last_name" + }, + "767": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "billing_address_id" + }, + "768": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "billing_address" + }, + "769": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "shipping_addresses" + }, + "770": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "password_hash" + }, + "771": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "phone" + }, + "772": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "has_account" + }, + "773": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "orders" + }, + "774": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "groups" + }, + "775": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "metadata" + }, + "776": { + "sourceFileName": "../../../packages/medusa/src/interfaces/models/soft-deletable-entity.ts", + "qualifiedName": "deleted_at" + }, + "777": { + "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", + "qualifiedName": "id" + }, + "778": { + "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", + "qualifiedName": "created_at" + }, + "779": { + "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", + "qualifiedName": "updated_at" + }, + "780": { "sourceFileName": "../../../packages/medusa/src/repositories/customer.ts", "qualifiedName": "q" }, - "753": { + "781": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.addressRepository_" }, - "754": { + "782": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.eventBusService_" }, - "755": { + "783": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.generateResetPasswordToken" }, - "756": { + "784": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.generateResetPasswordToken" }, - "757": { + "785": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "customerId" }, - "758": { + "786": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.list" }, - "759": { + "787": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.list" }, - "760": { + "788": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "selector" }, - "761": { - "sourceFileName": "../../../packages/medusa/src/services/customer.ts", - "qualifiedName": "__type" + "790": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "__type.groups" }, - "762": { + "792": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "__type.q" }, - "763": { - "sourceFileName": "../../../packages/medusa/src/services/customer.ts", - "qualifiedName": "__type.groups" - }, - "764": { + "793": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "config" }, - "765": { + "794": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.listAndCount" }, - "766": { + "795": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.listAndCount" }, - "767": { + "796": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "selector" }, - "768": { - "sourceFileName": "../../../packages/medusa/src/services/customer.ts", - "qualifiedName": "__type" + "798": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "__type.groups" }, - "769": { + "800": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "__type.q" }, - "770": { - "sourceFileName": "../../../packages/medusa/src/services/customer.ts", - "qualifiedName": "__type.groups" - }, - "771": { + "801": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "config" }, - "772": { + "802": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.count" }, - "773": { + "803": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.count" }, - "774": { + "804": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.retrieve_" }, - "775": { + "805": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.retrieve_" }, - "776": { + "806": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "selector" }, - "777": { + "807": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "config" }, - "778": { + "808": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.retrieveByEmail" }, - "779": { + "809": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.retrieveByEmail" }, - "780": { + "810": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "email" }, - "781": { + "811": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "config" }, - "782": { + "812": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.retrieveUnregisteredByEmail" }, - "783": { + "813": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.retrieveUnregisteredByEmail" }, - "784": { + "814": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "email" }, - "785": { + "815": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "config" }, - "786": { + "816": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.retrieveRegisteredByEmail" }, - "787": { + "817": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.retrieveRegisteredByEmail" }, - "788": { + "818": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "email" }, - "789": { + "819": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "config" }, - "790": { + "820": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.listByEmail" }, - "791": { + "821": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.listByEmail" }, - "792": { + "822": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "email" }, - "793": { + "823": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "config" }, - "794": { + "824": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.retrieveByPhone" }, - "795": { + "825": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.retrieveByPhone" }, - "796": { + "826": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "phone" }, - "797": { + "827": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "config" }, - "798": { + "828": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.retrieve" }, - "799": { + "829": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.retrieve" }, - "800": { + "830": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "customerId" }, - "801": { + "831": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "config" }, - "802": { + "832": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.hashPassword_" }, - "803": { + "833": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.hashPassword_" }, - "804": { + "834": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "password" }, - "805": { + "835": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.create" }, - "806": { + "836": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.create" }, - "807": { + "837": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "customer" }, - "808": { + "838": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.update" }, - "809": { + "839": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.update" }, - "810": { + "840": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "customerId" }, - "811": { + "841": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "update" }, - "812": { + "842": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.updateBillingAddress_" }, - "813": { + "843": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.updateBillingAddress_" }, - "814": { + "844": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "customer" }, - "815": { + "845": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "addressOrId" }, - "816": { + "846": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.updateAddress" }, - "817": { + "847": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.updateAddress" }, - "818": { + "848": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "customerId" }, - "819": { + "849": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "addressId" }, - "820": { + "850": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "address" }, - "821": { + "851": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.removeAddress" }, - "822": { + "852": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.removeAddress" }, - "823": { + "853": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "customerId" }, - "824": { + "854": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "addressId" }, - "825": { + "855": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.addAddress" }, - "826": { + "856": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.addAddress" }, - "827": { + "857": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "customerId" }, - "828": { + "858": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "address" }, - "829": { + "859": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.delete" }, - "830": { + "860": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "CustomerService.delete" }, - "831": { + "861": { "sourceFileName": "../../../packages/medusa/src/services/customer.ts", "qualifiedName": "customerId" }, - "832": { + "862": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "833": { + "863": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "834": { + "864": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "835": { + "865": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "836": { + "866": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "837": { + "867": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "838": { + "868": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "839": { + "869": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "840": { + "870": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "841": { + "871": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "842": { + "872": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "843": { + "873": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "844": { + "874": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "845": { + "875": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "846": { + "876": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "847": { + "877": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "848": { + "878": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "849": { + "879": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "850": { + "880": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "851": { + "881": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "852": { + "882": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "853": { + "883": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "854": { + "884": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "855": { + "885": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "856": { + "886": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "857": { + "887": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "858": { + "888": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "859": { + "889": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "860": { + "890": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "861": { + "891": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "862": { + "892": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "863": { + "893": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService" }, - "864": { + "894": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.__constructor" }, - "865": { + "895": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService" }, - "866": { + "896": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "__0" }, - "867": { + "897": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.customerGroupRepository_" }, - "868": { + "898": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "__object" }, - "869": { + "899": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "__object.addCustomers" }, - "870": { + "900": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "__object.addCustomers" }, - "871": { + "901": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "groupId" }, - "872": { + "902": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "customerIds" }, - "873": { + "903": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "__object.removeCustomers" }, - "874": { + "904": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "__object.removeCustomers" }, - "875": { + "905": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "groupId" }, - "876": { + "906": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "customerIds" }, - "877": { + "907": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "__object.findWithRelationsAndCount" }, - "878": { + "908": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "__object.findWithRelationsAndCount" }, - "879": { + "909": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "relations" }, - "880": { + "910": { "sourceFileName": "../../../packages/medusa/src/repositories/customer-group.ts", "qualifiedName": "idsOrOptionsWithoutRelations" }, - "881": { + "911": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.customerService_" }, - "882": { + "912": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.retrieve" }, - "883": { + "913": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.retrieve" }, - "884": { + "914": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "customerGroupId" }, - "885": { + "915": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "config" }, - "886": { + "916": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "__object" }, - "887": { + "917": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.create" }, - "888": { + "918": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.create" }, - "889": { + "919": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "group" }, - "890": { + "920": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.addCustomers" }, - "891": { + "921": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.addCustomers" }, - "892": { + "922": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "id" }, - "893": { + "923": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "customerIds" }, - "894": { + "924": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.update" }, - "895": { + "925": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.update" }, - "896": { + "926": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "customerGroupId" }, - "897": { + "927": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "update" }, - "898": { + "928": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.delete" }, - "899": { + "929": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.delete" }, - "900": { + "930": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "groupId" }, - "901": { + "931": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.list" }, - "902": { + "932": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.list" }, - "903": { + "933": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "selector" }, - "904": { - "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", - "qualifiedName": "__type" - }, - "905": { + "935": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "__type.q" }, - "906": { + "936": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "__type.discount_condition_id" }, - "907": { + "937": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "config" }, - "908": { + "938": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.listAndCount" }, - "909": { + "939": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.listAndCount" }, - "910": { + "940": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "selector" }, - "911": { - "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", - "qualifiedName": "__type" - }, - "912": { + "942": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "__type.q" }, - "913": { + "943": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "__type.discount_condition_id" }, - "914": { + "944": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "config" }, - "915": { + "945": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.removeCustomer" }, - "916": { + "946": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.removeCustomer" }, - "917": { + "947": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "id" }, - "918": { + "948": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "customerIds" }, - "919": { + "949": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.handleCreationFail" }, - "920": { + "950": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "CustomerGroupService.handleCreationFail" }, - "921": { + "951": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "id" }, - "922": { + "952": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "ids" }, - "923": { + "953": { "sourceFileName": "../../../packages/medusa/src/services/customer-group.ts", "qualifiedName": "error" }, - "924": { + "954": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "925": { + "955": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "926": { + "956": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "927": { + "957": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "928": { + "958": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "929": { + "959": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "930": { + "960": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "931": { + "961": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "932": { + "962": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "933": { + "963": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "934": { + "964": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "935": { + "965": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "936": { + "966": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "937": { + "967": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "938": { + "968": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "939": { + "969": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "940": { + "970": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "941": { + "971": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "942": { + "972": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "943": { + "973": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "944": { + "974": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "945": { + "975": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "946": { + "976": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "947": { + "977": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "948": { + "978": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "949": { + "979": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "950": { + "980": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "951": { + "981": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "952": { + "982": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "953": { + "983": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "954": { + "984": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "955": { + "985": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService" }, - "956": { + "986": { + "sourceFileName": "../../../packages/medusa/src/services/discount.ts", + "qualifiedName": "DiscountService.Events" + }, + "987": { + "sourceFileName": "../../../packages/medusa/src/services/discount.ts", + "qualifiedName": "__object" + }, + "988": { + "sourceFileName": "../../../packages/medusa/src/services/discount.ts", + "qualifiedName": "__object.CREATED" + }, + "989": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.__constructor" }, - "957": { + "990": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService" }, - "958": { + "991": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "__0" }, - "959": { + "993": { + "sourceFileName": "", + "qualifiedName": "discountRepository" + }, + "994": { + "sourceFileName": "", + "qualifiedName": "discountRuleRepository" + }, + "995": { + "sourceFileName": "", + "qualifiedName": "giftCardRepository" + }, + "996": { + "sourceFileName": "", + "qualifiedName": "discountConditionRepository" + }, + "997": { + "sourceFileName": "", + "qualifiedName": "discountConditionService" + }, + "998": { + "sourceFileName": "", + "qualifiedName": "totalsService" + }, + "999": { + "sourceFileName": "", + "qualifiedName": "newTotalsService" + }, + "1000": { + "sourceFileName": "", + "qualifiedName": "productService" + }, + "1001": { + "sourceFileName": "", + "qualifiedName": "regionService" + }, + "1002": { + "sourceFileName": "", + "qualifiedName": "customerService" + }, + "1003": { + "sourceFileName": "", + "qualifiedName": "eventBusService" + }, + "1004": { + "sourceFileName": "", + "qualifiedName": "featureFlagRouter" + }, + "1005": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.discountRepository_" }, - "960": { + "1006": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.customerService_" }, - "961": { + "1007": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.discountRuleRepository_" }, - "962": { + "1008": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.giftCardRepository_" }, - "963": { + "1009": { "sourceFileName": "../../../packages/medusa/src/repositories/gift-card.ts", "qualifiedName": "__object" }, - "964": { + "1010": { "sourceFileName": "../../../packages/medusa/src/repositories/gift-card.ts", "qualifiedName": "__object.listGiftCardsAndCount" }, - "965": { + "1011": { "sourceFileName": "../../../packages/medusa/src/repositories/gift-card.ts", "qualifiedName": "__object.listGiftCardsAndCount" }, - "966": { + "1012": { "sourceFileName": "../../../packages/medusa/src/repositories/gift-card.ts", "qualifiedName": "query" }, - "967": { + "1013": { "sourceFileName": "../../../packages/medusa/src/repositories/gift-card.ts", "qualifiedName": "q" }, - "968": { + "1014": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.discountConditionRepository_" }, - "969": { + "1015": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object" }, - "970": { + "1016": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.findOneWithDiscount" }, - "971": { + "1017": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.findOneWithDiscount" }, - "972": { + "1018": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "conditionId" }, - "973": { + "1019": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "discountId" }, - "974": { + "1020": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type" }, - "975": { + "1021": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.discount" }, - "976": { + "1022": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.getJoinTableResourceIdentifiers" }, - "977": { + "1023": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.getJoinTableResourceIdentifiers" }, - "978": { + "1024": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "type" }, - "979": { + "1025": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type" }, - "980": { + "1026": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.joinTable" }, - "981": { + "1027": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.resourceKey" }, - "982": { + "1028": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.joinTableForeignKey" }, - "983": { + "1029": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.conditionTable" }, - "984": { + "1030": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.joinTableKey" }, - "985": { + "1031": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.relatedTable" }, - "986": { + "1032": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.removeConditionResources" }, - "987": { + "1033": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.removeConditionResources" }, - "988": { + "1034": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "id" }, - "989": { + "1035": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "type" }, - "990": { + "1036": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "resourceIds" }, - "991": { + "1037": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type" }, - "992": { + "1038": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.id" }, - "993": { + "1039": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.addConditionResources" }, - "994": { + "1040": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.addConditionResources" }, - "995": { + "1041": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "conditionId" }, - "996": { + "1042": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "resourceIds" }, - "997": { + "1043": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type" }, - "998": { + "1044": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.id" }, - "999": { + "1045": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "type" }, - "1000": { + "1046": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "overrideExisting" }, - "1001": { + "1047": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.queryConditionTable" }, - "1002": { + "1048": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.queryConditionTable" }, - "1003": { + "1049": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__0" }, - "1004": { + "1051": { + "sourceFileName": "", + "qualifiedName": "type" + }, + "1052": { + "sourceFileName": "", + "qualifiedName": "conditionId" + }, + "1053": { + "sourceFileName": "", + "qualifiedName": "resourceId" + }, + "1054": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.isValidForProduct" }, - "1005": { + "1055": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.isValidForProduct" }, - "1006": { + "1056": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "discountRuleId" }, - "1007": { + "1057": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "productId" }, - "1008": { + "1058": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.canApplyForCustomer" }, - "1009": { + "1059": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.canApplyForCustomer" }, - "1010": { + "1060": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "discountRuleId" }, - "1011": { + "1061": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "customerId" }, - "1012": { + "1062": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.discountConditionService_" }, - "1013": { + "1063": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.totalsService_" }, - "1014": { + "1064": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.newTotalsService_" }, - "1015": { + "1065": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.productService_" }, - "1016": { + "1066": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.regionService_" }, - "1017": { + "1067": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.eventBus_" }, - "1018": { + "1068": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.featureFlagRouter_" }, - "1019": { + "1069": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.validateDiscountRule_" }, - "1020": { + "1070": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.validateDiscountRule_" }, - "1021": { + "1071": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "T" }, - "1022": { + "1072": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "__type" }, - "1023": { + "1073": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "__type.type" }, - "1024": { + "1074": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "__type.value" }, - "1025": { + "1075": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountRule" }, - "1026": { + "1076": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.list" }, - "1027": { + "1077": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.list" }, - "1028": { + "1078": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "selector" }, - "1029": { + "1079": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "config" }, - "1030": { + "1080": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.listAndCount" }, - "1031": { + "1081": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.listAndCount" }, - "1032": { + "1082": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "selector" }, - "1033": { + "1083": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "config" }, - "1034": { + "1084": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.create" }, - "1035": { + "1085": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.create" }, - "1036": { + "1086": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discount" }, - "1037": { + "1087": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.retrieve" }, - "1038": { + "1088": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.retrieve" }, - "1039": { + "1089": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountId" }, - "1040": { + "1090": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "config" }, - "1041": { + "1091": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.retrieveByCode" }, - "1042": { + "1092": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.retrieveByCode" }, - "1043": { + "1093": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountCode" }, - "1044": { + "1094": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "config" }, - "1045": { + "1095": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.listByCodes" }, - "1046": { + "1096": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.listByCodes" }, - "1047": { + "1097": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountCodes" }, - "1048": { + "1098": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "config" }, - "1049": { + "1099": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.update" }, - "1050": { + "1100": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.update" }, - "1051": { + "1101": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountId" }, - "1052": { + "1102": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "update" }, - "1053": { + "1103": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.createDynamicCode" }, - "1054": { + "1104": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.createDynamicCode" }, - "1055": { + "1105": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountId" }, - "1056": { + "1106": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "data" }, - "1057": { + "1107": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.deleteDynamicCode" }, - "1058": { + "1108": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.deleteDynamicCode" }, - "1059": { + "1109": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountId" }, - "1060": { + "1110": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "code" }, - "1061": { + "1111": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.addRegion" }, - "1062": { + "1112": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.addRegion" }, - "1063": { + "1113": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountId" }, - "1064": { + "1114": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "regionId" }, - "1065": { + "1115": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.removeRegion" }, - "1066": { + "1116": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.removeRegion" }, - "1067": { + "1117": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountId" }, - "1068": { + "1118": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "regionId" }, - "1069": { + "1119": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.delete" }, - "1070": { + "1120": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.delete" }, - "1071": { + "1121": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountId" }, - "1072": { + "1122": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.validateDiscountForProduct" }, - "1073": { + "1123": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.validateDiscountForProduct" }, - "1074": { + "1124": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountRuleId" }, - "1075": { + "1125": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "productId" }, - "1076": { + "1126": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.calculateDiscountForLineItem" }, - "1077": { + "1127": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.calculateDiscountForLineItem" }, - "1078": { + "1128": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountId" }, - "1079": { + "1129": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "lineItem" }, - "1080": { + "1130": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "calculationContextData" }, - "1081": { + "1131": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.validateDiscountForCartOrThrow" }, - "1082": { + "1132": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.validateDiscountForCartOrThrow" }, - "1083": { + "1133": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "cart" }, - "1084": { + "1134": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discount" }, - "1085": { + "1135": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.hasCustomersGroupCondition" }, - "1086": { + "1136": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.hasCustomersGroupCondition" }, - "1087": { + "1137": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discount" }, - "1088": { + "1138": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.hasReachedLimit" }, - "1089": { + "1139": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.hasReachedLimit" }, - "1090": { + "1140": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discount" }, - "1091": { + "1141": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.hasNotStarted" }, - "1092": { + "1142": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.hasNotStarted" }, - "1093": { + "1143": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discount" }, - "1094": { + "1144": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.hasExpired" }, - "1095": { + "1145": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.hasExpired" }, - "1096": { + "1146": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discount" }, - "1097": { + "1147": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.isDisabled" }, - "1098": { + "1148": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.isDisabled" }, - "1099": { + "1149": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discount" }, - "1100": { + "1150": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.isValidForRegion" }, - "1101": { + "1151": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.isValidForRegion" }, - "1102": { + "1152": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discount" }, - "1103": { + "1153": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "region_id" }, - "1104": { + "1154": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.canApplyForCustomer" }, - "1105": { + "1155": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "DiscountService.canApplyForCustomer" }, - "1106": { + "1156": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "discountRuleId" }, - "1107": { + "1157": { "sourceFileName": "../../../packages/medusa/src/services/discount.ts", "qualifiedName": "customerId" }, - "1108": { + "1158": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "1109": { + "1159": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "1110": { + "1160": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1111": { + "1161": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1112": { + "1162": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "1113": { + "1163": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "1114": { + "1164": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "1115": { + "1165": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1116": { + "1166": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1117": { + "1167": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1118": { + "1168": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1119": { + "1169": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1120": { + "1170": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "1121": { + "1171": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1122": { + "1172": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "1123": { + "1173": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1124": { + "1174": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1125": { + "1175": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "1126": { + "1176": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "1127": { + "1177": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "1128": { + "1178": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1129": { + "1179": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1130": { + "1180": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1131": { + "1181": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "1132": { + "1182": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1133": { + "1183": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1134": { + "1184": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1135": { + "1185": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "1136": { + "1186": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1137": { + "1187": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1138": { + "1188": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1139": { + "1189": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService" }, - "1140": { + "1190": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.resolveConditionType_" }, - "1141": { + "1191": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.resolveConditionType_" }, - "1142": { + "1192": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "data" }, - "1143": { + "1193": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "__type" }, - "1144": { + "1194": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "__type.type" }, - "1145": { + "1195": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "__type.resource_ids" }, - "1146": { + "1196": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "__type" }, - "1147": { + "1197": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "__type.id" }, - "1148": { + "1198": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.__constructor" }, - "1149": { + "1199": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService" }, - "1150": { + "1200": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "__0" }, - "1151": { + "1201": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.discountConditionRepository_" }, - "1152": { + "1202": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object" }, - "1153": { + "1203": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.findOneWithDiscount" }, - "1154": { + "1204": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.findOneWithDiscount" }, - "1155": { + "1205": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "conditionId" }, - "1156": { + "1206": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "discountId" }, - "1157": { + "1207": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type" }, - "1158": { + "1208": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.discount" }, - "1159": { + "1209": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.getJoinTableResourceIdentifiers" }, - "1160": { + "1210": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.getJoinTableResourceIdentifiers" }, - "1161": { + "1211": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "type" }, - "1162": { + "1212": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type" }, - "1163": { + "1213": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.joinTable" }, - "1164": { + "1214": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.resourceKey" }, - "1165": { + "1215": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.joinTableForeignKey" }, - "1166": { + "1216": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.conditionTable" }, - "1167": { + "1217": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.joinTableKey" }, - "1168": { + "1218": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.relatedTable" }, - "1169": { + "1219": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.removeConditionResources" }, - "1170": { + "1220": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.removeConditionResources" }, - "1171": { + "1221": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "id" }, - "1172": { + "1222": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "type" }, - "1173": { + "1223": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "resourceIds" }, - "1174": { + "1224": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type" }, - "1175": { + "1225": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.id" }, - "1176": { + "1226": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.addConditionResources" }, - "1177": { + "1227": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.addConditionResources" }, - "1178": { + "1228": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "conditionId" }, - "1179": { + "1229": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "resourceIds" }, - "1180": { + "1230": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type" }, - "1181": { + "1231": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__type.id" }, - "1182": { + "1232": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "type" }, - "1183": { + "1233": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "overrideExisting" }, - "1184": { + "1234": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.queryConditionTable" }, - "1185": { + "1235": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.queryConditionTable" }, - "1186": { + "1236": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__0" }, - "1187": { + "1238": { + "sourceFileName": "", + "qualifiedName": "type" + }, + "1239": { + "sourceFileName": "", + "qualifiedName": "conditionId" + }, + "1240": { + "sourceFileName": "", + "qualifiedName": "resourceId" + }, + "1241": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.isValidForProduct" }, - "1188": { + "1242": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.isValidForProduct" }, - "1189": { + "1243": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "discountRuleId" }, - "1190": { + "1244": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "productId" }, - "1191": { + "1245": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.canApplyForCustomer" }, - "1192": { + "1246": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "__object.canApplyForCustomer" }, - "1193": { + "1247": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "discountRuleId" }, - "1194": { + "1248": { "sourceFileName": "../../../packages/medusa/src/repositories/discount-condition.ts", "qualifiedName": "customerId" }, - "1195": { + "1249": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.eventBus_" }, - "1196": { + "1250": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.retrieve" }, - "1197": { + "1251": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.retrieve" }, - "1198": { + "1252": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "conditionId" }, - "1199": { + "1253": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "config" }, - "1200": { + "1254": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.upsertCondition" }, - "1201": { + "1255": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.upsertCondition" }, - "1202": { + "1256": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "data" }, - "1203": { + "1257": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "overrideExisting" }, - "1204": { + "1258": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.removeResources" }, - "1205": { + "1259": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.removeResources" }, - "1206": { + "1260": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "data" }, - "1207": { + "1261": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "__type" }, - "1208": { + "1262": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "__type.id" }, - "1209": { + "1263": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.delete" }, - "1210": { + "1264": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "DiscountConditionService.delete" }, - "1211": { + "1265": { "sourceFileName": "../../../packages/medusa/src/services/discount-condition.ts", "qualifiedName": "discountConditionId" }, - "1212": { + "1266": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "1213": { + "1267": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "1214": { + "1268": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1215": { + "1269": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1216": { + "1270": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "1217": { + "1271": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "1218": { + "1272": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "1219": { + "1273": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1220": { + "1274": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1221": { + "1275": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1222": { + "1276": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1223": { + "1277": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1224": { + "1278": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "1225": { + "1279": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1226": { + "1280": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "1227": { + "1281": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1228": { + "1282": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1229": { + "1283": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "1230": { + "1284": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "1231": { + "1285": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "1232": { + "1286": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1233": { + "1287": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1234": { + "1288": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1235": { + "1289": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "1236": { + "1290": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1237": { + "1291": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1238": { + "1292": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1239": { + "1293": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "1240": { + "1294": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1241": { + "1295": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1242": { + "1296": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1243": { + "1297": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService" }, - "1244": { + "1298": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.Events" }, - "1245": { + "1299": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "__object" }, - "1246": { + "1300": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "__object.CREATED" }, - "1247": { + "1301": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "__object.UPDATED" }, - "1248": { + "1302": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.__constructor" }, - "1249": { + "1303": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService" }, - "1250": { + "1304": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "__0" }, - "1251": { + "1305": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.draftOrderRepository_" }, - "1252": { + "1306": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.paymentRepository_" }, - "1253": { + "1307": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.orderRepository_" }, - "1254": { + "1308": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "__object" }, - "1255": { + "1309": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "__object.findWithRelations" }, - "1256": { + "1310": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "__object.findWithRelations" }, - "1257": { + "1311": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "relations" }, - "1258": { + "1312": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "optionsWithoutRelations" }, - "1259": { + "1313": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "__object.findOneWithRelations" }, - "1260": { + "1314": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "__object.findOneWithRelations" }, - "1261": { + "1315": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "relations" }, - "1262": { + "1316": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "optionsWithoutRelations" }, - "1263": { + "1317": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.eventBus_" }, - "1264": { + "1318": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.cartService_" }, - "1265": { + "1319": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.lineItemService_" }, - "1266": { + "1320": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.productVariantService_" }, - "1267": { + "1321": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.shippingOptionService_" }, - "1268": { + "1322": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.customShippingOptionService_" }, - "1269": { + "1323": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.retrieve" }, - "1270": { + "1324": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.retrieve" }, - "1271": { + "1325": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "draftOrderId" }, - "1272": { + "1326": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "config" }, - "1273": { + "1327": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.retrieveByCartId" }, - "1274": { + "1328": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.retrieveByCartId" }, - "1275": { + "1329": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "cartId" }, - "1276": { + "1330": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "config" }, - "1277": { + "1331": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.delete" }, - "1278": { + "1332": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.delete" }, - "1279": { + "1333": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "draftOrderId" }, - "1280": { + "1334": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.listAndCount" }, - "1281": { + "1335": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.listAndCount" }, - "1282": { + "1336": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "selector" }, - "1283": { + "1337": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "config" }, - "1284": { + "1338": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.list" }, - "1285": { + "1339": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.list" }, - "1286": { + "1340": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "selector" }, - "1287": { + "1341": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "config" }, - "1288": { + "1342": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.create" }, - "1289": { + "1343": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.create" }, - "1290": { + "1344": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "data" }, - "1291": { + "1345": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.registerCartCompletion" }, - "1292": { + "1346": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.registerCartCompletion" }, - "1293": { + "1347": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "draftOrderId" }, - "1294": { + "1348": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "orderId" }, - "1295": { + "1349": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.update" }, - "1296": { + "1350": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "DraftOrderService.update" }, - "1297": { + "1351": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "id" }, - "1298": { + "1352": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "data" }, - "1299": { + "1353": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "__type" }, - "1300": { + "1354": { "sourceFileName": "../../../packages/medusa/src/services/draft-order.ts", "qualifiedName": "__type.no_notification_order" }, - "1301": { + "1355": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "1302": { + "1356": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "1303": { + "1357": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1304": { + "1358": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1305": { + "1359": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "1306": { + "1360": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "1307": { + "1361": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "1308": { + "1362": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1309": { + "1363": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1310": { + "1364": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1311": { + "1365": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1312": { + "1366": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1313": { + "1367": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "1314": { + "1368": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1315": { + "1369": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "1316": { + "1370": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1317": { + "1371": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1318": { + "1372": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "1319": { + "1373": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "1320": { + "1374": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "1321": { + "1375": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1322": { + "1376": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1323": { + "1377": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1324": { + "1378": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "1325": { + "1379": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1326": { + "1380": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1327": { + "1381": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1328": { + "1382": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "1329": { + "1383": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1330": { + "1384": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1331": { + "1385": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1332": { + "1386": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default" }, - "1333": { + "1387": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.__constructor" }, - "1334": { + "1388": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default" }, - "1335": { + "1389": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "__0" }, - "1336": { + "1390": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "config" }, - "1337": { + "1391": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "isSingleton" }, - "1338": { + "1392": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.config_" }, - "1339": { + "1393": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.stagedJobService_" }, - "1340": { + "1394": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.eventBusModuleService_" }, - "1341": { + "1395": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.eventBusModuleService_" }, - "1342": { + "1396": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.logger_" }, - "1343": { + "1397": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.shouldEnqueuerRun" }, - "1344": { + "1398": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.enqueue_" }, - "1345": { + "1399": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.withTransaction" }, - "1346": { + "1400": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.withTransaction" }, - "1347": { + "1401": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "transactionManager" }, - "1348": { + "1402": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.subscribe" }, - "1349": { + "1403": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.subscribe" }, - "1350": { + "1404": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "event" }, - "1351": { + "1405": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "subscriber" }, - "1352": { + "1406": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "context" }, - "1353": { + "1407": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.unsubscribe" }, - "1354": { + "1408": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.unsubscribe" }, - "1355": { + "1409": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "event" }, - "1356": { + "1410": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "subscriber" }, - "1357": { + "1411": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "context" }, - "1358": { + "1412": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.emit" }, - "1359": { + "1413": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.emit" }, - "1360": { + "1414": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "T" }, - "1361": { + "1415": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "data" }, - "1362": { + "1416": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.emit" }, - "1363": { + "1417": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "T" }, - "1364": { + "1418": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "eventName" }, - "1365": { + "1419": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "data" }, - "1366": { + "1420": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "options" }, - "1367": { + "1421": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.startEnqueuer" }, - "1368": { + "1422": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.startEnqueuer" }, - "1369": { + "1423": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.stopEnqueuer" }, - "1370": { + "1424": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.stopEnqueuer" }, - "1371": { + "1425": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.enqueuer_" }, - "1372": { + "1426": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.enqueuer_" }, - "1373": { + "1427": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.listJobs" }, - "1374": { + "1428": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "default.listJobs" }, - "1375": { + "1429": { "sourceFileName": "../../../packages/medusa/src/services/event-bus.ts", "qualifiedName": "listConfig" }, - "1376": { + "1430": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "1377": { + "1431": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "1378": { + "1432": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1379": { + "1433": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1380": { + "1434": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "1381": { + "1435": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "1382": { + "1436": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "1383": { + "1437": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1384": { + "1438": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1385": { + "1439": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "1386": { + "1440": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1387": { + "1441": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "1388": { + "1442": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1389": { + "1443": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1390": { + "1444": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "1391": { + "1445": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "1392": { + "1446": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "1393": { + "1447": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1394": { + "1448": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1395": { + "1449": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1396": { + "1450": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "1397": { + "1451": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1398": { + "1452": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1399": { + "1453": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1400": { + "1454": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "1401": { + "1455": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1402": { + "1456": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1403": { + "1457": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1404": { + "1458": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService" }, - "1405": { + "1459": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.__constructor" }, - "1406": { + "1460": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService" }, - "1407": { + "1461": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "__0" }, - "1408": { + "1462": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.totalsService_" }, - "1409": { + "1463": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.lineItemService_" }, - "1410": { + "1464": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.shippingProfileService_" }, - "1411": { + "1465": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.fulfillmentProviderService_" }, - "1412": { + "1466": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.fulfillmentRepository_" }, - "1413": { + "1467": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.trackingLinkRepository_" }, - "1414": { + "1468": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.lineItemRepository_" }, - "1415": { + "1469": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", "qualifiedName": "__object" }, - "1416": { + "1470": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", "qualifiedName": "__object.findByReturn" }, - "1417": { + "1471": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", "qualifiedName": "__object.findByReturn" }, - "1418": { + "1472": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", "qualifiedName": "returnId" }, - "1419": { + "1473": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", "qualifiedName": "__type" }, - "1420": { + "1474": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", "qualifiedName": "__type.return_item" }, - "1421": { + "1475": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.productVariantInventoryService_" }, - "1422": { + "1476": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.partitionItems_" }, - "1423": { + "1477": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.partitionItems_" }, - "1424": { + "1478": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "shippingMethods" }, - "1425": { + "1479": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "items" }, - "1426": { + "1480": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.getFulfillmentItems_" }, - "1427": { + "1481": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.getFulfillmentItems_" }, - "1428": { + "1482": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "order" }, - "1429": { + "1483": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "items" }, - "1430": { + "1484": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.validateFulfillmentLineItem_" }, - "1431": { + "1485": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.validateFulfillmentLineItem_" }, - "1432": { + "1486": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "item" }, - "1433": { + "1487": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "quantity" }, - "1434": { + "1488": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.retrieve" }, - "1435": { + "1489": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.retrieve" }, - "1436": { + "1490": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "fulfillmentId" }, - "1437": { + "1491": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "config" }, - "1438": { + "1492": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.createFulfillment" }, - "1439": { + "1493": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.createFulfillment" }, - "1440": { + "1494": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "order" }, - "1441": { + "1495": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "itemsToFulfill" }, - "1442": { + "1496": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "custom" }, - "1443": { + "1497": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.cancelFulfillment" }, - "1444": { + "1498": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.cancelFulfillment" }, - "1445": { + "1499": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "fulfillmentOrId" }, - "1446": { + "1500": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.createShipment" }, - "1447": { + "1501": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "FulfillmentService.createShipment" }, - "1448": { + "1502": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "fulfillmentId" }, - "1449": { + "1503": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "trackingLinks" }, - "1450": { + "1504": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "__type" }, - "1451": { + "1505": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "__type.tracking_number" }, - "1452": { + "1506": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment.ts", "qualifiedName": "config" }, - "1453": { + "1507": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "1454": { + "1508": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "1455": { + "1509": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1456": { + "1510": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1457": { + "1511": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "1458": { + "1512": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "1459": { + "1513": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "1460": { + "1514": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1461": { + "1515": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1462": { + "1516": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1463": { + "1517": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1464": { + "1518": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1465": { + "1519": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "1466": { + "1520": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1467": { + "1521": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "1468": { + "1522": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1469": { + "1523": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1470": { + "1524": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "1471": { + "1525": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "1472": { + "1526": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "1473": { + "1527": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1474": { + "1528": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1475": { + "1529": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1476": { + "1530": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "1477": { + "1531": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1478": { + "1532": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1479": { + "1533": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1480": { + "1534": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "1481": { + "1535": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1482": { + "1536": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1483": { + "1537": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1484": { + "1538": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService" }, - "1485": { + "1539": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.__constructor" }, - "1486": { + "1540": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService" }, - "1487": { + "1541": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "container" }, - "1488": { + "1542": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.container_" }, - "1489": { + "1543": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.fulfillmentProviderRepository_" }, - "1490": { + "1544": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.registerInstalledProviders" }, - "1491": { + "1545": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.registerInstalledProviders" }, - "1492": { + "1546": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "providers" }, - "1493": { + "1547": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.list" }, - "1494": { + "1548": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.list" }, - "1495": { + "1549": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.listFulfillmentOptions" }, - "1496": { + "1550": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.listFulfillmentOptions" }, - "1497": { + "1551": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "providerIds" }, - "1498": { + "1552": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.retrieveProvider" }, - "1499": { + "1553": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.retrieveProvider" }, - "1500": { + "1554": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "providerId" }, - "1501": { + "1555": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.createFulfillment" }, - "1502": { + "1556": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.createFulfillment" }, - "1503": { + "1557": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "method" }, - "1504": { + "1558": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "items" }, - "1505": { + "1559": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "order" }, - "1506": { + "1560": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "fulfillment" }, - "1507": { + "1561": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.canCalculate" }, - "1508": { + "1562": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.canCalculate" }, - "1509": { + "1563": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "option" }, - "1510": { + "1564": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.validateFulfillmentData" }, - "1511": { + "1565": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.validateFulfillmentData" }, - "1512": { + "1566": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "option" }, - "1513": { + "1567": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "data" }, - "1514": { + "1568": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "cart" }, - "1515": { + "1569": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.cancelFulfillment" }, - "1516": { + "1570": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.cancelFulfillment" }, - "1517": { + "1571": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "fulfillment" }, - "1518": { + "1572": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.calculatePrice" }, - "1519": { + "1573": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.calculatePrice" }, - "1520": { + "1574": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "option" }, - "1521": { + "1575": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "data" }, - "1522": { + "1576": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "cart" }, - "1523": { + "1577": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.validateOption" }, - "1524": { + "1578": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.validateOption" }, - "1525": { + "1579": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "option" }, - "1526": { + "1580": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.createReturn" }, - "1527": { + "1581": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.createReturn" }, - "1528": { + "1582": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "returnOrder" }, - "1529": { + "1583": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.retrieveDocuments" }, - "1530": { + "1584": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "FulfillmentProviderService.retrieveDocuments" }, - "1531": { + "1585": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "providerId" }, - "1532": { + "1586": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "fulfillmentData" }, - "1533": { + "1587": { "sourceFileName": "../../../packages/medusa/src/services/fulfillment-provider.ts", "qualifiedName": "documentType" }, - "1534": { + "1588": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "1535": { + "1589": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "1536": { + "1590": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1537": { + "1591": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1538": { + "1592": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "1539": { + "1593": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "1540": { + "1594": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "1541": { + "1595": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1542": { + "1596": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1543": { + "1597": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1544": { + "1598": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1545": { + "1599": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1546": { + "1600": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "1547": { + "1601": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1548": { + "1602": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "1549": { + "1603": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1550": { + "1604": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1551": { + "1605": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "1552": { + "1606": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "1553": { + "1607": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "1554": { + "1608": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1555": { + "1609": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1556": { + "1610": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1557": { + "1611": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "1558": { + "1612": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1559": { + "1613": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1560": { + "1614": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1561": { + "1615": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "1562": { + "1616": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1563": { + "1617": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1564": { + "1618": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1565": { + "1619": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService" }, - "1566": { + "1620": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.Events" }, - "1567": { + "1621": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "__object" }, - "1568": { + "1622": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "__object.CREATED" }, - "1569": { + "1623": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.generateCode" }, - "1570": { + "1624": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.generateCode" }, - "1571": { + "1625": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.resolveTaxRate" }, - "1572": { + "1626": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.resolveTaxRate" }, - "1573": { + "1627": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "giftCardTaxRate" }, - "1574": { + "1628": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "region" }, - "1575": { + "1629": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.__constructor" }, - "1576": { + "1630": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService" }, - "1577": { + "1631": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "__0" }, - "1578": { + "1632": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.giftCardRepository_" }, - "1579": { + "1633": { "sourceFileName": "../../../packages/medusa/src/repositories/gift-card.ts", "qualifiedName": "__object" }, - "1580": { + "1634": { "sourceFileName": "../../../packages/medusa/src/repositories/gift-card.ts", "qualifiedName": "__object.listGiftCardsAndCount" }, - "1581": { + "1635": { "sourceFileName": "../../../packages/medusa/src/repositories/gift-card.ts", "qualifiedName": "__object.listGiftCardsAndCount" }, - "1582": { + "1636": { "sourceFileName": "../../../packages/medusa/src/repositories/gift-card.ts", "qualifiedName": "query" }, - "1583": { + "1637": { "sourceFileName": "../../../packages/medusa/src/repositories/gift-card.ts", "qualifiedName": "q" }, - "1584": { + "1638": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.giftCardTransactionRepo_" }, - "1585": { + "1639": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.regionService_" }, - "1586": { + "1640": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.eventBus_" }, - "1587": { + "1641": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.listAndCount" }, - "1588": { + "1642": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.listAndCount" }, - "1589": { + "1643": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "selector" }, - "1590": { + "1644": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "config" }, - "1591": { + "1645": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.list" }, - "1592": { + "1646": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.list" }, - "1593": { + "1647": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "selector" }, - "1594": { + "1648": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "config" }, - "1595": { + "1649": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.createTransaction" }, - "1596": { + "1650": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.createTransaction" }, - "1597": { + "1651": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "data" }, - "1598": { + "1652": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.create" }, - "1599": { + "1653": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.create" }, - "1600": { + "1654": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "giftCard" }, - "1601": { + "1655": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.retrieve_" }, - "1602": { + "1656": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.retrieve_" }, - "1603": { + "1657": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "selector" }, - "1604": { + "1658": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "config" }, - "1605": { + "1659": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.retrieve" }, - "1606": { + "1660": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.retrieve" }, - "1607": { + "1661": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "giftCardId" }, - "1608": { + "1662": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "config" }, - "1609": { + "1663": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.retrieveByCode" }, - "1610": { + "1664": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.retrieveByCode" }, - "1611": { + "1665": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "code" }, - "1612": { + "1666": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "config" }, - "1613": { + "1667": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.update" }, - "1614": { + "1668": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.update" }, - "1615": { + "1669": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "giftCardId" }, - "1616": { + "1670": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "update" }, - "1617": { + "1671": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.delete" }, - "1618": { + "1672": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "GiftCardService.delete" }, - "1619": { + "1673": { "sourceFileName": "../../../packages/medusa/src/services/gift-card.ts", "qualifiedName": "giftCardId" }, - "1620": { + "1674": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "1621": { + "1675": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "1622": { + "1676": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1623": { + "1677": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1624": { + "1678": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "1625": { + "1679": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "1626": { + "1680": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "1627": { + "1681": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1628": { + "1682": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1629": { + "1683": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1630": { + "1684": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1631": { + "1685": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1632": { + "1686": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "1633": { + "1687": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1634": { + "1688": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "1635": { + "1689": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1636": { + "1690": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1637": { + "1691": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "1638": { + "1692": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "1639": { + "1693": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "1640": { + "1694": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1641": { + "1695": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1642": { + "1696": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1643": { + "1697": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "1644": { + "1698": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1645": { + "1699": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1646": { + "1700": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1647": { + "1701": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "1648": { + "1702": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1649": { + "1703": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1650": { + "1704": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1651": { + "1705": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService" }, - "1652": { + "1706": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.__constructor" }, - "1653": { + "1707": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService" }, - "1654": { + "1708": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "__0" }, - "1655": { + "1709": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.idempotencyKeyRepository_" }, - "1656": { + "1710": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.initializeRequest" }, - "1657": { + "1711": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.initializeRequest" }, - "1658": { + "1712": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "headerKey" }, - "1659": { + "1713": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "reqMethod" }, - "1660": { + "1714": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "reqParams" }, - "1661": { + "1715": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "reqPath" }, - "1662": { + "1716": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.create" }, - "1663": { + "1717": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.create" }, - "1664": { + "1718": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "payload" }, - "1665": { + "1719": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.retrieve" }, - "1666": { + "1720": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.retrieve" }, - "1667": { + "1721": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "idempotencyKeyOrSelector" }, - "1668": { + "1722": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.lock" }, - "1669": { + "1723": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.lock" }, - "1670": { + "1724": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "idempotencyKey" }, - "1671": { + "1725": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.update" }, - "1672": { + "1726": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.update" }, - "1673": { + "1727": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "idempotencyKey" }, - "1674": { + "1728": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "update" }, - "1675": { + "1729": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.workStage" }, - "1676": { + "1730": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "IdempotencyKeyService.workStage" }, - "1677": { + "1731": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "idempotencyKey" }, - "1678": { + "1732": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "callback" }, - "1679": { + "1733": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "__type" }, - "1680": { + "1734": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "__type" }, - "1681": { + "1735": { "sourceFileName": "../../../packages/medusa/src/services/idempotency-key.ts", "qualifiedName": "transactionManager" }, - "1682": { + "1736": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "1683": { + "1737": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "1684": { + "1738": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1685": { + "1739": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1686": { + "1740": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "1687": { + "1741": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "1688": { + "1742": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "1689": { + "1743": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1690": { + "1744": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1691": { + "1745": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1692": { + "1746": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1693": { + "1747": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1694": { + "1748": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "1695": { + "1749": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1696": { + "1750": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "1697": { + "1751": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1698": { + "1752": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1699": { + "1753": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "1700": { + "1754": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "1701": { + "1755": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "1702": { + "1756": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1703": { + "1757": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1704": { + "1758": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1705": { + "1759": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "1706": { + "1760": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1707": { + "1761": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1708": { + "1762": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1709": { + "1763": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "1710": { + "1764": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1711": { + "1765": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1712": { + "1766": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1713": { + "1767": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService" }, - "1714": { + "1768": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.__constructor" }, - "1715": { + "1769": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService" }, - "1716": { + "1770": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__0" }, - "1717": { + "1771": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.lineItemRepository_" }, - "1718": { + "1772": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", "qualifiedName": "__object" }, - "1719": { + "1773": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", "qualifiedName": "__object.findByReturn" }, - "1720": { + "1774": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", "qualifiedName": "__object.findByReturn" }, - "1721": { + "1775": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", "qualifiedName": "returnId" }, - "1722": { + "1776": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", "qualifiedName": "__type" }, - "1723": { + "1777": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item.ts", "qualifiedName": "__type.return_item" }, - "1724": { + "1778": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.itemTaxLineRepo_" }, - "1725": { + "1779": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "__object" }, - "1726": { + "1780": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "__object.upsertLines" }, - "1727": { + "1781": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "__object.upsertLines" }, - "1728": { + "1782": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "lines" }, - "1729": { + "1783": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "__object.deleteForCart" }, - "1730": { + "1784": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "__object.deleteForCart" }, - "1731": { + "1785": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "cartId" }, - "1732": { + "1786": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.cartRepository_" }, - "1733": { + "1787": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "__object" }, - "1734": { + "1788": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "__object.findWithRelations" }, - "1735": { + "1789": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "__object.findWithRelations" }, - "1736": { + "1790": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "relations" }, - "1737": { + "1791": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "optionsWithoutRelations" }, - "1738": { + "1792": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "__object.findOneWithRelations" }, - "1739": { + "1793": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "__object.findOneWithRelations" }, - "1740": { + "1794": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "relations" }, - "1741": { + "1795": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "optionsWithoutRelations" }, - "1742": { + "1796": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.productVariantService_" }, - "1743": { + "1797": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.productService_" }, - "1744": { + "1798": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.pricingService_" }, - "1745": { + "1799": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.regionService_" }, - "1746": { + "1800": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.featureFlagRouter_" }, - "1747": { + "1801": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.lineItemAdjustmentService_" }, - "1748": { + "1802": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.taxProviderService_" }, - "1749": { + "1803": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.list" }, - "1750": { + "1804": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.list" }, - "1751": { + "1805": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "selector" }, - "1752": { + "1806": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "config" }, - "1753": { + "1807": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.retrieve" }, - "1754": { + "1808": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.retrieve" }, - "1755": { + "1809": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "id" }, - "1756": { + "1810": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "config" }, - "1757": { + "1811": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__object" }, - "1758": { + "1812": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.createReturnLines" }, - "1759": { + "1813": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.createReturnLines" }, - "1760": { + "1814": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "returnId" }, - "1761": { + "1815": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "cartId" }, - "1762": { + "1816": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.generate" }, - "1763": { + "1817": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.generate" }, - "1764": { + "1818": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "T" }, - "1765": { + "1819": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "TResult" }, - "1766": { + "1820": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "variantIdOrData" }, - "1767": { + "1821": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "regionIdOrContext" }, - "1768": { + "1822": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "quantity" }, - "1769": { + "1823": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "context" }, - "1770": { + "1824": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.generateLineItem" }, - "1771": { + "1825": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.generateLineItem" }, - "1772": { + "1826": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "variant" }, - "1773": { + "1827": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type" }, - "1774": { + "1828": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type.id" }, - "1775": { + "1829": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type.title" }, - "1776": { + "1830": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type.product_id" }, - "1777": { + "1831": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type.product" }, - "1778": { + "1832": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type" }, - "1779": { + "1833": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type.title" }, - "1780": { + "1834": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type.thumbnail" }, - "1781": { + "1835": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type.discountable" }, - "1782": { + "1836": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type.is_giftcard" }, - "1783": { + "1837": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "quantity" }, - "1784": { + "1838": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "context" }, - "1785": { + "1839": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type" }, - "1786": { + "1840": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type.variantPricing" }, - "1787": { + "1841": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.create" }, - "1788": { + "1842": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.create" }, - "1789": { + "1843": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "T" }, - "1790": { + "1844": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "TResult" }, - "1791": { + "1845": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "data" }, - "1792": { + "1846": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.update" }, - "1793": { + "1847": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.update" }, - "1794": { + "1848": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "idOrSelector" }, - "1795": { + "1849": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "data" }, - "1796": { + "1850": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.delete" }, - "1797": { + "1851": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.delete" }, - "1798": { + "1852": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "id" }, - "1799": { + "1853": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.deleteWithTaxLines" }, - "1800": { + "1854": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.deleteWithTaxLines" }, - "1801": { + "1855": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "id" }, - "1802": { + "1856": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.createTaxLine" }, - "1803": { + "1857": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.createTaxLine" }, - "1804": { + "1858": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "args" }, - "1805": { + "1859": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.cloneTo" }, - "1806": { + "1860": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.cloneTo" }, - "1807": { + "1861": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "ids" }, - "1808": { + "1862": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "data" }, - "1809": { + "1863": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "options" }, - "1810": { + "1864": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type" }, - "1811": { + "1865": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "__type.setOriginalLineItemId" }, - "1812": { + "1866": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.validateGenerateArguments" }, - "1813": { + "1867": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "LineItemService.validateGenerateArguments" }, - "1814": { + "1868": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "T" }, - "1815": { + "1869": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "TResult" }, - "1816": { + "1870": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "variantIdOrData" }, - "1817": { + "1871": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "regionIdOrContext" }, - "1818": { + "1872": { "sourceFileName": "../../../packages/medusa/src/services/line-item.ts", "qualifiedName": "quantity" }, - "1819": { + "1873": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "1820": { + "1874": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "1821": { + "1875": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1822": { + "1876": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1823": { + "1877": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "1824": { + "1878": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "1825": { + "1879": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "1826": { + "1880": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1827": { + "1881": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1828": { + "1882": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1829": { + "1883": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1830": { + "1884": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1831": { + "1885": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "1832": { + "1886": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1833": { + "1887": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "1834": { + "1888": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1835": { + "1889": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1836": { + "1890": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "1837": { + "1891": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "1838": { + "1892": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "1839": { + "1893": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1840": { + "1894": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1841": { + "1895": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1842": { + "1896": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "1843": { + "1897": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1844": { + "1898": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1845": { + "1899": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1846": { + "1900": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "1847": { + "1901": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1848": { + "1902": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1849": { + "1903": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1850": { + "1904": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService" }, - "1851": { + "1905": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.__constructor" }, - "1852": { + "1906": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService" }, - "1853": { + "1907": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "__0" }, - "1854": { + "1908": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.lineItemAdjustmentRepo_" }, - "1855": { + "1909": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.discountService" }, - "1856": { + "1910": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.retrieve" }, - "1857": { + "1911": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.retrieve" }, - "1858": { + "1912": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "lineItemAdjustmentId" }, - "1859": { + "1913": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "config" }, - "1860": { + "1914": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.create" }, - "1861": { + "1915": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.create" }, - "1862": { + "1916": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "data" }, - "1863": { + "1917": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.update" }, - "1864": { + "1918": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.update" }, - "1865": { + "1919": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "id" }, - "1866": { + "1920": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "data" }, - "1867": { + "1921": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.list" }, - "1868": { + "1922": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.list" }, - "1869": { + "1923": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "selector" }, - "1870": { + "1924": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "config" }, - "1871": { + "1925": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.delete" }, - "1872": { + "1926": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.delete" }, - "1873": { + "1927": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "selectorOrIds" }, - "1874": { + "1928": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "__type" }, - "1875": { + "1929": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "__type.discount_id" }, - "1876": { + "1930": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.generateAdjustments" }, - "1877": { + "1931": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.generateAdjustments" }, - "1878": { + "1932": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "calculationContextData" }, - "1879": { + "1933": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "generatedLineItem" }, - "1880": { + "1934": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "context" }, - "1881": { + "1935": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.createAdjustmentForLineItem" }, - "1882": { + "1936": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.createAdjustmentForLineItem" }, - "1883": { + "1937": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "cart" }, - "1884": { + "1938": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "lineItem" }, - "1885": { + "1939": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.createAdjustments" }, - "1886": { + "1940": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "LineItemAdjustmentService.createAdjustments" }, - "1887": { + "1941": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "cart" }, - "1888": { + "1942": { "sourceFileName": "../../../packages/medusa/src/services/line-item-adjustment.ts", "qualifiedName": "lineItem" }, - "1889": { + "1943": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "1890": { + "1944": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "1891": { + "1945": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1892": { + "1946": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "1893": { + "1947": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "1894": { + "1948": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "1895": { + "1949": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "1896": { + "1950": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1897": { + "1951": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "1898": { + "1952": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1899": { + "1953": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1900": { + "1954": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "1901": { + "1955": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "1902": { + "1956": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1903": { + "1957": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "1904": { + "1958": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1905": { + "1959": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "1906": { + "1960": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "1907": { + "1961": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "1908": { + "1962": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "1909": { + "1963": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1910": { + "1964": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1911": { + "1965": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "1912": { + "1966": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "1913": { + "1967": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1914": { + "1968": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1915": { + "1969": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1916": { + "1970": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "1917": { + "1971": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1918": { + "1972": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "1919": { + "1973": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "1920": { + "1974": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService" }, - "1921": { + "1975": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.__constructor" }, - "1922": { + "1976": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService" }, - "1923": { + "1977": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.postAuthentication_" }, - "1924": { + "1978": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.preAuthentication_" }, - "1925": { + "1979": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.preCartCreation_" }, - "1926": { + "1980": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.routers" }, - "1927": { + "1981": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.addRouter" }, - "1928": { + "1982": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.addRouter" }, - "1929": { + "1983": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "path" }, - "1930": { + "1984": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "router" }, - "1931": { + "1985": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.getRouters" }, - "1932": { + "1986": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.getRouters" }, - "1933": { + "1987": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "path" }, - "1934": { + "1988": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.validateMiddleware_" }, - "1935": { + "1989": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.validateMiddleware_" }, - "1936": { + "1990": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "fn" }, - "1937": { + "1991": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.addPostAuthentication" }, - "1938": { + "1992": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.addPostAuthentication" }, - "1939": { + "1993": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "middleware" }, - "1940": { + "1994": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "options" }, - "1941": { + "1995": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.addPreAuthentication" }, - "1942": { + "1996": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.addPreAuthentication" }, - "1943": { + "1997": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "middleware" }, - "1944": { + "1998": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "options" }, - "1945": { + "1999": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.addPreCartCreation" }, - "1946": { + "2000": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.addPreCartCreation" }, - "1947": { + "2001": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "middleware" }, - "1948": { + "2002": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.usePostAuthentication" }, - "1949": { + "2003": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.usePostAuthentication" }, - "1950": { + "2004": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "app" }, - "1951": { + "2005": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.usePreAuthentication" }, - "1952": { + "2006": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.usePreAuthentication" }, - "1953": { + "2007": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "app" }, - "1954": { + "2008": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.usePreCartCreation" }, - "1955": { + "2009": { "sourceFileName": "../../../packages/medusa/src/services/middleware.ts", "qualifiedName": "MiddlewareService.usePreCartCreation" }, - "1956": { + "2010": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default" }, - "1957": { + "2011": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.__constructor" }, - "1958": { + "2012": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default" }, - "1959": { + "2013": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__0" }, - "1960": { + "2014": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.taxProviderService_" }, - "1961": { + "2015": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.featureFlagRouter_" }, - "1962": { + "2016": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.taxCalculationStrategy_" }, - "1963": { + "2017": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getLineItemTotals" }, - "1964": { + "2018": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getLineItemTotals" }, - "1965": { + "2019": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "items" }, - "1966": { + "2020": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__1" }, - "1967": { + "2021": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "1968": { + "2022": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.includeTax" }, - "1969": { + "2023": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.calculationContext" }, - "1970": { + "2024": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.taxRate" }, - "1971": { + "2025": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "1972": { + "2026": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.__index" }, - "1974": { + "2028": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getLineItemTotals_" }, - "1975": { + "2029": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getLineItemTotals_" }, - "1976": { + "2030": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "item" }, - "1977": { + "2031": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__1" }, - "1978": { + "2032": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "1979": { + "2033": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.includeTax" }, - "1980": { + "2034": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.lineItemAllocation" }, - "1981": { + "2035": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type" }, - "1982": { + "2036": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type.gift_card" }, - "1983": { + "2037": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type.discount" }, - "1984": { + "2038": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.taxLines" }, - "1985": { + "2039": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.calculationContext" }, - "1986": { + "2040": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getLineItemTotalsLegacy" }, - "1987": { + "2041": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getLineItemTotalsLegacy" }, - "1988": { + "2042": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "item" }, - "1989": { + "2043": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__1" }, - "1990": { + "2044": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "1991": { + "2045": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.lineItemAllocation" }, - "1992": { + "2046": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type" }, - "1993": { + "2047": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type.gift_card" }, - "1994": { + "2048": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type.discount" }, - "1995": { + "2049": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.calculationContext" }, - "1996": { + "2050": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.taxRate" }, - "1997": { + "2051": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getLineItemRefund" }, - "1998": { + "2052": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getLineItemRefund" }, - "1999": { + "2053": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "lineItem" }, - "2000": { + "2054": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2001": { + "2055": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.id" }, - "2002": { + "2056": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.unit_price" }, - "2003": { + "2057": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.includes_tax" }, - "2004": { + "2058": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.quantity" }, - "2005": { + "2059": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.tax_lines" }, - "2006": { + "2060": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__1" }, - "2007": { + "2061": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2008": { + "2062": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.calculationContext" }, - "2009": { + "2063": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.taxRate" }, - "2010": { + "2064": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getLineItemRefundLegacy" }, - "2011": { + "2065": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getLineItemRefundLegacy" }, - "2012": { + "2066": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "lineItem" }, - "2013": { + "2067": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2014": { + "2068": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.id" }, - "2015": { + "2069": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.unit_price" }, - "2016": { + "2070": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.includes_tax" }, - "2017": { + "2071": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.quantity" }, - "2018": { + "2072": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__1" }, - "2019": { + "2073": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2020": { + "2074": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.calculationContext" }, - "2021": { + "2075": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.taxRate" }, - "2022": { + "2076": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getGiftCardTotals" }, - "2023": { + "2077": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getGiftCardTotals" }, - "2024": { + "2078": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "giftCardableAmount" }, - "2025": { + "2079": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__1" }, - "2026": { + "2080": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2027": { + "2081": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.region" }, - "2028": { + "2082": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.giftCardTransactions" }, - "2029": { + "2083": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.giftCards" }, - "2030": { + "2084": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2031": { + "2085": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.total" }, - "2032": { + "2086": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.tax_total" }, - "2033": { + "2087": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getGiftCardTransactionsTotals" }, - "2034": { + "2088": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getGiftCardTransactionsTotals" }, - "2035": { + "2089": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__0" }, - "2036": { + "2090": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2037": { + "2091": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.giftCardTransactions" }, - "2038": { + "2092": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.region" }, - "2039": { + "2093": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2040": { + "2094": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.gift_cards_taxable" }, - "2041": { + "2095": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.tax_rate" }, - "2042": { + "2096": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2043": { + "2097": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.total" }, - "2044": { + "2098": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.tax_total" }, - "2045": { + "2099": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getShippingMethodTotals" }, - "2046": { + "2100": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getShippingMethodTotals" }, - "2047": { + "2101": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "shippingMethods" }, - "2048": { + "2102": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__1" }, - "2049": { + "2103": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2050": { + "2104": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.includeTax" }, - "2051": { + "2105": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.calculationContext" }, - "2052": { + "2106": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.discounts" }, - "2053": { + "2107": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.taxRate" }, - "2054": { + "2108": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2055": { + "2109": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.__index" }, - "2057": { + "2111": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getGiftCardableAmount" }, - "2058": { + "2112": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getGiftCardableAmount" }, - "2059": { + "2113": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__0" }, - "2060": { + "2114": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2061": { + "2115": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.gift_cards_taxable" }, - "2062": { + "2116": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.subtotal" }, - "2063": { + "2117": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.shipping_total" }, - "2064": { + "2118": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.discount_total" }, - "2065": { + "2119": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.tax_total" }, - "2066": { + "2120": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getShippingMethodTotals_" }, - "2067": { + "2121": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getShippingMethodTotals_" }, - "2068": { + "2122": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "shippingMethod" }, - "2069": { + "2123": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__1" }, - "2070": { + "2124": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2071": { + "2125": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.includeTax" }, - "2072": { + "2126": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.calculationContext" }, - "2073": { + "2127": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.taxLines" }, - "2074": { + "2128": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.discounts" }, - "2075": { + "2129": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getShippingMethodTotalsLegacy" }, - "2076": { + "2130": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "default.getShippingMethodTotalsLegacy" }, - "2077": { + "2131": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "shippingMethod" }, - "2078": { + "2132": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__1" }, - "2079": { + "2133": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type" }, - "2080": { + "2134": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.calculationContext" }, - "2081": { + "2135": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.discounts" }, - "2082": { + "2136": { "sourceFileName": "../../../packages/medusa/src/services/new-totals.ts", "qualifiedName": "__type.taxRate" }, - "2083": { + "2137": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "2084": { + "2138": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "2085": { + "2139": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2086": { + "2140": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2087": { + "2141": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "2088": { + "2142": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "2089": { + "2143": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "2090": { + "2144": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2091": { + "2145": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2092": { + "2146": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2093": { + "2147": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2094": { + "2148": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2095": { + "2149": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "2096": { + "2150": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2097": { + "2151": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "2098": { + "2152": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2099": { + "2153": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2100": { + "2154": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "2101": { + "2155": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "2102": { + "2156": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "2103": { + "2157": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2104": { + "2158": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2105": { + "2159": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2106": { + "2160": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "2107": { + "2161": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2108": { + "2162": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2109": { + "2163": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2110": { + "2164": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "2111": { + "2165": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2112": { + "2166": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2113": { + "2167": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2114": { + "2168": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService" }, - "2115": { + "2169": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.Events" }, - "2116": { + "2170": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "__object" }, - "2117": { + "2171": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "__object.CREATED" }, - "2118": { + "2172": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "__object.UPDATED" }, - "2119": { + "2173": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "__object.DELETED" }, - "2120": { + "2174": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.__constructor" }, - "2121": { + "2175": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService" }, - "2122": { + "2176": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "__0" }, - "2123": { + "2177": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.noteRepository_" }, - "2124": { + "2178": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.eventBus_" }, - "2125": { + "2179": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.retrieve" }, - "2126": { + "2180": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.retrieve" }, - "2127": { + "2181": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "noteId" }, - "2128": { + "2182": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "config" }, - "2129": { + "2183": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.list" }, - "2130": { + "2184": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.list" }, - "2131": { + "2185": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "selector" }, - "2132": { + "2186": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "config" }, - "2133": { + "2187": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.listAndCount" }, - "2134": { + "2188": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.listAndCount" }, - "2135": { + "2189": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "selector" }, - "2136": { + "2190": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "config" }, - "2137": { + "2191": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.create" }, - "2138": { + "2192": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.create" }, - "2139": { + "2193": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "data" }, - "2140": { + "2194": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "config" }, - "2141": { + "2195": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "__type" }, - "2142": { + "2196": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "__type.metadata" }, - "2143": { + "2197": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.update" }, - "2144": { + "2198": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.update" }, - "2145": { + "2199": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "noteId" }, - "2146": { + "2200": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "value" }, - "2147": { + "2201": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.delete" }, - "2148": { + "2202": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "NoteService.delete" }, - "2149": { + "2203": { "sourceFileName": "../../../packages/medusa/src/services/note.ts", "qualifiedName": "noteId" }, - "2150": { + "2204": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "2151": { + "2205": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "2152": { + "2206": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2153": { + "2207": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2154": { + "2208": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "2155": { + "2209": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "2156": { + "2210": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "2157": { + "2211": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2158": { + "2212": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2159": { + "2213": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2160": { + "2214": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2161": { + "2215": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2162": { + "2216": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "2163": { + "2217": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2164": { + "2218": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "2165": { + "2219": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2166": { + "2220": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2167": { + "2221": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "2168": { + "2222": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "2169": { + "2223": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "2170": { + "2224": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2171": { + "2225": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2172": { + "2226": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2173": { + "2227": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "2174": { + "2228": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2175": { + "2229": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2176": { + "2230": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2177": { + "2231": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "2178": { + "2232": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2179": { + "2233": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2180": { + "2234": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2181": { + "2235": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService" }, - "2182": { + "2236": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.__constructor" }, - "2183": { + "2237": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService" }, - "2184": { + "2238": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "container" }, - "2185": { + "2239": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.subscribers_" }, - "2186": { + "2240": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "__object" }, - "2187": { + "2241": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.attachmentGenerator_" }, - "2188": { + "2242": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.container_" }, - "2189": { + "2243": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "__type" }, - "2190": { + "2244": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.logger_" }, - "2191": { + "2245": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.notificationRepository_" }, - "2192": { + "2246": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.notificationProviderRepository_" }, - "2193": { + "2247": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.registerAttachmentGenerator" }, - "2194": { + "2248": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.registerAttachmentGenerator" }, - "2195": { + "2249": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "service" }, - "2196": { + "2250": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.registerInstalledProviders" }, - "2197": { + "2251": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.registerInstalledProviders" }, - "2198": { + "2252": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "providerIds" }, - "2199": { + "2253": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.list" }, - "2200": { + "2254": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.list" }, - "2201": { + "2255": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "selector" }, - "2202": { + "2256": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "config" }, - "2203": { + "2257": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.listAndCount" }, - "2204": { + "2258": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.listAndCount" }, - "2205": { + "2259": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "selector" }, - "2206": { + "2260": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "config" }, - "2207": { + "2261": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.retrieve" }, - "2208": { + "2262": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.retrieve" }, - "2209": { + "2263": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "id" }, - "2210": { + "2264": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "config" }, - "2211": { + "2265": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.subscribe" }, - "2212": { + "2266": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.subscribe" }, - "2213": { + "2267": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "eventName" }, - "2214": { + "2268": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "providerId" }, - "2215": { + "2269": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.retrieveProvider_" }, - "2216": { + "2270": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.retrieveProvider_" }, - "2217": { + "2271": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "id" }, - "2218": { + "2272": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.handleEvent" }, - "2219": { + "2273": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.handleEvent" }, - "2220": { + "2274": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "eventName" }, - "2221": { + "2275": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "data" }, - "2222": { + "2276": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.send" }, - "2223": { + "2277": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.send" }, - "2224": { + "2278": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "event" }, - "2225": { + "2279": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "eventData" }, - "2226": { + "2280": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "providerId" }, - "2227": { + "2281": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.resend" }, - "2228": { + "2282": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "NotificationService.resend" }, - "2229": { + "2283": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "id" }, - "2230": { + "2284": { "sourceFileName": "../../../packages/medusa/src/services/notification.ts", "qualifiedName": "config" }, - "2231": { + "2285": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "2232": { + "2286": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "2233": { + "2287": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2234": { + "2288": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2235": { + "2289": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "2236": { + "2290": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "2237": { + "2291": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "2238": { + "2292": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2239": { + "2293": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2240": { + "2294": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2241": { + "2295": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2242": { + "2296": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2243": { + "2297": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "2244": { + "2298": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2245": { + "2299": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "2246": { + "2300": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2247": { + "2301": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2248": { + "2302": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "2249": { + "2303": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "2250": { + "2304": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "2251": { + "2305": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2252": { + "2306": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2253": { + "2307": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2254": { + "2308": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "2255": { + "2309": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2256": { + "2310": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2257": { + "2311": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2258": { + "2312": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "2259": { + "2313": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2260": { + "2314": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2261": { + "2315": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2262": { + "2316": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth" }, - "2263": { + "2317": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.Events" }, - "2264": { + "2318": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "__object" }, - "2265": { + "2319": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "__object.TOKEN_GENERATED" }, - "2266": { + "2320": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "__object.TOKEN_REFRESHED" }, - "2267": { + "2321": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.__constructor" }, - "2268": { + "2322": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth" }, - "2269": { + "2323": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "cradle" }, - "2270": { + "2324": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.container_" }, - "2271": { + "2325": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.oauthRepository_" }, - "2272": { + "2326": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.eventBus_" }, - "2273": { + "2327": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.retrieveByName" }, - "2274": { + "2328": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.retrieveByName" }, - "2275": { + "2329": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "appName" }, - "2276": { + "2330": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.retrieve" }, - "2277": { + "2331": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.retrieve" }, - "2278": { + "2332": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "oauthId" }, - "2279": { + "2333": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.list" }, - "2280": { + "2334": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.list" }, - "2281": { + "2335": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "selector" }, - "2282": { + "2336": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.create" }, - "2283": { + "2337": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.create" }, - "2284": { + "2338": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "data" }, - "2285": { + "2339": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.update" }, - "2286": { + "2340": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.update" }, - "2287": { + "2341": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "id" }, - "2288": { + "2342": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "update" }, - "2289": { + "2343": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.registerOauthApp" }, - "2290": { + "2344": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.registerOauthApp" }, - "2291": { + "2345": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "appDetails" }, - "2292": { + "2346": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.generateToken" }, - "2293": { + "2347": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.generateToken" }, - "2294": { + "2348": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "appName" }, - "2295": { + "2349": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "code" }, - "2296": { + "2350": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "state" }, - "2297": { + "2351": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.refreshToken" }, - "2298": { + "2352": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "Oauth.refreshToken" }, - "2299": { + "2353": { "sourceFileName": "../../../packages/medusa/src/services/oauth.ts", "qualifiedName": "appName" }, - "2300": { + "2354": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "2301": { + "2355": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "2302": { + "2356": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2303": { + "2357": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2304": { + "2358": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "2305": { + "2359": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "2306": { + "2360": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "2307": { + "2361": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2308": { + "2362": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2309": { + "2363": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2310": { + "2364": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2311": { + "2365": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2312": { + "2366": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "2313": { + "2367": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2314": { + "2368": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "2315": { + "2369": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2316": { + "2370": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2317": { + "2371": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "2318": { + "2372": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "2319": { + "2373": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "2320": { + "2374": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2321": { + "2375": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2322": { + "2376": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2323": { + "2377": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "2324": { + "2378": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2325": { + "2379": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2326": { + "2380": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2327": { + "2381": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "2328": { + "2382": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2329": { + "2383": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2330": { + "2384": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2331": { + "2385": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService" }, - "2332": { + "2386": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.Events" }, - "2333": { + "2387": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object" }, - "2334": { + "2388": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.GIFT_CARD_CREATED" }, - "2335": { + "2389": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.PAYMENT_CAPTURED" }, - "2336": { + "2390": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.PAYMENT_CAPTURE_FAILED" }, - "2337": { + "2391": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.SHIPMENT_CREATED" }, - "2338": { + "2392": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.FULFILLMENT_CREATED" }, - "2339": { + "2393": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.FULFILLMENT_CANCELED" }, - "2340": { + "2394": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.RETURN_REQUESTED" }, - "2341": { + "2395": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.ITEMS_RETURNED" }, - "2342": { + "2396": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.RETURN_ACTION_REQUIRED" }, - "2343": { + "2397": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.REFUND_CREATED" }, - "2344": { + "2398": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.REFUND_FAILED" }, - "2345": { + "2399": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.SWAP_CREATED" }, - "2346": { + "2400": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.PLACED" }, - "2347": { + "2401": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.UPDATED" }, - "2348": { + "2402": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.CANCELED" }, - "2349": { + "2403": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__object.COMPLETED" }, - "2350": { + "2404": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.__constructor" }, - "2351": { + "2405": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService" }, - "2352": { + "2406": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__0" }, - "2353": { + "2407": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.orderRepository_" }, - "2354": { + "2408": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "__object" }, - "2355": { + "2409": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "__object.findWithRelations" }, - "2356": { + "2410": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "__object.findWithRelations" }, - "2357": { + "2411": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "relations" }, - "2358": { + "2412": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "optionsWithoutRelations" }, - "2359": { + "2413": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "__object.findOneWithRelations" }, - "2360": { + "2414": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "__object.findOneWithRelations" }, - "2361": { + "2415": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "relations" }, - "2362": { + "2416": { "sourceFileName": "../../../packages/medusa/src/repositories/order.ts", "qualifiedName": "optionsWithoutRelations" }, - "2363": { + "2417": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.customerService_" }, - "2364": { + "2418": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.paymentProviderService_" }, - "2365": { + "2419": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.shippingOptionService_" }, - "2366": { + "2420": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.shippingProfileService_" }, - "2367": { + "2421": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.discountService_" }, - "2368": { + "2422": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.fulfillmentProviderService_" }, - "2369": { + "2423": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.fulfillmentService_" }, - "2370": { + "2424": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.lineItemService_" }, - "2371": { + "2425": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.totalsService_" }, - "2372": { + "2426": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.newTotalsService_" }, - "2373": { + "2427": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.taxProviderService_" }, - "2374": { + "2428": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.regionService_" }, - "2375": { + "2429": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.cartService_" }, - "2376": { + "2430": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.addressRepository_" }, - "2377": { + "2431": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.giftCardService_" }, - "2378": { + "2432": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.draftOrderService_" }, - "2379": { + "2433": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.inventoryService_" }, - "2380": { + "2434": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.eventBus_" }, - "2381": { + "2435": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.featureFlagRouter_" }, - "2382": { + "2436": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.productVariantInventoryService_" }, - "2383": { + "2437": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.list" }, - "2384": { + "2438": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.list" }, - "2385": { + "2439": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "selector" }, - "2386": { + "2440": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "config" }, - "2387": { + "2441": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.listAndCount" }, - "2388": { + "2442": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.listAndCount" }, - "2389": { + "2443": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "selector" }, - "2390": { + "2444": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "config" }, - "2391": { + "2445": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.transformQueryForTotals" }, - "2392": { + "2446": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.transformQueryForTotals" }, - "2393": { + "2447": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "config" }, - "2394": { + "2448": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type" }, - "2395": { + "2449": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type.relations" }, - "2396": { + "2450": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type.select" }, - "2397": { + "2451": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type.totalsToSelect" }, - "2398": { + "2452": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.retrieve" }, - "2399": { + "2453": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.retrieve" }, - "2400": { + "2454": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderId" }, - "2401": { + "2455": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "config" }, - "2402": { + "2456": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.retrieveLegacy" }, - "2403": { + "2457": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.retrieveLegacy" }, - "2404": { + "2458": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderIdOrSelector" }, - "2405": { + "2459": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "config" }, - "2406": { + "2460": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.retrieveWithTotals" }, - "2407": { + "2461": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.retrieveWithTotals" }, - "2408": { + "2462": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderId" }, - "2409": { + "2463": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "options" }, - "2410": { + "2464": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "context" }, - "2411": { + "2465": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.retrieveByCartId" }, - "2412": { + "2466": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.retrieveByCartId" }, - "2413": { + "2467": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "cartId" }, - "2414": { + "2468": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "config" }, - "2415": { + "2469": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.retrieveByCartIdWithTotals" }, - "2416": { + "2470": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.retrieveByCartIdWithTotals" }, - "2417": { + "2471": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "cartId" }, - "2418": { + "2472": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "options" }, - "2419": { + "2473": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.retrieveByExternalId" }, - "2420": { + "2474": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.retrieveByExternalId" }, - "2421": { + "2475": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "externalId" }, - "2422": { + "2476": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "config" }, - "2423": { + "2477": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.completeOrder" }, - "2424": { + "2478": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.completeOrder" }, - "2425": { + "2479": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderId" }, - "2426": { + "2480": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.createFromCart" }, - "2427": { + "2481": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.createFromCart" }, - "2428": { + "2482": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "cartOrId" }, - "2429": { + "2483": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.createGiftCardsFromLineItem_" }, - "2430": { + "2484": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.createGiftCardsFromLineItem_" }, - "2431": { + "2485": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "order" }, - "2432": { + "2486": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "lineItem" }, - "2433": { + "2487": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "manager" }, - "2434": { + "2488": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.createShipment" }, - "2435": { + "2489": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.createShipment" }, - "2436": { + "2490": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderId" }, - "2437": { + "2491": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "fulfillmentId" }, - "2438": { + "2492": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "trackingLinks" }, - "2439": { + "2493": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "config" }, - "2440": { + "2494": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type" }, - "2441": { + "2495": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type.no_notification" }, - "2442": { + "2496": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type.metadata" }, - "2443": { + "2497": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.updateBillingAddress" }, - "2444": { + "2498": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.updateBillingAddress" }, - "2445": { + "2499": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "order" }, - "2446": { + "2500": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "address" }, - "2447": { + "2501": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.updateShippingAddress" }, - "2448": { + "2502": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.updateShippingAddress" }, - "2449": { + "2503": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "order" }, - "2450": { + "2504": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "address" }, - "2451": { + "2505": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.addShippingMethod" }, - "2452": { + "2506": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.addShippingMethod" }, - "2453": { + "2507": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderId" }, - "2454": { + "2508": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "optionId" }, - "2455": { + "2509": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "data" }, - "2456": { + "2510": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "config" }, - "2457": { + "2511": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.update" }, - "2458": { + "2512": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.update" }, - "2459": { + "2513": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderId" }, - "2460": { + "2514": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "update" }, - "2461": { + "2515": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.cancel" }, - "2462": { + "2516": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.cancel" }, - "2463": { + "2517": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderId" }, - "2464": { + "2518": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.capturePayment" }, - "2465": { + "2519": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.capturePayment" }, - "2466": { + "2520": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderId" }, - "2467": { + "2521": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.validateFulfillmentLineItem" }, - "2468": { + "2522": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.validateFulfillmentLineItem" }, - "2469": { + "2523": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "item" }, - "2470": { + "2524": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "quantity" }, - "2471": { + "2525": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.createFulfillment" }, - "2472": { + "2526": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.createFulfillment" }, - "2473": { + "2527": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderId" }, - "2474": { + "2528": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "itemsToFulfill" }, - "2475": { + "2529": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "config" }, - "2476": { + "2530": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type" }, - "2477": { + "2531": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type.no_notification" }, - "2478": { + "2532": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type.location_id" }, - "2479": { + "2533": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type.metadata" }, - "2480": { + "2534": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.cancelFulfillment" }, - "2481": { + "2535": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.cancelFulfillment" }, - "2482": { + "2536": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "fulfillmentId" }, - "2483": { + "2537": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.getFulfillmentItems" }, - "2484": { + "2538": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.getFulfillmentItems" }, - "2485": { + "2539": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "order" }, - "2486": { + "2540": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "items" }, - "2487": { + "2541": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "transformer" }, - "2488": { + "2542": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type" }, - "2489": { + "2543": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type" }, - "2490": { + "2544": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "item" }, - "2491": { + "2545": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "quantity" }, - "2492": { + "2546": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.archive" }, - "2493": { + "2547": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.archive" }, - "2494": { + "2548": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderId" }, - "2495": { + "2549": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.createRefund" }, - "2496": { + "2550": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.createRefund" }, - "2497": { + "2551": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderId" }, - "2498": { + "2552": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "refundAmount" }, - "2499": { + "2553": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "reason" }, - "2500": { + "2554": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "note" }, - "2501": { + "2555": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "config" }, - "2502": { + "2556": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type" }, - "2503": { + "2557": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "__type.no_notification" }, - "2504": { + "2558": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.decorateTotalsLegacy" }, - "2505": { + "2559": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.decorateTotalsLegacy" }, - "2506": { + "2560": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "order" }, - "2507": { + "2561": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "totalsFields" }, - "2508": { + "2562": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.decorateTotals" }, - "2509": { + "2563": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.decorateTotals" }, - "2510": { + "2564": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "order" }, - "2511": { + "2565": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "totalsFields" }, - "2512": { + "2566": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.decorateTotals" }, - "2513": { + "2567": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "order" }, - "2514": { + "2568": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "context" }, - "2515": { + "2569": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.registerReturnReceived" }, - "2516": { + "2570": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.registerReturnReceived" }, - "2517": { + "2571": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "orderId" }, - "2518": { + "2572": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "receivedReturn" }, - "2519": { + "2573": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "customRefundAmount" }, - "2520": { + "2574": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.getTotalsRelations" }, - "2521": { + "2575": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "OrderService.getTotalsRelations" }, - "2522": { + "2576": { "sourceFileName": "../../../packages/medusa/src/services/order.ts", "qualifiedName": "config" }, - "2523": { + "2577": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "2524": { + "2578": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "2525": { + "2579": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2526": { + "2580": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2527": { + "2581": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "2528": { + "2582": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "2529": { + "2583": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "2530": { + "2584": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2531": { + "2585": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2532": { + "2586": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2533": { + "2587": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2534": { + "2588": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2535": { + "2589": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "2536": { + "2590": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2537": { + "2591": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "2538": { + "2592": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2539": { + "2593": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2540": { + "2594": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "2541": { + "2595": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "2542": { + "2596": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "2543": { + "2597": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2544": { + "2598": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2545": { + "2599": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2546": { + "2600": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "2547": { + "2601": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2548": { + "2602": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2549": { + "2603": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2550": { + "2604": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "2551": { + "2605": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2552": { + "2606": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2553": { + "2607": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2554": { + "2608": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default" }, - "2555": { + "2609": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.Events" }, - "2556": { + "2610": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__object" }, - "2557": { + "2611": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__object.CREATED" }, - "2558": { + "2612": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__object.UPDATED" }, - "2559": { + "2613": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__object.DECLINED" }, - "2560": { + "2614": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__object.REQUESTED" }, - "2561": { + "2615": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__object.CANCELED" }, - "2562": { + "2616": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__object.CONFIRMED" }, - "2563": { + "2617": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.isOrderEditActive" }, - "2564": { + "2618": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.isOrderEditActive" }, - "2565": { + "2619": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEdit" }, - "2566": { + "2620": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.__constructor" }, - "2567": { + "2621": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default" }, - "2568": { + "2622": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__0" }, - "2569": { + "2623": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.orderEditRepository_" }, - "2570": { + "2624": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.orderService_" }, - "2571": { + "2625": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.totalsService_" }, - "2572": { + "2626": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.newTotalsService_" }, - "2573": { + "2627": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.lineItemService_" }, - "2574": { + "2628": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.eventBusService_" }, - "2575": { + "2629": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.taxProviderService_" }, - "2576": { + "2630": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.lineItemAdjustmentService_" }, - "2577": { + "2631": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.orderEditItemChangeService_" }, - "2578": { + "2632": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.inventoryService_" }, - "2579": { + "2633": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.inventoryService_" }, - "2580": { + "2634": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.retrieve" }, - "2581": { + "2635": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.retrieve" }, - "2582": { + "2636": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEditId" }, - "2583": { + "2637": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "config" }, - "2584": { + "2638": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.listAndCount" }, - "2585": { + "2639": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.listAndCount" }, - "2586": { + "2640": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "selector" }, - "2587": { - "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", - "qualifiedName": "__type" - }, - "2588": { + "2642": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type.q" }, - "2589": { + "2643": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "config" }, - "2590": { + "2644": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.list" }, - "2591": { + "2645": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.list" }, - "2592": { + "2646": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "selector" }, - "2593": { + "2647": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "config" }, - "2594": { + "2648": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.create" }, - "2595": { + "2649": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.create" }, - "2596": { + "2650": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "data" }, - "2597": { + "2651": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "context" }, - "2598": { + "2652": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type" }, - "2599": { + "2653": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type.createdBy" }, - "2600": { + "2654": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.update" }, - "2601": { + "2655": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.update" }, - "2602": { + "2656": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEditId" }, - "2603": { + "2657": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "data" }, - "2604": { + "2658": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.delete" }, - "2605": { + "2659": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.delete" }, - "2606": { + "2660": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "id" }, - "2607": { + "2661": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.decline" }, - "2608": { + "2662": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.decline" }, - "2609": { + "2663": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEditId" }, - "2610": { + "2664": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "context" }, - "2611": { + "2665": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type" }, - "2612": { + "2666": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type.declinedReason" }, - "2613": { + "2667": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type.declinedBy" }, - "2614": { + "2668": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.updateLineItem" }, - "2615": { + "2669": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.updateLineItem" }, - "2616": { + "2670": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEditId" }, - "2617": { + "2671": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "itemId" }, - "2618": { + "2672": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "data" }, - "2619": { + "2673": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type" }, - "2620": { + "2674": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type.quantity" }, - "2621": { + "2675": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.removeLineItem" }, - "2622": { + "2676": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.removeLineItem" }, - "2623": { + "2677": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEditId" }, - "2624": { + "2678": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "lineItemId" }, - "2625": { + "2679": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.refreshAdjustments" }, - "2626": { + "2680": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.refreshAdjustments" }, - "2627": { + "2681": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEditId" }, - "2628": { + "2682": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "config" }, - "2629": { + "2683": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__object" }, - "2630": { + "2684": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__object.preserveCustomAdjustments" }, - "2631": { + "2685": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.decorateTotals" }, - "2632": { + "2686": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.decorateTotals" }, - "2633": { + "2687": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEdit" }, - "2634": { + "2688": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.addLineItem" }, - "2635": { + "2689": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.addLineItem" }, - "2636": { + "2690": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEditId" }, - "2637": { + "2691": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "data" }, - "2638": { + "2692": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.deleteItemChange" }, - "2639": { + "2693": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.deleteItemChange" }, - "2640": { + "2694": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEditId" }, - "2641": { + "2695": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "itemChangeId" }, - "2642": { + "2696": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.requestConfirmation" }, - "2643": { + "2697": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.requestConfirmation" }, - "2644": { + "2698": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEditId" }, - "2645": { + "2699": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "context" }, - "2646": { + "2700": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type" }, - "2647": { + "2701": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type.requestedBy" }, - "2648": { + "2702": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.cancel" }, - "2649": { + "2703": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.cancel" }, - "2650": { + "2704": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEditId" }, - "2651": { + "2705": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "context" }, - "2652": { + "2706": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type" }, - "2653": { + "2707": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type.canceledBy" }, - "2654": { + "2708": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.confirm" }, - "2655": { + "2709": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.confirm" }, - "2656": { + "2710": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEditId" }, - "2657": { + "2711": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "context" }, - "2658": { + "2712": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type" }, - "2659": { + "2713": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "__type.confirmedBy" }, - "2660": { + "2714": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.retrieveActive" }, - "2661": { + "2715": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.retrieveActive" }, - "2662": { + "2716": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderId" }, - "2663": { + "2717": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "config" }, - "2664": { + "2718": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.deleteClonedItems" }, - "2665": { + "2719": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "default.deleteClonedItems" }, - "2666": { + "2720": { "sourceFileName": "../../../packages/medusa/src/services/order-edit.ts", "qualifiedName": "orderEditId" }, - "2667": { + "2721": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "2668": { + "2722": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "2669": { + "2723": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2670": { + "2724": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2671": { + "2725": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "2672": { + "2726": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "2673": { + "2727": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "2674": { + "2728": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2675": { + "2729": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2676": { + "2730": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2677": { + "2731": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2678": { + "2732": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2679": { + "2733": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "2680": { + "2734": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2681": { + "2735": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "2682": { + "2736": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2683": { + "2737": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2684": { + "2738": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "2685": { + "2739": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "2686": { + "2740": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "2687": { + "2741": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2688": { + "2742": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2689": { + "2743": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2690": { + "2744": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "2691": { + "2745": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2692": { + "2746": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2693": { + "2747": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2694": { + "2748": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "2695": { + "2749": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2696": { + "2750": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2697": { + "2751": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2698": { + "2752": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default" }, - "2699": { + "2753": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.Events" }, - "2700": { + "2754": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "__object" }, - "2701": { + "2755": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "__object.CREATED" }, - "2702": { + "2756": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "__object.DELETED" }, - "2703": { + "2757": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.__constructor" }, - "2704": { + "2758": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default" }, - "2705": { + "2759": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "__0" }, - "2706": { + "2760": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.orderItemChangeRepository_" }, - "2707": { + "2761": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.eventBus_" }, - "2708": { + "2762": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.lineItemService_" }, - "2709": { + "2763": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.taxProviderService_" }, - "2710": { + "2764": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.retrieve" }, - "2711": { + "2765": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.retrieve" }, - "2712": { + "2766": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "id" }, - "2713": { + "2767": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "config" }, - "2714": { + "2768": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.list" }, - "2715": { + "2769": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.list" }, - "2716": { + "2770": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "selector" }, - "2717": { + "2771": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "config" }, - "2718": { + "2772": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.create" }, - "2719": { + "2773": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.create" }, - "2720": { + "2774": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "data" }, - "2721": { + "2775": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.delete" }, - "2722": { + "2776": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "default.delete" }, - "2723": { + "2777": { "sourceFileName": "../../../packages/medusa/src/services/order-edit-item-change.ts", "qualifiedName": "itemChangeIds" }, - "2724": { + "2778": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "2725": { + "2779": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "2726": { + "2780": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2727": { + "2781": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2728": { + "2782": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "2729": { + "2783": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "2730": { + "2784": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "2731": { + "2785": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2732": { + "2786": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2733": { + "2787": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2734": { + "2788": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2735": { + "2789": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2736": { + "2790": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "2737": { + "2791": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2738": { + "2792": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "2739": { + "2793": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2740": { + "2794": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2741": { + "2795": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "2742": { + "2796": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "2743": { + "2797": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "2744": { + "2798": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2745": { + "2799": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2746": { + "2800": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2747": { + "2801": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "2748": { + "2802": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2749": { + "2803": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2750": { + "2804": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2751": { + "2805": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "2752": { + "2806": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2753": { + "2807": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2754": { + "2808": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2755": { + "2809": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default" }, - "2756": { + "2810": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.Events" }, - "2757": { + "2811": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "__object" }, - "2758": { + "2812": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "__object.CREATED" }, - "2759": { + "2813": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "__object.UPDATED" }, - "2760": { + "2814": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "__object.PAYMENT_CAPTURED" }, - "2761": { + "2815": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "__object.PAYMENT_CAPTURE_FAILED" }, - "2762": { + "2816": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "__object.REFUND_CREATED" }, - "2763": { + "2817": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "__object.REFUND_FAILED" }, - "2764": { + "2818": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.__constructor" }, - "2765": { + "2819": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default" }, - "2766": { + "2820": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "__0" }, - "2767": { + "2821": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.eventBusService_" }, - "2768": { + "2822": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.paymentProviderService_" }, - "2769": { + "2823": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.paymentRepository_" }, - "2770": { + "2824": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.retrieve" }, - "2771": { + "2825": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.retrieve" }, - "2772": { + "2826": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "paymentId" }, - "2773": { + "2827": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "config" }, - "2774": { + "2828": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.create" }, - "2775": { + "2829": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.create" }, - "2776": { + "2830": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "paymentInput" }, - "2777": { + "2831": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.update" }, - "2778": { + "2832": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.update" }, - "2779": { + "2833": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "paymentId" }, - "2780": { + "2834": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "data" }, - "2781": { + "2835": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "__type" }, - "2782": { + "2836": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "__type.order_id" }, - "2783": { + "2837": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "__type.swap_id" }, - "2784": { + "2838": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.capture" }, - "2785": { + "2839": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.capture" }, - "2786": { + "2840": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "paymentOrId" }, - "2787": { + "2841": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.refund" }, - "2788": { + "2842": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "default.refund" }, - "2789": { + "2843": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "paymentOrId" }, - "2790": { + "2844": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "amount" }, - "2791": { + "2845": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "reason" }, - "2792": { + "2846": { "sourceFileName": "../../../packages/medusa/src/services/payment.ts", "qualifiedName": "note" }, - "2793": { + "2847": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "2794": { + "2848": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "2795": { + "2849": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2796": { + "2850": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2797": { + "2851": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "2798": { + "2852": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "2799": { + "2853": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "2800": { + "2854": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2801": { + "2855": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2802": { + "2856": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2803": { + "2857": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2804": { + "2858": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2805": { + "2859": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "2806": { + "2860": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2807": { + "2861": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "2808": { + "2862": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2809": { + "2863": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2810": { + "2864": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "2811": { + "2865": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "2812": { + "2866": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "2813": { + "2867": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2814": { + "2868": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2815": { + "2869": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2816": { + "2870": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "2817": { + "2871": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2818": { + "2872": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2819": { + "2873": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2820": { + "2874": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "2821": { + "2875": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2822": { + "2876": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2823": { + "2877": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2824": { + "2878": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default" }, - "2825": { + "2879": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.Events" }, - "2826": { + "2880": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "__object" }, - "2827": { + "2881": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "__object.CREATED" }, - "2828": { + "2882": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "__object.UPDATED" }, - "2829": { + "2883": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "__object.DELETED" }, - "2830": { + "2884": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "__object.PAYMENT_AUTHORIZED" }, - "2831": { + "2885": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.__constructor" }, - "2832": { + "2886": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default" }, - "2833": { + "2887": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "__0" }, - "2834": { + "2888": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.eventBusService_" }, - "2835": { + "2889": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.paymentProviderService_" }, - "2836": { + "2890": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.customerService_" }, - "2837": { + "2891": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.paymentCollectionRepository_" }, - "2838": { + "2892": { "sourceFileName": "../../../packages/medusa/src/repositories/payment-collection.ts", "qualifiedName": "__object" }, - "2839": { + "2893": { "sourceFileName": "../../../packages/medusa/src/repositories/payment-collection.ts", "qualifiedName": "__object.getPaymentCollectionIdBySessionId" }, - "2840": { + "2894": { "sourceFileName": "../../../packages/medusa/src/repositories/payment-collection.ts", "qualifiedName": "__object.getPaymentCollectionIdBySessionId" }, - "2841": { + "2895": { "sourceFileName": "../../../packages/medusa/src/repositories/payment-collection.ts", "qualifiedName": "sessionId" }, - "2842": { + "2896": { "sourceFileName": "../../../packages/medusa/src/repositories/payment-collection.ts", "qualifiedName": "config" }, - "2843": { + "2897": { "sourceFileName": "../../../packages/medusa/src/repositories/payment-collection.ts", "qualifiedName": "__object.getPaymentCollectionIdByPaymentId" }, - "2844": { + "2898": { "sourceFileName": "../../../packages/medusa/src/repositories/payment-collection.ts", "qualifiedName": "__object.getPaymentCollectionIdByPaymentId" }, - "2845": { + "2899": { "sourceFileName": "../../../packages/medusa/src/repositories/payment-collection.ts", "qualifiedName": "paymentId" }, - "2846": { + "2900": { "sourceFileName": "../../../packages/medusa/src/repositories/payment-collection.ts", "qualifiedName": "config" }, - "2847": { + "2901": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.retrieve" }, - "2848": { + "2902": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.retrieve" }, - "2849": { + "2903": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "paymentCollectionId" }, - "2850": { + "2904": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "config" }, - "2851": { + "2905": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.create" }, - "2852": { + "2906": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.create" }, - "2853": { + "2907": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "data" }, - "2854": { + "2908": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.update" }, - "2855": { + "2909": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.update" }, - "2856": { + "2910": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "paymentCollectionId" }, - "2857": { + "2911": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "data" }, - "2858": { + "2912": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.delete" }, - "2859": { + "2913": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.delete" }, - "2860": { + "2914": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "paymentCollectionId" }, - "2861": { + "2915": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.isValidTotalAmount" }, - "2862": { + "2916": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.isValidTotalAmount" }, - "2863": { + "2917": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "total" }, - "2864": { + "2918": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "sessionsInput" }, - "2865": { + "2919": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.setPaymentSessionsBatch" }, - "2866": { + "2920": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.setPaymentSessionsBatch" }, - "2867": { + "2921": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "paymentCollectionOrId" }, - "2868": { + "2922": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "sessionsInput" }, - "2869": { + "2923": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "customerId" }, - "2870": { + "2924": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.setPaymentSession" }, - "2871": { + "2925": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.setPaymentSession" }, - "2872": { + "2926": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "paymentCollectionId" }, - "2873": { + "2927": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "sessionInput" }, - "2874": { + "2928": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "customerId" }, - "2875": { + "2929": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.refreshPaymentSession" }, - "2876": { + "2930": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.refreshPaymentSession" }, - "2877": { + "2931": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "paymentCollectionId" }, - "2878": { + "2932": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "sessionId" }, - "2879": { + "2933": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "customerId" }, - "2880": { + "2934": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.markAsAuthorized" }, - "2881": { + "2935": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.markAsAuthorized" }, - "2882": { + "2936": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "paymentCollectionId" }, - "2883": { + "2937": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.authorizePaymentSessions" }, - "2884": { + "2938": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "default.authorizePaymentSessions" }, - "2885": { + "2939": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "paymentCollectionId" }, - "2886": { + "2940": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "sessionIds" }, - "2887": { + "2941": { "sourceFileName": "../../../packages/medusa/src/services/payment-collection.ts", "qualifiedName": "context" }, - "2888": { + "2942": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "2889": { + "2943": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "2890": { + "2944": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2891": { + "2945": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "2892": { + "2946": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "2893": { + "2947": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "2894": { + "2948": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "2895": { + "2949": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2896": { + "2950": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "2897": { + "2951": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2898": { + "2952": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2899": { + "2953": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "2900": { + "2954": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "2901": { + "2955": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2902": { + "2956": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "2903": { + "2957": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2904": { + "2958": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "2905": { + "2959": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "2906": { + "2960": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "2907": { + "2961": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "2908": { + "2962": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2909": { + "2963": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2910": { + "2964": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "2911": { + "2965": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "2912": { + "2966": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2913": { + "2967": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2914": { + "2968": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2915": { + "2969": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "2916": { + "2970": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2917": { + "2971": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "2918": { + "2972": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "2919": { + "2973": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default" }, - "2920": { + "2974": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.__constructor" }, - "2921": { + "2975": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default" }, - "2922": { + "2976": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "container" }, - "2923": { + "2977": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.container_" }, - "2924": { + "2978": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.paymentSessionRepository_" }, - "2925": { + "2979": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.paymentProviderRepository_" }, - "2926": { + "2980": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.paymentRepository_" }, - "2927": { + "2981": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.paymentService_" }, - "2928": { + "2982": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.paymentService_" }, - "2929": { + "2983": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.refundRepository_" }, - "2930": { + "2984": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.customerService_" }, - "2931": { + "2985": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.logger_" }, - "2932": { + "2986": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.featureFlagRouter_" }, - "2933": { + "2987": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.registerInstalledProviders" }, - "2934": { + "2988": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.registerInstalledProviders" }, - "2935": { + "2989": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "providerIds" }, - "2936": { + "2990": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.list" }, - "2937": { + "2991": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.list" }, - "2938": { + "2992": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.retrievePayment" }, - "2939": { + "2993": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.retrievePayment" }, - "2940": { + "2994": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "paymentId" }, - "2941": { + "2995": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "relations" }, - "2942": { + "2996": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.listPayments" }, - "2943": { + "2997": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.listPayments" }, - "2944": { + "2998": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "selector" }, - "2945": { + "2999": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "config" }, - "2946": { + "3000": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.retrieveSession" }, - "2947": { + "3001": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.retrieveSession" }, - "2948": { + "3002": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "paymentSessionId" }, - "2949": { + "3003": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "relations" }, - "2950": { + "3004": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.createSession" }, - "2951": { + "3005": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.createSession" }, - "2952": { + "3006": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "providerId" }, - "2953": { + "3007": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "cart" }, - "2954": { + "3008": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.createSession" }, - "2955": { + "3009": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "sessionInput" }, - "2956": { + "3010": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.refreshSession" }, - "2957": { + "3011": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.refreshSession" }, - "2958": { + "3012": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "paymentSession" }, - "2959": { + "3013": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type" }, - "2960": { + "3014": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.id" }, - "2961": { + "3015": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.data" }, - "2962": { + "3016": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.provider_id" }, - "2963": { + "3017": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "sessionInput" }, - "2964": { + "3018": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.updateSession" }, - "2965": { + "3019": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.updateSession" }, - "2966": { + "3020": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "paymentSession" }, - "2967": { + "3021": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type" }, - "2968": { + "3022": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.id" }, - "2969": { + "3023": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.data" }, - "2970": { + "3024": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.provider_id" }, - "2971": { + "3025": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "sessionInput" }, - "2972": { + "3026": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.deleteSession" }, - "2973": { + "3027": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.deleteSession" }, - "2974": { + "3028": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "paymentSession" }, - "2975": { + "3029": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.retrieveProvider" }, - "2976": { + "3030": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.retrieveProvider" }, - "2977": { + "3031": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "TProvider" }, - "2978": { + "3032": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "providerId" }, - "2979": { + "3033": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.createPayment" }, - "2980": { + "3034": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.createPayment" }, - "2981": { + "3035": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "data" }, - "2982": { + "3036": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.updatePayment" }, - "2983": { + "3037": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.updatePayment" }, - "2984": { + "3038": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "paymentId" }, - "2985": { + "3039": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "data" }, - "2986": { + "3040": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type" }, - "2987": { + "3041": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.order_id" }, - "2988": { + "3042": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.swap_id" }, - "2989": { + "3043": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.authorizePayment" }, - "2990": { + "3044": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.authorizePayment" }, - "2991": { + "3045": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "paymentSession" }, - "2992": { + "3046": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "context" }, - "2993": { + "3047": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.updateSessionData" }, - "2994": { + "3048": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.updateSessionData" }, - "2995": { + "3049": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "paymentSession" }, - "2996": { + "3050": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "data" }, - "2997": { + "3051": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.cancelPayment" }, - "2998": { + "3052": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.cancelPayment" }, - "2999": { + "3053": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "paymentObj" }, - "3000": { + "3054": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type" }, - "3001": { + "3055": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.id" }, - "3002": { + "3056": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.getStatus" }, - "3003": { + "3057": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.getStatus" }, - "3004": { + "3058": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "payment" }, - "3005": { + "3059": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.capturePayment" }, - "3006": { + "3060": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.capturePayment" }, - "3007": { + "3061": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "paymentObj" }, - "3008": { + "3062": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type" }, - "3009": { + "3063": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.id" }, - "3010": { + "3064": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.refundPayment" }, - "3011": { + "3065": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.refundPayment" }, - "3012": { + "3066": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "payObjs" }, - "3013": { + "3067": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "amount" }, - "3014": { + "3068": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "reason" }, - "3015": { + "3069": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "note" }, - "3016": { + "3070": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.refundFromPayment" }, - "3017": { + "3071": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.refundFromPayment" }, - "3018": { + "3072": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "payment" }, - "3019": { + "3073": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "amount" }, - "3020": { + "3074": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "reason" }, - "3021": { + "3075": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "note" }, - "3022": { + "3076": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.retrieveRefund" }, - "3023": { + "3077": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.retrieveRefund" }, - "3024": { + "3078": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "id" }, - "3025": { + "3079": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "config" }, - "3026": { + "3080": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.buildPaymentProcessorContext" }, - "3027": { + "3081": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.buildPaymentProcessorContext" }, - "3028": { + "3082": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "cartOrData" }, - "3029": { + "3083": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.saveSession" }, - "3030": { + "3084": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.saveSession" }, - "3031": { + "3085": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "providerId" }, - "3032": { + "3086": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "data" }, - "3033": { + "3087": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type" }, - "3034": { + "3088": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.payment_session_id" }, - "3035": { + "3089": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.cartId" }, - "3036": { + "3090": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.amount" }, - "3037": { + "3091": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.sessionData" }, - "3038": { + "3092": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.isSelected" }, - "3039": { + "3093": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.isInitiated" }, - "3040": { + "3094": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.status" }, - "3041": { + "3095": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.processUpdateRequestsData" }, - "3042": { + "3096": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.processUpdateRequestsData" }, - "3043": { + "3097": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "data" }, - "3044": { + "3098": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type" }, - "3045": { + "3099": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.customer" }, - "3046": { + "3100": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type" }, - "3047": { + "3101": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "__type.id" }, - "3048": { + "3102": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "paymentResponse" }, - "3049": { + "3103": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.throwFromPaymentProcessorError" }, - "3050": { + "3104": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "default.throwFromPaymentProcessorError" }, - "3051": { + "3105": { "sourceFileName": "../../../packages/medusa/src/services/payment-provider.ts", "qualifiedName": "errObj" }, - "3052": { + "3106": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "3053": { + "3107": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "3054": { + "3108": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3055": { + "3109": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3056": { + "3110": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "3057": { + "3111": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "3058": { + "3112": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "3059": { + "3113": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3060": { + "3114": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3061": { + "3115": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3062": { + "3116": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3063": { + "3117": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3064": { + "3118": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "3065": { + "3119": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3066": { + "3120": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "3067": { + "3121": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3068": { + "3122": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3069": { + "3123": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "3070": { + "3124": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "3071": { + "3125": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "3072": { + "3126": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3073": { + "3127": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3074": { + "3128": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3075": { + "3129": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "3076": { + "3130": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3077": { + "3131": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3078": { + "3132": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3079": { + "3133": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "3080": { + "3134": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3081": { + "3135": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3082": { + "3136": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3083": { + "3137": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService" }, - "3084": { + "3138": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.__constructor" }, - "3085": { + "3139": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService" }, - "3086": { + "3140": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "__0" }, - "3087": { + "3141": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.customerGroupService_" }, - "3088": { + "3142": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.regionService_" }, - "3089": { + "3143": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.productService_" }, - "3090": { + "3144": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.variantService_" }, - "3091": { + "3145": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.priceListRepo_" }, - "3092": { + "3146": { "sourceFileName": "../../../packages/medusa/src/repositories/price-list.ts", "qualifiedName": "__object" }, - "3093": { + "3147": { "sourceFileName": "../../../packages/medusa/src/repositories/price-list.ts", "qualifiedName": "__object.listAndCount" }, - "3094": { + "3148": { "sourceFileName": "../../../packages/medusa/src/repositories/price-list.ts", "qualifiedName": "__object.listAndCount" }, - "3095": { + "3149": { "sourceFileName": "../../../packages/medusa/src/repositories/price-list.ts", "qualifiedName": "query" }, - "3096": { + "3150": { "sourceFileName": "../../../packages/medusa/src/repositories/price-list.ts", "qualifiedName": "q" }, - "3097": { + "3151": { "sourceFileName": "../../../packages/medusa/src/repositories/price-list.ts", "qualifiedName": "__object.listPriceListsVariantIdsMap" }, - "3098": { + "3152": { "sourceFileName": "../../../packages/medusa/src/repositories/price-list.ts", "qualifiedName": "__object.listPriceListsVariantIdsMap" }, - "3099": { + "3153": { "sourceFileName": "../../../packages/medusa/src/repositories/price-list.ts", "qualifiedName": "priceListIds" }, - "3100": { + "3154": { "sourceFileName": "../../../packages/medusa/src/repositories/price-list.ts", "qualifiedName": "__type" }, - "3101": { + "3155": { "sourceFileName": "../../../packages/medusa/src/repositories/price-list.ts", "qualifiedName": "__type.__index" }, - "3103": { + "3157": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.moneyAmountRepo_" }, - "3104": { + "3158": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object" }, - "3105": { + "3159": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.insertBulk" }, - "3106": { + "3160": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.insertBulk" }, - "3107": { + "3161": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "data" }, - "3108": { + "3162": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findVariantPricesNotIn" }, - "3109": { + "3163": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findVariantPricesNotIn" }, - "3110": { + "3164": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variantId" }, - "3111": { + "3165": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "prices" }, - "3112": { + "3166": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.deleteVariantPricesNotIn" }, - "3113": { + "3167": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.deleteVariantPricesNotIn" }, - "3114": { + "3168": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variantIdOrData" }, - "3115": { + "3169": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type" }, - "3116": { + "3170": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.variantId" }, - "3117": { + "3171": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.prices" }, - "3118": { + "3172": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "prices" }, - "3119": { + "3173": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.upsertVariantCurrencyPrice" }, - "3120": { + "3174": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.upsertVariantCurrencyPrice" }, - "3121": { + "3175": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variantId" }, - "3122": { + "3176": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "price" }, - "3123": { + "3177": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.addPriceListPrices" }, - "3124": { + "3178": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.addPriceListPrices" }, - "3125": { + "3179": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "priceListId" }, - "3126": { + "3180": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "prices" }, - "3127": { + "3181": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "overrideExisting" }, - "3128": { + "3182": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.deletePriceListPrices" }, - "3129": { + "3183": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.deletePriceListPrices" }, - "3130": { + "3184": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "priceListId" }, - "3131": { + "3185": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "moneyAmountIds" }, - "3132": { + "3186": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findManyForVariantInPriceList" }, - "3133": { + "3187": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findManyForVariantInPriceList" }, - "3134": { + "3188": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variant_id" }, - "3135": { + "3189": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "price_list_id" }, - "3136": { + "3190": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "requiresPriceList" }, - "3137": { + "3191": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findManyForVariantInRegion" }, - "3138": { + "3192": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findManyForVariantInRegion" }, - "3139": { + "3193": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variant_id" }, - "3140": { + "3194": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "region_id" }, - "3141": { + "3195": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "currency_code" }, - "3142": { + "3196": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "customer_id" }, - "3143": { + "3197": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "include_discount_prices" }, - "3144": { + "3198": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "include_tax_inclusive_pricing" }, - "3145": { + "3199": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findCurrencyMoneyAmounts" }, - "3146": { + "3200": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findCurrencyMoneyAmounts" }, - "3147": { + "3201": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "where" }, - "3148": { + "3202": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type" }, - "3149": { + "3203": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.variant_id" }, - "3150": { + "3204": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.currency_code" }, - "3151": { + "3205": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object" }, - "3152": { + "3206": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.variant_id" }, - "3153": { + "3207": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.currency_code" }, - "3154": { + "3208": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.currency" }, - "3155": { + "3209": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.amount" }, - "3156": { + "3210": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.min_quantity" }, - "3157": { + "3211": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.max_quantity" }, - "3158": { + "3212": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.price_list_id" }, - "3159": { + "3213": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.price_list" }, - "3160": { + "3214": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.variants" }, - "3161": { + "3215": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.variant" }, - "3162": { + "3216": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.region_id" }, - "3163": { + "3217": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.region" }, - "3164": { + "3218": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/soft-deletable-entity.ts", "qualifiedName": "SoftDeletableEntity.deleted_at" }, - "3165": { + "3219": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "3166": { + "3220": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "3167": { + "3221": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "3168": { + "3222": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findRegionMoneyAmounts" }, - "3169": { + "3223": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findRegionMoneyAmounts" }, - "3170": { + "3224": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "where" }, - "3171": { + "3225": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type" }, - "3172": { + "3226": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.variant_id" }, - "3173": { + "3227": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.region_id" }, - "3174": { + "3228": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object" }, - "3175": { + "3229": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.variant_id" }, - "3176": { + "3230": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.currency_code" }, - "3177": { + "3231": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.currency" }, - "3178": { + "3232": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.amount" }, - "3179": { + "3233": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.min_quantity" }, - "3180": { + "3234": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.max_quantity" }, - "3181": { + "3235": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.price_list_id" }, - "3182": { + "3236": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.price_list" }, - "3183": { + "3237": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.variants" }, - "3184": { + "3238": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.variant" }, - "3185": { + "3239": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.region_id" }, - "3186": { + "3240": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.region" }, - "3187": { + "3241": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/soft-deletable-entity.ts", "qualifiedName": "SoftDeletableEntity.deleted_at" }, - "3188": { + "3242": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "3189": { + "3243": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "3190": { + "3244": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "3191": { + "3245": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findManyForVariantsInRegion" }, - "3192": { + "3246": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findManyForVariantsInRegion" }, - "3193": { + "3247": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variant_ids" }, - "3194": { + "3248": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "region_id" }, - "3195": { + "3249": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "currency_code" }, - "3196": { + "3250": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "customer_id" }, - "3197": { + "3251": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "include_discount_prices" }, - "3198": { + "3252": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "include_tax_inclusive_pricing" }, - "3199": { + "3253": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.updatePriceListPrices" }, - "3200": { + "3254": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.updatePriceListPrices" }, - "3201": { + "3255": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "priceListId" }, - "3202": { + "3256": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "updates" }, - "3203": { + "3257": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.getPricesForVariantInRegion" }, - "3204": { + "3258": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.getPricesForVariantInRegion" }, - "3205": { + "3259": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variantId" }, - "3206": { + "3260": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "regionId" }, - "3207": { + "3261": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.createProductVariantMoneyAmounts" }, - "3208": { + "3262": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.createProductVariantMoneyAmounts" }, - "3209": { + "3263": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "toCreate" }, - "3210": { + "3264": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type" }, - "3211": { + "3265": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.variant_id" }, - "3212": { + "3266": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.money_amount_id" }, - "3213": { + "3267": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.productVariantRepo_" }, - "3214": { + "3268": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.featureFlagRouter_" }, - "3215": { + "3269": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.retrieve" }, - "3216": { + "3270": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.retrieve" }, - "3217": { + "3271": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "priceListId" }, - "3218": { + "3272": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "config" }, - "3219": { + "3273": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.listPriceListsVariantIdsMap" }, - "3220": { + "3274": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.listPriceListsVariantIdsMap" }, - "3221": { + "3275": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "priceListIds" }, - "3222": { + "3276": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "__type" }, - "3223": { + "3277": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "__type.__index" }, - "3225": { + "3279": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.create" }, - "3226": { + "3280": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.create" }, - "3227": { + "3281": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "priceListObject" }, - "3228": { + "3282": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.update" }, - "3229": { + "3283": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.update" }, - "3230": { + "3284": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "id" }, - "3231": { + "3285": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "update" }, - "3232": { + "3286": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.addPrices" }, - "3233": { + "3287": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.addPrices" }, - "3234": { + "3288": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "id" }, - "3235": { + "3289": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "prices" }, - "3236": { + "3290": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "replace" }, - "3237": { + "3291": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.deletePrices" }, - "3238": { + "3292": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.deletePrices" }, - "3239": { + "3293": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "id" }, - "3240": { + "3294": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "priceIds" }, - "3241": { + "3295": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.clearPrices" }, - "3242": { + "3296": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.clearPrices" }, - "3243": { + "3297": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "id" }, - "3244": { + "3298": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.delete" }, - "3245": { + "3299": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.delete" }, - "3246": { + "3300": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "id" }, - "3247": { + "3301": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.list" }, - "3248": { + "3302": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.list" }, - "3249": { + "3303": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "selector" }, - "3250": { + "3304": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "config" }, - "3251": { + "3305": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.listAndCount" }, - "3252": { + "3306": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.listAndCount" }, - "3253": { + "3307": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "selector" }, - "3254": { + "3308": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "config" }, - "3255": { + "3309": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.upsertCustomerGroups_" }, - "3256": { + "3310": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.upsertCustomerGroups_" }, - "3257": { + "3311": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "priceListId" }, - "3258": { + "3312": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "customerGroups" }, - "3259": { + "3313": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "__type" }, - "3260": { + "3314": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "__type.id" }, - "3261": { + "3315": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.listProducts" }, - "3262": { + "3316": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.listProducts" }, - "3263": { + "3317": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "priceListId" }, - "3264": { + "3318": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "selector" }, - "3265": { + "3319": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "config" }, - "3266": { + "3320": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "requiresPriceList" }, - "3267": { + "3321": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.listVariants" }, - "3268": { + "3322": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.listVariants" }, - "3269": { + "3323": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "priceListId" }, - "3270": { + "3324": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "selector" }, - "3271": { + "3325": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "config" }, - "3272": { + "3326": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "requiresPriceList" }, - "3273": { + "3327": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.deleteProductPrices" }, - "3274": { + "3328": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.deleteProductPrices" }, - "3275": { + "3329": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "priceListId" }, - "3276": { + "3330": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "productIds" }, - "3277": { + "3331": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.deleteVariantPrices" }, - "3278": { + "3332": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.deleteVariantPrices" }, - "3279": { + "3333": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "priceListId" }, - "3280": { + "3334": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "variantIds" }, - "3281": { + "3335": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.addCurrencyFromRegion" }, - "3282": { + "3336": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "PriceListService.addCurrencyFromRegion" }, - "3283": { + "3337": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "T" }, - "3284": { + "3338": { "sourceFileName": "../../../packages/medusa/src/services/price-list.ts", "qualifiedName": "prices" }, - "3285": { + "3339": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "3286": { + "3340": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "3287": { + "3341": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3288": { + "3342": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3289": { + "3343": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "3290": { + "3344": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "3291": { + "3345": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "3292": { + "3346": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3293": { + "3347": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3294": { + "3348": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3295": { + "3349": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3296": { + "3350": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3297": { + "3351": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "3298": { + "3352": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3299": { + "3353": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "3300": { + "3354": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3301": { + "3355": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3302": { + "3356": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "3303": { + "3357": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "3304": { + "3358": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "3305": { + "3359": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3306": { + "3360": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3307": { + "3361": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3308": { + "3362": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "3309": { + "3363": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3310": { + "3364": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3311": { + "3365": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3312": { + "3366": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "3313": { + "3367": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3314": { + "3368": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3315": { + "3369": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3316": { + "3370": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService" }, - "3317": { + "3371": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.__constructor" }, - "3318": { + "3372": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService" }, - "3319": { + "3373": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__0" }, - "3320": { + "3374": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.regionService" }, - "3321": { + "3375": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.taxProviderService" }, - "3322": { + "3376": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.customerService_" }, - "3323": { + "3377": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.priceSelectionStrategy" }, - "3324": { + "3378": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.productVariantService" }, - "3325": { + "3379": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.featureFlagRouter" }, - "3326": { + "3380": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.pricingModuleService" }, - "3327": { + "3381": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.pricingModuleService" }, - "3328": { + "3382": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.remoteQuery" }, - "3329": { + "3383": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.remoteQuery" }, - "3330": { + "3384": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.collectPricingContext" }, - "3331": { + "3385": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.collectPricingContext" }, - "3332": { + "3386": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3333": { + "3387": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.calculateTaxes" }, - "3334": { + "3388": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.calculateTaxes" }, - "3335": { + "3389": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "variantPricing" }, - "3336": { + "3390": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "productRates" }, - "3337": { + "3391": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductVariantPricingModulePricing_" }, - "3338": { + "3392": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductVariantPricingModulePricing_" }, - "3339": { + "3393": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "variantPriceData" }, - "3340": { + "3394": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type" }, - "3341": { + "3395": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type.variantId" }, - "3342": { + "3396": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type.quantity" }, - "3343": { + "3397": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3344": { + "3398": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductVariantPricing_" }, - "3345": { + "3399": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductVariantPricing_" }, - "3346": { + "3400": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "data" }, - "3347": { + "3401": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type" }, - "3348": { + "3402": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type.variantId" }, - "3349": { + "3403": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type.quantity" }, - "3350": { + "3404": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3351": { + "3405": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductVariantPricing" }, - "3352": { + "3406": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductVariantPricing" }, - "3353": { + "3407": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "variant" }, - "3354": { + "3408": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3355": { + "3409": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductVariantPricingById" }, - "3356": { + "3410": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductVariantPricingById" }, - "3357": { + "3411": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "variantId" }, - "3358": { + "3412": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3359": { + "3413": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductVariantsPricing" }, - "3360": { + "3414": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductVariantsPricing" }, - "3361": { + "3415": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "data" }, - "3362": { + "3416": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type" }, - "3363": { + "3417": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type.variantId" }, - "3364": { + "3418": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type.quantity" }, - "3365": { + "3419": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3366": { + "3420": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type" }, - "3367": { + "3421": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type.__index" }, - "3369": { + "3423": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductPricing_" }, - "3370": { + "3424": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductPricing_" }, - "3371": { + "3425": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "data" }, - "3372": { + "3426": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type" }, - "3373": { + "3427": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type.productId" }, - "3374": { + "3428": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "__type.variants" }, - "3375": { + "3429": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3376": { + "3430": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductPricing" }, - "3377": { + "3431": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductPricing" }, - "3378": { + "3432": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "product" }, - "3379": { + "3433": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3380": { + "3434": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductPricingById" }, - "3381": { + "3435": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getProductPricingById" }, - "3382": { + "3436": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "productId" }, - "3383": { + "3437": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3384": { + "3438": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.setVariantPrices" }, - "3385": { + "3439": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.setVariantPrices" }, - "3386": { + "3440": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "variants" }, - "3387": { + "3441": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3388": { + "3442": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.setProductPrices" }, - "3389": { + "3443": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.setProductPrices" }, - "3390": { + "3444": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "products" }, - "3391": { + "3445": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3392": { + "3446": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getPricingModuleVariantMoneyAmounts" }, - "3393": { + "3447": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getPricingModuleVariantMoneyAmounts" }, - "3394": { + "3448": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "variantIds" }, - "3395": { + "3449": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.setAdminVariantPricing" }, - "3396": { + "3450": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.setAdminVariantPricing" }, - "3397": { + "3451": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "variants" }, - "3398": { + "3452": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3399": { + "3453": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.setAdminProductPricing" }, - "3400": { + "3454": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.setAdminProductPricing" }, - "3401": { + "3455": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "products" }, - "3402": { + "3456": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getShippingOptionPricing" }, - "3403": { + "3457": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.getShippingOptionPricing" }, - "3404": { + "3458": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "shippingOption" }, - "3405": { + "3459": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3406": { + "3460": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.setShippingOptionPrices" }, - "3407": { + "3461": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "PricingService.setShippingOptionPrices" }, - "3408": { + "3462": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "shippingOptions" }, - "3409": { + "3463": { "sourceFileName": "../../../packages/medusa/src/services/pricing.ts", "qualifiedName": "context" }, - "3410": { + "3464": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "3411": { + "3465": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "3412": { + "3466": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3413": { + "3467": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3414": { + "3468": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "3415": { + "3469": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "3416": { + "3470": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "3417": { + "3471": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3418": { + "3472": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3419": { + "3473": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3420": { + "3474": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3421": { + "3475": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3422": { + "3476": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "3423": { + "3477": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3424": { + "3478": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "3425": { + "3479": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3426": { + "3480": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3427": { + "3481": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "3428": { + "3482": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "3429": { + "3483": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "3430": { + "3484": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3431": { + "3485": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3432": { + "3486": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3433": { + "3487": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "3434": { + "3488": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3435": { + "3489": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3436": { + "3490": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3437": { + "3491": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "3438": { + "3492": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3439": { + "3493": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3440": { + "3494": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3441": { + "3495": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService" }, - "3442": { + "3496": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.IndexName" }, - "3443": { + "3497": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.Events" }, - "3444": { + "3498": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "__object" }, - "3445": { + "3499": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "__object.UPDATED" }, - "3446": { + "3500": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "__object.CREATED" }, - "3447": { + "3501": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "__object.DELETED" }, - "3448": { + "3502": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.__constructor" }, - "3449": { + "3503": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService" }, - "3450": { + "3504": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "__0" }, - "3451": { + "3505": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.productOptionRepository_" }, - "3452": { + "3506": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.productRepository_" }, - "3453": { + "3507": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object" }, - "3454": { + "3508": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProducts" }, - "3455": { + "3509": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProducts" }, - "3456": { + "3510": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "optionsWithoutRelations" }, - "3457": { + "3511": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "shouldCount" }, - "3458": { + "3512": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProductsWithIds" }, - "3459": { + "3513": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProductsWithIds" }, - "3460": { + "3514": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__0" }, - "3461": { + "3515": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "3462": { + "3516": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.entityIds" }, - "3463": { + "3517": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.groupedRelations" }, - "3464": { + "3518": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "3465": { + "3519": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.__index" }, - "3467": { + "3521": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.withDeleted" }, - "3468": { + "3522": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.select" }, - "3469": { + "3523": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.order" }, - "3470": { + "3524": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "3471": { + "3525": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.__index" }, - "3473": { + "3527": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.where" }, - "3474": { + "3528": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelationsAndCount" }, - "3475": { + "3529": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelationsAndCount" }, - "3476": { + "3530": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "3477": { + "3531": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "idsOrOptionsWithoutRelations" }, - "3478": { + "3532": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelations" }, - "3479": { + "3533": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelations" }, - "3480": { + "3534": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "3481": { + "3535": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "idsOrOptionsWithoutRelations" }, - "3482": { + "3536": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "withDeleted" }, - "3483": { + "3537": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findOneWithRelations" }, - "3484": { + "3538": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findOneWithRelations" }, - "3485": { + "3539": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "3486": { + "3540": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "optionsWithoutRelations" }, - "3487": { + "3541": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkAddToCollection" }, - "3488": { + "3542": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkAddToCollection" }, - "3489": { + "3543": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "productIds" }, - "3490": { + "3544": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "collectionId" }, - "3491": { + "3545": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkRemoveFromCollection" }, - "3492": { + "3546": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkRemoveFromCollection" }, - "3493": { + "3547": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "productIds" }, - "3494": { + "3548": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "collectionId" }, - "3495": { + "3549": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "3496": { + "3550": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "3497": { + "3551": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "q" }, - "3498": { + "3552": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "options" }, - "3499": { + "3553": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "3500": { + "3554": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsFromInput" }, - "3501": { + "3555": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsFromInput" }, - "3502": { + "3556": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "categoryId" }, - "3503": { + "3557": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "includeCategoryChildren" }, - "3504": { + "3558": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsRecursively" }, - "3505": { + "3559": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsRecursively" }, - "3506": { + "3560": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "productCategory" }, - "3507": { + "3561": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._findWithRelations" }, - "3508": { + "3562": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._findWithRelations" }, - "3509": { + "3563": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__0" }, - "3510": { + "3564": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "3511": { + "3565": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.relations" }, - "3512": { + "3566": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.idsOrOptionsWithoutRelations" }, - "3513": { + "3567": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.withDeleted" }, - "3514": { + "3568": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.shouldCount" }, - "3515": { + "3569": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.isProductInSalesChannels" }, - "3516": { + "3570": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.isProductInSalesChannels" }, - "3517": { + "3571": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "id" }, - "3518": { + "3572": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "salesChannelIds" }, - "3519": { + "3573": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._applyCategoriesQuery" }, - "3520": { + "3574": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._applyCategoriesQuery" }, - "3521": { + "3575": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "qb" }, - "3522": { + "3576": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__1" }, - "3523": { + "3578": { + "sourceFileName": "", + "qualifiedName": "alias" + }, + "3579": { + "sourceFileName": "", + "qualifiedName": "categoryAlias" + }, + "3580": { + "sourceFileName": "", + "qualifiedName": "where" + }, + "3581": { + "sourceFileName": "", + "qualifiedName": "joinName" + }, + "3582": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.productVariantRepository_" }, - "3524": { + "3583": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.productTypeRepository_" }, - "3525": { + "3584": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "__object" }, - "3526": { + "3585": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "__object.upsertType" }, - "3527": { + "3586": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "__object.upsertType" }, - "3528": { + "3587": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "type" }, - "3529": { + "3588": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "__object.findAndCountByDiscountConditionId" }, - "3530": { + "3589": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "__object.findAndCountByDiscountConditionId" }, - "3531": { + "3590": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "conditionId" }, - "3532": { + "3591": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "query" }, - "3533": { + "3592": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.productTagRepository_" }, - "3534": { + "3593": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "__object" }, - "3535": { + "3594": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "__object.insertBulk" }, - "3536": { + "3595": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "__object.insertBulk" }, - "3537": { + "3596": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "data" }, - "3538": { + "3597": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "__object.listTagsByUsage" }, - "3539": { + "3598": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "__object.listTagsByUsage" }, - "3540": { + "3599": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "take" }, - "3541": { + "3600": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "__object.upsertTags" }, - "3542": { + "3601": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "__object.upsertTags" }, - "3543": { + "3602": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "tags" }, - "3544": { + "3603": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "__object.findAndCountByDiscountConditionId" }, - "3545": { + "3604": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "__object.findAndCountByDiscountConditionId" }, - "3546": { + "3605": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "conditionId" }, - "3547": { + "3606": { "sourceFileName": "../../../packages/medusa/src/repositories/product-tag.ts", "qualifiedName": "query" }, - "3548": { + "3607": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.imageRepository_" }, - "3549": { + "3608": { "sourceFileName": "../../../packages/medusa/src/repositories/image.ts", "qualifiedName": "__object" }, - "3550": { + "3609": { "sourceFileName": "../../../packages/medusa/src/repositories/image.ts", "qualifiedName": "__object.insertBulk" }, - "3551": { + "3610": { "sourceFileName": "../../../packages/medusa/src/repositories/image.ts", "qualifiedName": "__object.insertBulk" }, - "3552": { + "3611": { "sourceFileName": "../../../packages/medusa/src/repositories/image.ts", "qualifiedName": "data" }, - "3553": { + "3612": { "sourceFileName": "../../../packages/medusa/src/repositories/image.ts", "qualifiedName": "__object.upsertImages" }, - "3554": { + "3613": { "sourceFileName": "../../../packages/medusa/src/repositories/image.ts", "qualifiedName": "__object.upsertImages" }, - "3555": { + "3614": { "sourceFileName": "../../../packages/medusa/src/repositories/image.ts", "qualifiedName": "imageUrls" }, - "3556": { + "3615": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.productCategoryRepository_" }, - "3557": { + "3616": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object" }, - "3558": { + "3617": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.findOneWithDescendants" }, - "3559": { + "3618": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.findOneWithDescendants" }, - "3560": { + "3619": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "query" }, - "3561": { + "3620": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "treeScope" }, - "3562": { + "3621": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "3563": { + "3622": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "3564": { + "3623": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "options" }, - "3565": { + "3624": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "q" }, - "3566": { + "3625": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "treeScope" }, - "3567": { + "3626": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "includeTree" }, - "3568": { + "3627": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.addProducts" }, - "3569": { + "3628": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.addProducts" }, - "3570": { + "3629": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productCategoryId" }, - "3571": { + "3630": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productIds" }, - "3572": { + "3631": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.removeProducts" }, - "3573": { + "3632": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.removeProducts" }, - "3574": { + "3633": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productCategoryId" }, - "3575": { + "3634": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productIds" }, - "3576": { + "3635": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.productVariantService_" }, - "3577": { + "3636": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.searchService_" }, - "3578": { + "3637": { + "sourceFileName": "../../../packages/medusa/src/services/product.ts", + "qualifiedName": "ProductService.salesChannelService_" + }, + "3638": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.eventBus_" }, - "3579": { + "3639": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.featureFlagRouter_" }, - "3580": { + "3640": { + "sourceFileName": "../../../packages/medusa/src/services/product.ts", + "qualifiedName": "ProductService.remoteQuery_" + }, + "3641": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.list" }, - "3581": { + "3642": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.list" }, - "3582": { + "3643": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "selector" }, - "3583": { + "3644": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "config" }, - "3584": { + "3645": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.listAndCount" }, - "3585": { + "3646": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.listAndCount" }, - "3586": { + "3647": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "selector" }, - "3587": { + "3648": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "config" }, - "3588": { + "3649": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.count" }, - "3589": { + "3650": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.count" }, - "3590": { + "3651": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "selector" }, - "3591": { + "3652": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.retrieve" }, - "3592": { + "3653": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.retrieve" }, - "3593": { + "3654": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productId" }, - "3594": { + "3655": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "config" }, - "3595": { + "3656": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.retrieveByHandle" }, - "3596": { + "3657": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.retrieveByHandle" }, - "3597": { + "3658": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productHandle" }, - "3598": { + "3659": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "config" }, - "3599": { + "3660": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.retrieveByExternalId" }, - "3600": { + "3661": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.retrieveByExternalId" }, - "3601": { + "3662": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "externalId" }, - "3602": { + "3663": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "config" }, - "3603": { + "3664": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.retrieve_" }, - "3604": { + "3665": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.retrieve_" }, - "3605": { + "3666": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "selector" }, - "3606": { + "3667": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "config" }, - "3607": { + "3668": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.retrieveVariants" }, - "3608": { + "3669": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.retrieveVariants" }, - "3609": { + "3670": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productId" }, - "3610": { + "3671": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "config" }, - "3611": { + "3672": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.filterProductsBySalesChannel" }, - "3612": { + "3673": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.filterProductsBySalesChannel" }, - "3613": { + "3674": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productIds" }, - "3614": { + "3675": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "salesChannelId" }, - "3615": { + "3676": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "config" }, - "3616": { + "3677": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.listTypes" }, - "3617": { + "3678": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.listTypes" }, - "3618": { + "3679": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.listTagsByUsage" }, - "3619": { + "3680": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.listTagsByUsage" }, - "3620": { + "3681": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "take" }, - "3621": { + "3682": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.isProductInSalesChannels" }, - "3622": { + "3683": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.isProductInSalesChannels" }, - "3623": { + "3684": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "id" }, - "3624": { + "3685": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "salesChannelIds" }, - "3625": { + "3686": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.create" }, - "3626": { + "3687": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.create" }, - "3627": { + "3688": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productObject" }, - "3628": { + "3689": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.update" }, - "3629": { + "3690": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.update" }, - "3630": { + "3691": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productId" }, - "3631": { + "3692": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "update" }, - "3632": { + "3693": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.delete" }, - "3633": { + "3694": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.delete" }, - "3634": { + "3695": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productId" }, - "3635": { + "3696": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.addOption" }, - "3636": { + "3697": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.addOption" }, - "3637": { + "3698": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productId" }, - "3638": { + "3699": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "optionTitle" }, - "3639": { + "3700": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.reorderVariants" }, - "3640": { + "3701": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.reorderVariants" }, - "3641": { + "3702": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productId" }, - "3642": { + "3703": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "variantOrder" }, - "3643": { + "3704": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.updateOption" }, - "3644": { + "3705": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.updateOption" }, - "3645": { + "3706": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productId" }, - "3646": { + "3707": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "optionId" }, - "3647": { + "3708": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "data" }, - "3648": { + "3709": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.retrieveOptionByTitle" }, - "3649": { + "3710": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.retrieveOptionByTitle" }, - "3650": { + "3711": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "title" }, - "3651": { + "3712": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productId" }, - "3652": { + "3713": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.deleteOption" }, - "3653": { + "3714": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.deleteOption" }, - "3654": { + "3715": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productId" }, - "3655": { + "3716": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "optionId" }, - "3656": { + "3717": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.updateShippingProfile" }, - "3657": { + "3718": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.updateShippingProfile" }, - "3658": { + "3719": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "productIds" }, - "3659": { + "3720": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "profileId" }, - "3660": { + "3721": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.prepareListQuery_" }, - "3661": { + "3722": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "ProductService.prepareListQuery_" }, - "3662": { + "3723": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "selector" }, - "3663": { + "3724": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "config" }, - "3664": { + "3725": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "__type" }, - "3665": { + "3726": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "__type.q" }, - "3666": { + "3727": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "__type.relations" }, - "3667": { + "3728": { "sourceFileName": "../../../packages/medusa/src/services/product.ts", "qualifiedName": "__type.query" }, - "3668": { + "3729": { + "sourceFileName": "../../../packages/medusa/src/services/product.ts", + "qualifiedName": "ProductService.decorateProductsWithSalesChannels" + }, + "3730": { + "sourceFileName": "../../../packages/medusa/src/services/product.ts", + "qualifiedName": "ProductService.decorateProductsWithSalesChannels" + }, + "3731": { + "sourceFileName": "../../../packages/medusa/src/services/product.ts", + "qualifiedName": "products" + }, + "3732": { + "sourceFileName": "../../../packages/medusa/src/services/product.ts", + "qualifiedName": "ProductService.getSalesChannelModuleChannels" + }, + "3733": { + "sourceFileName": "../../../packages/medusa/src/services/product.ts", + "qualifiedName": "ProductService.getSalesChannelModuleChannels" + }, + "3734": { + "sourceFileName": "../../../packages/medusa/src/services/product.ts", + "qualifiedName": "productIds" + }, + "3735": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "3669": { + "3736": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "3670": { + "3737": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3671": { + "3738": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3672": { + "3739": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "3673": { + "3740": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "3674": { + "3741": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "3675": { + "3742": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3676": { + "3743": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3677": { + "3744": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3678": { + "3745": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3679": { + "3746": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3680": { + "3747": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "3681": { + "3748": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3682": { + "3749": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "3683": { + "3750": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3684": { + "3751": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3685": { + "3752": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "3686": { + "3753": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "3687": { + "3754": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "3688": { + "3755": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3689": { + "3756": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3690": { + "3757": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3691": { + "3758": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "3692": { + "3759": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3693": { + "3760": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3694": { + "3761": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3695": { + "3762": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "3696": { + "3763": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3697": { + "3764": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3698": { + "3765": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3699": { + "3766": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService" }, - "3700": { + "3767": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.Events" }, - "3701": { + "3768": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "__object" }, - "3702": { + "3769": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "__object.CREATED" }, - "3703": { + "3770": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "__object.UPDATED" }, - "3704": { + "3771": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "__object.DELETED" }, - "3705": { + "3772": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.__constructor" }, - "3706": { + "3773": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService" }, - "3707": { + "3774": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "__0" }, - "3708": { + "3775": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.productCategoryRepo_" }, - "3709": { + "3776": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object" }, - "3710": { + "3777": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.findOneWithDescendants" }, - "3711": { + "3778": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.findOneWithDescendants" }, - "3712": { + "3779": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "query" }, - "3713": { + "3780": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "treeScope" }, - "3714": { + "3781": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "3715": { + "3782": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "3716": { + "3783": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "options" }, - "3717": { + "3784": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "q" }, - "3718": { + "3785": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "treeScope" }, - "3719": { + "3786": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "includeTree" }, - "3720": { + "3787": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.addProducts" }, - "3721": { + "3788": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.addProducts" }, - "3722": { + "3789": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productCategoryId" }, - "3723": { + "3790": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productIds" }, - "3724": { + "3791": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.removeProducts" }, - "3725": { + "3792": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.removeProducts" }, - "3726": { + "3793": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productCategoryId" }, - "3727": { + "3794": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productIds" }, - "3728": { + "3795": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.eventBusService_" }, - "3729": { + "3796": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.listAndCount" }, - "3730": { + "3797": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.listAndCount" }, - "3731": { + "3798": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "selector" }, - "3732": { + "3799": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "config" }, - "3733": { + "3800": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "treeSelector" }, - "3734": { + "3801": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.retrieve_" }, - "3735": { + "3802": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.retrieve_" }, - "3736": { + "3803": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "config" }, - "3737": { + "3804": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "selector" }, - "3738": { + "3805": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "treeSelector" }, - "3739": { + "3806": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.retrieve" }, - "3740": { + "3807": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.retrieve" }, - "3741": { + "3808": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "productCategoryId" }, - "3742": { + "3809": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "config" }, - "3743": { + "3810": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "selector" }, - "3744": { + "3811": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "treeSelector" }, - "3745": { + "3812": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.retrieveByHandle" }, - "3746": { + "3813": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.retrieveByHandle" }, - "3747": { + "3814": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "handle" }, - "3748": { + "3815": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "config" }, - "3749": { + "3816": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "selector" }, - "3750": { + "3817": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "treeSelector" }, - "3751": { + "3818": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.create" }, - "3752": { + "3819": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.create" }, - "3753": { + "3820": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "productCategoryInput" }, - "3754": { + "3821": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.update" }, - "3755": { + "3822": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.update" }, - "3756": { + "3823": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "productCategoryId" }, - "3757": { + "3824": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "productCategoryInput" }, - "3758": { + "3825": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.delete" }, - "3759": { + "3826": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.delete" }, - "3760": { + "3827": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "productCategoryId" }, - "3761": { + "3828": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.addProducts" }, - "3762": { + "3829": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.addProducts" }, - "3763": { + "3830": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "productCategoryId" }, - "3764": { + "3831": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "productIds" }, - "3765": { + "3832": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.removeProducts" }, - "3766": { + "3833": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.removeProducts" }, - "3767": { + "3834": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "productCategoryId" }, - "3768": { + "3835": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "productIds" }, - "3769": { + "3836": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.fetchReorderConditions" }, - "3770": { + "3837": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.fetchReorderConditions" }, - "3771": { + "3838": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "productCategory" }, - "3772": { + "3839": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "input" }, - "3773": { + "3840": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "shouldDeleteElement" }, - "3774": { + "3841": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.performReordering" }, - "3775": { + "3842": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.performReordering" }, - "3776": { + "3843": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "repository" }, - "3777": { + "3844": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object" }, - "3778": { + "3845": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.findOneWithDescendants" }, - "3779": { + "3846": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.findOneWithDescendants" }, - "3780": { + "3847": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "query" }, - "3781": { + "3848": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "treeScope" }, - "3782": { + "3849": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "3783": { + "3850": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "3784": { + "3851": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "options" }, - "3785": { + "3852": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "q" }, - "3786": { + "3853": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "treeScope" }, - "3787": { + "3854": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "includeTree" }, - "3788": { + "3855": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.addProducts" }, - "3789": { + "3856": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.addProducts" }, - "3790": { + "3857": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productCategoryId" }, - "3791": { + "3858": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productIds" }, - "3792": { + "3859": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.removeProducts" }, - "3793": { + "3860": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.removeProducts" }, - "3794": { + "3861": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productCategoryId" }, - "3795": { + "3862": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productIds" }, - "3796": { + "3863": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "conditions" }, - "3797": { + "3864": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.shiftSiblings" }, - "3798": { + "3865": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.shiftSiblings" }, - "3799": { + "3866": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "repository" }, - "3800": { + "3867": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object" }, - "3801": { + "3868": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.findOneWithDescendants" }, - "3802": { + "3869": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.findOneWithDescendants" }, - "3803": { + "3870": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "query" }, - "3804": { + "3871": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "treeScope" }, - "3805": { + "3872": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "3806": { + "3873": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "3807": { + "3874": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "options" }, - "3808": { + "3875": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "q" }, - "3809": { + "3876": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "treeScope" }, - "3810": { + "3877": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "includeTree" }, - "3811": { + "3878": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.addProducts" }, - "3812": { + "3879": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.addProducts" }, - "3813": { + "3880": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productCategoryId" }, - "3814": { + "3881": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productIds" }, - "3815": { + "3882": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.removeProducts" }, - "3816": { + "3883": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "__object.removeProducts" }, - "3817": { + "3884": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productCategoryId" }, - "3818": { + "3885": { "sourceFileName": "../../../packages/medusa/src/repositories/product-category.ts", "qualifiedName": "productIds" }, - "3819": { + "3886": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "conditions" }, - "3820": { + "3887": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.transformParentIdToEntity" }, - "3821": { + "3888": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "ProductCategoryService.transformParentIdToEntity" }, - "3822": { + "3889": { "sourceFileName": "../../../packages/medusa/src/services/product-category.ts", "qualifiedName": "productCategoryInput" }, - "3823": { + "3890": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "3824": { + "3891": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "3825": { + "3892": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3826": { + "3893": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3827": { + "3894": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "3828": { + "3895": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "3829": { + "3896": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "3830": { + "3897": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3831": { + "3898": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3832": { + "3899": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3833": { + "3900": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3834": { + "3901": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3835": { + "3902": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "3836": { + "3903": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3837": { + "3904": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "3838": { + "3905": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3839": { + "3906": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3840": { + "3907": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "3841": { + "3908": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "3842": { + "3909": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "3843": { + "3910": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3844": { + "3911": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3845": { + "3912": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3846": { + "3913": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "3847": { + "3914": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3848": { + "3915": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3849": { + "3916": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3850": { + "3917": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "3851": { + "3918": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3852": { + "3919": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3853": { + "3920": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3854": { + "3921": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService" }, - "3855": { + "3922": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.Events" }, - "3856": { + "3923": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "__object" }, - "3857": { + "3924": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "__object.CREATED" }, - "3858": { + "3925": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "__object.UPDATED" }, - "3859": { + "3926": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "__object.DELETED" }, - "3860": { + "3927": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "__object.PRODUCTS_ADDED" }, - "3861": { + "3928": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "__object.PRODUCTS_REMOVED" }, - "3862": { + "3929": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.__constructor" }, - "3863": { + "3930": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService" }, - "3864": { + "3931": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "__0" }, - "3865": { + "3932": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.eventBus_" }, - "3866": { + "3933": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.productCollectionRepository_" }, - "3867": { + "3934": { "sourceFileName": "../../../packages/medusa/src/repositories/product-collection.ts", "qualifiedName": "__object" }, - "3868": { + "3935": { "sourceFileName": "../../../packages/medusa/src/repositories/product-collection.ts", "qualifiedName": "__object.findAndCountByDiscountConditionId" }, - "3869": { + "3936": { "sourceFileName": "../../../packages/medusa/src/repositories/product-collection.ts", "qualifiedName": "__object.findAndCountByDiscountConditionId" }, - "3870": { + "3937": { "sourceFileName": "../../../packages/medusa/src/repositories/product-collection.ts", "qualifiedName": "conditionId" }, - "3871": { + "3938": { "sourceFileName": "../../../packages/medusa/src/repositories/product-collection.ts", "qualifiedName": "query" }, - "3872": { + "3939": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.productRepository_" }, - "3873": { + "3940": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object" }, - "3874": { + "3941": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProducts" }, - "3875": { + "3942": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProducts" }, - "3876": { + "3943": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "optionsWithoutRelations" }, - "3877": { + "3944": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "shouldCount" }, - "3878": { + "3945": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProductsWithIds" }, - "3879": { + "3946": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProductsWithIds" }, - "3880": { + "3947": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__0" }, - "3881": { + "3948": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "3882": { + "3949": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.entityIds" }, - "3883": { + "3950": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.groupedRelations" }, - "3884": { + "3951": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "3885": { + "3952": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.__index" }, - "3887": { + "3954": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.withDeleted" }, - "3888": { + "3955": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.select" }, - "3889": { + "3956": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.order" }, - "3890": { + "3957": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "3891": { + "3958": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.__index" }, - "3893": { + "3960": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.where" }, - "3894": { + "3961": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelationsAndCount" }, - "3895": { + "3962": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelationsAndCount" }, - "3896": { + "3963": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "3897": { + "3964": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "idsOrOptionsWithoutRelations" }, - "3898": { + "3965": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelations" }, - "3899": { + "3966": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelations" }, - "3900": { + "3967": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "3901": { + "3968": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "idsOrOptionsWithoutRelations" }, - "3902": { + "3969": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "withDeleted" }, - "3903": { + "3970": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findOneWithRelations" }, - "3904": { + "3971": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findOneWithRelations" }, - "3905": { + "3972": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "3906": { + "3973": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "optionsWithoutRelations" }, - "3907": { + "3974": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkAddToCollection" }, - "3908": { + "3975": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkAddToCollection" }, - "3909": { + "3976": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "productIds" }, - "3910": { + "3977": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "collectionId" }, - "3911": { + "3978": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkRemoveFromCollection" }, - "3912": { + "3979": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkRemoveFromCollection" }, - "3913": { + "3980": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "productIds" }, - "3914": { + "3981": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "collectionId" }, - "3915": { + "3982": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "3916": { + "3983": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "3917": { + "3984": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "q" }, - "3918": { + "3985": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "options" }, - "3919": { + "3986": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "3920": { + "3987": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsFromInput" }, - "3921": { + "3988": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsFromInput" }, - "3922": { + "3989": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "categoryId" }, - "3923": { + "3990": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "includeCategoryChildren" }, - "3924": { + "3991": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsRecursively" }, - "3925": { + "3992": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsRecursively" }, - "3926": { + "3993": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "productCategory" }, - "3927": { + "3994": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._findWithRelations" }, - "3928": { + "3995": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._findWithRelations" }, - "3929": { + "3996": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__0" }, - "3930": { + "3997": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "3931": { + "3998": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.relations" }, - "3932": { + "3999": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.idsOrOptionsWithoutRelations" }, - "3933": { + "4000": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.withDeleted" }, - "3934": { + "4001": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.shouldCount" }, - "3935": { + "4002": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.isProductInSalesChannels" }, - "3936": { + "4003": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.isProductInSalesChannels" }, - "3937": { + "4004": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "id" }, - "3938": { + "4005": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "salesChannelIds" }, - "3939": { + "4006": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._applyCategoriesQuery" }, - "3940": { + "4007": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._applyCategoriesQuery" }, - "3941": { + "4008": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "qb" }, - "3942": { + "4009": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__1" }, - "3943": { + "4011": { + "sourceFileName": "", + "qualifiedName": "alias" + }, + "4012": { + "sourceFileName": "", + "qualifiedName": "categoryAlias" + }, + "4013": { + "sourceFileName": "", + "qualifiedName": "where" + }, + "4014": { + "sourceFileName": "", + "qualifiedName": "joinName" + }, + "4015": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.retrieve" }, - "3944": { + "4016": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.retrieve" }, - "3945": { + "4017": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "collectionId" }, - "3946": { + "4018": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "config" }, - "3947": { + "4019": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.retrieveByHandle" }, - "3948": { + "4020": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.retrieveByHandle" }, - "3949": { + "4021": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "collectionHandle" }, - "3950": { + "4022": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "config" }, - "3951": { + "4023": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.create" }, - "3952": { + "4024": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.create" }, - "3953": { + "4025": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "collection" }, - "3954": { + "4026": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.update" }, - "3955": { + "4027": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.update" }, - "3956": { + "4028": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "collectionId" }, - "3957": { + "4029": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "update" }, - "3958": { + "4030": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.delete" }, - "3959": { + "4031": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.delete" }, - "3960": { + "4032": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "collectionId" }, - "3961": { + "4033": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.addProducts" }, - "3962": { + "4034": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.addProducts" }, - "3963": { + "4035": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "collectionId" }, - "3964": { + "4036": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "productIds" }, - "3965": { + "4037": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.removeProducts" }, - "3966": { + "4038": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.removeProducts" }, - "3967": { + "4039": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "collectionId" }, - "3968": { + "4040": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "productIds" }, - "3969": { + "4041": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.list" }, - "3970": { + "4042": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.list" }, - "3971": { + "4043": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "selector" }, - "3972": { - "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", - "qualifiedName": "__type" - }, - "3973": { + "4045": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "__type.q" }, - "3974": { + "4046": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "__type.discount_condition_id" }, - "3975": { + "4047": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "config" }, - "3976": { + "4048": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "__object" }, - "3977": { + "4049": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "__object.skip" }, - "3978": { + "4050": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "__object.take" }, - "3979": { + "4051": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.listAndCount" }, - "3980": { + "4052": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "ProductCollectionService.listAndCount" }, - "3981": { + "4053": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "selector" }, - "3982": { + "4054": { "sourceFileName": "../../../packages/medusa/src/services/product-collection.ts", "qualifiedName": "config" }, - "3983": { + "4055": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "3984": { + "4056": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "3985": { + "4057": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3986": { + "4058": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3987": { + "4059": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "3988": { + "4060": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "3989": { + "4061": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "3990": { + "4062": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3991": { + "4063": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3992": { + "4064": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3993": { + "4065": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3994": { + "4066": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3995": { + "4067": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "3996": { + "4068": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3997": { + "4069": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "3998": { + "4070": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3999": { + "4071": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4000": { + "4072": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "4001": { + "4073": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "4002": { + "4074": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "4003": { + "4075": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4004": { + "4076": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4005": { + "4077": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4006": { + "4078": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "4007": { + "4079": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4008": { + "4080": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4009": { + "4081": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4010": { + "4082": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "4011": { + "4083": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4012": { + "4084": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4013": { + "4085": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4014": { + "4086": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "ProductTypeService" }, - "4015": { + "4087": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "ProductTypeService.__constructor" }, - "4016": { + "4088": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "ProductTypeService" }, - "4017": { + "4089": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "__0" }, - "4018": { + "4091": { + "sourceFileName": "", + "qualifiedName": "productTypeRepository" + }, + "4092": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "ProductTypeService.typeRepository_" }, - "4019": { + "4093": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "__object" }, - "4020": { + "4094": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "__object.upsertType" }, - "4021": { + "4095": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "__object.upsertType" }, - "4022": { + "4096": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "type" }, - "4023": { + "4097": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "__object.findAndCountByDiscountConditionId" }, - "4024": { + "4098": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "__object.findAndCountByDiscountConditionId" }, - "4025": { + "4099": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "conditionId" }, - "4026": { + "4100": { "sourceFileName": "../../../packages/medusa/src/repositories/product-type.ts", "qualifiedName": "query" }, - "4027": { + "4101": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "ProductTypeService.retrieve" }, - "4028": { + "4102": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "ProductTypeService.retrieve" }, - "4029": { + "4103": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "id" }, - "4030": { + "4104": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "config" }, - "4031": { + "4105": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "ProductTypeService.list" }, - "4032": { + "4106": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "ProductTypeService.list" }, - "4033": { + "4107": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "selector" }, - "4034": { - "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", - "qualifiedName": "__type" - }, - "4035": { + "4109": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "__type.q" }, - "4036": { + "4110": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "__type.discount_condition_id" }, - "4037": { + "4111": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "config" }, - "4038": { + "4112": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "ProductTypeService.listAndCount" }, - "4039": { + "4113": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "ProductTypeService.listAndCount" }, - "4040": { + "4114": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "selector" }, - "4041": { - "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", - "qualifiedName": "__type" - }, - "4042": { + "4116": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "__type.q" }, - "4043": { + "4117": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "__type.discount_condition_id" }, - "4044": { + "4118": { "sourceFileName": "../../../packages/medusa/src/services/product-type.ts", "qualifiedName": "config" }, - "4045": { + "4119": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "4046": { + "4120": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "4047": { + "4121": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4048": { + "4122": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4049": { + "4123": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "4050": { + "4124": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "4051": { + "4125": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "4052": { + "4126": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4053": { + "4127": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4054": { + "4128": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4055": { + "4129": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4056": { + "4130": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4057": { + "4131": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "4058": { + "4132": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4059": { + "4133": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "4060": { + "4134": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4061": { + "4135": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4062": { + "4136": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "4063": { + "4137": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "4064": { + "4138": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "4065": { + "4139": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4066": { + "4140": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4067": { + "4141": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4068": { + "4142": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "4069": { + "4143": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4070": { + "4144": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4071": { + "4145": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4072": { + "4146": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "4073": { + "4147": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4074": { + "4148": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4075": { + "4149": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4076": { + "4150": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService" }, - "4077": { + "4151": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.Events" }, - "4078": { + "4152": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "__object" }, - "4079": { + "4153": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "__object.UPDATED" }, - "4080": { + "4154": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "__object.CREATED" }, - "4081": { + "4155": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "__object.DELETED" }, - "4082": { + "4156": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.__constructor" }, - "4083": { + "4157": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService" }, - "4084": { + "4158": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "__0" }, - "4085": { + "4160": { + "sourceFileName": "", + "qualifiedName": "productVariantRepository" + }, + "4161": { + "sourceFileName": "", + "qualifiedName": "productRepository" + }, + "4162": { + "sourceFileName": "", + "qualifiedName": "eventBusService" + }, + "4163": { + "sourceFileName": "", + "qualifiedName": "regionService" + }, + "4164": { + "sourceFileName": "", + "qualifiedName": "moneyAmountRepository" + }, + "4165": { + "sourceFileName": "", + "qualifiedName": "productOptionValueRepository" + }, + "4166": { + "sourceFileName": "", + "qualifiedName": "cartRepository" + }, + "4167": { + "sourceFileName": "", + "qualifiedName": "priceSelectionStrategy" + }, + "4168": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.productVariantRepository_" }, - "4086": { + "4169": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.productRepository_" }, - "4087": { + "4170": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object" }, - "4088": { + "4171": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProducts" }, - "4089": { + "4172": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProducts" }, - "4090": { + "4173": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "optionsWithoutRelations" }, - "4091": { + "4174": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "shouldCount" }, - "4092": { + "4175": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProductsWithIds" }, - "4093": { + "4176": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProductsWithIds" }, - "4094": { + "4177": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__0" }, - "4095": { + "4178": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "4096": { + "4179": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.entityIds" }, - "4097": { + "4180": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.groupedRelations" }, - "4098": { + "4181": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "4099": { + "4182": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.__index" }, - "4101": { + "4184": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.withDeleted" }, - "4102": { + "4185": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.select" }, - "4103": { + "4186": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.order" }, - "4104": { + "4187": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "4105": { + "4188": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.__index" }, - "4107": { + "4190": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.where" }, - "4108": { + "4191": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelationsAndCount" }, - "4109": { + "4192": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelationsAndCount" }, - "4110": { + "4193": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "4111": { + "4194": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "idsOrOptionsWithoutRelations" }, - "4112": { + "4195": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelations" }, - "4113": { + "4196": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelations" }, - "4114": { + "4197": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "4115": { + "4198": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "idsOrOptionsWithoutRelations" }, - "4116": { + "4199": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "withDeleted" }, - "4117": { + "4200": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findOneWithRelations" }, - "4118": { + "4201": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findOneWithRelations" }, - "4119": { + "4202": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "4120": { + "4203": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "optionsWithoutRelations" }, - "4121": { + "4204": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkAddToCollection" }, - "4122": { + "4205": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkAddToCollection" }, - "4123": { + "4206": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "productIds" }, - "4124": { + "4207": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "collectionId" }, - "4125": { + "4208": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkRemoveFromCollection" }, - "4126": { + "4209": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkRemoveFromCollection" }, - "4127": { + "4210": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "productIds" }, - "4128": { + "4211": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "collectionId" }, - "4129": { + "4212": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "4130": { + "4213": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "4131": { + "4214": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "q" }, - "4132": { + "4215": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "options" }, - "4133": { + "4216": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "4134": { + "4217": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsFromInput" }, - "4135": { + "4218": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsFromInput" }, - "4136": { + "4219": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "categoryId" }, - "4137": { + "4220": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "includeCategoryChildren" }, - "4138": { + "4221": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsRecursively" }, - "4139": { + "4222": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsRecursively" }, - "4140": { + "4223": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "productCategory" }, - "4141": { + "4224": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._findWithRelations" }, - "4142": { + "4225": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._findWithRelations" }, - "4143": { + "4226": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__0" }, - "4144": { + "4227": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "4145": { + "4228": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.relations" }, - "4146": { + "4229": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.idsOrOptionsWithoutRelations" }, - "4147": { + "4230": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.withDeleted" }, - "4148": { + "4231": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.shouldCount" }, - "4149": { + "4232": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.isProductInSalesChannels" }, - "4150": { + "4233": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.isProductInSalesChannels" }, - "4151": { + "4234": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "id" }, - "4152": { + "4235": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "salesChannelIds" }, - "4153": { + "4236": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._applyCategoriesQuery" }, - "4154": { + "4237": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._applyCategoriesQuery" }, - "4155": { + "4238": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "qb" }, - "4156": { + "4239": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__1" }, - "4157": { + "4241": { + "sourceFileName": "", + "qualifiedName": "alias" + }, + "4242": { + "sourceFileName": "", + "qualifiedName": "categoryAlias" + }, + "4243": { + "sourceFileName": "", + "qualifiedName": "where" + }, + "4244": { + "sourceFileName": "", + "qualifiedName": "joinName" + }, + "4245": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.eventBus_" }, - "4158": { + "4246": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.regionService_" }, - "4159": { + "4247": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.priceSelectionStrategy_" }, - "4160": { + "4248": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.moneyAmountRepository_" }, - "4161": { + "4249": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object" }, - "4162": { + "4250": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.insertBulk" }, - "4163": { + "4251": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.insertBulk" }, - "4164": { + "4252": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "data" }, - "4165": { + "4253": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findVariantPricesNotIn" }, - "4166": { + "4254": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findVariantPricesNotIn" }, - "4167": { + "4255": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variantId" }, - "4168": { + "4256": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "prices" }, - "4169": { + "4257": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.deleteVariantPricesNotIn" }, - "4170": { + "4258": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.deleteVariantPricesNotIn" }, - "4171": { + "4259": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variantIdOrData" }, - "4172": { + "4260": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type" }, - "4173": { + "4261": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.variantId" }, - "4174": { + "4262": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.prices" }, - "4175": { + "4263": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "prices" }, - "4176": { + "4264": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.upsertVariantCurrencyPrice" }, - "4177": { + "4265": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.upsertVariantCurrencyPrice" }, - "4178": { + "4266": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variantId" }, - "4179": { + "4267": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "price" }, - "4180": { + "4268": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.addPriceListPrices" }, - "4181": { + "4269": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.addPriceListPrices" }, - "4182": { + "4270": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "priceListId" }, - "4183": { + "4271": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "prices" }, - "4184": { + "4272": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "overrideExisting" }, - "4185": { + "4273": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.deletePriceListPrices" }, - "4186": { + "4274": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.deletePriceListPrices" }, - "4187": { + "4275": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "priceListId" }, - "4188": { + "4276": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "moneyAmountIds" }, - "4189": { + "4277": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findManyForVariantInPriceList" }, - "4190": { + "4278": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findManyForVariantInPriceList" }, - "4191": { + "4279": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variant_id" }, - "4192": { + "4280": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "price_list_id" }, - "4193": { + "4281": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "requiresPriceList" }, - "4194": { + "4282": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findManyForVariantInRegion" }, - "4195": { + "4283": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findManyForVariantInRegion" }, - "4196": { + "4284": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variant_id" }, - "4197": { + "4285": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "region_id" }, - "4198": { + "4286": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "currency_code" }, - "4199": { + "4287": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "customer_id" }, - "4200": { + "4288": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "include_discount_prices" }, - "4201": { + "4289": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "include_tax_inclusive_pricing" }, - "4202": { + "4290": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findCurrencyMoneyAmounts" }, - "4203": { + "4291": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findCurrencyMoneyAmounts" }, - "4204": { + "4292": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "where" }, - "4205": { + "4293": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type" }, - "4206": { + "4294": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.variant_id" }, - "4207": { + "4295": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.currency_code" }, - "4208": { + "4296": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object" }, - "4209": { + "4297": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.variant_id" }, - "4210": { + "4298": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.currency_code" }, - "4211": { + "4299": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.currency" }, - "4212": { + "4300": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.amount" }, - "4213": { + "4301": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.min_quantity" }, - "4214": { + "4302": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.max_quantity" }, - "4215": { + "4303": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.price_list_id" }, - "4216": { + "4304": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.price_list" }, - "4217": { + "4305": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.variants" }, - "4218": { + "4306": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.variant" }, - "4219": { + "4307": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.region_id" }, - "4220": { + "4308": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.region" }, - "4221": { + "4309": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/soft-deletable-entity.ts", "qualifiedName": "SoftDeletableEntity.deleted_at" }, - "4222": { + "4310": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "4223": { + "4311": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "4224": { + "4312": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "4225": { + "4313": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findRegionMoneyAmounts" }, - "4226": { + "4314": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findRegionMoneyAmounts" }, - "4227": { + "4315": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "where" }, - "4228": { + "4316": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type" }, - "4229": { + "4317": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.variant_id" }, - "4230": { + "4318": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.region_id" }, - "4231": { + "4319": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object" }, - "4232": { + "4320": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.variant_id" }, - "4233": { + "4321": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.currency_code" }, - "4234": { + "4322": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.currency" }, - "4235": { + "4323": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.amount" }, - "4236": { + "4324": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.min_quantity" }, - "4237": { + "4325": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.max_quantity" }, - "4238": { + "4326": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.price_list_id" }, - "4239": { + "4327": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.price_list" }, - "4240": { + "4328": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.variants" }, - "4241": { + "4329": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.variant" }, - "4242": { + "4330": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.region_id" }, - "4243": { + "4331": { "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", "qualifiedName": "MoneyAmount.region" }, - "4244": { + "4332": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/soft-deletable-entity.ts", "qualifiedName": "SoftDeletableEntity.deleted_at" }, - "4245": { + "4333": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.id" }, - "4246": { + "4334": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.created_at" }, - "4247": { + "4335": { "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", "qualifiedName": "BaseEntity.updated_at" }, - "4248": { + "4336": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findManyForVariantsInRegion" }, - "4249": { + "4337": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.findManyForVariantsInRegion" }, - "4250": { + "4338": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variant_ids" }, - "4251": { + "4339": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "region_id" }, - "4252": { + "4340": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "currency_code" }, - "4253": { + "4341": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "customer_id" }, - "4254": { + "4342": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "include_discount_prices" }, - "4255": { + "4343": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "include_tax_inclusive_pricing" }, - "4256": { + "4344": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.updatePriceListPrices" }, - "4257": { + "4345": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.updatePriceListPrices" }, - "4258": { + "4346": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "priceListId" }, - "4259": { + "4347": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "updates" }, - "4260": { + "4348": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.getPricesForVariantInRegion" }, - "4261": { + "4349": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.getPricesForVariantInRegion" }, - "4262": { + "4350": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "variantId" }, - "4263": { + "4351": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "regionId" }, - "4264": { + "4352": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.createProductVariantMoneyAmounts" }, - "4265": { + "4353": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__object.createProductVariantMoneyAmounts" }, - "4266": { + "4354": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "toCreate" }, - "4267": { + "4355": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type" }, - "4268": { + "4356": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.variant_id" }, - "4269": { + "4357": { "sourceFileName": "../../../packages/medusa/src/repositories/money-amount.ts", "qualifiedName": "__type.money_amount_id" }, - "4270": { + "4358": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.productOptionValueRepository_" }, - "4271": { + "4359": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.cartRepository_" }, - "4272": { + "4360": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "__object" }, - "4273": { + "4361": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "__object.findWithRelations" }, - "4274": { + "4362": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "__object.findWithRelations" }, - "4275": { + "4363": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "relations" }, - "4276": { + "4364": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "optionsWithoutRelations" }, - "4277": { + "4365": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "__object.findOneWithRelations" }, - "4278": { + "4366": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "__object.findOneWithRelations" }, - "4279": { + "4367": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "relations" }, - "4280": { + "4368": { "sourceFileName": "../../../packages/medusa/src/repositories/cart.ts", "qualifiedName": "optionsWithoutRelations" }, - "4281": { + "4369": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.retrieve" }, - "4282": { + "4370": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.retrieve" }, - "4283": { + "4371": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantId" }, - "4284": { + "4372": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "config" }, - "4285": { + "4373": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.retrieveBySKU" }, - "4286": { + "4374": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.retrieveBySKU" }, - "4287": { + "4375": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "sku" }, - "4288": { + "4376": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "config" }, - "4289": { + "4377": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.create" }, - "4290": { + "4378": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.create" }, - "4291": { + "4379": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "TVariants" }, - "4292": { + "4380": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "TOutput" }, - "4293": { + "4381": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "productOrProductId" }, - "4294": { + "4382": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variants" }, - "4295": { + "4383": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.update" }, - "4296": { + "4384": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.update" }, - "4297": { + "4385": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantData" }, - "4298": { + "4386": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "__type" }, - "4299": { + "4387": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "__type.variant" }, - "4300": { + "4388": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "__type.updateData" }, - "4301": { + "4389": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.update" }, - "4302": { + "4390": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantOrVariantId" }, - "4303": { + "4391": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "update" }, - "4304": { + "4392": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.update" }, - "4305": { + "4393": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantOrVariantId" }, - "4306": { + "4394": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "update" }, - "4307": { + "4395": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.updateBatch" }, - "4308": { + "4396": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.updateBatch" }, - "4309": { + "4397": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantData" }, - "4310": { + "4398": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.updateVariantPrices" }, - "4311": { + "4399": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.updateVariantPrices" }, - "4312": { + "4400": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "data" }, - "4313": { + "4401": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.updateVariantPrices" }, - "4314": { + "4402": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantId" }, - "4315": { + "4403": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "prices" }, - "4316": { + "4404": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.updateVariantPricesBatch" }, - "4317": { + "4405": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.updateVariantPricesBatch" }, - "4318": { + "4406": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "data" }, - "4319": { + "4407": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.upsertRegionPrices" }, - "4320": { + "4408": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.upsertRegionPrices" }, - "4321": { + "4409": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "data" }, - "4322": { + "4410": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.upsertCurrencyPrices" }, - "4323": { + "4411": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.upsertCurrencyPrices" }, - "4324": { + "4412": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "data" }, - "4325": { + "4413": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "__type" }, - "4326": { + "4414": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "__type.variantId" }, - "4327": { + "4415": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "__type.price" }, - "4328": { + "4416": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.getRegionPrice" }, - "4329": { + "4417": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.getRegionPrice" }, - "4330": { + "4418": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantId" }, - "4331": { + "4419": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "context" }, - "4332": { + "4420": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.setRegionPrice" }, - "4333": { + "4421": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.setRegionPrice" }, - "4334": { + "4422": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantId" }, - "4335": { + "4423": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "price" }, - "4336": { + "4424": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.setCurrencyPrice" }, - "4337": { + "4425": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.setCurrencyPrice" }, - "4338": { + "4426": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantId" }, - "4339": { + "4427": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "price" }, - "4340": { + "4428": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.updateOptionValue" }, - "4341": { + "4429": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.updateOptionValue" }, - "4342": { + "4430": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantId" }, - "4343": { + "4431": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "optionId" }, - "4344": { + "4432": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "optionValue" }, - "4345": { + "4433": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.addOptionValue" }, - "4346": { + "4434": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.addOptionValue" }, - "4347": { + "4435": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantId" }, - "4348": { + "4436": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "optionId" }, - "4349": { + "4437": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "optionValue" }, - "4350": { + "4438": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.deleteOptionValue" }, - "4351": { + "4439": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.deleteOptionValue" }, - "4352": { + "4440": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantId" }, - "4353": { + "4441": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "optionId" }, - "4354": { + "4442": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.listAndCount" }, - "4355": { + "4443": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.listAndCount" }, - "4356": { + "4444": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "selector" }, - "4357": { + "4445": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "config" }, - "4358": { + "4446": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.list" }, - "4359": { + "4447": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.list" }, - "4360": { + "4448": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "selector" }, - "4361": { + "4449": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "config" }, - "4362": { + "4450": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.delete" }, - "4363": { + "4451": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.delete" }, - "4364": { + "4452": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantIds" }, - "4365": { + "4453": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.isVariantInSalesChannels" }, - "4366": { + "4454": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.isVariantInSalesChannels" }, - "4367": { + "4455": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "id" }, - "4368": { + "4456": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "salesChannelIds" }, - "4369": { + "4457": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.getFreeTextQueryBuilder_" }, - "4370": { + "4458": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.getFreeTextQueryBuilder_" }, - "4371": { + "4459": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variantRepo" }, - "4372": { + "4460": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "query" }, - "4373": { + "4461": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "q" }, - "4374": { + "4462": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.validateVariantsToCreate_" }, - "4375": { + "4463": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "ProductVariantService.validateVariantsToCreate_" }, - "4376": { + "4464": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "product" }, - "4377": { + "4465": { "sourceFileName": "../../../packages/medusa/src/services/product-variant.ts", "qualifiedName": "variants" }, - "4378": { + "4466": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "4379": { + "4467": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "4380": { + "4468": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4381": { + "4469": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4382": { + "4470": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "4383": { + "4471": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "4384": { + "4472": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "4385": { + "4473": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4386": { + "4474": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4387": { + "4475": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4388": { + "4476": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4389": { + "4477": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4390": { + "4478": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "4391": { + "4479": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4392": { + "4480": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "4393": { + "4481": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4394": { + "4482": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4395": { + "4483": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "4396": { + "4484": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "4397": { + "4485": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "4398": { + "4486": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4399": { + "4487": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4400": { + "4488": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4401": { + "4489": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "4402": { + "4490": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4403": { + "4491": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4404": { + "4492": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4405": { + "4493": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "4406": { + "4494": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4407": { + "4495": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4408": { + "4496": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4409": { + "4497": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService" }, - "4410": { + "4498": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.__constructor" }, - "4411": { + "4499": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService" }, - "4412": { + "4500": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "__0" }, - "4413": { + "4501": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.manager_" }, - "4414": { + "4502": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.transactionManager_" }, - "4415": { + "4503": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.salesChannelLocationService_" }, - "4416": { + "4504": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.salesChannelInventoryService_" }, - "4417": { + "4505": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.productVariantService_" }, - "4418": { + "4506": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.eventBusService_" }, - "4419": { + "4507": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.inventoryService_" }, - "4420": { + "4508": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.inventoryService_" }, - "4421": { + "4509": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.stockLocationService_" }, - "4422": { + "4510": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.stockLocationService_" }, - "4423": { + "4511": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.confirmInventory" }, - "4424": { + "4512": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.confirmInventory" }, - "4425": { + "4513": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variantId" }, - "4426": { + "4514": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "quantity" }, - "4427": { + "4515": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "context" }, - "4428": { + "4516": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "__type" }, - "4429": { + "4517": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "__type.salesChannelId" }, - "4430": { + "4518": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.retrieve" }, - "4431": { + "4519": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.retrieve" }, - "4432": { + "4520": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "inventoryItemId" }, - "4433": { + "4521": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variantId" }, - "4434": { + "4522": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.listByItem" }, - "4435": { + "4523": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.listByItem" }, - "4436": { + "4524": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "itemIds" }, - "4437": { + "4525": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.listByVariant" }, - "4438": { + "4526": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.listByVariant" }, - "4439": { + "4527": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variantId" }, - "4440": { + "4528": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.listVariantsByItem" }, - "4441": { + "4529": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.listVariantsByItem" }, - "4442": { + "4530": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "itemId" }, - "4443": { + "4531": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.listInventoryItemsByVariant" }, - "4444": { + "4532": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.listInventoryItemsByVariant" }, - "4445": { + "4533": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variantId" }, - "4446": { + "4534": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.attachInventoryItem" }, - "4447": { + "4535": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.attachInventoryItem" }, - "4448": { + "4536": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "attachments" }, - "4449": { + "4537": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "__type" }, - "4450": { + "4538": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "__type.variantId" }, - "4451": { + "4539": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "__type.inventoryItemId" }, - "4452": { + "4540": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "__type.requiredQuantity" }, - "4453": { + "4541": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.attachInventoryItem" }, - "4454": { + "4542": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variantId" }, - "4455": { + "4543": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "inventoryItemId" }, - "4456": { + "4544": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "requiredQuantity" }, - "4457": { + "4545": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.detachInventoryItem" }, - "4458": { + "4546": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.detachInventoryItem" }, - "4459": { + "4547": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "inventoryItemId" }, - "4460": { + "4548": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variantId" }, - "4461": { + "4549": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.reserveQuantity" }, - "4462": { + "4550": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.reserveQuantity" }, - "4463": { + "4551": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variantId" }, - "4464": { + "4552": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "quantity" }, - "4465": { + "4553": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "context" }, - "4466": { + "4554": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.adjustReservationsQuantityByLineItem" }, - "4467": { + "4555": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.adjustReservationsQuantityByLineItem" }, - "4468": { + "4556": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "lineItemId" }, - "4469": { + "4557": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variantId" }, - "4470": { + "4558": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "locationId" }, - "4471": { + "4559": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "quantity" }, - "4472": { + "4560": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.validateInventoryAtLocation" }, - "4473": { + "4561": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.validateInventoryAtLocation" }, - "4474": { + "4562": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "items" }, - "4475": { + "4563": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "locationId" }, - "4476": { + "4564": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.deleteReservationsByLineItem" }, - "4477": { + "4565": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.deleteReservationsByLineItem" }, - "4478": { + "4566": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "lineItemId" }, - "4479": { + "4567": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variantId" }, - "4480": { + "4568": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "quantity" }, - "4481": { + "4569": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.adjustInventory" }, - "4482": { + "4570": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.adjustInventory" }, - "4483": { + "4571": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variantId" }, - "4484": { + "4572": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "locationId" }, - "4485": { + "4573": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "quantity" }, - "4486": { + "4574": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.setVariantAvailability" }, - "4487": { + "4575": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.setVariantAvailability" }, - "4488": { + "4576": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variants" }, - "4489": { + "4577": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "salesChannelId" }, - "4490": { + "4578": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "availabilityContext" }, - "4491": { + "4579": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.getAvailabilityContext" }, - "4492": { + "4580": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.getAvailabilityContext" }, - "4493": { + "4581": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variants" }, - "4494": { + "4582": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "salesChannelId" }, - "4495": { + "4583": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "existingContext" }, - "4496": { + "4584": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.setProductAvailability" }, - "4497": { + "4585": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.setProductAvailability" }, - "4498": { + "4586": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "products" }, - "4499": { + "4587": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "salesChannelId" }, - "4500": { + "4588": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.getVariantQuantityFromVariantInventoryItems" }, - "4501": { + "4589": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "ProductVariantInventoryService.getVariantQuantityFromVariantInventoryItems" }, - "4502": { + "4590": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "variantInventoryItems" }, - "4503": { + "4591": { "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", "qualifiedName": "channelId" }, - "4504": { + "4592": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4505": { + "4593": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4506": { + "4594": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "4507": { + "4595": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "4508": { + "4596": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "4509": { + "4597": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4510": { + "4598": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4511": { + "4599": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4512": { + "4600": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4513": { + "4601": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4514": { + "4602": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "4515": { + "4603": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4516": { + "4604": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "4517": { + "4605": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4518": { + "4606": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4519": { + "4607": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "4520": { + "4608": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "4521": { + "4609": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "4522": { + "4610": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4523": { + "4611": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4524": { + "4612": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4525": { + "4613": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "4526": { + "4614": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4527": { + "4615": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4528": { + "4616": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4529": { + "4617": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "4530": { + "4618": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4531": { + "4619": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4532": { + "4620": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4533": { + "4621": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService" }, - "4534": { + "4622": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.Events" }, - "4535": { + "4623": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "__object" }, - "4536": { + "4624": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "__object.UPDATED" }, - "4537": { + "4625": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "__object.CREATED" }, - "4538": { + "4626": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "__object.DELETED" }, - "4539": { + "4627": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.__constructor" }, - "4540": { + "4628": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService" }, - "4541": { + "4629": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "__0" }, - "4542": { + "4630": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.featureFlagRouter_" }, - "4543": { + "4631": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.eventBus_" }, - "4544": { + "4632": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.storeService_" }, - "4545": { + "4633": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.paymentProviderService_" }, - "4546": { + "4634": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.fulfillmentProviderService_" }, - "4547": { + "4635": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.regionRepository_" }, - "4548": { + "4636": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.countryRepository_" }, - "4549": { + "4637": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.currencyRepository_" }, - "4550": { + "4638": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.paymentProviderRepository_" }, - "4551": { + "4639": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.fulfillmentProviderRepository_" }, - "4552": { + "4640": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.taxProviderRepository_" }, - "4553": { + "4641": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.create" }, - "4554": { + "4642": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.create" }, - "4555": { + "4643": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "data" }, - "4556": { + "4644": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.update" }, - "4557": { + "4645": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.update" }, - "4558": { + "4646": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "regionId" }, - "4559": { + "4647": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "update" }, - "4560": { + "4648": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.validateFields" }, - "4561": { + "4649": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.validateFields" }, - "4562": { + "4650": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "T" }, - "4563": { + "4651": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "regionData" }, - "4564": { + "4652": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "id" }, - "4565": { + "4653": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.validateTaxRate" }, - "4566": { + "4654": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.validateTaxRate" }, - "4567": { + "4655": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "taxRate" }, - "4568": { + "4656": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.validateCurrency" }, - "4569": { + "4657": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.validateCurrency" }, - "4570": { + "4658": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "currencyCode" }, - "4571": { + "4659": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.validateCountry" }, - "4572": { + "4660": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.validateCountry" }, - "4573": { + "4661": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "code" }, - "4574": { + "4662": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "regionId" }, - "4575": { + "4663": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.retrieveByCountryCode" }, - "4576": { + "4664": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.retrieveByCountryCode" }, - "4577": { + "4665": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "code" }, - "4578": { + "4666": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "config" }, - "4579": { + "4667": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.retrieveByName" }, - "4580": { + "4668": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.retrieveByName" }, - "4581": { + "4669": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "name" }, - "4582": { + "4670": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.retrieve" }, - "4583": { + "4671": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.retrieve" }, - "4584": { + "4672": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "regionId" }, - "4585": { + "4673": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "config" }, - "4586": { + "4674": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.list" }, - "4587": { + "4675": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.list" }, - "4588": { + "4676": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "selector" }, - "4589": { + "4677": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "config" }, - "4590": { + "4678": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.listAndCount" }, - "4591": { + "4679": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.listAndCount" }, - "4592": { + "4680": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "selector" }, - "4593": { + "4681": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "config" }, - "4594": { + "4682": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.delete" }, - "4595": { + "4683": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.delete" }, - "4596": { + "4684": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "regionId" }, - "4597": { + "4685": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.addCountry" }, - "4598": { + "4686": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.addCountry" }, - "4599": { + "4687": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "regionId" }, - "4600": { + "4688": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "code" }, - "4601": { + "4689": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.removeCountry" }, - "4602": { + "4690": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.removeCountry" }, - "4603": { + "4691": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "regionId" }, - "4604": { + "4692": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "code" }, - "4605": { + "4693": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.addPaymentProvider" }, - "4606": { + "4694": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.addPaymentProvider" }, - "4607": { + "4695": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "regionId" }, - "4608": { + "4696": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "providerId" }, - "4609": { + "4697": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.addFulfillmentProvider" }, - "4610": { + "4698": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.addFulfillmentProvider" }, - "4611": { + "4699": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "regionId" }, - "4612": { + "4700": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "providerId" }, - "4613": { + "4701": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.removePaymentProvider" }, - "4614": { + "4702": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.removePaymentProvider" }, - "4615": { + "4703": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "regionId" }, - "4616": { + "4704": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "providerId" }, - "4617": { + "4705": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.removeFulfillmentProvider" }, - "4618": { + "4706": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "RegionService.removeFulfillmentProvider" }, - "4619": { + "4707": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "regionId" }, - "4620": { + "4708": { "sourceFileName": "../../../packages/medusa/src/services/region.ts", "qualifiedName": "providerId" }, - "4621": { + "4709": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "4622": { + "4710": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "4623": { + "4711": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4624": { + "4712": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4625": { + "4713": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "4626": { + "4714": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "4627": { + "4715": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "4628": { + "4716": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4629": { + "4717": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4630": { + "4718": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4631": { + "4719": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4632": { + "4720": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4633": { + "4721": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "4634": { + "4722": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4635": { + "4723": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "4636": { + "4724": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4637": { + "4725": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4638": { + "4726": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "4639": { + "4727": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "4640": { + "4728": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "4641": { + "4729": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4642": { + "4730": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4643": { + "4731": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4644": { + "4732": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "4645": { + "4733": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4646": { + "4734": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4647": { + "4735": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4648": { + "4736": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "4649": { + "4737": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4650": { + "4738": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4651": { + "4739": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4652": { + "4740": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService" }, - "4653": { + "4741": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.__constructor" }, - "4654": { + "4742": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService" }, - "4655": { + "4743": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "__0" }, - "4656": { + "4744": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.totalsService_" }, - "4657": { + "4745": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.returnRepository_" }, - "4658": { + "4746": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.returnItemRepository_" }, - "4659": { + "4747": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.lineItemService_" }, - "4660": { + "4748": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.taxProviderService_" }, - "4661": { + "4749": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.shippingOptionService_" }, - "4662": { + "4750": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.fulfillmentProviderService_" }, - "4663": { + "4751": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.returnReasonService_" }, - "4664": { + "4752": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.orderService_" }, - "4665": { + "4753": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.productVariantInventoryService_" }, - "4666": { + "4754": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.featureFlagRouter_" }, - "4667": { + "4755": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.getFulfillmentItems" }, - "4668": { + "4756": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.getFulfillmentItems" }, - "4669": { + "4757": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "order" }, - "4670": { + "4758": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "items" }, - "4671": { + "4759": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "transformer" }, - "4672": { + "4760": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "__type" }, - "4673": { + "4761": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "__type.reason_id" }, - "4674": { + "4762": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "__type.note" }, - "4675": { + "4763": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.list" }, - "4676": { + "4764": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.list" }, - "4677": { + "4765": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "selector" }, - "4678": { + "4766": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "config" }, - "4679": { + "4767": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.listAndCount" }, - "4680": { + "4768": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.listAndCount" }, - "4681": { + "4769": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "selector" }, - "4682": { + "4770": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "config" }, - "4683": { + "4771": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.cancel" }, - "4684": { + "4772": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.cancel" }, - "4685": { + "4773": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "returnId" }, - "4686": { + "4774": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.validateReturnStatuses" }, - "4687": { + "4775": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.validateReturnStatuses" }, - "4688": { + "4776": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "order" }, - "4689": { + "4777": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.validateReturnLineItem" }, - "4690": { + "4778": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.validateReturnLineItem" }, - "4691": { + "4779": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "item" }, - "4692": { + "4780": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "quantity" }, - "4693": { + "4781": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "additional" }, - "4694": { + "4782": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "__type" }, - "4695": { + "4783": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "__type.reason_id" }, - "4696": { + "4784": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "__type.note" }, - "4697": { + "4785": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.retrieve" }, - "4698": { + "4786": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.retrieve" }, - "4699": { + "4787": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "returnId" }, - "4700": { + "4788": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "config" }, - "4701": { + "4789": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.retrieveBySwap" }, - "4702": { + "4790": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.retrieveBySwap" }, - "4703": { + "4791": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "swapId" }, - "4704": { + "4792": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "relations" }, - "4705": { + "4793": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.update" }, - "4706": { + "4794": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.update" }, - "4707": { + "4795": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "returnId" }, - "4708": { + "4796": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "update" }, - "4709": { + "4797": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.create" }, - "4710": { + "4798": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.create" }, - "4711": { + "4799": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "data" }, - "4712": { + "4800": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.fulfill" }, - "4713": { + "4801": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.fulfill" }, - "4714": { + "4802": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "returnId" }, - "4715": { + "4803": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.receive" }, - "4716": { + "4804": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "ReturnService.receive" }, - "4717": { + "4805": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "returnId" }, - "4718": { + "4806": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "receivedItems" }, - "4719": { + "4807": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "refundAmount" }, - "4720": { + "4808": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "allowMismatch" }, - "4721": { + "4809": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "context" }, - "4722": { + "4810": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "__type" }, - "4723": { + "4811": { "sourceFileName": "../../../packages/medusa/src/services/return.ts", "qualifiedName": "__type.locationId" }, - "4724": { + "4812": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "4725": { + "4813": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "4726": { + "4814": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4727": { + "4815": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4728": { + "4816": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "4729": { + "4817": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "4730": { + "4818": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "4731": { + "4819": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4732": { + "4820": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4733": { + "4821": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4734": { + "4822": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4735": { + "4823": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4736": { + "4824": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "4737": { + "4825": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4738": { + "4826": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "4739": { + "4827": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4740": { + "4828": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4741": { + "4829": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "4742": { + "4830": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "4743": { + "4831": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "4744": { + "4832": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4745": { + "4833": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4746": { + "4834": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4747": { + "4835": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "4748": { + "4836": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4749": { + "4837": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4750": { + "4838": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4751": { + "4839": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "4752": { + "4840": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4753": { + "4841": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4754": { + "4842": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4755": { + "4843": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService" }, - "4756": { + "4844": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService.__constructor" }, - "4757": { + "4845": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService" }, - "4758": { + "4846": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "__0" }, - "4759": { + "4847": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService.retReasonRepo_" }, - "4760": { + "4848": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService.create" }, - "4761": { + "4849": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService.create" }, - "4762": { + "4850": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "data" }, - "4763": { + "4851": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService.update" }, - "4764": { + "4852": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService.update" }, - "4765": { + "4853": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "id" }, - "4766": { + "4854": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "data" }, - "4767": { + "4855": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService.list" }, - "4768": { + "4856": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService.list" }, - "4769": { + "4857": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "selector" }, - "4770": { + "4858": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "config" }, - "4771": { + "4859": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService.retrieve" }, - "4772": { + "4860": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService.retrieve" }, - "4773": { + "4861": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "returnReasonId" }, - "4774": { + "4862": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "config" }, - "4775": { + "4863": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService.delete" }, - "4776": { + "4864": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "ReturnReasonService.delete" }, - "4777": { + "4865": { "sourceFileName": "../../../packages/medusa/src/services/return-reason.ts", "qualifiedName": "returnReasonId" }, - "4778": { + "4866": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "4779": { + "4867": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "4780": { + "4868": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4781": { + "4869": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4782": { + "4870": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "4783": { + "4871": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "4784": { + "4872": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "4785": { + "4873": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4786": { + "4874": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4787": { + "4875": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4788": { + "4876": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4789": { + "4877": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4790": { + "4878": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "4791": { + "4879": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4792": { + "4880": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "4793": { + "4881": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4794": { + "4882": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4795": { + "4883": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "4796": { + "4884": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "4797": { + "4885": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "4798": { + "4886": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4799": { + "4887": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4800": { + "4888": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4801": { + "4889": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "4802": { + "4890": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4803": { + "4891": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4804": { + "4892": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4805": { + "4893": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "4806": { + "4894": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4807": { + "4895": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4808": { + "4896": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4809": { + "4897": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService" }, - "4810": { + "4898": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.Events" }, - "4811": { + "4899": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "__object" }, - "4812": { + "4900": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "__object.UPDATED" }, - "4813": { + "4901": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "__object.CREATED" }, - "4814": { + "4902": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "__object.DELETED" }, - "4815": { + "4903": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.__constructor" }, - "4816": { + "4904": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService" }, - "4817": { + "4905": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "__0" }, - "4818": { + "4906": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.salesChannelRepository_" }, - "4819": { + "4907": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "__object" }, - "4820": { + "4908": { + "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", + "qualifiedName": "__object.getFreeTextSearchResults_" + }, + "4909": { + "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", + "qualifiedName": "__object.getFreeTextSearchResults_" + }, + "4910": { + "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", + "qualifiedName": "q" + }, + "4911": { + "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", + "qualifiedName": "options" + }, + "4913": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "__type.select" + }, + "4914": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "__type.relations" + }, + "4915": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "__type.where" + }, + "4916": { + "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", + "qualifiedName": "__type.withCount" + }, + "4917": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "4821": { + "4918": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "4822": { + "4919": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "q" }, - "4823": { + "4920": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "options" }, - "4824": { + "4921": { + "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", + "qualifiedName": "__object.getFreeTextSearchResults" + }, + "4922": { + "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", + "qualifiedName": "__object.getFreeTextSearchResults" + }, + "4923": { + "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", + "qualifiedName": "q" + }, + "4924": { + "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", + "qualifiedName": "options" + }, + "4925": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "__object.removeProducts" }, - "4825": { + "4926": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "__object.removeProducts" }, - "4826": { + "4927": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "salesChannelId" }, - "4827": { + "4928": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "productIds" }, - "4828": { + "4929": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "__object.addProducts" }, - "4829": { + "4930": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "__object.addProducts" }, - "4830": { + "4931": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "salesChannelId" }, - "4831": { + "4932": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "productIds" }, - "4832": { + "4933": { + "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", + "qualifiedName": "isMedusaV2Enabled" + }, + "4934": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "__object.listProductIdsBySalesChannelIds" }, - "4833": { + "4935": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "__object.listProductIdsBySalesChannelIds" }, - "4834": { + "4936": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "salesChannelIds" }, - "4835": { + "4937": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "__type" }, - "4836": { + "4938": { "sourceFileName": "../../../packages/medusa/src/repositories/sales-channel.ts", "qualifiedName": "__type.__index" }, - "4838": { + "4940": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.eventBusService_" }, - "4839": { + "4941": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.storeService_" }, - "4840": { + "4942": { + "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", + "qualifiedName": "SalesChannelService.featureFlagRouter_" + }, + "4943": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.retrieve_" }, - "4841": { + "4944": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.retrieve_" }, - "4842": { + "4945": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "selector" }, - "4843": { + "4946": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "config" }, - "4844": { + "4947": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.retrieve" }, - "4845": { + "4948": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.retrieve" }, - "4846": { + "4949": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "salesChannelId" }, - "4847": { + "4950": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "config" }, - "4848": { + "4951": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.retrieveByName" }, - "4849": { + "4952": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.retrieveByName" }, - "4850": { + "4953": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "name" }, - "4851": { + "4954": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "config" }, - "4852": { + "4955": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.listAndCount" }, - "4853": { + "4956": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.listAndCount" }, - "4854": { + "4957": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "selector" }, - "4855": { + "4958": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "config" }, - "4856": { + "4959": { + "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", + "qualifiedName": "SalesChannelService.list" + }, + "4960": { + "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", + "qualifiedName": "SalesChannelService.list" + }, + "4961": { + "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", + "qualifiedName": "selector" + }, + "4962": { + "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", + "qualifiedName": "config" + }, + "4963": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.create" }, - "4857": { + "4964": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.create" }, - "4858": { + "4965": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "data" }, - "4859": { + "4966": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.update" }, - "4860": { + "4967": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.update" }, - "4861": { + "4968": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "salesChannelId" }, - "4862": { + "4969": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "data" }, - "4863": { + "4970": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.delete" }, - "4864": { + "4971": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.delete" }, - "4865": { + "4972": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "salesChannelId" }, - "4866": { + "4973": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.createDefault" }, - "4867": { + "4974": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.createDefault" }, - "4868": { + "4975": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.retrieveDefault" }, - "4869": { + "4976": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.retrieveDefault" }, - "4870": { + "4977": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.listProductIdsBySalesChannelIds" }, - "4871": { + "4978": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.listProductIdsBySalesChannelIds" }, - "4872": { + "4979": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "salesChannelIds" }, - "4873": { + "4980": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "__type" }, - "4874": { + "4981": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "__type.__index" }, - "4876": { + "4983": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.removeProducts" }, - "4877": { + "4984": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.removeProducts" }, - "4878": { + "4985": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "salesChannelId" }, - "4879": { + "4986": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "productIds" }, - "4880": { + "4987": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.addProducts" }, - "4881": { + "4988": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "SalesChannelService.addProducts" }, - "4882": { + "4989": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "salesChannelId" }, - "4883": { + "4990": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel.ts", "qualifiedName": "productIds" }, - "4884": { + "4991": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "4885": { + "4992": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "4886": { + "4993": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4887": { + "4994": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4888": { + "4995": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "4889": { + "4996": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "4890": { + "4997": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "4891": { + "4998": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4892": { + "4999": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4893": { + "5000": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4894": { + "5001": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4895": { + "5002": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4896": { + "5003": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "4897": { + "5004": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4898": { + "5005": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "4899": { + "5006": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4900": { + "5007": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4901": { + "5008": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "4902": { + "5009": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "4903": { + "5010": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "4904": { + "5011": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4905": { + "5012": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4906": { + "5013": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4907": { + "5014": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "4908": { + "5015": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4909": { + "5016": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4910": { + "5017": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4911": { + "5018": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "4912": { + "5019": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4913": { + "5020": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4914": { + "5021": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4915": { + "5022": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-inventory.ts", "qualifiedName": "SalesChannelInventoryService" }, - "4916": { + "5023": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-inventory.ts", "qualifiedName": "SalesChannelInventoryService.__constructor" }, - "4917": { + "5024": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-inventory.ts", "qualifiedName": "SalesChannelInventoryService" }, - "4918": { + "5025": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-inventory.ts", "qualifiedName": "__0" }, - "4919": { + "5026": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-inventory.ts", "qualifiedName": "SalesChannelInventoryService.salesChannelLocationService_" }, - "4920": { + "5027": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-inventory.ts", "qualifiedName": "SalesChannelInventoryService.eventBusService_" }, - "4921": { + "5028": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-inventory.ts", "qualifiedName": "SalesChannelInventoryService.inventoryService_" }, - "4922": { + "5029": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-inventory.ts", "qualifiedName": "SalesChannelInventoryService.inventoryService_" }, - "4923": { + "5030": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-inventory.ts", "qualifiedName": "SalesChannelInventoryService.retrieveAvailableItemQuantity" }, - "4924": { + "5031": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-inventory.ts", "qualifiedName": "SalesChannelInventoryService.retrieveAvailableItemQuantity" }, - "4925": { + "5032": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-inventory.ts", "qualifiedName": "salesChannelId" }, - "4926": { + "5033": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-inventory.ts", "qualifiedName": "inventoryItemId" }, - "4927": { + "5034": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "4928": { + "5035": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "4929": { + "5036": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4930": { + "5037": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4931": { + "5038": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "4932": { + "5039": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "4933": { + "5040": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "4934": { + "5041": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4935": { + "5042": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4936": { + "5043": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4937": { + "5044": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4938": { + "5045": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4939": { + "5046": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "4940": { + "5047": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4941": { + "5048": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "4942": { + "5049": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4943": { + "5050": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4944": { + "5051": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "4945": { + "5052": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "4946": { + "5053": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "4947": { + "5054": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4948": { + "5055": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4949": { + "5056": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4950": { + "5057": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "4951": { + "5058": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4952": { + "5059": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4953": { + "5060": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4954": { + "5061": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "4955": { + "5062": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4956": { + "5063": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4957": { + "5064": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "4958": { + "5065": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService" }, - "4959": { + "5066": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.__constructor" }, - "4960": { + "5067": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService" }, - "4961": { + "5068": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "__0" }, - "4962": { + "5069": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.salesChannelService_" }, - "4963": { + "5070": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.eventBusService_" }, - "4964": { + "5071": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.stockLocationService_" }, - "4965": { + "5072": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.stockLocationService_" }, - "4966": { + "5073": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.removeLocation" }, - "4967": { + "5074": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.removeLocation" }, - "4968": { + "5075": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "locationId" }, - "4969": { + "5076": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "salesChannelId" }, - "4970": { + "5077": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.associateLocation" }, - "4971": { + "5078": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.associateLocation" }, - "4972": { + "5079": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "salesChannelId" }, - "4973": { + "5080": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "locationId" }, - "4974": { + "5081": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.listLocationIds" }, - "4975": { + "5082": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.listLocationIds" }, - "4976": { + "5083": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "salesChannelId" }, - "4977": { + "5084": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.listSalesChannelIds" }, - "4978": { + "5085": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "SalesChannelLocationService.listSalesChannelIds" }, - "4979": { + "5086": { "sourceFileName": "../../../packages/medusa/src/services/sales-channel-location.ts", "qualifiedName": "locationId" }, - "4980": { + "5087": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "4981": { + "5088": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "4982": { + "5089": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4983": { + "5090": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "4984": { + "5091": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "4985": { + "5092": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "4986": { + "5093": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "4987": { + "5094": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4988": { + "5095": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "4989": { + "5096": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "4990": { + "5097": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4991": { + "5098": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "4992": { + "5099": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "4993": { + "5100": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "4994": { + "5101": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "4995": { + "5102": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4996": { + "5103": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "4997": { + "5104": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "4998": { + "5105": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "4999": { + "5106": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "5000": { + "5107": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5001": { + "5108": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5002": { + "5109": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5003": { + "5110": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "5004": { + "5111": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5005": { + "5112": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5006": { + "5113": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5007": { + "5114": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "5008": { + "5115": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5009": { + "5116": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5010": { + "5117": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5011": { + "5118": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default" }, - "5012": { + "5119": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.__constructor" }, - "5013": { + "5120": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default" }, - "5014": { + "5121": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "__0" }, - "5015": { + "5122": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "options" }, - "5016": { + "5123": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.isDefault" }, - "5017": { + "5124": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.logger_" }, - "5018": { + "5125": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.options_" }, - "5019": { + "5126": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.createIndex" }, - "5020": { + "5127": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.createIndex" }, - "5021": { + "5128": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "indexName" }, - "5022": { + "5129": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "options" }, - "5023": { + "5130": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.getIndex" }, - "5024": { + "5131": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.getIndex" }, - "5025": { + "5132": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "indexName" }, - "5026": { + "5133": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.addDocuments" }, - "5027": { + "5134": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.addDocuments" }, - "5028": { + "5135": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "indexName" }, - "5029": { + "5136": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "documents" }, - "5030": { + "5137": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "type" }, - "5031": { + "5138": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.replaceDocuments" }, - "5032": { + "5139": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.replaceDocuments" }, - "5033": { + "5140": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "indexName" }, - "5034": { + "5141": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "documents" }, - "5035": { + "5142": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "type" }, - "5036": { + "5143": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.deleteDocument" }, - "5037": { + "5144": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.deleteDocument" }, - "5038": { + "5145": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "indexName" }, - "5039": { + "5146": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "document_id" }, - "5040": { + "5147": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.deleteAllDocuments" }, - "5041": { + "5148": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.deleteAllDocuments" }, - "5042": { + "5149": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "indexName" }, - "5043": { + "5150": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.search" }, - "5044": { + "5151": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.search" }, - "5045": { + "5152": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "indexName" }, - "5046": { + "5153": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "query" }, - "5047": { + "5154": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "options" }, - "5048": { + "5155": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "__type" }, - "5049": { + "5156": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "__type.hits" }, - "5050": { + "5157": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.updateSettings" }, - "5051": { + "5158": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "default.updateSettings" }, - "5052": { + "5159": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "indexName" }, - "5053": { + "5160": { "sourceFileName": "../../../packages/medusa/src/services/search.ts", "qualifiedName": "settings" }, - "5054": { + "5161": { "sourceFileName": "../../../packages/utils/dist/search/abstract-service.d.ts", "qualifiedName": "AbstractSearchService.options" }, - "5055": { + "5162": { "sourceFileName": "../../../packages/utils/dist/search/abstract-service.d.ts", "qualifiedName": "AbstractSearchService.options" }, - "5056": { + "5163": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService" }, - "5057": { + "5164": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.__constructor" }, - "5058": { + "5165": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService" }, - "5059": { + "5166": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "__0" }, - "5060": { + "5167": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.providerService_" }, - "5061": { + "5168": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.regionService_" }, - "5062": { + "5169": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.requirementRepository_" }, - "5063": { + "5170": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.optionRepository_" }, - "5064": { + "5171": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-option.ts", "qualifiedName": "__object" }, - "5065": { + "5172": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-option.ts", "qualifiedName": "__object.upsertShippingProfile" }, - "5066": { + "5173": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-option.ts", "qualifiedName": "__object.upsertShippingProfile" }, - "5067": { + "5174": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-option.ts", "qualifiedName": "shippingOptionIds" }, - "5068": { + "5175": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-option.ts", "qualifiedName": "shippingProfileId" }, - "5069": { + "5176": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.methodRepository_" }, - "5070": { + "5177": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.featureFlagRouter_" }, - "5071": { + "5178": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.validateRequirement_" }, - "5072": { + "5179": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.validateRequirement_" }, - "5073": { + "5180": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "requirement" }, - "5074": { + "5181": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "optionId" }, - "5075": { + "5182": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.list" }, - "5076": { + "5183": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.list" }, - "5077": { + "5184": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "selector" }, - "5078": { + "5185": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "config" }, - "5079": { + "5186": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.listAndCount" }, - "5080": { + "5187": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.listAndCount" }, - "5081": { + "5188": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "selector" }, - "5082": { + "5189": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "config" }, - "5083": { + "5190": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.retrieve" }, - "5084": { + "5191": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.retrieve" }, - "5085": { + "5192": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "optionId" }, - "5086": { + "5193": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "options" }, - "5087": { + "5194": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.updateShippingMethod" }, - "5088": { + "5195": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.updateShippingMethod" }, - "5089": { + "5196": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "id" }, - "5090": { + "5197": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "update" }, - "5091": { + "5198": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.deleteShippingMethods" }, - "5092": { + "5199": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.deleteShippingMethods" }, - "5093": { + "5200": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "shippingMethods" }, - "5094": { + "5201": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.createShippingMethod" }, - "5095": { + "5202": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.createShippingMethod" }, - "5096": { + "5203": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "optionId" }, - "5097": { + "5204": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "data" }, - "5098": { + "5205": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "config" }, - "5099": { + "5206": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.validateCartOption" }, - "5100": { + "5207": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.validateCartOption" }, - "5101": { + "5208": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "option" }, - "5102": { + "5209": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "cart" }, - "5103": { + "5210": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.validateAndMutatePrice" }, - "5104": { + "5211": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.validateAndMutatePrice" }, - "5105": { + "5212": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "option" }, - "5106": { + "5213": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "priceInput" }, - "5107": { + "5214": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.create" }, - "5108": { + "5215": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.create" }, - "5109": { + "5216": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "data" }, - "5110": { + "5217": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.validatePriceType_" }, - "5111": { + "5218": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.validatePriceType_" }, - "5112": { + "5219": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "priceType" }, - "5113": { + "5220": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "option" }, - "5114": { + "5221": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.update" }, - "5115": { + "5222": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.update" }, - "5116": { + "5223": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "optionId" }, - "5117": { + "5224": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "update" }, - "5118": { + "5225": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.delete" }, - "5119": { + "5226": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.delete" }, - "5120": { + "5227": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "optionId" }, - "5121": { + "5228": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.addRequirement" }, - "5122": { + "5229": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.addRequirement" }, - "5123": { + "5230": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "optionId" }, - "5124": { + "5231": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "requirement" }, - "5125": { + "5232": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.removeRequirement" }, - "5126": { + "5233": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.removeRequirement" }, - "5127": { + "5234": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "requirementId" }, - "5128": { + "5235": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.updateShippingProfile" }, - "5129": { + "5236": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.updateShippingProfile" }, - "5130": { + "5237": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "optionIds" }, - "5131": { + "5238": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "profileId" }, - "5132": { + "5239": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.getPrice_" }, - "5133": { + "5240": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "ShippingOptionService.getPrice_" }, - "5134": { + "5241": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "option" }, - "5135": { + "5242": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "data" }, - "5136": { + "5243": { "sourceFileName": "../../../packages/medusa/src/services/shipping-option.ts", "qualifiedName": "cart" }, - "5137": { + "5244": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "5138": { + "5245": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "5139": { + "5246": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5140": { + "5247": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5141": { + "5248": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "5142": { + "5249": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "5143": { + "5250": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "5144": { + "5251": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5145": { + "5252": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5146": { + "5253": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5147": { + "5254": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5148": { + "5255": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5149": { + "5256": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "5150": { + "5257": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5151": { + "5258": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "5152": { + "5259": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5153": { + "5260": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5154": { + "5261": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "5155": { + "5262": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "5156": { + "5263": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "5157": { + "5264": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5158": { + "5265": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5159": { + "5266": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5160": { + "5267": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "5161": { + "5268": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5162": { + "5269": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5163": { + "5270": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5164": { + "5271": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "5165": { + "5272": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5166": { + "5273": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5167": { + "5274": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5168": { + "5275": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService" }, - "5169": { + "5276": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.__constructor" }, - "5170": { + "5277": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService" }, - "5171": { + "5278": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "__0" }, - "5172": { + "5279": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.productService_" }, - "5173": { + "5280": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.shippingOptionService_" }, - "5174": { + "5281": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.customShippingOptionService_" }, - "5175": { + "5282": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.shippingProfileRepository_" }, - "5176": { + "5283": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-profile.ts", "qualifiedName": "__object" }, - "5177": { + "5284": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-profile.ts", "qualifiedName": "__object.findByProducts" }, - "5178": { + "5285": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-profile.ts", "qualifiedName": "__object.findByProducts" }, - "5179": { + "5286": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-profile.ts", "qualifiedName": "productIds" }, - "5180": { + "5287": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-profile.ts", "qualifiedName": "__type" }, - "5181": { + "5288": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-profile.ts", "qualifiedName": "__type.__index" }, - "5183": { + "5290": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.productRepository_" }, - "5184": { + "5291": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object" }, - "5185": { + "5292": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProducts" }, - "5186": { + "5293": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProducts" }, - "5187": { + "5294": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "optionsWithoutRelations" }, - "5188": { + "5295": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "shouldCount" }, - "5189": { + "5296": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProductsWithIds" }, - "5190": { + "5297": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.queryProductsWithIds" }, - "5191": { + "5298": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__0" }, - "5192": { + "5299": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "5193": { + "5300": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.entityIds" }, - "5194": { + "5301": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.groupedRelations" }, - "5195": { + "5302": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "5196": { + "5303": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.__index" }, - "5198": { + "5305": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.withDeleted" }, - "5199": { + "5306": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.select" }, - "5200": { + "5307": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.order" }, - "5201": { + "5308": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "5202": { + "5309": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.__index" }, - "5204": { + "5311": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.where" }, - "5205": { + "5312": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelationsAndCount" }, - "5206": { + "5313": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelationsAndCount" }, - "5207": { + "5314": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "5208": { + "5315": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "idsOrOptionsWithoutRelations" }, - "5209": { + "5316": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelations" }, - "5210": { + "5317": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findWithRelations" }, - "5211": { + "5318": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "5212": { + "5319": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "idsOrOptionsWithoutRelations" }, - "5213": { + "5320": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "withDeleted" }, - "5214": { + "5321": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findOneWithRelations" }, - "5215": { + "5322": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.findOneWithRelations" }, - "5216": { + "5323": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "5217": { + "5324": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "optionsWithoutRelations" }, - "5218": { + "5325": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkAddToCollection" }, - "5219": { + "5326": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkAddToCollection" }, - "5220": { + "5327": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "productIds" }, - "5221": { + "5328": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "collectionId" }, - "5222": { + "5329": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkRemoveFromCollection" }, - "5223": { + "5330": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.bulkRemoveFromCollection" }, - "5224": { + "5331": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "productIds" }, - "5225": { + "5332": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "collectionId" }, - "5226": { + "5333": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "5227": { + "5334": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getFreeTextSearchResultsAndCount" }, - "5228": { + "5335": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "q" }, - "5229": { + "5336": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "options" }, - "5230": { + "5337": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "relations" }, - "5231": { + "5338": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsFromInput" }, - "5232": { + "5339": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsFromInput" }, - "5233": { + "5340": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "categoryId" }, - "5234": { + "5341": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "includeCategoryChildren" }, - "5235": { + "5342": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsRecursively" }, - "5236": { + "5343": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.getCategoryIdsRecursively" }, - "5237": { + "5344": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "productCategory" }, - "5238": { + "5345": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._findWithRelations" }, - "5239": { + "5346": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._findWithRelations" }, - "5240": { + "5347": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__0" }, - "5241": { + "5348": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type" }, - "5242": { + "5349": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.relations" }, - "5243": { + "5350": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.idsOrOptionsWithoutRelations" }, - "5244": { + "5351": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.withDeleted" }, - "5245": { + "5352": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__type.shouldCount" }, - "5246": { + "5353": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.isProductInSalesChannels" }, - "5247": { + "5354": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object.isProductInSalesChannels" }, - "5248": { + "5355": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "id" }, - "5249": { + "5356": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "salesChannelIds" }, - "5250": { + "5357": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._applyCategoriesQuery" }, - "5251": { + "5358": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__object._applyCategoriesQuery" }, - "5252": { + "5359": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "qb" }, - "5253": { + "5360": { "sourceFileName": "../../../packages/medusa/src/repositories/product.ts", "qualifiedName": "__1" }, - "5254": { + "5362": { + "sourceFileName": "", + "qualifiedName": "alias" + }, + "5363": { + "sourceFileName": "", + "qualifiedName": "categoryAlias" + }, + "5364": { + "sourceFileName": "", + "qualifiedName": "where" + }, + "5365": { + "sourceFileName": "", + "qualifiedName": "joinName" + }, + "5366": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.featureFlagRouter_" }, - "5255": { + "5367": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.list" }, - "5256": { + "5368": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.list" }, - "5257": { + "5369": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "selector" }, - "5258": { + "5370": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "config" }, - "5259": { + "5371": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.getMapProfileIdsByProductIds" }, - "5260": { + "5372": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.getMapProfileIdsByProductIds" }, - "5261": { + "5373": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "productIds" }, - "5262": { + "5374": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.retrieve" }, - "5263": { + "5375": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.retrieve" }, - "5264": { + "5376": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "profileId" }, - "5265": { + "5377": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "options" }, - "5266": { + "5378": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.retrieveForProducts" }, - "5267": { + "5379": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.retrieveForProducts" }, - "5268": { + "5380": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "productIds" }, - "5269": { + "5381": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "__type" }, - "5270": { + "5382": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "__type.__index" }, - "5272": { + "5384": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.retrieveDefault" }, - "5273": { + "5385": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.retrieveDefault" }, - "5274": { + "5386": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.createDefault" }, - "5275": { + "5387": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.createDefault" }, - "5276": { + "5388": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.retrieveGiftCardDefault" }, - "5277": { + "5389": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.retrieveGiftCardDefault" }, - "5278": { + "5390": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.createGiftCardDefault" }, - "5279": { + "5391": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.createGiftCardDefault" }, - "5280": { + "5392": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.create" }, - "5281": { + "5393": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.create" }, - "5282": { + "5394": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "profile" }, - "5283": { + "5395": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.update" }, - "5284": { + "5396": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.update" }, - "5285": { + "5397": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "profileId" }, - "5286": { + "5398": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "update" }, - "5287": { + "5399": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.delete" }, - "5288": { + "5400": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.delete" }, - "5289": { + "5401": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "profileId" }, - "5290": { + "5402": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.addProduct" }, - "5291": { + "5403": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.addProduct" }, - "5292": { + "5404": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "profileId" }, - "5293": { + "5405": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "productId" }, - "5294": { + "5406": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.addProducts" }, - "5295": { + "5407": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.addProducts" }, - "5296": { + "5408": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "profileId" }, - "5297": { + "5409": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "productId" }, - "5298": { + "5410": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.removeProducts" }, - "5299": { + "5411": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.removeProducts" }, - "5300": { + "5412": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "profileId" }, - "5301": { + "5413": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "productId" }, - "5302": { + "5414": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.addShippingOption" }, - "5303": { + "5415": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.addShippingOption" }, - "5304": { + "5416": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "profileId" }, - "5305": { + "5417": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "optionId" }, - "5306": { + "5418": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.fetchCartOptions" }, - "5307": { + "5419": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.fetchCartOptions" }, - "5308": { + "5420": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "cart" }, - "5309": { + "5421": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.getProfilesInCart" }, - "5310": { + "5422": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "ShippingProfileService.getProfilesInCart" }, - "5311": { + "5423": { "sourceFileName": "../../../packages/medusa/src/services/shipping-profile.ts", "qualifiedName": "cart" }, - "5312": { + "5424": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "5313": { + "5425": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "5314": { + "5426": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5315": { + "5427": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5316": { + "5428": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "5317": { + "5429": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "5318": { + "5430": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "5319": { + "5431": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5320": { + "5432": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5321": { + "5433": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5322": { + "5434": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5323": { + "5435": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5324": { + "5436": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "5325": { + "5437": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5326": { + "5438": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "5327": { + "5439": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5328": { + "5440": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5329": { + "5441": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "5330": { + "5442": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "5331": { + "5443": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "5332": { + "5444": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5333": { + "5445": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5334": { + "5446": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5335": { + "5447": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "5336": { + "5448": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5337": { + "5449": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5338": { + "5450": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5339": { + "5451": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "5340": { + "5452": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5341": { + "5453": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5342": { + "5454": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5343": { + "5455": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "StagedJobService" }, - "5344": { + "5456": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "StagedJobService.__constructor" }, - "5345": { + "5457": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "StagedJobService" }, - "5346": { + "5458": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "__0" }, - "5347": { + "5459": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "StagedJobService.stagedJobRepository_" }, - "5348": { + "5460": { "sourceFileName": "../../../packages/medusa/src/repositories/staged-job.ts", "qualifiedName": "__object" }, - "5349": { + "5461": { "sourceFileName": "../../../packages/medusa/src/repositories/staged-job.ts", "qualifiedName": "__object.insertBulk" }, - "5350": { + "5462": { "sourceFileName": "../../../packages/medusa/src/repositories/staged-job.ts", "qualifiedName": "__object.insertBulk" }, - "5351": { + "5463": { "sourceFileName": "../../../packages/medusa/src/repositories/staged-job.ts", "qualifiedName": "jobToCreates" }, - "5352": { + "5464": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "StagedJobService.list" }, - "5353": { + "5465": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "StagedJobService.list" }, - "5354": { + "5466": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "config" }, - "5355": { + "5467": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "StagedJobService.delete" }, - "5356": { + "5468": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "StagedJobService.delete" }, - "5357": { + "5469": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "stagedJobIds" }, - "5358": { + "5470": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "StagedJobService.create" }, - "5359": { + "5471": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "StagedJobService.create" }, - "5360": { + "5472": { "sourceFileName": "../../../packages/medusa/src/services/staged-job.ts", "qualifiedName": "data" }, - "5361": { + "5473": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "5362": { + "5474": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "5363": { + "5475": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5364": { + "5476": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5365": { + "5477": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "5366": { + "5478": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "5367": { + "5479": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "5368": { + "5480": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5369": { + "5481": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5370": { + "5482": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5371": { + "5483": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5372": { + "5484": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5373": { + "5485": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "5374": { + "5486": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5375": { + "5487": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "5376": { + "5488": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5377": { + "5489": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5378": { + "5490": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "5379": { + "5491": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "5380": { + "5492": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "5381": { + "5493": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5382": { + "5494": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5383": { + "5495": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5384": { + "5496": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "5385": { + "5497": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5386": { + "5498": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5387": { + "5499": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5388": { + "5500": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "5389": { + "5501": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5390": { + "5502": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5391": { + "5503": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5392": { + "5504": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService" }, - "5393": { + "5505": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.__constructor" }, - "5394": { + "5506": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService" }, - "5395": { + "5507": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "__0" }, - "5396": { + "5508": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.storeRepository_" }, - "5397": { + "5509": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.currencyRepository_" }, - "5398": { + "5510": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.eventBus_" }, - "5399": { + "5511": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.create" }, - "5400": { + "5512": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.create" }, - "5401": { + "5513": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.retrieve" }, - "5402": { + "5514": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.retrieve" }, - "5403": { + "5515": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "config" }, - "5404": { + "5516": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.getDefaultCurrency_" }, - "5405": { + "5517": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.getDefaultCurrency_" }, - "5406": { + "5518": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "code" }, - "5407": { + "5519": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.update" }, - "5408": { + "5520": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.update" }, - "5409": { + "5521": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "data" }, - "5410": { + "5522": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.addCurrency" }, - "5411": { + "5523": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.addCurrency" }, - "5412": { + "5524": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "code" }, - "5413": { + "5525": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.removeCurrency" }, - "5414": { + "5526": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "StoreService.removeCurrency" }, - "5415": { + "5527": { "sourceFileName": "../../../packages/medusa/src/services/store.ts", "qualifiedName": "code" }, - "5416": { + "5528": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "5417": { + "5529": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "5418": { + "5530": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5419": { + "5531": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5420": { + "5532": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "5421": { + "5533": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "5422": { + "5534": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "5423": { + "5535": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5424": { + "5536": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5425": { + "5537": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5426": { + "5538": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5427": { + "5539": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5428": { + "5540": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "5429": { + "5541": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5430": { + "5542": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "5431": { + "5543": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5432": { + "5544": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5433": { + "5545": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "5434": { + "5546": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "5435": { + "5547": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "5436": { + "5548": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5437": { + "5549": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5438": { + "5550": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5439": { + "5551": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "5440": { + "5552": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5441": { + "5553": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5442": { + "5554": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5443": { + "5555": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "5444": { + "5556": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5445": { + "5557": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5446": { + "5558": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5447": { + "5559": { "sourceFileName": "../../../packages/medusa/src/services/strategy-resolver.ts", "qualifiedName": "default" }, - "5448": { + "5560": { "sourceFileName": "../../../packages/medusa/src/services/strategy-resolver.ts", "qualifiedName": "default.__constructor" }, - "5449": { + "5561": { "sourceFileName": "../../../packages/medusa/src/services/strategy-resolver.ts", "qualifiedName": "default" }, - "5450": { + "5562": { "sourceFileName": "../../../packages/medusa/src/services/strategy-resolver.ts", "qualifiedName": "container" }, - "5451": { + "5563": { "sourceFileName": "../../../packages/medusa/src/services/strategy-resolver.ts", "qualifiedName": "default.container" }, - "5452": { + "5564": { "sourceFileName": "../../../packages/medusa/src/services/strategy-resolver.ts", "qualifiedName": "default.resolveBatchJobByType" }, - "5453": { + "5565": { "sourceFileName": "../../../packages/medusa/src/services/strategy-resolver.ts", "qualifiedName": "default.resolveBatchJobByType" }, - "5454": { + "5566": { "sourceFileName": "../../../packages/medusa/src/services/strategy-resolver.ts", "qualifiedName": "type" }, - "5455": { + "5567": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "5456": { + "5568": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "5457": { + "5569": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5458": { + "5570": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5459": { + "5571": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "5460": { + "5572": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "5461": { + "5573": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "5462": { + "5574": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5463": { + "5575": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5464": { + "5576": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5465": { + "5577": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5466": { + "5578": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5467": { + "5579": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "5468": { + "5580": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5469": { + "5581": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "5470": { + "5582": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5471": { + "5583": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5472": { + "5584": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "5473": { + "5585": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "5474": { + "5586": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "5475": { + "5587": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5476": { + "5588": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5477": { + "5589": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5478": { + "5590": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "5479": { + "5591": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5480": { + "5592": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5481": { + "5593": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5482": { + "5594": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "5483": { + "5595": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5484": { + "5596": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5485": { + "5597": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5486": { + "5598": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService" }, - "5487": { + "5599": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.Events" }, - "5488": { + "5600": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__object" }, - "5489": { + "5601": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__object.CREATED" }, - "5490": { + "5602": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__object.RECEIVED" }, - "5491": { + "5603": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__object.SHIPMENT_CREATED" }, - "5492": { + "5604": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__object.PAYMENT_COMPLETED" }, - "5493": { + "5605": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__object.PAYMENT_CAPTURED" }, - "5494": { + "5606": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__object.PAYMENT_CAPTURE_FAILED" }, - "5495": { + "5607": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__object.PROCESS_REFUND_FAILED" }, - "5496": { + "5608": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__object.REFUND_PROCESSED" }, - "5497": { + "5609": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__object.FULFILLMENT_CREATED" }, - "5498": { + "5610": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.__constructor" }, - "5499": { + "5611": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService" }, - "5500": { + "5612": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__0" }, - "5501": { + "5613": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.swapRepository_" }, - "5502": { + "5614": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.cartService_" }, - "5503": { + "5615": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.eventBus_" }, - "5504": { + "5616": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.orderService_" }, - "5505": { + "5617": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.returnService_" }, - "5506": { + "5618": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.totalsService_" }, - "5507": { + "5619": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.lineItemService_" }, - "5508": { + "5620": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.fulfillmentService_" }, - "5509": { + "5621": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.shippingOptionService_" }, - "5510": { + "5622": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.paymentProviderService_" }, - "5511": { + "5623": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.lineItemAdjustmentService_" }, - "5512": { + "5624": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.customShippingOptionService_" }, - "5513": { + "5625": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.productVariantInventoryService_" }, - "5514": { + "5626": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.transformQueryForCart" }, - "5515": { + "5627": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.transformQueryForCart" }, - "5516": { + "5628": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "config" }, - "5517": { + "5629": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type" }, - "5518": { + "5630": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.select" }, - "5519": { + "5631": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type" }, - "5520": { + "5632": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.select" }, - "5521": { + "5633": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type" }, - "5522": { + "5634": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.cartSelects" }, - "5523": { + "5635": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.cartRelations" }, - "5524": { + "5636": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.retrieve" }, - "5525": { + "5637": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.retrieve" }, - "5526": { + "5638": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "swapId" }, - "5527": { + "5639": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "config" }, - "5528": { + "5640": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type" }, - "5529": { + "5641": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.select" }, - "5530": { + "5642": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.retrieveByCartId" }, - "5531": { + "5643": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.retrieveByCartId" }, - "5532": { + "5644": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "cartId" }, - "5533": { + "5645": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "relations" }, - "5534": { + "5646": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.list" }, - "5535": { + "5647": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.list" }, - "5536": { + "5648": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "selector" }, - "5537": { + "5649": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "config" }, - "5538": { + "5650": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.listAndCount" }, - "5539": { + "5651": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.listAndCount" }, - "5540": { + "5652": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "selector" }, - "5541": { + "5653": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "config" }, - "5542": { + "5654": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.create" }, - "5543": { + "5655": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.create" }, - "5544": { + "5656": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "order" }, - "5545": { + "5657": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "returnItems" }, - "5546": { + "5658": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "additionalItems" }, - "5547": { + "5659": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "returnShipping" }, - "5548": { + "5660": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type" }, - "5549": { + "5661": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.option_id" }, - "5550": { + "5662": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.price" }, - "5551": { + "5663": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "custom" }, - "5552": { + "5664": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type" }, - "5553": { + "5665": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.no_notification" }, - "5554": { + "5666": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.idempotency_key" }, - "5555": { + "5667": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.allow_backorder" }, - "5556": { + "5668": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.location_id" }, - "5557": { + "5669": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.processDifference" }, - "5558": { + "5670": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.processDifference" }, - "5559": { + "5671": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "swapId" }, - "5560": { + "5672": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.update" }, - "5561": { + "5673": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.update" }, - "5562": { + "5674": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "swapId" }, - "5563": { + "5675": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "update" }, - "5564": { + "5676": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.createCart" }, - "5565": { + "5677": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.createCart" }, - "5566": { + "5678": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "swapId" }, - "5567": { + "5679": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "customShippingOptions" }, - "5568": { + "5680": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type" }, - "5569": { + "5681": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.option_id" }, - "5570": { + "5682": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.price" }, - "5571": { + "5683": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "context" }, - "5572": { + "5684": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type" }, - "5573": { + "5685": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.sales_channel_id" }, - "5574": { + "5686": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.registerCartCompletion" }, - "5575": { + "5687": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.registerCartCompletion" }, - "5576": { + "5688": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "swapId" }, - "5577": { + "5689": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.cancel" }, - "5578": { + "5690": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.cancel" }, - "5579": { + "5691": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "swapId" }, - "5580": { + "5692": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.createFulfillment" }, - "5581": { + "5693": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.createFulfillment" }, - "5582": { + "5694": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "swapId" }, - "5583": { + "5695": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "config" }, - "5584": { + "5696": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.cancelFulfillment" }, - "5585": { + "5697": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.cancelFulfillment" }, - "5586": { + "5698": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "fulfillmentId" }, - "5587": { + "5699": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.createShipment" }, - "5588": { + "5700": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.createShipment" }, - "5589": { + "5701": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "swapId" }, - "5590": { + "5702": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "fulfillmentId" }, - "5591": { + "5703": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "trackingLinks" }, - "5592": { + "5704": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type" }, - "5593": { + "5705": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "__type.tracking_number" }, - "5594": { + "5706": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "config" }, - "5595": { + "5707": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.deleteMetadata" }, - "5596": { + "5708": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.deleteMetadata" }, - "5597": { + "5709": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "swapId" }, - "5598": { + "5710": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "key" }, - "5599": { + "5711": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.registerReceived" }, - "5600": { + "5712": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.registerReceived" }, - "5601": { + "5713": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "id" }, - "5602": { + "5714": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.areReturnItemsValid" }, - "5603": { + "5715": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "SwapService.areReturnItemsValid" }, - "5604": { + "5716": { "sourceFileName": "../../../packages/medusa/src/services/swap.ts", "qualifiedName": "returnItems" }, - "5605": { + "5717": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "5606": { + "5718": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "5607": { + "5719": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5608": { + "5720": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5609": { + "5721": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "5610": { + "5722": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "5611": { + "5723": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "5612": { + "5724": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5613": { + "5725": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5614": { + "5726": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5615": { + "5727": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5616": { + "5728": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5617": { + "5729": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "5618": { + "5730": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5619": { + "5731": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "5620": { + "5732": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5621": { + "5733": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5622": { + "5734": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "5623": { + "5735": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "5624": { + "5736": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "5625": { + "5737": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5626": { + "5738": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5627": { + "5739": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5628": { + "5740": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "5629": { + "5741": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5630": { + "5742": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5631": { + "5743": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5632": { + "5744": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "5633": { + "5745": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5634": { + "5746": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5635": { + "5747": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5636": { + "5748": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService" }, - "5637": { + "5749": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.identifier" }, - "5638": { + "5750": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.__constructor" }, - "5639": { + "5751": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService" }, - "5640": { + "5752": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "_" }, - "5641": { + "5753": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.createPayment" }, - "5642": { + "5754": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.createPayment" }, - "5643": { + "5755": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "_" }, - "5644": { + "5756": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.getStatus" }, - "5645": { + "5757": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.getStatus" }, - "5646": { + "5758": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "_" }, - "5647": { + "5759": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.getPaymentData" }, - "5648": { + "5760": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.getPaymentData" }, - "5649": { + "5761": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "_" }, - "5650": { + "5762": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.authorizePayment" }, - "5651": { + "5763": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.authorizePayment" }, - "5652": { + "5764": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "_" }, - "5653": { + "5765": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.updatePaymentData" }, - "5654": { + "5766": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.updatePaymentData" }, - "5655": { + "5767": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "_" }, - "5656": { + "5768": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.updatePayment" }, - "5657": { + "5769": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.updatePayment" }, - "5658": { + "5770": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "_" }, - "5659": { + "5771": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.deletePayment" }, - "5660": { + "5772": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.deletePayment" }, - "5661": { + "5773": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "_" }, - "5662": { + "5774": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.capturePayment" }, - "5663": { + "5775": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.capturePayment" }, - "5664": { + "5776": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "_" }, - "5665": { + "5777": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.refundPayment" }, - "5666": { + "5778": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.refundPayment" }, - "5667": { + "5779": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "_" }, - "5668": { + "5780": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.cancelPayment" }, - "5669": { + "5781": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "SystemProviderService.cancelPayment" }, - "5670": { + "5782": { "sourceFileName": "../../../packages/medusa/src/services/system-payment-provider.ts", "qualifiedName": "_" }, - "5671": { + "5783": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "5672": { + "5784": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "5673": { + "5785": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5674": { + "5786": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5675": { + "5787": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "5676": { + "5788": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "5677": { + "5789": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "5678": { + "5790": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5679": { + "5791": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5680": { + "5792": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5681": { + "5793": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5682": { + "5794": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5683": { + "5795": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "5684": { + "5796": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5685": { + "5797": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "5686": { + "5798": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5687": { + "5799": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5688": { + "5800": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "5689": { + "5801": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "5690": { + "5802": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "5691": { + "5803": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5692": { + "5804": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5693": { + "5805": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5694": { + "5806": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "5695": { + "5807": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5696": { + "5808": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5697": { + "5809": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5698": { + "5810": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "5699": { + "5811": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5700": { + "5812": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5701": { + "5813": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5702": { + "5814": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService" }, - "5703": { + "5815": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.__constructor" }, - "5704": { + "5816": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService" }, - "5705": { + "5817": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "container" }, - "5706": { + "5818": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.container_" }, - "5707": { + "5819": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.cacheService_" }, - "5708": { + "5820": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.taxRateService_" }, - "5709": { + "5821": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.taxLineRepo_" }, - "5710": { + "5822": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "__object" }, - "5711": { + "5823": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "__object.upsertLines" }, - "5712": { + "5824": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "__object.upsertLines" }, - "5713": { + "5825": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "lines" }, - "5714": { + "5826": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "__object.deleteForCart" }, - "5715": { + "5827": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "__object.deleteForCart" }, - "5716": { + "5828": { "sourceFileName": "../../../packages/medusa/src/repositories/line-item-tax-line.ts", "qualifiedName": "cartId" }, - "5717": { + "5829": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.smTaxLineRepo_" }, - "5718": { + "5830": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-method-tax-line.ts", "qualifiedName": "__object" }, - "5719": { + "5831": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-method-tax-line.ts", "qualifiedName": "__object.upsertLines" }, - "5720": { + "5832": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-method-tax-line.ts", "qualifiedName": "__object.upsertLines" }, - "5721": { + "5833": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-method-tax-line.ts", "qualifiedName": "lines" }, - "5722": { + "5834": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-method-tax-line.ts", "qualifiedName": "__object.deleteForCart" }, - "5723": { + "5835": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-method-tax-line.ts", "qualifiedName": "__object.deleteForCart" }, - "5724": { + "5836": { "sourceFileName": "../../../packages/medusa/src/repositories/shipping-method-tax-line.ts", "qualifiedName": "cartId" }, - "5725": { + "5837": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.taxProviderRepo_" }, - "5726": { + "5838": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.eventBus_" }, - "5727": { + "5839": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.list" }, - "5728": { + "5840": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.list" }, - "5729": { + "5841": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.retrieveProvider" }, - "5730": { + "5842": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.retrieveProvider" }, - "5731": { + "5843": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "region" }, - "5732": { + "5844": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.clearLineItemsTaxLines" }, - "5733": { + "5845": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.clearLineItemsTaxLines" }, - "5734": { + "5846": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "itemIds" }, - "5735": { + "5847": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.clearTaxLines" }, - "5736": { + "5848": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.clearTaxLines" }, - "5737": { + "5849": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "cartId" }, - "5738": { + "5850": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.createTaxLines" }, - "5739": { + "5851": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.createTaxLines" }, - "5740": { + "5852": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "cartOrLineItems" }, - "5741": { + "5853": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "calculationContext" }, - "5742": { + "5854": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.createShippingTaxLines" }, - "5743": { + "5855": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.createShippingTaxLines" }, - "5744": { + "5856": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "shippingMethod" }, - "5745": { + "5857": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "calculationContext" }, - "5746": { + "5858": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.getShippingTaxLines" }, - "5747": { + "5859": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.getShippingTaxLines" }, - "5748": { + "5860": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "shippingMethod" }, - "5749": { + "5861": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "calculationContext" }, - "5750": { + "5862": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.getTaxLines" }, - "5751": { + "5863": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.getTaxLines" }, - "5752": { + "5864": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "lineItems" }, - "5753": { + "5865": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "calculationContext" }, - "5754": { + "5866": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.getTaxLinesMap" }, - "5755": { + "5867": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.getTaxLinesMap" }, - "5756": { + "5868": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "items" }, - "5757": { + "5869": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "calculationContext" }, - "5758": { + "5870": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.getRegionRatesForShipping" }, - "5759": { + "5871": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.getRegionRatesForShipping" }, - "5760": { + "5872": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "optionId" }, - "5761": { + "5873": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "regionDetails" }, - "5762": { + "5874": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.getRegionRatesForProduct" }, - "5763": { + "5875": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.getRegionRatesForProduct" }, - "5764": { + "5876": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "productIds" }, - "5765": { + "5877": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "region" }, - "5766": { + "5878": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.getCacheKey" }, - "5767": { + "5879": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.getCacheKey" }, - "5768": { + "5880": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "id" }, - "5769": { + "5881": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "regionId" }, - "5770": { + "5882": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.registerInstalledProviders" }, - "5771": { + "5883": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "TaxProviderService.registerInstalledProviders" }, - "5772": { + "5884": { "sourceFileName": "../../../packages/medusa/src/services/tax-provider.ts", "qualifiedName": "providers" }, - "5773": { + "5885": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "5774": { + "5886": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "5775": { + "5887": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5776": { + "5888": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5777": { + "5889": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "5778": { + "5890": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "5779": { + "5891": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "5780": { + "5892": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5781": { + "5893": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5782": { + "5894": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5783": { + "5895": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5784": { + "5896": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5785": { + "5897": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "5786": { + "5898": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5787": { + "5899": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "5788": { + "5900": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5789": { + "5901": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5790": { + "5902": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "5791": { + "5903": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "5792": { + "5904": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "5793": { + "5905": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5794": { + "5906": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5795": { + "5907": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5796": { + "5908": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "5797": { + "5909": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5798": { + "5910": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5799": { + "5911": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5800": { + "5912": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "5801": { + "5913": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5802": { + "5914": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5803": { + "5915": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5804": { + "5916": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService" }, - "5805": { + "5917": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.__constructor" }, - "5806": { + "5918": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService" }, - "5807": { + "5919": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "__0" }, - "5808": { + "5921": { + "sourceFileName": "", + "qualifiedName": "productService" + }, + "5922": { + "sourceFileName": "", + "qualifiedName": "productTypeService" + }, + "5923": { + "sourceFileName": "", + "qualifiedName": "shippingOptionService" + }, + "5924": { + "sourceFileName": "", + "qualifiedName": "taxRateRepository" + }, + "5925": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.productService_" }, - "5809": { + "5926": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.productTypeService_" }, - "5810": { + "5927": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.shippingOptionService_" }, - "5811": { + "5928": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.taxRateRepository_" }, - "5812": { + "5929": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object" }, - "5813": { + "5930": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.getFindQueryBuilder" }, - "5814": { + "5931": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.getFindQueryBuilder" }, - "5815": { + "5932": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "findOptions" }, - "5816": { + "5933": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.findWithResolution" }, - "5817": { + "5934": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.findWithResolution" }, - "5818": { + "5935": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "findOptions" }, - "5819": { + "5936": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.findOneWithResolution" }, - "5820": { + "5937": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.findOneWithResolution" }, - "5821": { + "5938": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "findOptions" }, - "5822": { + "5939": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.findAndCountWithResolution" }, - "5823": { + "5940": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.findAndCountWithResolution" }, - "5824": { + "5941": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "findOptions" }, - "5825": { + "5942": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.applyResolutionsToQueryBuilder" }, - "5826": { + "5943": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.applyResolutionsToQueryBuilder" }, - "5827": { + "5944": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "qb" }, - "5828": { + "5945": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "resolverFields" }, - "5829": { + "5946": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.removeFromProduct" }, - "5830": { + "5947": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.removeFromProduct" }, - "5831": { + "5948": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "id" }, - "5832": { + "5949": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "productIds" }, - "5833": { + "5950": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.addToProduct" }, - "5834": { + "5951": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.addToProduct" }, - "5835": { + "5952": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "id" }, - "5836": { + "5953": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "productIds" }, - "5837": { + "5954": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "overrideExisting" }, - "5838": { + "5955": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.removeFromProductType" }, - "5839": { + "5956": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.removeFromProductType" }, - "5840": { + "5957": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "id" }, - "5841": { + "5958": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "productTypeIds" }, - "5842": { + "5959": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.addToProductType" }, - "5843": { + "5960": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.addToProductType" }, - "5844": { + "5961": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "id" }, - "5845": { + "5962": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "productTypeIds" }, - "5846": { + "5963": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "overrideExisting" }, - "5847": { + "5964": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.removeFromShippingOption" }, - "5848": { + "5965": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.removeFromShippingOption" }, - "5849": { + "5966": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "id" }, - "5850": { + "5967": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "optionIds" }, - "5851": { + "5968": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.addToShippingOption" }, - "5852": { + "5969": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.addToShippingOption" }, - "5853": { + "5970": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "id" }, - "5854": { + "5971": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "optionIds" }, - "5855": { + "5972": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "overrideExisting" }, - "5856": { + "5973": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.listByProduct" }, - "5857": { + "5974": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.listByProduct" }, - "5858": { + "5975": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "productId" }, - "5859": { + "5976": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "config" }, - "5860": { + "5977": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.listByShippingOption" }, - "5861": { + "5978": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "__object.listByShippingOption" }, - "5862": { + "5979": { "sourceFileName": "../../../packages/medusa/src/repositories/tax-rate.ts", "qualifiedName": "optionId" }, - "5863": { + "5980": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.list" }, - "5864": { + "5981": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.list" }, - "5865": { + "5982": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "selector" }, - "5866": { + "5983": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "config" }, - "5867": { + "5984": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.listAndCount" }, - "5868": { + "5985": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.listAndCount" }, - "5869": { + "5986": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "selector" }, - "5870": { + "5987": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "config" }, - "5871": { + "5988": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.retrieve" }, - "5872": { + "5989": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.retrieve" }, - "5873": { + "5990": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "taxRateId" }, - "5874": { + "5991": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "config" }, - "5875": { + "5992": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.create" }, - "5876": { + "5993": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.create" }, - "5877": { + "5994": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "data" }, - "5878": { + "5995": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.update" }, - "5879": { + "5996": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.update" }, - "5880": { + "5997": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "id" }, - "5881": { + "5998": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "data" }, - "5882": { + "5999": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.delete" }, - "5883": { + "6000": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.delete" }, - "5884": { + "6001": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "id" }, - "5885": { + "6002": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.removeFromProduct" }, - "5886": { + "6003": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.removeFromProduct" }, - "5887": { + "6004": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "id" }, - "5888": { + "6005": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "productIds" }, - "5889": { + "6006": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.removeFromProductType" }, - "5890": { + "6007": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.removeFromProductType" }, - "5891": { + "6008": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "id" }, - "5892": { + "6009": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "typeIds" }, - "5893": { + "6010": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.removeFromShippingOption" }, - "5894": { + "6011": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.removeFromShippingOption" }, - "5895": { + "6012": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "id" }, - "5896": { + "6013": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "optionIds" }, - "5897": { + "6014": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.addToProduct" }, - "5898": { + "6015": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.addToProduct" }, - "5899": { + "6016": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "id" }, - "5900": { + "6017": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "productIds" }, - "5901": { + "6018": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "replace" }, - "5902": { + "6019": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.addToProductType" }, - "5903": { + "6020": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.addToProductType" }, - "5904": { + "6021": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "id" }, - "5905": { + "6022": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "productTypeIds" }, - "5906": { + "6023": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "replace" }, - "5907": { + "6024": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.addToShippingOption" }, - "5908": { + "6025": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.addToShippingOption" }, - "5909": { + "6026": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "id" }, - "5910": { + "6027": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "optionIds" }, - "5911": { + "6028": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "replace" }, - "5912": { + "6029": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.listByProduct" }, - "5913": { + "6030": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.listByProduct" }, - "5914": { + "6031": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "productId" }, - "5915": { + "6032": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "config" }, - "5916": { + "6033": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.listByShippingOption" }, - "5917": { + "6034": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "TaxRateService.listByShippingOption" }, - "5918": { + "6035": { "sourceFileName": "../../../packages/medusa/src/services/tax-rate.ts", "qualifiedName": "shippingOptionId" }, - "5919": { + "6036": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "5920": { + "6037": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "5921": { + "6038": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5922": { + "6039": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "5923": { + "6040": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "5924": { + "6041": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "5925": { + "6042": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "5926": { + "6043": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5927": { + "6044": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "5928": { + "6045": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5929": { + "6046": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5930": { + "6047": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "5931": { + "6048": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "5932": { + "6049": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5933": { + "6050": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "5934": { + "6051": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5935": { + "6052": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "5936": { + "6053": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "5937": { + "6054": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "5938": { + "6055": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "5939": { + "6056": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5940": { + "6057": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5941": { + "6058": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "5942": { + "6059": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "5943": { + "6060": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5944": { + "6061": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5945": { + "6062": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5946": { + "6063": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "5947": { + "6064": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5948": { + "6065": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "5949": { + "6066": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "5950": { + "6067": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "TokenService" }, - "5951": { + "6068": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "TokenService.RESOLUTION_KEY" }, - "5952": { + "6069": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "TokenService.__constructor" }, - "5953": { + "6070": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "TokenService" }, - "5954": { + "6071": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "__0" }, - "5955": { + "6072": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "TokenService.configModule_" }, - "5956": { + "6073": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "TokenService.verifyToken" }, - "5957": { + "6074": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "TokenService.verifyToken" }, - "5958": { + "6075": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "token" }, - "5959": { + "6076": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "options" }, - "5960": { + "6077": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "TokenService.signToken" }, - "5961": { + "6078": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "TokenService.signToken" }, - "5962": { + "6079": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "data" }, - "5963": { + "6080": { "sourceFileName": "../../../packages/medusa/src/services/token.ts", "qualifiedName": "options" }, - "5964": { + "6081": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService" }, - "5965": { + "6082": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.__constructor" }, - "5966": { + "6083": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService" }, - "5967": { + "6084": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__0" }, - "5968": { + "6085": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.taxProviderService_" }, - "5969": { + "6086": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.newTotalsService_" }, - "5970": { + "6087": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.taxCalculationStrategy_" }, - "5971": { + "6088": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.featureFlagRouter_" }, - "5972": { + "6089": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getTotal" }, - "5973": { + "6090": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getTotal" }, - "5974": { + "6091": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cartOrOrder" }, - "5975": { + "6092": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "options" }, - "5976": { + "6093": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getPaidTotal" }, - "5977": { + "6094": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getPaidTotal" }, - "5978": { + "6095": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "order" }, - "5979": { + "6096": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getSwapTotal" }, - "5980": { + "6097": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getSwapTotal" }, - "5981": { + "6098": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "order" }, - "5982": { + "6099": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getShippingMethodTotals" }, - "5983": { + "6100": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getShippingMethodTotals" }, - "5984": { + "6101": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "shippingMethod" }, - "5985": { + "6102": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cartOrOrder" }, - "5986": { + "6103": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "opts" }, - "5987": { + "6104": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getSubtotal" }, - "5988": { + "6105": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getSubtotal" }, - "5989": { + "6106": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cartOrOrder" }, - "5990": { + "6107": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "opts" }, - "5991": { + "6108": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getShippingTotal" }, - "5992": { + "6109": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getShippingTotal" }, - "5993": { + "6110": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cartOrOrder" }, - "5994": { + "6111": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getTaxTotal" }, - "5995": { + "6112": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getTaxTotal" }, - "5996": { + "6113": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cartOrOrder" }, - "5997": { + "6114": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "forceTaxes" }, - "5998": { + "6115": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getAllocationMap" }, - "5999": { + "6116": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getAllocationMap" }, - "6000": { + "6117": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "orderOrCart" }, - "6001": { + "6118": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type" }, - "6002": { + "6119": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type.discounts" }, - "6003": { + "6120": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type.items" }, - "6004": { + "6121": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type.swaps" }, - "6005": { + "6122": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type.claims" }, - "6006": { + "6123": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "options" }, - "6007": { + "6124": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getRefundedTotal" }, - "6008": { + "6125": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getRefundedTotal" }, - "6009": { + "6126": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "order" }, - "6010": { + "6127": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getLineItemRefund" }, - "6011": { + "6128": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getLineItemRefund" }, - "6012": { + "6129": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "order" }, - "6013": { + "6130": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "lineItem" }, - "6014": { + "6131": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getRefundTotal" }, - "6015": { + "6132": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getRefundTotal" }, - "6016": { + "6133": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "order" }, - "6017": { + "6134": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "lineItems" }, - "6018": { + "6135": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.calculateDiscount_" }, - "6019": { + "6136": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.calculateDiscount_" }, - "6020": { + "6137": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "lineItem" }, - "6021": { + "6138": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "variant" }, - "6022": { + "6139": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "variantPrice" }, - "6023": { + "6140": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "value" }, - "6024": { + "6141": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "discountType" }, - "6025": { + "6142": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getAllocationItemDiscounts" }, - "6026": { + "6143": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getAllocationItemDiscounts" }, - "6027": { + "6144": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "discount" }, - "6028": { + "6145": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cart" }, - "6029": { + "6146": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getLineItemDiscountAdjustment" }, - "6030": { + "6147": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getLineItemDiscountAdjustment" }, - "6031": { + "6148": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "lineItem" }, - "6032": { + "6149": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "discount" }, - "6033": { + "6150": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getLineItemAdjustmentsTotal" }, - "6034": { + "6151": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getLineItemAdjustmentsTotal" }, - "6035": { + "6152": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cartOrOrder" }, - "6036": { + "6153": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getLineDiscounts" }, - "6037": { + "6154": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getLineDiscounts" }, - "6038": { + "6155": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cartOrOrder" }, - "6039": { + "6156": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type" }, - "6040": { + "6157": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type.items" }, - "6041": { + "6158": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type.swaps" }, - "6042": { + "6159": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type.claims" }, - "6043": { + "6160": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "discount" }, - "6044": { + "6161": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getLineItemTotals" }, - "6045": { + "6162": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getLineItemTotals" }, - "6046": { + "6163": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "lineItem" }, - "6047": { + "6164": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cartOrOrder" }, - "6048": { + "6165": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "options" }, - "6049": { + "6166": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getLineItemTotal" }, - "6050": { + "6167": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getLineItemTotal" }, - "6051": { + "6168": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "lineItem" }, - "6052": { + "6169": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cartOrOrder" }, - "6053": { + "6170": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "options" }, - "6054": { + "6171": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getGiftCardableAmount" }, - "6055": { + "6172": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getGiftCardableAmount" }, - "6056": { + "6173": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cartOrOrder" }, - "6057": { + "6174": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getGiftCardTotal" }, - "6058": { + "6175": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getGiftCardTotal" }, - "6059": { + "6176": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cartOrOrder" }, - "6060": { + "6177": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "opts" }, - "6061": { + "6178": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type" }, - "6062": { + "6179": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type.gift_cardable" }, - "6063": { + "6180": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type" }, - "6064": { + "6181": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type.total" }, - "6065": { + "6182": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "__type.tax_total" }, - "6066": { + "6183": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getDiscountTotal" }, - "6067": { + "6184": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getDiscountTotal" }, - "6068": { + "6185": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "cartOrOrder" }, - "6069": { + "6186": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getCalculationContext" }, - "6070": { + "6187": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.getCalculationContext" }, - "6071": { + "6188": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "calculationContextData" }, - "6072": { + "6189": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "options" }, - "6073": { + "6190": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.rounded" }, - "6074": { + "6191": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "TotalsService.rounded" }, - "6075": { + "6192": { "sourceFileName": "../../../packages/medusa/src/services/totals.ts", "qualifiedName": "value" }, - "6076": { + "6193": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "6077": { + "6194": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "6078": { + "6195": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "6079": { + "6196": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "6080": { + "6197": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "6081": { + "6198": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "6082": { + "6199": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "6083": { + "6200": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "6084": { + "6201": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "6085": { + "6202": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "6086": { + "6203": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "6087": { + "6204": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "6088": { + "6205": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "6089": { + "6206": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6090": { + "6207": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "6091": { + "6208": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "6092": { + "6209": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "6093": { + "6210": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "6094": { + "6211": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "6095": { + "6212": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "6096": { + "6213": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6097": { + "6214": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6098": { + "6215": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "6099": { + "6216": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "6100": { + "6217": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6101": { + "6218": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6102": { + "6219": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "6103": { + "6220": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "6104": { + "6221": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6105": { + "6222": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6106": { + "6223": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "6107": { + "6224": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService" }, - "6108": { + "6225": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.Events" }, - "6109": { + "6226": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "__object" }, - "6110": { + "6227": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "__object.PASSWORD_RESET" }, - "6111": { + "6228": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "__object.CREATED" }, - "6112": { + "6229": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "__object.UPDATED" }, - "6113": { + "6230": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "__object.DELETED" }, - "6114": { + "6231": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.__constructor" }, - "6115": { + "6232": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService" }, - "6116": { + "6233": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "__0" }, - "6117": { + "6234": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.analyticsConfigService_" }, - "6118": { + "6235": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.userRepository_" }, - "6119": { + "6236": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.eventBus_" }, - "6120": { + "6237": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.featureFlagRouter_" }, - "6121": { + "6238": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.list" }, - "6122": { + "6239": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.list" }, - "6123": { + "6240": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "selector" }, - "6124": { + "6241": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "config" }, - "6125": { + "6242": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "__object" }, - "6126": { + "6243": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.retrieve" }, - "6127": { + "6244": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.retrieve" }, - "6128": { + "6245": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "userId" }, - "6129": { + "6246": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "config" }, - "6130": { + "6247": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.retrieveByApiToken" }, - "6131": { + "6248": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.retrieveByApiToken" }, - "6132": { + "6249": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "apiToken" }, - "6133": { + "6250": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "relations" }, - "6134": { + "6251": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.retrieveByEmail" }, - "6135": { + "6252": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.retrieveByEmail" }, - "6136": { + "6253": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "email" }, - "6137": { + "6254": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "config" }, - "6138": { + "6255": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.hashPassword_" }, - "6139": { + "6256": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.hashPassword_" }, - "6140": { + "6257": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "password" }, - "6141": { + "6258": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.create" }, - "6142": { + "6259": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.create" }, - "6143": { + "6260": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "user" }, - "6144": { + "6261": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "password" }, - "6145": { + "6262": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.update" }, - "6146": { + "6263": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.update" }, - "6147": { + "6264": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "userId" }, - "6148": { + "6265": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "update" }, - "6149": { + "6266": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.delete" }, - "6150": { + "6267": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.delete" }, - "6151": { + "6268": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "userId" }, - "6152": { + "6269": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.setPassword_" }, - "6153": { + "6270": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.setPassword_" }, - "6154": { + "6271": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "userId" }, - "6155": { + "6272": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "password" }, - "6156": { + "6273": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.generateResetPasswordToken" }, - "6157": { + "6274": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "UserService.generateResetPasswordToken" }, - "6158": { + "6275": { "sourceFileName": "../../../packages/medusa/src/services/user.ts", "qualifiedName": "userId" }, - "6159": { + "6276": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "6160": { + "6277": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "6161": { + "6278": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "6162": { + "6279": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "6163": { + "6280": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "6164": { + "6281": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "6165": { + "6282": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "6166": { + "6283": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "6167": { + "6284": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "6168": { + "6285": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "6169": { + "6286": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "6170": { + "6287": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "6171": { + "6288": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "6172": { + "6289": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6173": { + "6290": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "6174": { + "6291": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "6175": { + "6292": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "6176": { + "6293": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "6177": { + "6294": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "6178": { + "6295": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "6179": { + "6296": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6180": { + "6297": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6181": { + "6298": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "6182": { + "6299": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "6183": { + "6300": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6184": { + "6301": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6185": { + "6302": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "6186": { + "6303": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "6187": { + "6304": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6188": { + "6305": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "6189": { + "6306": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" } diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteCustomerGroupsGroupCustomerBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteCustomerGroupsGroupCustomerBatchReq.ts index 4ca6aceff96e8..dcb21679a577b 100644 --- a/packages/generated/client-types/src/lib/models/AdminDeleteCustomerGroupsGroupCustomerBatchReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminDeleteCustomerGroupsGroupCustomerBatchReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The customers to remove from the customer group. + */ export interface AdminDeleteCustomerGroupsGroupCustomerBatchReq { /** * The ids of the customers to remove diff --git a/packages/generated/client-types/src/lib/models/AdminDeletePriceListPricesPricesReq.ts b/packages/generated/client-types/src/lib/models/AdminDeletePriceListPricesPricesReq.ts index 0d905722b893e..15b75b8f8a7ef 100644 --- a/packages/generated/client-types/src/lib/models/AdminDeletePriceListPricesPricesReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminDeletePriceListPricesPricesReq.ts @@ -3,9 +3,12 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the prices to delete. + */ export interface AdminDeletePriceListPricesPricesReq { /** - * The price IDs of the Money Amounts to delete. + * The IDs of the prices to delete. */ price_ids?: Array } diff --git a/packages/generated/client-types/src/lib/models/AdminDeletePriceListsPriceListProductsPricesBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminDeletePriceListsPriceListProductsPricesBatchReq.ts index 54df98202a6a2..feb4b5922e421 100644 --- a/packages/generated/client-types/src/lib/models/AdminDeletePriceListsPriceListProductsPricesBatchReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminDeletePriceListsPriceListProductsPricesBatchReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the products' prices to delete. + */ export interface AdminDeletePriceListsPriceListProductsPricesBatchReq { /** * The IDs of the products to delete their associated prices. diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteProductCategoriesCategoryProductsBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteProductCategoriesCategoryProductsBatchReq.ts index ae5cf7a88d784..b25e2c97d653f 100644 --- a/packages/generated/client-types/src/lib/models/AdminDeleteProductCategoriesCategoryProductsBatchReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminDeleteProductCategoriesCategoryProductsBatchReq.ts @@ -3,9 +3,12 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the products to delete from the product category. + */ export interface AdminDeleteProductCategoriesCategoryProductsBatchReq { /** - * The IDs of the products to delete from the Product Category. + * The IDs of the products to delete from the product category. */ product_ids: Array<{ /** diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteProductsFromCollectionReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteProductsFromCollectionReq.ts index 56e8b680cc8ae..cd745671a1c55 100644 --- a/packages/generated/client-types/src/lib/models/AdminDeleteProductsFromCollectionReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminDeleteProductsFromCollectionReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the products to remove from the collection. + */ export interface AdminDeleteProductsFromCollectionReq { /** * An array of Product IDs to remove from the Product Collection. diff --git a/packages/generated/client-types/src/lib/models/AdminDeletePublishableApiKeySalesChannelsBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminDeletePublishableApiKeySalesChannelsBatchReq.ts index dc2f9e9a79b44..d6ff4851bbb50 100644 --- a/packages/generated/client-types/src/lib/models/AdminDeletePublishableApiKeySalesChannelsBatchReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminDeletePublishableApiKeySalesChannelsBatchReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the sales channels to remove from the publishable API key. + */ export interface AdminDeletePublishableApiKeySalesChannelsBatchReq { /** * The IDs of the sales channels to remove from the publishable API key diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteSalesChannelsChannelProductsBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteSalesChannelsChannelProductsBatchReq.ts index b603e2dd78a7a..c0b0255a74943 100644 --- a/packages/generated/client-types/src/lib/models/AdminDeleteSalesChannelsChannelProductsBatchReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminDeleteSalesChannelsChannelProductsBatchReq.ts @@ -3,9 +3,12 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the products to delete from the sales channel. + */ export interface AdminDeleteSalesChannelsChannelProductsBatchReq { /** - * The IDs of the products to remove from the Sales Channel. + * The IDs of the products to remove from the sales channel. */ product_ids: Array<{ /** diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductsReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductsReq.ts index 4c17f496162fe..36e7bb06737c3 100644 --- a/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the products to remove their associated with the tax rate. + */ export interface AdminDeleteTaxRatesTaxRateProductsReq { /** * The IDs of the products to remove their association with this tax rate. diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateShippingOptionsReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateShippingOptionsReq.ts index 0872cc7bd79a9..7b8c69b86a977 100644 --- a/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateShippingOptionsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateShippingOptionsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the shipping options to remove their associate with the tax rate. + */ export interface AdminDeleteTaxRatesTaxRateShippingOptionsReq { /** * The IDs of the shipping options to remove their association with this tax rate. diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteUploadsReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteUploadsReq.ts index 85c5c188c6bf4..6a29a88847e2f 100644 --- a/packages/generated/client-types/src/lib/models/AdminDeleteUploadsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminDeleteUploadsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the file to delete. + */ export interface AdminDeleteUploadsReq { /** * 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. diff --git a/packages/generated/client-types/src/lib/models/AdminPaymentCollectionsRes.ts b/packages/generated/client-types/src/lib/models/AdminPaymentCollectionsRes.ts index 47c6434dc955e..d86f4f74df138 100644 --- a/packages/generated/client-types/src/lib/models/AdminPaymentCollectionsRes.ts +++ b/packages/generated/client-types/src/lib/models/AdminPaymentCollectionsRes.ts @@ -6,6 +6,9 @@ import { SetRelation, Merge } from "../core/ModelUtils" import type { PaymentCollection } from "./PaymentCollection" import type { Region } from "./Region" +/** + * The payment collection's details. + */ export interface AdminPaymentCollectionsRes { /** * Payment Collection details. diff --git a/packages/generated/client-types/src/lib/models/AdminPostAuthReq.ts b/packages/generated/client-types/src/lib/models/AdminPostAuthReq.ts index 4035adb976d0b..e1cb0e818cbf6 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostAuthReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostAuthReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The admin's credentials used to log in. + */ export interface AdminPostAuthReq { /** * The user's email. diff --git a/packages/generated/client-types/src/lib/models/AdminPostBatchesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostBatchesReq.ts index 07ad34cc60548..51d4da190d3c9 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostBatchesReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostBatchesReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the batch job to create. + */ export interface AdminPostBatchesReq { /** * The type of batch job to start, which is defined by the `batchType` property of the associated batch job strategy. diff --git a/packages/generated/client-types/src/lib/models/AdminPostCollectionsCollectionReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCollectionsCollectionReq.ts index e13e3e1eb30f3..0a6cf316aa0c7 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostCollectionsCollectionReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostCollectionsCollectionReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The product collection's details to update. + */ export interface AdminPostCollectionsCollectionReq { /** * The title of the collection. diff --git a/packages/generated/client-types/src/lib/models/AdminPostCollectionsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCollectionsReq.ts index 6c1b69c44904c..605e5fc488c79 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostCollectionsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostCollectionsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The product collection's details. + */ export interface AdminPostCollectionsReq { /** * The title of the collection. diff --git a/packages/generated/client-types/src/lib/models/AdminPostCurrenciesCurrencyReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCurrenciesCurrencyReq.ts index 1d4f3c53488af..5fb5b1284758f 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostCurrenciesCurrencyReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostCurrenciesCurrencyReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update in the currency + */ export interface AdminPostCurrenciesCurrencyReq { /** * Tax included in prices of currency. diff --git a/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupCustomersBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupCustomersBatchReq.ts index 156b348634abf..6057cf2b4e819 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupCustomersBatchReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupCustomersBatchReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The customers to add to the customer group. + */ export interface AdminPostCustomerGroupsGroupCustomersBatchReq { /** * The ids of the customers to add diff --git a/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupReq.ts index 5c66766aed9f7..d62e699f53e06 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update in the customer group. + */ export interface AdminPostCustomerGroupsGroupReq { /** * Name of the customer group diff --git a/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsReq.ts index f02e319bbec16..6c59b0eaa88dc 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the customer group to create. + */ export interface AdminPostCustomerGroupsReq { /** * Name of the customer group diff --git a/packages/generated/client-types/src/lib/models/AdminPostCustomersCustomerReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCustomersCustomerReq.ts index fab9996fc964c..f974739d0a4a7 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostCustomersCustomerReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostCustomersCustomerReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the customer to update. + */ export interface AdminPostCustomersCustomerReq { /** * The Customer's email. You can't update the email of a registered customer. diff --git a/packages/generated/client-types/src/lib/models/AdminPostCustomersReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCustomersReq.ts index eb63fd55eafa0..dc62bb8e171f7 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostCustomersReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostCustomersReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the customer to create. + */ export interface AdminPostCustomersReq { /** * The customer's email. diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionBatchReq.ts index 777ef0eaa8ecd..ee2422374bf07 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionBatchReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionBatchReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the resources to add. + */ export interface AdminPostDiscountsDiscountConditionsConditionBatchReq { /** * The resources to be added to the discount condition diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountDynamicCodesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountDynamicCodesReq.ts index 7e6eaf748ea5e..767239986966d 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountDynamicCodesReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountDynamicCodesReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the dynamic discount to create. + */ export interface AdminPostDiscountsDiscountDynamicCodesReq { /** * A unique code that will be used to redeem the Discount diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountReq.ts index c34f2bdd253d3..ea72274487b92 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the discount to update. + */ export interface AdminPostDiscountsDiscountReq { /** * A unique code that will be used to redeem the discount diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsReq.ts index 53a94cb7815c3..e4df80ed3da09 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostDiscountsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the discount to create. + */ export interface AdminPostDiscountsReq { /** * A unique code that will be used to redeem the discount diff --git a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsItemReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsItemReq.ts index 7aa9bfd5df7d0..34124d810c66a 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsItemReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsItemReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the line item. + */ export interface AdminPostDraftOrdersDraftOrderLineItemsItemReq { /** * The custom price of the line item. If a `variant_id` is supplied, the price provided here will override the variant's price. diff --git a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsReq.ts index 33a2fd389daac..cc260234d10e8 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the line item to create. + */ export interface AdminPostDraftOrdersDraftOrderLineItemsReq { /** * The ID of the Product Variant associated with the line item. If the line item is custom, the `variant_id` should be omitted. diff --git a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderReq.ts index ee6f6bf805967..87fcff3fafd3b 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderReq.ts @@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils" import type { AddressPayload } from "./AddressPayload" +/** + * The details of the draft order to update. + */ export interface AdminPostDraftOrdersDraftOrderReq { /** * The ID of the Region to create the Draft Order in. diff --git a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersReq.ts index 10f7ed2dc59c8..f577a6f04c370 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersReq.ts @@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils" import type { AddressPayload } from "./AddressPayload" +/** + * The details of the draft order to create. + */ export interface AdminPostDraftOrdersReq { /** * 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. diff --git a/packages/generated/client-types/src/lib/models/AdminPostGiftCardsGiftCardReq.ts b/packages/generated/client-types/src/lib/models/AdminPostGiftCardsGiftCardReq.ts index 01f370e5968e2..8ad7da41d8617 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostGiftCardsGiftCardReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostGiftCardsGiftCardReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the gift card. + */ export interface AdminPostGiftCardsGiftCardReq { /** * The value (excluding VAT) that the Gift Card should represent. diff --git a/packages/generated/client-types/src/lib/models/AdminPostGiftCardsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostGiftCardsReq.ts index 622ebea381729..9fde24029b966 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostGiftCardsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostGiftCardsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the gift card to create. + */ export interface AdminPostGiftCardsReq { /** * The value (excluding VAT) that the Gift Card should represent. diff --git a/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsReq.ts index 2089a7fd03f18..4889b3c77e3e1 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the location level to create. + */ export interface AdminPostInventoryItemsItemLocationLevelsReq { /** * the ID of the stock location diff --git a/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsReq.ts index 430d4b5d54eba..a2ae904b96abd 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the inventory item to create. + */ export interface AdminPostInventoryItemsReq { /** * The ID of the variant to create the inventory item for. diff --git a/packages/generated/client-types/src/lib/models/AdminPostNotesNoteReq.ts b/packages/generated/client-types/src/lib/models/AdminPostNotesNoteReq.ts index 56f5559e0ecf7..d32867586fde7 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostNotesNoteReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostNotesNoteReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the note. + */ export interface AdminPostNotesNoteReq { /** * The description of the Note. diff --git a/packages/generated/client-types/src/lib/models/AdminPostNotesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostNotesReq.ts index b577cfd0d4f4a..5e54577becb70 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostNotesReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostNotesReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the note to be created. + */ export interface AdminPostNotesReq { /** * The ID of the resource which the Note relates to. For example, an order ID. diff --git a/packages/generated/client-types/src/lib/models/AdminPostNotificationsNotificationResendReq.ts b/packages/generated/client-types/src/lib/models/AdminPostNotificationsNotificationResendReq.ts index 3d429724b6797..c1aaa4e65f81d 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostNotificationsNotificationResendReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostNotificationsNotificationResendReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The resend details. + */ export interface AdminPostNotificationsNotificationResendReq { /** * 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. diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsLineItemReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsLineItemReq.ts index df10e55219c2f..2d750a3737f2d 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsLineItemReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsLineItemReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to create or update of the line item change. + */ export interface AdminPostOrderEditsEditLineItemsLineItemReq { /** * The quantity to update diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsReq.ts index 561fff1bda82a..7fb4124998a9a 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the line item change to create. + */ export interface AdminPostOrderEditsEditLineItemsReq { /** * The ID of the product variant associated with the item. diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrderEditsOrderEditReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsOrderEditReq.ts index 23b0a62cf6d47..e59ad7b3da6a7 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostOrderEditsOrderEditReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsOrderEditReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the order edit. + */ export interface AdminPostOrderEditsOrderEditReq { /** * An optional note to create or update in the order edit. diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrderEditsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsReq.ts index 159c81cc67154..cfaae1c20c643 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostOrderEditsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the order edit to create. + */ export interface AdminPostOrderEditsReq { /** * The ID of the order to create the edit for. diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderRefundsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderRefundsReq.ts index ea31abd48420b..a0d5e02875a14 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderRefundsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderRefundsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the order refund. + */ export interface AdminPostOrdersOrderRefundsReq { /** * The amount to refund. It should be less than or equal the `refundable_amount` of the order. diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReq.ts index 00897ab79ca8f..bd613f644106c 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReq.ts @@ -7,6 +7,9 @@ import type { AddressPayload } from "./AddressPayload" import type { Discount } from "./Discount" import type { LineItem } from "./LineItem" +/** + * The details to update of the order. + */ export interface AdminPostOrdersOrderReq { /** * The email associated with the order diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReturnsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReturnsReq.ts index 0b7e23001e6a3..a1dacf6c4c392 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReturnsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReturnsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the requested return. + */ export interface AdminPostOrdersOrderReturnsReq { /** * The line items that will be returned. diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderShipmentReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderShipmentReq.ts index 143f9b8327107..94a12a4dc83f4 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderShipmentReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderShipmentReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the shipment to create. + */ export interface AdminPostOrdersOrderShipmentReq { /** * The ID of the Fulfillment. diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsReq.ts index 1a0be7c9b130e..104a14d1f9816 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the swap to create. + */ export interface AdminPostOrdersOrderSwapsReq { /** * The Line Items to associate with the swap's return. diff --git a/packages/generated/client-types/src/lib/models/AdminPostPaymentRefundsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPaymentRefundsReq.ts index 95ae412c4366b..32ca6bd3d193c 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostPaymentRefundsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostPaymentRefundsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the refund to create. + */ export interface AdminPostPaymentRefundsReq { /** * The amount to refund. diff --git a/packages/generated/client-types/src/lib/models/AdminPostPriceListPricesPricesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPriceListPricesPricesReq.ts index 16fdf4e165d74..e92b51fb9e40e 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostPriceListPricesPricesReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostPriceListPricesPricesReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the prices to add. + */ export interface AdminPostPriceListPricesPricesReq { /** * The prices to update or add. diff --git a/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListPriceListReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListPriceListReq.ts index 6ef67500785a3..e3c5484895bcb 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListPriceListReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListPriceListReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the payment collection. + */ export interface AdminPostPriceListsPriceListPriceListReq { /** * The name of the Price List diff --git a/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListReq.ts index 20db6307a3c90..34d6bd22b3402 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the price list to create. + */ export interface AdminPostPriceListsPriceListReq { /** * The name of the Price List. diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryProductsBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryProductsBatchReq.ts index 3397dcecefeca..5a307207a0054 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryProductsBatchReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryProductsBatchReq.ts @@ -3,9 +3,12 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the products to add to the product category. + */ export interface AdminPostProductCategoriesCategoryProductsBatchReq { /** - * The IDs of the products to add to the Product Category + * The IDs of the products to add to the product category */ product_ids: Array<{ /** diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryReq.ts index 1b97e3ba48e9b..4e69f16d1b88c 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the product category. + */ export interface AdminPostProductCategoriesCategoryReq { /** * The name to identify the Product Category by. diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesReq.ts index edb17f41bfcd8..d7f0def78a58c 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the product category to create. + */ export interface AdminPostProductCategoriesReq { /** * The name of the product category diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsProductOptionsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsProductOptionsReq.ts index 3f63474876b99..2f8e755a96c29 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostProductsProductOptionsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsProductOptionsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the product option to create. + */ export interface AdminPostProductsProductOptionsReq { /** * The title the Product Option. diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsProductReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsProductReq.ts index 8ba2ec36e6e58..204961ddf237b 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostProductsProductReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsProductReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the product. + */ export interface AdminPostProductsProductReq { /** * The title of the Product diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsProductVariantsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsProductVariantsReq.ts index 4c50aa10e9bc0..319441cfddc4f 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostProductsProductVariantsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsProductVariantsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the product variant to create. + */ export interface AdminPostProductsProductVariantsReq { /** * The title of the product variant. diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsReq.ts index fd1ff73f1fdf0..bf16d3eb5b884 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostProductsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the product to create. + */ export interface AdminPostProductsReq { /** * The title of the Product diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsToCollectionReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsToCollectionReq.ts index 3003612160d9f..2827f562e5078 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostProductsToCollectionReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsToCollectionReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the products to add to the collection. + */ export interface AdminPostProductsToCollectionReq { /** * An array of Product IDs to add to the Product Collection. diff --git a/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeySalesChannelsBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeySalesChannelsBatchReq.ts index ede163465ff79..2ad2a473041fb 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeySalesChannelsBatchReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeySalesChannelsBatchReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the sales channels to add to the publishable API key. + */ export interface AdminPostPublishableApiKeySalesChannelsBatchReq { /** * The IDs of the sales channels to add to the publishable API key diff --git a/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysPublishableApiKeyReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysPublishableApiKeyReq.ts index 34fd55ce4057b..c86d1de7a5820 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysPublishableApiKeyReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysPublishableApiKeyReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the publishable API key. + */ export interface AdminPostPublishableApiKeysPublishableApiKeyReq { /** * The title of the Publishable API Key. diff --git a/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysReq.ts index 2e3c0c4d540fa..1e4997b3e8e9a 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the publishable API key to create. + */ export interface AdminPostPublishableApiKeysReq { /** * The title of the publishable API key diff --git a/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionCountriesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionCountriesReq.ts index adcfe4a254759..f3b5e5ee813d8 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionCountriesReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionCountriesReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the country to add to the region. + */ export interface AdminPostRegionsRegionCountriesReq { /** * The 2 character ISO code for the Country. diff --git a/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionFulfillmentProvidersReq.ts b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionFulfillmentProvidersReq.ts index 7274cab75c621..75be0dda72e0e 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionFulfillmentProvidersReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionFulfillmentProvidersReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the fulfillment provider to add to the region. + */ export interface AdminPostRegionsRegionFulfillmentProvidersReq { /** * The ID of the Fulfillment Provider. diff --git a/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionPaymentProvidersReq.ts b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionPaymentProvidersReq.ts index b9524becc212e..5bc3a5aab0375 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionPaymentProvidersReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionPaymentProvidersReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the payment provider to add to the region. + */ export interface AdminPostRegionsRegionPaymentProvidersReq { /** * The ID of the Payment Provider. diff --git a/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionReq.ts b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionReq.ts index 010edf302388b..05a576356714f 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the regions. + */ export interface AdminPostRegionsRegionReq { /** * The name of the Region diff --git a/packages/generated/client-types/src/lib/models/AdminPostRegionsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostRegionsReq.ts index a3f146225df44..de1f0679d9bef 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostRegionsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostRegionsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the region to create. + */ export interface AdminPostRegionsReq { /** * The name of the Region diff --git a/packages/generated/client-types/src/lib/models/AdminPostReservationsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostReservationsReq.ts index 5806f2d331de0..6a7f2e984624b 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostReservationsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostReservationsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the reservation to create. + */ export interface AdminPostReservationsReq { /** * The ID of the line item of the reservation. diff --git a/packages/generated/client-types/src/lib/models/AdminPostReservationsReservationReq.ts b/packages/generated/client-types/src/lib/models/AdminPostReservationsReservationReq.ts index fb6bb939da347..fbd6c18bb7000 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostReservationsReservationReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostReservationsReservationReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the reservation. + */ export interface AdminPostReservationsReservationReq { /** * The ID of the location associated with the reservation. diff --git a/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReasonReq.ts b/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReasonReq.ts index 5ae9bce9a35a0..15161d2db2430 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReasonReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReasonReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the return reason. + */ export interface AdminPostReturnReasonsReasonReq { /** * The label to display to the Customer. diff --git a/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReq.ts index ad093a2a85ae1..799fdb89a4ac9 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the return reason to create. + */ export interface AdminPostReturnReasonsReq { /** * The label to display to the Customer. diff --git a/packages/generated/client-types/src/lib/models/AdminPostReturnsReturnReceiveReq.ts b/packages/generated/client-types/src/lib/models/AdminPostReturnsReturnReceiveReq.ts index 76c24ef1d790a..a739dfa497479 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostReturnsReturnReceiveReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostReturnsReturnReceiveReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the received return. + */ export interface AdminPostReturnsReturnReceiveReq { /** * The Line Items that have been received. diff --git a/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsChannelProductsBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsChannelProductsBatchReq.ts index a20f0baf5a5ee..19680cd7b4cc5 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsChannelProductsBatchReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsChannelProductsBatchReq.ts @@ -3,9 +3,12 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the products to add to the sales channel. + */ export interface AdminPostSalesChannelsChannelProductsBatchReq { /** - * The IDs of the products to add to the Sales Channel + * The IDs of the products to add to the sales channel */ product_ids: Array<{ /** diff --git a/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsReq.ts index c316e642e4497..8b02425a2ed16 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the sales channel to create. + */ export interface AdminPostSalesChannelsReq { /** * The name of the Sales Channel diff --git a/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsSalesChannelReq.ts b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsSalesChannelReq.ts index 25065f50e4fc6..f1e1c82b51de5 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsSalesChannelReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsSalesChannelReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the sales channel. + */ export interface AdminPostSalesChannelsSalesChannelReq { /** * The name of the sales channel diff --git a/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsOptionReq.ts b/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsOptionReq.ts index ad393120d27a8..f7059a957d0eb 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsOptionReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsOptionReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the shipping option. + */ export interface AdminPostShippingOptionsOptionReq { /** * The name of the Shipping Option diff --git a/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsReq.ts index 3732f64450377..696cc25791c3b 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the shipping option to create. + */ export interface AdminPostShippingOptionsReq { /** * The name of the Shipping Option diff --git a/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesProfileReq.ts b/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesProfileReq.ts index f735a73794c8e..e8554bc30d03a 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesProfileReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesProfileReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The detail to update of the shipping profile. + */ export interface AdminPostShippingProfilesProfileReq { /** * The name of the Shipping Profile diff --git a/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesReq.ts index 3b036517860c7..2cc4d2eadabd4 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the shipping profile to create. + */ export interface AdminPostShippingProfilesReq { /** * The name of the Shipping Profile diff --git a/packages/generated/client-types/src/lib/models/AdminPostStockLocationsLocationReq.ts b/packages/generated/client-types/src/lib/models/AdminPostStockLocationsLocationReq.ts index 2547849afd615..8cf082fc28f8e 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostStockLocationsLocationReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostStockLocationsLocationReq.ts @@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils" import type { StockLocationAddressInput } from "./StockLocationAddressInput" +/** + * The details to update of the stock location. + */ export interface AdminPostStockLocationsLocationReq { /** * the name of the stock location diff --git a/packages/generated/client-types/src/lib/models/AdminPostStockLocationsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostStockLocationsReq.ts index 27d68aa3d66db..b8f7b1bee7e00 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostStockLocationsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostStockLocationsReq.ts @@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils" import type { StockLocationAddressInput } from "./StockLocationAddressInput" +/** + * The details of the stock location to create. + */ export interface AdminPostStockLocationsReq { /** * the name of the stock location diff --git a/packages/generated/client-types/src/lib/models/AdminPostStoreReq.ts b/packages/generated/client-types/src/lib/models/AdminPostStoreReq.ts index 2defa77d97d94..a8c360064cace 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostStoreReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostStoreReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the store. + */ export interface AdminPostStoreReq { /** * The name of the Store diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesReq.ts index c9234e0746ec0..c5db7daf422c2 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the tax rate to create. + */ export interface AdminPostTaxRatesReq { /** * The code of the tax rate. diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductsReq.ts index ed7bfb1677be3..df7b5ed21d3ca 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the products to associat with the tax rate. + */ export interface AdminPostTaxRatesTaxRateProductsReq { /** * The IDs of the products to associate with this tax rate diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateReq.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateReq.ts index c7e22cb8c5548..e659bc54c66ed 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the tax rate. + */ export interface AdminPostTaxRatesTaxRateReq { /** * The code of the tax rate. diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateShippingOptionsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateShippingOptionsReq.ts index a4038264d2ed7..c8b776a62856e 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateShippingOptionsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateShippingOptionsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the shipping options to associate with the tax rate. + */ export interface AdminPostTaxRatesTaxRateShippingOptionsReq { /** * The IDs of the shipping options to associate with this tax rate diff --git a/packages/generated/client-types/src/lib/models/AdminPostUploadsDownloadUrlReq.ts b/packages/generated/client-types/src/lib/models/AdminPostUploadsDownloadUrlReq.ts index 162c62e3992ee..fc8e8f94f10fd 100644 --- a/packages/generated/client-types/src/lib/models/AdminPostUploadsDownloadUrlReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminPostUploadsDownloadUrlReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the file to retrieve its download URL. + */ export interface AdminPostUploadsDownloadUrlReq { /** * 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. diff --git a/packages/generated/client-types/src/lib/models/AdminResetPasswordRequest.ts b/packages/generated/client-types/src/lib/models/AdminResetPasswordRequest.ts index b4109024b98e6..2493fe170662d 100644 --- a/packages/generated/client-types/src/lib/models/AdminResetPasswordRequest.ts +++ b/packages/generated/client-types/src/lib/models/AdminResetPasswordRequest.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the password reset request. + */ export interface AdminResetPasswordRequest { /** * The User's email. diff --git a/packages/generated/client-types/src/lib/models/AdminResetPasswordTokenRequest.ts b/packages/generated/client-types/src/lib/models/AdminResetPasswordTokenRequest.ts index fa0133e47ced8..1cdfe63e7cbd6 100644 --- a/packages/generated/client-types/src/lib/models/AdminResetPasswordTokenRequest.ts +++ b/packages/generated/client-types/src/lib/models/AdminResetPasswordTokenRequest.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the password reset token request. + */ export interface AdminResetPasswordTokenRequest { /** * The User's email. diff --git a/packages/generated/client-types/src/lib/models/AdminStockLocationsListRes.ts b/packages/generated/client-types/src/lib/models/AdminStockLocationsListRes.ts index 461de6f7ae1f7..903b36f000851 100644 --- a/packages/generated/client-types/src/lib/models/AdminStockLocationsListRes.ts +++ b/packages/generated/client-types/src/lib/models/AdminStockLocationsListRes.ts @@ -9,6 +9,9 @@ import type { StockLocationExpandedDTO } from "./StockLocationExpandedDTO" * The list of stock locations with pagination fields. */ export interface AdminStockLocationsListRes { + /** + * The list of stock locations. + */ stock_locations: Array /** * The total number of items available diff --git a/packages/generated/client-types/src/lib/models/AdminUpdatePaymentCollectionsReq.ts b/packages/generated/client-types/src/lib/models/AdminUpdatePaymentCollectionsReq.ts index a4bf4d3a7f348..ea265c210d6ec 100644 --- a/packages/generated/client-types/src/lib/models/AdminUpdatePaymentCollectionsReq.ts +++ b/packages/generated/client-types/src/lib/models/AdminUpdatePaymentCollectionsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the payment collection. + */ export interface AdminUpdatePaymentCollectionsReq { /** * A description to create or update the payment collection. diff --git a/packages/generated/client-types/src/lib/models/StorePaymentCollectionSessionsReq.ts b/packages/generated/client-types/src/lib/models/StorePaymentCollectionSessionsReq.ts index 67425573e6b12..23a7eb8c7b31a 100644 --- a/packages/generated/client-types/src/lib/models/StorePaymentCollectionSessionsReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePaymentCollectionSessionsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the payment session to manage. + */ export interface StorePaymentCollectionSessionsReq { /** * The ID of the Payment Provider. diff --git a/packages/generated/client-types/src/lib/models/StorePaymentCollectionsSessionRes.ts b/packages/generated/client-types/src/lib/models/StorePaymentCollectionsSessionRes.ts index e5c67195a02d7..22a813c152ba3 100644 --- a/packages/generated/client-types/src/lib/models/StorePaymentCollectionsSessionRes.ts +++ b/packages/generated/client-types/src/lib/models/StorePaymentCollectionsSessionRes.ts @@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils" import type { PaymentSession } from "./PaymentSession" +/** + * The details of the payment session. + */ export interface StorePaymentCollectionsSessionRes { /** * Payment session's details. diff --git a/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsItemReq.ts b/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsItemReq.ts index 1fff6e030407f..4a6ed016a9024 100644 --- a/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsItemReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsItemReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details to update of the line item. + */ export interface StorePostCartsCartLineItemsItemReq { /** * The quantity of the line item in the cart. diff --git a/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsReq.ts b/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsReq.ts index 22c21cf5b9c6d..c5a64dbb2c041 100644 --- a/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the line item to create. + */ export interface StorePostCartsCartLineItemsReq { /** * The id of the Product Variant to generate the Line Item from. diff --git a/packages/generated/client-types/src/lib/models/StorePostCartsCartPaymentSessionReq.ts b/packages/generated/client-types/src/lib/models/StorePostCartsCartPaymentSessionReq.ts index 1d465565cc135..34eff65f0da87 100644 --- a/packages/generated/client-types/src/lib/models/StorePostCartsCartPaymentSessionReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostCartsCartPaymentSessionReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the payment session to set. + */ export interface StorePostCartsCartPaymentSessionReq { /** * The ID of the Payment Provider. diff --git a/packages/generated/client-types/src/lib/models/StorePostCartsCartReq.ts b/packages/generated/client-types/src/lib/models/StorePostCartsCartReq.ts index c318cd0644f0b..a4f2190ccbcf2 100644 --- a/packages/generated/client-types/src/lib/models/StorePostCartsCartReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostCartsCartReq.ts @@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils" import type { AddressPayload } from "./AddressPayload" +/** + * The details to update of the cart. + */ export interface StorePostCartsCartReq { /** * 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. diff --git a/packages/generated/client-types/src/lib/models/StorePostCartsCartShippingMethodReq.ts b/packages/generated/client-types/src/lib/models/StorePostCartsCartShippingMethodReq.ts index 848c60b3434bf..56d2731d3f7df 100644 --- a/packages/generated/client-types/src/lib/models/StorePostCartsCartShippingMethodReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostCartsCartShippingMethodReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the shipping method to add to the cart. + */ export interface StorePostCartsCartShippingMethodReq { /** * ID of the shipping option to create the method from. diff --git a/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAcceptClaimReq.ts b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAcceptClaimReq.ts index fc89eb5d0b761..1f484090df808 100644 --- a/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAcceptClaimReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAcceptClaimReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details necessary to grant order access. + */ export interface StorePostCustomersCustomerAcceptClaimReq { /** * The claim token generated by previous request to the Claim Order API Route. diff --git a/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerOrderClaimReq.ts b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerOrderClaimReq.ts index 279432e1d72c9..8af4b21bbdf61 100644 --- a/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerOrderClaimReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerOrderClaimReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the orders to claim. + */ export interface StorePostCustomersCustomerOrderClaimReq { /** * The ID of the orders to claim diff --git a/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerReq.ts b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerReq.ts index dbfd4a896e6b8..7077fd87c1818 100644 --- a/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerReq.ts @@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils" import type { AddressPayload } from "./AddressPayload" +/** + * The details to update of the customer. + */ export interface StorePostCustomersCustomerReq { /** * The customer's first name. diff --git a/packages/generated/client-types/src/lib/models/StorePostCustomersReq.ts b/packages/generated/client-types/src/lib/models/StorePostCustomersReq.ts index e0529a552d93a..015ee9dc27167 100644 --- a/packages/generated/client-types/src/lib/models/StorePostCustomersReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostCustomersReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the customer to create. + */ export interface StorePostCustomersReq { /** * The customer's first name. diff --git a/packages/generated/client-types/src/lib/models/StorePostOrderEditsOrderEditDecline.ts b/packages/generated/client-types/src/lib/models/StorePostOrderEditsOrderEditDecline.ts index 5360a2fc78e56..078fcd90b4115 100644 --- a/packages/generated/client-types/src/lib/models/StorePostOrderEditsOrderEditDecline.ts +++ b/packages/generated/client-types/src/lib/models/StorePostOrderEditsOrderEditDecline.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the order edit's decline. + */ export interface StorePostOrderEditsOrderEditDecline { /** * The reason for declining the Order Edit. diff --git a/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.ts b/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.ts index 24b2f85b83d72..8cc278f3efa68 100644 --- a/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the payment sessions to authorize. + */ export interface StorePostPaymentCollectionsBatchSessionsAuthorizeReq { /** * List of Payment Session IDs to authorize. diff --git a/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsReq.ts b/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsReq.ts index 860417861512c..c2d6ace23b567 100644 --- a/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the payment sessions to manage. + */ export interface StorePostPaymentCollectionsBatchSessionsReq { /** * Payment sessions related to the Payment Collection. Existing sessions that are not added in this array will be deleted. diff --git a/packages/generated/client-types/src/lib/models/StorePostReturnsReq.ts b/packages/generated/client-types/src/lib/models/StorePostReturnsReq.ts index eca9358ef8756..339aa64c90b7a 100644 --- a/packages/generated/client-types/src/lib/models/StorePostReturnsReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostReturnsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the return to create. + */ export interface StorePostReturnsReq { /** * The ID of the Order to create the return for. diff --git a/packages/generated/client-types/src/lib/models/StorePostSwapsReq.ts b/packages/generated/client-types/src/lib/models/StorePostSwapsReq.ts index fee2d717bef7e..16e788ea237cb 100644 --- a/packages/generated/client-types/src/lib/models/StorePostSwapsReq.ts +++ b/packages/generated/client-types/src/lib/models/StorePostSwapsReq.ts @@ -3,6 +3,9 @@ /* eslint-disable */ import { SetRelation, Merge } from "../core/ModelUtils" +/** + * The details of the swap to create. + */ export interface StorePostSwapsReq { /** * The ID of the Order to create the Swap for. diff --git a/packages/medusa-js/src/resources/admin/draft-orders.ts b/packages/medusa-js/src/resources/admin/draft-orders.ts index 7bdf20c9716a1..cb356660f16a2 100644 --- a/packages/medusa-js/src/resources/admin/draft-orders.ts +++ b/packages/medusa-js/src/resources/admin/draft-orders.ts @@ -87,7 +87,7 @@ class AdminDraftOrdersResource extends BaseResource { } /** - * Delete a Draft Order + * Delete a Draft Order. * @param {string} id - The ID of the draft order. * @param {Record} customHeaders - Custom headers to attach to the request. * @returns {ResponsePromise} Resolves to the deletion operation details. diff --git a/packages/medusa-js/src/resources/admin/gift-cards.ts b/packages/medusa-js/src/resources/admin/gift-cards.ts index ed07a80d5e9d8..fb5685b4fb1ef 100644 --- a/packages/medusa-js/src/resources/admin/gift-cards.ts +++ b/packages/medusa-js/src/resources/admin/gift-cards.ts @@ -23,7 +23,7 @@ import BaseResource from "../base" */ class AdminGiftCardsResource extends BaseResource { /** - * Create a gift card that can redeemed by its unique code. The Gift Card is only valid within `1` region. + * Create a gift card that can redeemed by its unique code. The Gift Card is only valid within one region. * @param {AdminPostGiftCardsReq} payload - The gift card to be created. * @param {Record} customHeaders - Custom headers to attach to the request. * @returns {ResponsePromise} Resolves to the gift card's details. diff --git a/packages/medusa-js/src/resources/admin/inventory-item.ts b/packages/medusa-js/src/resources/admin/inventory-item.ts index 489522d5a0693..c58bc19fb0c95 100644 --- a/packages/medusa-js/src/resources/admin/inventory-item.ts +++ b/packages/medusa-js/src/resources/admin/inventory-item.ts @@ -162,15 +162,6 @@ class AdminInventoryItemsResource extends BaseResource { * @returns {ResponsePromise} The list of inventory items with pagination fields. * * @example - * import Medusa from "@medusajs/medusa-js" - * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - * // must be previously logged in or use api token - * medusa.admin.inventoryItems.list() - * .then(({ inventory_items, count, offset, limit }) => { - * console.log(inventory_items.length); - * }) - * - * @example * To list inventory items: * * ```ts diff --git a/packages/medusa-js/src/resources/admin/orders.ts b/packages/medusa-js/src/resources/admin/orders.ts index 39fdb4f3bc588..3bb36506da563 100644 --- a/packages/medusa-js/src/resources/admin/orders.ts +++ b/packages/medusa-js/src/resources/admin/orders.ts @@ -34,7 +34,7 @@ import BaseResource from "../base" */ class AdminOrdersResource extends BaseResource { /** - * Update and order's details. + * Update an order's details. * @param {string} id - The order's ID. * @param {AdminPostOrdersOrderReq} payload - The attributes to update in the order. * @param {Record} customHeaders - Custom headers to attach to the request. @@ -248,7 +248,7 @@ class AdminOrdersResource extends BaseResource { /** * 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 - * whether all the items were fulfilled. + * whether all the items were fulfilled. * @param {string} id - The ID of the order that the fulfillment belongs to. * @param {AdminPostOrdersOrderFulfillmentsReq} payload - The fulfillment to be created. * @param {Record} customHeaders - Custom headers to attach to the request. @@ -513,7 +513,7 @@ class AdminOrdersResource extends BaseResource { * ] * }) * .then(({ order }) => { - * console.log(order.id); + * console.log(order.swaps); * }) */ createSwap( @@ -642,7 +642,7 @@ class AdminOrdersResource extends BaseResource { * @param {string} id - The order's ID. * @param {AdminPostOrdersOrderClaimsReq} payload - The claim to be created. * @param {Record} customHeaders - Custom headers to attach to the request. - * @returns {ResponsePromise} Resolves to the order's details. You can access the swap under the `claims` property. + * @returns {ResponsePromise} Resolves to the order's details. You can access the claim under the `claims` property. * * @example * import Medusa from "@medusajs/medusa-js" @@ -701,7 +701,7 @@ class AdminOrdersResource extends BaseResource { * @param {string} claimId - The claim's ID. * @param {AdminPostOrdersOrderClaimsClaimReq} payload - The attributes to update in the claim. * @param {Record} customHeaders - Custom headers to attach to the request. - * @returns {ResponsePromise} Resolves to the order's details. You can access the swap under the `claims` property. + * @returns {ResponsePromise} Resolves to the order's details. You can access the claims under the `claims` property. * * @example * import Medusa from "@medusajs/medusa-js" diff --git a/packages/medusa-js/src/resources/admin/payments.ts b/packages/medusa-js/src/resources/admin/payments.ts index 0316e88cacc04..6acfe68a89c24 100644 --- a/packages/medusa-js/src/resources/admin/payments.ts +++ b/packages/medusa-js/src/resources/admin/payments.ts @@ -79,16 +79,17 @@ class AdminPaymentsResource extends BaseResource { * @returns {ResponsePromise} Resolves to the refund's details. * * @example + * import { RefundReason } from "@medusajs/medusa"; * import Medusa from "@medusajs/medusa-js" * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) * // must be previously logged in or use api token * medusa.admin.payments.refundPayment(paymentId, { * amount: 1000, - * reason: "return", + * reason: RefundReason.RETURN, * note: "Do not like it", * }) - * .then(({ payment }) => { - * console.log(payment.id); + * .then(({ refund }) => { + * console.log(refund.amount); * }) */ refundPayment( diff --git a/packages/medusa-js/src/resources/admin/publishable-api-keys.ts b/packages/medusa-js/src/resources/admin/publishable-api-keys.ts index 67aa3504f39ae..0e2b33e89d3ec 100644 --- a/packages/medusa-js/src/resources/admin/publishable-api-keys.ts +++ b/packages/medusa-js/src/resources/admin/publishable-api-keys.ts @@ -33,8 +33,6 @@ class AdminPublishableApiKeyResource extends BaseResource { /** * Retrieve a publishable API key's details. * @param {string} id - The ID of the publishable API key. - * @privateRemarks The query parameter serves no purpose, so will leave this without a description until it's removed/fixed. - * @param {Record} query * @param {Record} customHeaders - Custom headers to attach to the request. * @returns {ResponsePromise} Resolves to the publishable API key's details. * diff --git a/packages/medusa-js/src/resources/admin/returns.ts b/packages/medusa-js/src/resources/admin/returns.ts index d41a89dace950..97c2d31cb3918 100644 --- a/packages/medusa-js/src/resources/admin/returns.ts +++ b/packages/medusa-js/src/resources/admin/returns.ts @@ -22,7 +22,7 @@ import BaseResource from "../base" */ class AdminReturnsResource extends BaseResource { /** - * Registers a return as canceled. The return can be associated with an order, claim, or swap. + * Register a return as canceled. The return can be associated with an order, claim, or swap. * @param {string} id - The return's ID. * @param {Record} customHeaders - Custom headers to attach to the request. * @returns {ResponsePromise} Resolves to the details of the order associated with the return. If the return is associated with a claim or a swap, then it'll be the order diff --git a/packages/medusa-js/src/resources/admin/sales-channels.ts b/packages/medusa-js/src/resources/admin/sales-channels.ts index 7fd8c3edc6f6e..a904744c2d469 100644 --- a/packages/medusa-js/src/resources/admin/sales-channels.ts +++ b/packages/medusa-js/src/resources/admin/sales-channels.ts @@ -251,7 +251,9 @@ class AdminSalesChannelsResource extends BaseResource { } /** - * Associate a stock location with a sales channel. + * Associate a stock location with a sales channel. It requires the + * [@medusajs/stock-location](https://docs.medusajs.com/modules/multiwarehouse/install-modules#stock-location-module) module to be installed in + * your Medusa backend. * @param {string} salesChannelId - The sales channel's ID. * @param {AdminPostSalesChannelsChannelStockLocationsReq} payload - The stock location to associate with the sales channel. * @param {Record} customHeaders - Custom headers to attach to the request. diff --git a/packages/medusa-js/src/resources/admin/shipping-profiles.ts b/packages/medusa-js/src/resources/admin/shipping-profiles.ts index b8214c62f951c..3ada7ce428890 100644 --- a/packages/medusa-js/src/resources/admin/shipping-profiles.ts +++ b/packages/medusa-js/src/resources/admin/shipping-profiles.ts @@ -27,11 +27,13 @@ class AdminShippingProfilesResource extends BaseResource { * @returns {ResponsePromise} Resolves to the shipping profile's details. * * @example + * import { ShippingProfileType } from "@medusajs/medusa" * import Medusa from "@medusajs/medusa-js" * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) * // must be previously logged in or use api token * medusa.admin.shippingProfiles.create({ - * name: "Large Products" + * name: "Large Products", + * type: ShippingProfileType.DEFAULT * }) * .then(({ shipping_profile }) => { * console.log(shipping_profile.id); diff --git a/packages/medusa-js/src/resources/admin/tax-rates.ts b/packages/medusa-js/src/resources/admin/tax-rates.ts index 58d582c2a53c0..66d54126efc9e 100644 --- a/packages/medusa-js/src/resources/admin/tax-rates.ts +++ b/packages/medusa-js/src/resources/admin/tax-rates.ts @@ -110,7 +110,7 @@ class AdminTaxRatesResource extends BaseResource { * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) * // must be previously logged in or use api token * medusa.admin.taxRates.list({ - * expand: "shipping_options" + * expand: ["shipping_options"] * }) * .then(({ tax_rates, limit, offset, count }) => { * console.log(tax_rates.length); @@ -124,7 +124,7 @@ class AdminTaxRatesResource extends BaseResource { * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) * // must be previously logged in or use api token * medusa.admin.taxRates.list({ - * expand: "shipping_options", + * expand: ["shipping_options"], * limit, * offset * }) diff --git a/packages/medusa-js/src/resources/admin/uploads.ts b/packages/medusa-js/src/resources/admin/uploads.ts index c5e3b790454d4..6e2517ac69f38 100644 --- a/packages/medusa-js/src/resources/admin/uploads.ts +++ b/packages/medusa-js/src/resources/admin/uploads.ts @@ -28,8 +28,8 @@ class AdminUploadsResource extends BaseResource { } /** - * Upload a file to a public bucket or storage. The file upload is handled by the file service installed on the Medusa backend. - * @param {AdminCreateUploadPayload} file - The file to upload. + * Upload a file or multiple files to a public bucket or storage. The file upload is handled by the file service installed on the Medusa backend. + * @param {AdminCreateUploadPayload} file - The file(s) to upload. * @returns {ResponsePromise} Resolves to the uploaded file details. * * @example diff --git a/packages/medusa-js/src/resources/carts.ts b/packages/medusa-js/src/resources/carts.ts index ba159650ef560..4cd8766abf1c3 100644 --- a/packages/medusa-js/src/resources/carts.ts +++ b/packages/medusa-js/src/resources/carts.ts @@ -66,8 +66,8 @@ class CartsResource extends BaseResource { * import Medusa from "@medusajs/medusa-js" * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) * medusa.carts.complete(cartId) - * .then(({ cart }) => { - * console.log(cart.id); + * .then(({ data, type }) => { + * console.log(data.id, type); * }) */ complete( diff --git a/packages/medusa-js/src/resources/line-items.ts b/packages/medusa-js/src/resources/line-items.ts index 12cbcd97fcc42..afc639554c60a 100644 --- a/packages/medusa-js/src/resources/line-items.ts +++ b/packages/medusa-js/src/resources/line-items.ts @@ -12,7 +12,7 @@ import BaseResource from "./base" */ class LineItemsResource extends BaseResource { /** - * Generates a Line Item with a given Product Variant and adds it to the Cart + * Generate a Line Item with a given Product Variant and adds it to the Cart * @param {string} cart_id - The cart's ID. * @param {StorePostCartsCartLineItemsReq} payload - The line item to be created. * @param {Record} customHeaders - Custom headers to attach to the request. diff --git a/packages/medusa-js/src/resources/order-edits.ts b/packages/medusa-js/src/resources/order-edits.ts index 9057e9af38fb7..cca61fbc6e888 100644 --- a/packages/medusa-js/src/resources/order-edits.ts +++ b/packages/medusa-js/src/resources/order-edits.ts @@ -62,7 +62,7 @@ class OrderEditsResource extends BaseResource { } /** - * Complete an Order Edit and reflect its changes on the original order. Any additional payment required must be authorized first using the {@link PaymentCollectionsResource} routes. + * Complete and confirm an Order Edit and reflect its changes on the original order. Any additional payment required must be authorized first using the {@link PaymentCollectionsResource} routes. * @param {string} id - The ID of the order edit. * @param {Record} customHeaders - Custom headers to attach to the request. * @returns {ResponsePromise} Resolves to the order edit's details. diff --git a/packages/medusa-js/src/resources/payment-collections.ts b/packages/medusa-js/src/resources/payment-collections.ts index d6609f88d5906..a831860c823a2 100644 --- a/packages/medusa-js/src/resources/payment-collections.ts +++ b/packages/medusa-js/src/resources/payment-collections.ts @@ -103,7 +103,9 @@ class PaymentCollectionsResource extends BaseResource { * import Medusa from "@medusajs/medusa-js" * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) * // must be previously logged in or use api token - * medusa.paymentCollections.authorize(paymentId) + * medusa.paymentCollections.authorizePaymentSessionsBatch(paymentCollectionId, { + * session_ids: ["ps_123456"] + * }) * .then(({ payment_collection }) => { * console.log(payment_collection.id); * }) @@ -131,7 +133,7 @@ class PaymentCollectionsResource extends BaseResource { * import Medusa from "@medusajs/medusa-js" * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) * // must be previously logged in or use api token - * + * * // Total amount = 10000 * medusa.paymentCollections.managePaymentSessionsBatch(paymentId, { * sessions: [ @@ -213,7 +215,7 @@ class PaymentCollectionsResource extends BaseResource { * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) * medusa.paymentCollections.refreshPaymentSession(paymentCollectionId, sessionId) * .then(({ payment_session }) => { - * console.log(payment_session.id); + * console.log(payment_session.status); * }) */ refreshPaymentSession( diff --git a/packages/medusa-js/src/resources/products.ts b/packages/medusa-js/src/resources/products.ts index d8f6a6f5971e1..16b706af4a4d0 100644 --- a/packages/medusa-js/src/resources/products.ts +++ b/packages/medusa-js/src/resources/products.ts @@ -77,7 +77,7 @@ class ProductsResource extends BaseResource { } /** - * Retrieves a list of products. The products can be filtered by fields such as `id` or `q` passed in the `query` parameter. The products can also be sorted or paginated. + * Retrieve a list of products. The products can be filtered by fields such as `id` or `q` passed in the `query` parameter. The products can also be sorted or paginated. * This method can also be used to retrieve a product by its handle. * * For accurate and correct pricing of the products based on the customer's context, it's highly recommended to pass fields such as diff --git a/packages/medusa-js/src/resources/regions.ts b/packages/medusa-js/src/resources/regions.ts index 06e73914adc23..d723646e0b651 100644 --- a/packages/medusa-js/src/resources/regions.ts +++ b/packages/medusa-js/src/resources/regions.ts @@ -9,7 +9,7 @@ import BaseResource from "./base" * Regions are different countries or geographical regions that the commerce store serves customers in. * Customers can choose what region they're in, which can be used to change the prices shown based on the region and its currency. * - * Related Guide: [How to use regions in a storefront](https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions) + * Related Guide: [How to use regions in a storefront](https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions). */ class RegionsResource extends BaseResource { /** diff --git a/packages/medusa-js/src/typings.ts b/packages/medusa-js/src/typings.ts index 4e75906ff41b8..44e4d4e6cc8d2 100644 --- a/packages/medusa-js/src/typings.ts +++ b/packages/medusa-js/src/typings.ts @@ -27,7 +27,9 @@ type CreateUserRolesEnum = NoUndefined // convert Enum type to union of string literals export type CreateUserRoles = `${CreateUserRolesEnum}` -// remove enum type and replace with union type +/** + * The details of the user to create. + */ export type AdminCreateUserPayload = | Omit | { @@ -38,6 +40,9 @@ type UpdateUserRolesEnum = NoUndefined export type UpdateUserRoles = `${UpdateUserRolesEnum}` +/** + * The details to update of the user. + */ export type AdminUpdateUserPayload = Omit & { role?: UpdateUserRoles } @@ -48,4 +53,7 @@ export type AdminPostInvitesPayload = Omit & { role: InviteUserRolesEnum } +/** + * The file(s) to upload. + */ export type AdminCreateUploadPayload = File | File[] diff --git a/packages/medusa-react/src/contexts/cart.tsx b/packages/medusa-react/src/contexts/cart.tsx index 214cf477e0857..997a9d127f209 100644 --- a/packages/medusa-react/src/contexts/cart.tsx +++ b/packages/medusa-react/src/contexts/cart.tsx @@ -1,3 +1,9 @@ +/** + * @packageDocumentation + * + * @customNamespace Providers.Cart + */ + import React, { useState } from "react" import { useAddShippingMethodToCart, @@ -10,22 +16,113 @@ import { import { Cart } from "../types" interface CartState { + /** + * The currently-used cart. + */ cart?: Cart } -interface CartContext extends CartState { +/** + * The cart context available if the {@link CartProvider} is used previously in the React components tree. + */ +export interface CartContext extends CartState { + /** + * A state function used to set the cart object. + * + * @param {Cart} cart - The new value of the cart. + */ setCart: (cart: Cart) => void + /** + * A mutation used to select a payment processor during checkout. + * Using it is equivalent to using the {@link useSetPaymentSession} mutation. + */ pay: ReturnType + /** + * A mutation used to create a cart. + * Using it is equivalent to using the {@link useCreateCart} mutation. + */ createCart: ReturnType + /** + * A mutation used to initialize payment sessions during checkout. + * Using it is equivalent to using the {@link useCreatePaymentSession} mutation. + */ startCheckout: ReturnType + /** + * A mutation used to complete the cart and place the order. + * Using it is equivalent to using the {@link useCompleteCart} mutation. + */ completeCheckout: ReturnType + /** + * A mutation used to update a cart’s details such as region, customer email, shipping address, and more. + * Using it is equivalent to using the {@link useUpdateCart} mutation. + */ updateCart: ReturnType + /** + * A mutation used to add a shipping method to the cart during checkout. + * Using it is equivalent to using the {@link useAddShippingMethodToCart} mutation. + */ addShippingMethod: ReturnType + /** + * The number of items in the cart. + */ totalItems: number } const CartContext = React.createContext(null) +/** + * This hook exposes the context of {@link CartProvider}. + * + * The context provides helper functions and mutations for managing the cart and checkout. You can refer to the following guides for examples on how to use them: + * + * - [How to Add Cart Functionality](https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart) + * - [How to Implement Checkout Flow](https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-checkout-flow) + * + * @example + * ```tsx title="src/Cart.ts" + * import * as React from "react" + * + * import { useCart } from "medusa-react" + * + * const Cart = () => { + * const handleClick = () => { + * createCart.mutate({}) // create an empty cart + * } + * + * const { cart, createCart } = useCart() + * + * return ( + *
+ * {createCart.isLoading &&
Loading...
} + * {!cart?.id && ( + * + * )} + * {cart?.id && ( + *
Cart ID: {cart.id}
+ * )} + *
+ * ) + * } + * + * export default Cart + * ``` + * + * In the example above, you retrieve the `createCart` mutation and `cart` state object using the `useCart` hook. + * If the `cart` is not set, a button is shown. When the button is clicked, the `createCart` mutation is executed, which interacts with the backend and creates a new cart. + * + * After the cart is created, the `cart` state variable is set and its ID is shown instead of the button. + * + * :::note + * + * The example above does not store in the browser the ID of the cart created, so the cart’s data will be gone on refresh. + * You would have to do that using the browser’s [Local Storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). + * + * ::: + * + * @customNamespace Providers.Cart + */ export const useCart = () => { const context = React.useContext(CartContext) if (!context) { @@ -34,8 +131,14 @@ export const useCart = () => { return context } -interface CartProps { +export interface CartProps { + /** + * @ignore + */ children: React.ReactNode + /** + * An optional initial value to be used for the cart. + */ initialState?: Cart } @@ -44,6 +147,44 @@ const defaultInitialState = { items: [] as any, } as Cart +/** + * `CartProvider` makes use of some of the hooks already exposed by `medusa-react` to perform cart operations on the Medusa backend. + * You can use it to create a cart, start the checkout flow, authorize payment sessions, and so on. + * + * It also manages one single global piece of state which represents a cart, exactly like the one created on your Medusa backend. + * + * To use `CartProvider`, you first have to insert it somewhere in your component tree below the {@link Providers.Medusa.MedusaProvider | MedusaProvider}. Then, in any of the child components, + * you can use the {@link useCart} hook exposed by `medusa-react` to get access to cart operations and data. + * + * @param {CartProps} param0 - Props of the provider. + * + * @example + * ```tsx title="src/App.ts" + * import { CartProvider, MedusaProvider } from "medusa-react" + * import Storefront from "./Storefront" + * import { QueryClient } from "@tanstack/react-query" + * import React from "react" + * + * const queryClient = new QueryClient() + * + * function App() { + * return ( + * + * + * + * + * + * ) + * } + * + * export default App + * ``` + * + * @customNamespace Providers.Cart + */ export const CartProvider = ({ children, initialState = defaultInitialState, diff --git a/packages/medusa-react/src/contexts/index.ts b/packages/medusa-react/src/contexts/index.ts index eb028cd2d640b..2a239e844887a 100644 --- a/packages/medusa-react/src/contexts/index.ts +++ b/packages/medusa-react/src/contexts/index.ts @@ -1,3 +1,17 @@ +/** + * @packageDocumentation + * + * :::info + * + * This is an experimental feature. + * + * ::: + * + * `medusa-react` exposes React Context Providers that facilitate building custom storefronts. + * + * @customNamespace Providers + */ + export * from "./medusa" export * from "./session-cart" export * from "./cart" diff --git a/packages/medusa-react/src/contexts/medusa.tsx b/packages/medusa-react/src/contexts/medusa.tsx index eb5cafd04aeef..7a14831dd619c 100644 --- a/packages/medusa-react/src/contexts/medusa.tsx +++ b/packages/medusa-react/src/contexts/medusa.tsx @@ -1,3 +1,9 @@ +/** + * @packageDocumentation + * + * @customNamespace Providers.Medusa + */ + import Medusa from "@medusajs/medusa-js" import { QueryClientProvider, @@ -5,12 +11,50 @@ import { } from "@tanstack/react-query" import React from "react" -interface MedusaContextState { +export interface MedusaContextState { + /** + * The Medusa JS Client instance. + */ client: Medusa } const MedusaContext = React.createContext(null) +/** + * This hook gives you access to context of {@link MedusaProvider}. It's useful if you want access to the + * [Medusa JS Client](https://docs.medusajs.com/js-client/overview). + * + * @example + * import React from "react" + * import { useMeCustomer, useMedusa } from "medusa-react" + * + * const CustomerLogin = () => { + * const { client } = useMedusa() + * const { refetch: refetchCustomer } = useMeCustomer() + * // ... + * + * const handleLogin = ( + * email: string, + * password: string + * ) => { + * client.auth.authenticate({ + * email, + * password + * }) + * .then(() => { + * // customer is logged-in successfully + * refetchCustomer() + * }) + * .catch(() => { + * // an error occurred. + * }) + * } + * + * // ... + * } + * + * @customNamespace Providers.Medusa + */ export const useMedusa = () => { const context = React.useContext(MedusaContext) if (!context) { @@ -19,27 +63,79 @@ export const useMedusa = () => { return context } -interface MedusaProviderProps { +export interface MedusaProviderProps { + /** + * The URL to your Medusa backend. + */ baseUrl: string + /** + * An object used to set the Tanstack Query client. The object requires a `client` property, + * which should be an instance of [QueryClient](https://tanstack.com/query/v4/docs/react/reference/QueryClient). + */ queryClientProviderProps: QueryClientProviderProps + /** + * @ignore + */ children: React.ReactNode /** - * Authentication token + * API key used for authenticating admin requests. Follow [this guide](https://docs.medusajs.com/api/admin#authentication) to learn how to create an API key for an admin user. */ apiKey?: string /** - * PublishableApiKey identifier that defines the scope of resources - * available within the request + * Publishable API key used for storefront requests. You can create a publishable API key either using the + * [admin APIs](https://docs.medusajs.com/development/publishable-api-keys/admin/manage-publishable-api-keys) or the + * [Medusa admin](https://docs.medusajs.com/user-guide/settings/publishable-api-keys#create-publishable-api-key). */ publishableApiKey?: string /** - * Number of times to retry a request if it fails - * @default 3 + * Number of times to retry a request if it fails. + * + * @defaultValue 3 */ maxRetries?: number + /** + * An object of custom headers to pass with every request. Each key of the object is the name of the header, and its value is the header's value. + * + * @defaultValue `{}` + */ customHeaders?: Record } +/** + * The `MedusaProvider` must be used at the highest possible point in the React component tree. Using any of `medusa-react`'s hooks or providers requires having `MedusaProvider` + * higher in the component tree. + * + * @param {MedusaProviderProps} param0 - Props of the provider. + * + * @example + * ```tsx title="src/App.ts" + * import { MedusaProvider } from "medusa-react" + * import Storefront from "./Storefront" + * import { QueryClient } from "@tanstack/react-query" + * import React from "react" + * + * const queryClient = new QueryClient() + * + * const App = () => { + * return ( + * + * + * + * ) + * } + * + * export default App + * ``` + * + * In the example above, you wrap the `Storefront` component with the `MedusaProvider`. `Storefront` is assumed to be the top-level component of your storefront, but you can place `MedusaProvider` at any point in your tree. Only children of `MedusaProvider` can benefit from its hooks. + * + * The `Storefront` component and its child components can now use hooks exposed by Medusa React. + * + * @customNamespace Providers.Medusa + */ export const MedusaProvider = ({ queryClientProviderProps, baseUrl, diff --git a/packages/medusa-react/src/contexts/session-cart.tsx b/packages/medusa-react/src/contexts/session-cart.tsx index ab26c1307258f..83e043d3bf615 100644 --- a/packages/medusa-react/src/contexts/session-cart.tsx +++ b/packages/medusa-react/src/contexts/session-cart.tsx @@ -1,32 +1,113 @@ +/** + * @packageDocumentation + * + * @customNamespace Providers.Session Cart + */ + import React, { useContext, useEffect } from "react" import { getVariantPrice } from "../helpers" import { useLocalStorage } from "../hooks/utils" import { ProductVariant, RegionInfo } from "../types" import { isArray, isEmpty, isObject } from "../utils" -interface Item { +/** + * A session cart's item. + */ +export interface Item { + /** + * The product variant represented by this item in the cart. + */ variant: ProductVariant + /** + * The quantity added in the cart. + */ quantity: number + /** + * The total amount of the item in the cart. + */ readonly total?: number } export interface SessionCartState { + /** + * The region of the cart. + */ region: RegionInfo + /** + * The items in the cart. + */ items: Item[] + /** + * The total items in the cart. + */ totalItems: number + /** + * The total amount of the cart. + */ total: number } -interface SessionCartContextState extends SessionCartState { +export interface SessionCartContextState extends SessionCartState { + /** + * A state function used to set the region. + * + * @param region - The new value of the region. + */ setRegion: (region: RegionInfo) => void + /** + * This function adds an item to the session cart. + * + * @param {Item} item - The item to add. + */ addItem: (item: Item) => void + /** + * This function removes an item from the session cart. + * + * @param {string} id - The ID of the item. + */ removeItem: (id: string) => void + /** + * This function updates an item in the session cart. + * + * @param {string} id - The ID of the item. + * @param {Partial} item - The item's data to update. + */ updateItem: (id: string, item: Partial) => void + /** + * A state function used to set the items in the cart. + * + * @param {Item[]} items - The items to set in the cart. + */ setItems: (items: Item[]) => void + /** + * This function updates an item's quantity in the cart. + * + * @param {string} id - The ID of the item. + * @param {number} quantity - The new quantity of the item. + */ updateItemQuantity: (id: string, quantity: number) => void + /** + * This function increments the item's quantity in the cart. + * + * @param {string} id - The ID of the item. + */ incrementItemQuantity: (id: string) => void + /** + * This function decrements the item's quantity in the cart. + * + * @param {string} id - The ID of the item. + */ decrementItemQuantity: (id: string) => void + /** + * This function retrieves an item's details by its ID. + * + * @param {string} id - The ID of the item. + * @returns {Item | undefined} The item in the cart, if found. + */ getItem: (id: string) => Item | undefined + /** + * Removes all items in the cart. + */ clearItems: () => void } @@ -111,6 +192,9 @@ const reducer = (state: SessionCartState, action: Action) => { } } +/** + * @ignore + */ export const generateCartState = (state: SessionCartState, items: Item[]) => { const newItems = generateItems(state.region, items) return { @@ -135,8 +219,14 @@ const calculateSessionCartTotal = (items: Item[]) => { ) } -interface SessionCartProviderProps { +export interface SessionCartProviderProps { + /** + * @ignore + */ children: React.ReactNode + /** + * An optional initial value to be used for the session cart. + */ initialState?: SessionCartState } @@ -147,6 +237,44 @@ const defaultInitialState: SessionCartState = { totalItems: 0, } +/** + * Unlike the {@link Providers.Cart.CartProvider | CartProvider}, `SessionProvider` never interacts with the Medusa backend. It can be used to implement the user experience related to managing a cart’s items. + * Its state variables are JavaScript objects living in the browser, but are in no way communicated with the backend. + * + * You can use the `SessionProvider` as a lightweight client-side cart functionality. It’s not stored in any database or on the Medusa backend. + * + * To use `SessionProvider`, you first have to insert it somewhere in your component tree below the {@link Providers.Medusa.MedusaProvider | MedusaProvider}. Then, in any of the child components, + * you can use the {@link useSessionCart} hook to get access to client-side cart item functionalities. + * + * @param {SessionCartProviderProps} param0 - Props of the provider. + * + * @example + * ```tsx title="src/App.ts" + * import { SessionProvider, MedusaProvider } from "medusa-react" + * import Storefront from "./Storefront" + * import { QueryClient } from "@tanstack/react-query" + * import React from "react" + * + * const queryClient = new QueryClient() + * + * const App = () => { + * return ( + * + * + * + * + * + * ) + * } + * + * export default App + * ``` + * + * @customNamespace Providers.Session Cart + */ export const SessionCartProvider = ({ initialState = defaultInitialState, children, @@ -278,6 +406,28 @@ export const SessionCartProvider = ({ ) } +/** + * This hook exposes the context of {@link SessionCartProvider}. + * + * @example + * The following example assumes that you've added `SessionCartProvider` previously in the React components tree: + * + * ```tsx title="src/Products.ts" + * const Products = () => { + * const { addItem } = useSessionCart() + * // ... + * + * function addToCart(variant: ProductVariant) { + * addItem({ + * variant: variant, + * quantity: 1, + * }) + * } + * } + * ``` + * + * @customNamespace Providers.Session Cart + */ export const useSessionCart = () => { const context = useContext(SessionCartContext) if (!context) { diff --git a/packages/medusa-react/src/helpers/index.ts b/packages/medusa-react/src/helpers/index.ts index b6064aec1d68a..059ebe711997d 100644 --- a/packages/medusa-react/src/helpers/index.ts +++ b/packages/medusa-react/src/helpers/index.ts @@ -1,17 +1,91 @@ +/** + * @packageDocumentation + * + * `medusa-react` exposes a set of utility functions that are mainly used to retrieve or format the price of a product variant. + * + * @customNamespace Utilities + */ + import { ProductVariantInfo, RegionInfo } from "../types" import { isEmpty } from "../utils" -type FormatVariantPriceParams = { +/** + * @interface + * + * Options to format a variant's price. + */ +export type FormatVariantPriceParams = { + /** + * A variant's details. + */ variant: ProductVariantInfo + /** + * A region's details. + */ region: RegionInfo + /** + * Whether the computed price should include taxes or not. + * + * @defaultValue true + */ includeTaxes?: boolean + /** + * The minimum number of fraction digits to use when formatting the price. This is passed as an option to `Intl.NumberFormat` in the underlying layer. + * You can learn more about this method’s options in + * [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). + */ minimumFractionDigits?: number + /** + * The maximum number of fraction digits to use when formatting the price. This is passed as an option to `Intl.NumberFormat` which is used within the utility method. + * You can learn more about this method’s options in + * [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). + */ maximumFractionDigits?: number + /** + * A BCP 47 language tag. The default value is `en-US`. This is passed as a first parameter to `Intl.NumberFormat` which is used within the utility method. + * You can learn more about this method’s parameters in + * [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). + */ locale?: string } /** - * Takes a product variant and a region, and converts the variant's price to a localized decimal format + * This utility function can be used to compute the price of a variant for a region and retrieve the formatted amount. For example, `$20.00`. + * + * @param {FormatVariantPriceParams} param0 - Options to format the variant's price. + * @returns {string} The formatted price. + * + * @example + * ```tsx title="src/Products.ts" + * import React from "react" + * import { formatVariantPrice } from "medusa-react" + * import { Product, ProductVariant } from "@medusajs/medusa" + * + * const Products = () => { + * // ... + * return ( + *
    + * {products?.map((product: Product) => ( + *
  • + * {product.title} + *
      + * {product.variants.map((variant: ProductVariant) => ( + *
    • + * {formatVariantPrice({ + * variant, + * region, // should be retrieved earlier + * })} + *
      • + * ))} + *
    + *
    • + * ))} + *
+ * ) + * } + * ``` + * + * @customNamespace Utilities */ export const formatVariantPrice = ({ variant, @@ -28,17 +102,66 @@ export const formatVariantPrice = ({ }) } -type ComputeVariantPriceParams = { +/** + * @interface + * + * Options to format a variant's price. + */ +export type ComputeVariantPriceParams = { + /** + * A variant's details. + */ variant: ProductVariantInfo + /** + * A region's details. + */ region: RegionInfo + /** + * Whether the computed price should include taxes or not. + * + * @defaultValue true + */ includeTaxes?: boolean } /** - * Takes a product variant and region, and returns the variant price as a decimal number - * @param params.variant - product variant - * @param params.region - region - * @param params.includeTaxes - whether to include taxes or not + * This utility function can be used to compute the price of a variant for a region and retrieve the amount without formatting. + * For example, `20`. This method is used by {@link formatVariantPrice} before applying the price formatting. + * + * @param {ComputeVariantPriceParams} param0 - Options to compute the variant's price. + * @returns The computed price of the variant. + * + * @example + * ```tsx title="src/Products.ts" + * import React from "react" + * import { computeVariantPrice } from "medusa-react" + * import { Product, ProductVariant } from "@medusajs/medusa" + * + * const Products = () => { + * // ... + * return ( + *
    + * {products?.map((product: Product) => ( + *
  • + * {product.title} + *
      + * {product.variants.map((variant: ProductVariant) => ( + *
    • + * {computeVariantPrice({ + * variant, + * region, // should be retrieved earlier + * })} + *
      • + * ))} + *
    + *
    • + * ))} + *
+ * ) + * } + * ``` + * + * @customNamespace Utilities */ export const computeVariantPrice = ({ variant, @@ -55,10 +178,44 @@ export const computeVariantPrice = ({ } /** - * Finds the price amount correspoding to the region selected - * @param variant - the product variant - * @param region - the region - * @returns - the price's amount + * This utility function is used to retrieve a variant's price in a region. It doesn't take into account taxes or any options, so you typically wouldn't need this function on its own. + * It's used by the {@link computeVariantPrice} function to retrieve the variant's price in a region before computing the correct price for the options provided. + * + * @param {ProductVariantInfo} variant - The variant's details. + * @param {RegionInfo} region - The region's details. + * @returns {number} The variant's price in a region. + * + * @example + * ```tsx title="src/Products.ts" + * import React from "react" + * import { getVariantPrice } from "medusa-react" + * import { Product, ProductVariant } from "@medusajs/medusa" + * + * const Products = () => { + * // ... + * return ( + *
    + * {products?.map((product: Product) => ( + *
  • + * {product.title} + *
      + * {product.variants.map((variant: ProductVariant) => ( + *
    • + * {getVariantPrice( + * variant, + * region, // should be retrieved earlier + * )} + *
      • + * ))} + *
    + *
    • + * ))} + *
+ * ) + * } + * ``` + * + * @customNamespace Utilities */ export const getVariantPrice = ( variant: ProductVariantInfo, @@ -72,14 +229,54 @@ export const getVariantPrice = ( return price?.amount || 0 } -type ComputeAmountParams = { +/** + * Options to compute an amount. + */ +export type ComputeAmountParams = { + /** + * The original amount used for computation. + */ amount: number + /** + * The region's details. + */ region: RegionInfo + /** + * Whether the computed price should include taxes or not. + * + * @defaultValue true + */ includeTaxes?: boolean } /** - * Takes an amount, a region, and returns the amount as a decimal including or excluding taxes + * This utility function can be used to compute the price of an amount for a region and retrieve the amount without formatting. For example, `20`. + * This function is used by {@link formatAmount} before applying the price formatting. + * + * The main difference between this utility function and {@link computeVariantPrice} is that you don’t need to pass a complete variant object. This can be used with any number. + * + * @param {ComputeAmountParams} params0 - The options to compute the amount. + * @returns {number} The computed amount. + * + * @example + * ```tsx title="src/MyComponent.ts" + * import React from "react" + * import { computeAmount } from "medusa-react" + * + * const MyComponent = () => { + * // ... + * return ( + *
+ * {computeAmount({ + * amount, + * region, // should be retrieved earlier + * })} + *
+ * ) + * } + * ``` + * + * @customNamespace Utilities */ export const computeAmount = ({ amount, @@ -95,17 +292,81 @@ export const computeAmount = ({ return amountWithTaxes } -type FormatAmountParams = { +/** + * Options to format an amount. + */ +export type FormatAmountParams = { + /** + * The original amount used for computation. + */ amount: number + /** + * The region's details. + */ region: RegionInfo + /** + * Whether the computed price should include taxes or not. + * + * @defaultValue true + */ includeTaxes?: boolean + /** + * The minimum number of fraction digits to use when formatting the price. This is passed as an option to `Intl.NumberFormat` in the underlying layer. + * You can learn more about this method’s options in + * [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). + */ minimumFractionDigits?: number + /** + * The maximum number of fraction digits to use when formatting the price. This is passed as an option to `Intl.NumberFormat` which is used within the utility method. + * You can learn more about this method’s options in + * [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). + */ maximumFractionDigits?: number + /** + * A BCP 47 language tag. The default value is `en-US`. This is passed as a first parameter to `Intl.NumberFormat` which is used within the utility method. + * You can learn more about this method’s parameters in + * [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). + */ locale?: string } /** - * Takes an amount and a region, and converts the amount to a localized decimal format + * This utility function can be used to compute the price of an amount for a region and retrieve the formatted amount. For example, `$20.00`. + * + * The main difference between this utility function and {@link formatVariantPrice} is that you don’t need to pass a complete variant object. This can be used with any number. + * + * @param {FormatAmountParams} param0 - Options to format the amount. + * @returns {string} The formatted price. + * + * @example + * import React from "react" + * import { formatVariantPrice } from "medusa-react" + * import { Product, ProductVariant } from "@medusajs/medusa" + * + * const Products = () => { + * // ... + * return ( + *
    + * {products?.map((product: Product) => ( + *
  • + * {product.title} + *
      + * {product.variants.map((variant: ProductVariant) => ( + *
    • + * {formatVariantPrice({ + * variant, + * region, // should be retrieved earlier + * })} + *
      • + * ))} + *
    + *
    • + * ))} + *
+ * ) + * } + * + * @customNamespace Utilities */ export const formatAmount = ({ amount, @@ -166,3 +427,8 @@ type ConvertToLocaleParams = { maximumFractionDigits?: number locale?: string } + +/** + * @internal We need to export these types so that they're included in the generated reference documentation. + */ +export { ProductVariantInfo, RegionInfo } \ No newline at end of file diff --git a/packages/medusa-react/src/hooks/admin/auth/index.ts b/packages/medusa-react/src/hooks/admin/auth/index.ts index a494946b87dc5..d00d0b97d3ec8 100644 --- a/packages/medusa-react/src/hooks/admin/auth/index.ts +++ b/packages/medusa-react/src/hooks/admin/auth/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and mutations listed here are used to send requests to the [Admin Auth API Routes](https://docs.medusajs.com/api/admin#auth_getauth). + * + * They allow admin users to manage their session, such as login or log out. + * You can send authenticated requests for an admin user either using the Cookie header, their API token, or the JWT Token. + * When you log the admin user in using the {@link Hooks.Admin.Auth.useAdminLogin | user authentication} hook, Medusa React will automatically attach the + * cookie header in all subsequent requests. + * + * Related Guide: [How to implement user profiles](https://docs.medusajs.com/modules/users/admin/manage-profile). + * + * @customNamespace Hooks.Admin.Auth + */ + export * from "./queries" -export * from "./mutations" +export * from "./mutations" \ No newline at end of file diff --git a/packages/medusa-react/src/hooks/admin/auth/mutations.ts b/packages/medusa-react/src/hooks/admin/auth/mutations.ts index ea7255691d44c..4556ef5b086fc 100644 --- a/packages/medusa-react/src/hooks/admin/auth/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/auth/mutations.ts @@ -9,7 +9,41 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminAuthKeys } from "./queries" +/** + * This hook is used to log a User in using their credentials. If the user is authenticated successfully, + * the cookie is automatically attached to subsequent requests sent with other hooks. + * + * @example + * import React from "react" + * import { useAdminLogin } from "medusa-react" + * + * const Login = () => { + * const adminLogin = useAdminLogin() + * // ... + * + * const handleLogin = () => { + * adminLogin.mutate({ + * email: "user@example.com", + * password: "supersecret", + * }, { + * onSuccess: ({ user }) => { + * console.log(user) + * } + * }) + * } + * + * // ... + * } + * + * export default Login + * + * @customNamespace Hooks.Admin.Auth + * @category Mutations + */ export const useAdminLogin = ( + /** + * stuff again + */ options?: UseMutationOptions, Error, AdminPostAuthReq> ) => { const { client } = useMedusa() @@ -21,6 +55,36 @@ export const useAdminLogin = ( ) } +/** + * This hook is used to Log out the user and remove their authentication session. This will only work if you're using Cookie session for authentication. If the API token is still passed in the header, + * the user is still authorized to perform admin functionalities in other API Routes. + * + * This hook requires {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * @example + * import React from "react" + * import { useAdminDeleteSession } from "medusa-react" + * + * const Logout = () => { + * const adminLogout = useAdminDeleteSession() + * // ... + * + * const handleLogout = () => { + * adminLogout.mutate(undefined, { + * onSuccess: () => { + * // user logged out. + * } + * }) + * } + * + * // ... + * } + * + * export default Logout + * + * @customNamespace Hooks.Admin.Auth + * @category Mutations + */ export const useAdminDeleteSession = ( options?: UseMutationOptions, Error, void> ) => { diff --git a/packages/medusa-react/src/hooks/admin/auth/queries.ts b/packages/medusa-react/src/hooks/admin/auth/queries.ts index 497a6236ed696..167cbc29b7d95 100644 --- a/packages/medusa-react/src/hooks/admin/auth/queries.ts +++ b/packages/medusa-react/src/hooks/admin/auth/queries.ts @@ -11,6 +11,31 @@ export const adminAuthKeys = queryKeysFactory(ADMIN_AUTH_QUERY_KEY) type AuthQueryKey = typeof adminAuthKeys +/** + * This hook is used to get the currently logged in user's details. Can also be used to check if there is an authenticated user. + * + * This hook requires {@link Hooks~Admin~Auth~useAdminLogin | user authentication}. + * + * @example + * import React from "react" + * import { useAdminGetSession } from "medusa-react" + * + * const Profile = () => { + * const { user, isLoading } = useAdminGetSession() + * + * return ( + *
+ * {isLoading && Loading...} + * {user && {user.email}} + *
+ * ) + * } + * + * export default Profile + * + * @customNamespace Hooks.Admin.Auth + * @category Queries + */ export const useAdminGetSession = ( options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/batch-jobs/index.ts b/packages/medusa-react/src/hooks/admin/batch-jobs/index.ts index a494946b87dc5..ccfb0ecde1bf5 100644 --- a/packages/medusa-react/src/hooks/admin/batch-jobs/index.ts +++ b/packages/medusa-react/src/hooks/admin/batch-jobs/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and mutations listed here are used to send requests to the [Admin Batch Job API Routes](https://docs.medusajs.com/api/admin#batch-jobs). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A batch job is a task that is performed by the Medusa backend asynchronusly. For example, the Import Product feature is implemented using batch jobs. + * The methods in this class allow admins to manage the batch jobs and their state. + * + * Related Guide: [How to import products](https://docs.medusajs.com/modules/products/admin/import-products). + * + * @customNamespace Hooks.Admin.Batch Jobs + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts b/packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts index 0e49fcaa36623..46c73d2a06fe7 100644 --- a/packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/batch-jobs/mutations.ts @@ -11,9 +11,36 @@ import { buildOptions } from "../../utils/buildOptions" import { adminBatchJobsKeys } from "./queries" /** - * Hook returns functions for creating batch jobs. - * - * @param options + * This hook creates a Batch Job to be executed asynchronously in the Medusa backend. If `dry_run` is set to `true`, the batch job will not be executed until the it is confirmed, + * which can be done using the {@link useAdminConfirmBatchJob} hook. + * + * @example + * import React from "react" + * import { useAdminCreateBatchJob } from "medusa-react" + * + * const CreateBatchJob = () => { + * const createBatchJob = useAdminCreateBatchJob() + * // ... + * + * const handleCreateBatchJob = () => { + * createBatchJob.mutate({ + * type: "publish-products", + * context: {}, + * dry_run: true + * }, { + * onSuccess: ({ batch_job }) => { + * console.log(batch_job) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateBatchJob + * + * @customNamespace Hooks.Admin.Batch Jobs + * @category Mutations */ export const useAdminCreateBatchJob = ( options?: UseMutationOptions< @@ -32,12 +59,40 @@ export const useAdminCreateBatchJob = ( } /** - * Hook return functions for canceling a batch job - * - * @param id - id of the batch job - * @param options + * This hook marks a batch job as canceled. When a batch job is canceled, the processing of the batch job doesn’t automatically stop. + * + * @example + * import React from "react" + * import { useAdminCancelBatchJob } from "medusa-react" + * + * type Props = { + * batchJobId: string + * } + * + * const BatchJob = ({ batchJobId }: Props) => { + * const cancelBatchJob = useAdminCancelBatchJob(batchJobId) + * // ... + * + * const handleCancel = () => { + * cancelBatchJob.mutate(undefined, { + * onSuccess: ({ batch_job }) => { + * console.log(batch_job) + * } + * }) + * } + * + * // ... + * } + * + * export default BatchJob + * + * @customNamespace Hooks.Admin.Batch Jobs + * @category Mutations */ export const useAdminCancelBatchJob = ( + /** + * The ID of the batch job. + */ id: string, options?: UseMutationOptions, Error> ) => { @@ -55,12 +110,39 @@ export const useAdminCancelBatchJob = ( } /** - * Hook return functions for confirming a batch job - * - * @param id - id of the batch job - * @param options + * @reactMutationHook + * + * When a batch job is created, it's not executed automatically if `dry_run` is set to `true`. This hook confirms that the batch job should be executed. + * + * @example + * import React from "react" + * import { useAdminConfirmBatchJob } from "medusa-react" + * + * type Props = { + * batchJobId: string + * } + * + * const BatchJob = ({ batchJobId }: Props) => { + * const confirmBatchJob = useAdminConfirmBatchJob(batchJobId) + * // ... + * + * const handleConfirm = () => { + * confirmBatchJob.mutate(undefined, { + * onSuccess: ({ batch_job }) => { + * console.log(batch_job) + * } + * }) + * } + * + * // ... + * } + * + * export default BatchJob */ export const useAdminConfirmBatchJob = ( + /** + * The ID of the batch job. + */ id: string, options?: UseMutationOptions, Error> ) => { diff --git a/packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts b/packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts index 5bb1a03e3ed50..5d2534c852c9a 100644 --- a/packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts +++ b/packages/medusa-react/src/hooks/admin/batch-jobs/queries.ts @@ -15,7 +15,127 @@ export const adminBatchJobsKeys = queryKeysFactory(ADMIN_COLLECTIONS_QUERY_KEY) type BatchJobsQueryKey = typeof adminBatchJobsKeys +/** + * This hook retrieves a list of Batch Jobs. The batch jobs can be filtered by fields such as `type` or `confirmed_at`. The batch jobs can also be sorted or paginated. + * + * @example + * To list batch jobs: + * + * ```ts + * import React from "react" + * import { useAdminBatchJobs } from "medusa-react" + * + * const BatchJobs = () => { + * const { + * batch_jobs, + * limit, + * offset, + * count, + * isLoading + * } = useAdminBatchJobs() + * + * return ( + *
+ * {isLoading && Loading...} + * {batch_jobs?.length && ( + *
    + * {batch_jobs.map((batchJob) => ( + *
  • + * {batchJob.id} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default BatchJobs + * ``` + * + * To specify relations that should be retrieved within the batch jobs: + * + * ```ts + * import React from "react" + * import { useAdminBatchJobs } from "medusa-react" + * + * const BatchJobs = () => { + * const { + * batch_jobs, + * limit, + * offset, + * count, + * isLoading + * } = useAdminBatchJobs({ + * expand: "created_by_user", + * limit: 10, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {batch_jobs?.length && ( + *
    + * {batch_jobs.map((batchJob) => ( + *
  • + * {batchJob.id} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default BatchJobs + * ``` + * + * By default, only the first `10` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```ts + * import React from "react" + * import { useAdminBatchJobs } from "medusa-react" + * + * const BatchJobs = () => { + * const { + * batch_jobs, + * limit, + * offset, + * count, + * isLoading + * } = useAdminBatchJobs({ + * expand: "created_by_user", + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {batch_jobs?.length && ( + *
    + * {batch_jobs.map((batchJob) => ( + *
  • + * {batchJob.id} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default BatchJobs + * ``` + * + * @customNamespace Hooks.Admin.Batch Jobs + * @category Queries + */ export const useAdminBatchJobs = ( + /** + * Filters and pagination configurations to apply on the retrieved batch jobs. + */ query?: AdminGetBatchParams, options?: UseQueryOptionsWrapper< Response, @@ -32,7 +152,37 @@ export const useAdminBatchJobs = ( return { ...data, ...rest } as const } +/** + * This hook retrieves the details of a batch job. + * + * @example + * import React from "react" + * import { useAdminBatchJob } from "medusa-react" + * + * type Props = { + * batchJobId: string + * } + * + * const BatchJob = ({ batchJobId }: Props) => { + * const { batch_job, isLoading } = useAdminBatchJob(batchJobId) + * + * return ( + *
+ * {isLoading && Loading...} + * {batch_job && {batch_job.created_by}} + *
+ * ) + * } + * + * export default BatchJob + * + * @customNamespace Hooks.Admin.Batch Jobs + * @category Queries + */ export const useAdminBatchJob = ( + /** + * The ID of the batch job. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/claims/index.ts b/packages/medusa-react/src/hooks/admin/claims/index.ts index bd086bcaef111..f735b931a9207 100644 --- a/packages/medusa-react/src/hooks/admin/claims/index.ts +++ b/packages/medusa-react/src/hooks/admin/claims/index.ts @@ -1 +1,16 @@ +/** + * @packageDocumentation + * + * Mutations listed here are used to send requests to the [Admin Order API Routes related to claims](https://docs.medusajs.com/api/admin#orders). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A claim represents a return or replacement request of order items. It allows refunding the customer or replacing some or all of its + * order items with new items. + * + * Related Guide: [How to manage claims](https://docs.medusajs.com/modules/orders/admin/manage-claims). + * + * @customNamespace Hooks.Admin.Claims + */ + export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/claims/mutations.ts b/packages/medusa-react/src/hooks/admin/claims/mutations.ts index 7f0bc763e1fa6..e8378ff6540a5 100644 --- a/packages/medusa-react/src/hooks/admin/claims/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/claims/mutations.ts @@ -17,7 +17,50 @@ import { adminProductKeys } from "../products" import { adminVariantKeys } from "../variants" import { adminOrderKeys } from "./../orders/queries" +/** + * This hook creates 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`, + * the refund is processed as well. + * + * @example + * import React from "react" + * import { useAdminCreateClaim } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const CreateClaim = ({ orderId }: Props) => { + * const createClaim = useAdminCreateClaim(orderId) + * // ... + * + * const handleCreate = (itemId: string) => { + * createClaim.mutate({ + * type: "refund", + * claim_items: [ + * { + * item_id: itemId, + * quantity: 1, + * }, + * ], + * }, { + * onSuccess: ({ order }) => { + * console.log(order.claims) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateClaim + * + * @customNamespace Hooks.Admin.Claims + * @category Mutations + */ export const useAdminCreateClaim = ( + /** + * The ID of the order the claim is associated with. + */ orderId: string, options?: UseMutationOptions< Response, @@ -35,12 +78,57 @@ export const useAdminCreateClaim = ( ) } +export type AdminUpdateClaimReq = AdminPostOrdersOrderClaimsClaimReq & { + /** + * The claim's ID. + */ + claim_id: string +} + +/** + * This hook updates a claim's details. + * + * @example + * import React from "react" + * import { useAdminUpdateClaim } from "medusa-react" + * + * type Props = { + * orderId: string + * claimId: string + * } + * + * const Claim = ({ orderId, claimId }: Props) => { + * const updateClaim = useAdminUpdateClaim(orderId) + * // ... + * + * const handleUpdate = () => { + * updateClaim.mutate({ + * claim_id: claimId, + * no_notification: false + * }, { + * onSuccess: ({ order }) => { + * console.log(order.claims) + * } + * }) + * } + * + * // ... + * } + * + * export default Claim + * + * @customNamespace Hooks.Admin.Claims + * @category Mutations + */ export const useAdminUpdateClaim = ( + /** + * The ID of the order the claim is associated with. + */ orderId: string, options?: UseMutationOptions< Response, Error, - AdminPostOrdersOrderClaimsClaimReq & { claim_id: string } + AdminUpdateClaimReq > ) => { const { client } = useMedusa() @@ -50,15 +138,53 @@ export const useAdminUpdateClaim = ( ({ claim_id, ...payload - }: AdminPostOrdersOrderClaimsClaimReq & { claim_id: string }) => + }: AdminUpdateClaimReq) => client.admin.orders.updateClaim(orderId, claim_id, payload), buildOptions(queryClient, adminOrderKeys.detail(orderId), options) ) } +/** + * This hook cancels 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. + * + * @typeParamDefinition string - The claim's ID. + * + * @example + * import React from "react" + * import { useAdminCancelClaim } from "medusa-react" + * + * type Props = { + * orderId: string + * claimId: string + * } + * + * const Claim = ({ orderId, claimId }: Props) => { + * const cancelClaim = useAdminCancelClaim(orderId) + * // ... + * + * const handleCancel = () => { + * cancelClaim.mutate(claimId) + * } + * + * // ... + * } + * + * export default Claim + * + * @customNamespace Hooks.Admin.Claims + * @category Mutations + */ export const useAdminCancelClaim = ( + /** + * The ID of the order the claim is associated with. + */ orderId: string, - options?: UseMutationOptions, Error, string> + options?: UseMutationOptions< + Response, + Error, + string + > ) => { const { client } = useMedusa() const queryClient = useQueryClient() @@ -69,12 +195,55 @@ export const useAdminCancelClaim = ( ) } +/** + * 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. + * + * @example + * import React from "react" + * import { useAdminFulfillClaim } from "medusa-react" + * + * type Props = { + * orderId: string + * claimId: string + * } + * + * const Claim = ({ orderId, claimId }: Props) => { + * const fulfillClaim = useAdminFulfillClaim(orderId) + * // ... + * + * const handleFulfill = () => { + * fulfillClaim.mutate({ + * claim_id: claimId, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.claims) + * } + * }) + * } + * + * // ... + * } + * + * export default Claim + * + * @customNamespace Hooks.Admin.Claims + * @category Mutations + */ export const useAdminFulfillClaim = ( + /** + * The ID of the order the claim is associated with. + */ orderId: string, options?: UseMutationOptions< Response, Error, - AdminPostOrdersOrderClaimsClaimFulfillmentsReq & { claim_id: string } + AdminPostOrdersOrderClaimsClaimFulfillmentsReq & { + /** + * The claim's ID. + */ + claim_id: string + } > ) => { const { client } = useMedusa() @@ -98,12 +267,66 @@ export const useAdminFulfillClaim = ( ) } +/** + * The cancelation details. + */ +export type AdminCancelClaimFulfillmentReq = { + /** + * The claim's ID. + */ + claim_id: string; + /** + * The fulfillment's ID. + */ + fulfillment_id: string +} + +/** + * This hook cancels a claim's fulfillment and change its fulfillment status to `canceled`. + * + * @example + * import React from "react" + * import { useAdminCancelClaimFulfillment } from "medusa-react" + * + * type Props = { + * orderId: string + * claimId: string + * } + * + * const Claim = ({ orderId, claimId }: Props) => { + * const cancelFulfillment = useAdminCancelClaimFulfillment( + * orderId + * ) + * // ... + * + * const handleCancel = (fulfillmentId: string) => { + * cancelFulfillment.mutate({ + * claim_id: claimId, + * fulfillment_id: fulfillmentId, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.claims) + * } + * }) + * } + * + * // ... + * } + * + * export default Claim + * + * @customNamespace Hooks.Admin.Claims + * @category Mutations + */ export const useAdminCancelClaimFulfillment = ( + /** + * The ID of the order the claim is associated with. + */ orderId: string, options?: UseMutationOptions< Response, Error, - { claim_id: string; fulfillment_id: string } + AdminCancelClaimFulfillmentReq > ) => { const { client } = useMedusa() @@ -113,10 +336,7 @@ export const useAdminCancelClaimFulfillment = ( ({ claim_id, fulfillment_id, - }: { - claim_id: string - fulfillment_id: string - }) => + }: AdminCancelClaimFulfillmentReq) => client.admin.orders.cancelClaimFulfillment( orderId, claim_id, @@ -126,12 +346,56 @@ export const useAdminCancelClaimFulfillment = ( ) } +/** + * This hook creates a shipment for the claim and mark its fulfillment as shipped. If the shipment is created successfully, this changes the claim's fulfillment status + * to either `partially_shipped` or `shipped`, depending on whether all the items were shipped. + * + * @example + * import React from "react" + * import { useAdminCreateClaimShipment } from "medusa-react" + * + * type Props = { + * orderId: string + * claimId: string + * } + * + * const Claim = ({ orderId, claimId }: Props) => { + * const createShipment = useAdminCreateClaimShipment(orderId) + * // ... + * + * const handleCreateShipment = (fulfillmentId: string) => { + * createShipment.mutate({ + * claim_id: claimId, + * fulfillment_id: fulfillmentId, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.claims) + * } + * }) + * } + * + * // ... + * } + * + * export default Claim + * + * @customNamespace Hooks.Admin.Claims + * @category Mutations + */ export const useAdminCreateClaimShipment = ( + /** + * The ID of the order the claim is associated with. + */ orderId: string, options?: UseMutationOptions< Response, Error, - AdminPostOrdersOrderClaimsClaimShipmentsReq & { claim_id: string } + AdminPostOrdersOrderClaimsClaimShipmentsReq & { + /** + * The claim's ID. + */ + claim_id: string + } > ) => { const { client } = useMedusa() diff --git a/packages/medusa-react/src/hooks/admin/collections/index.ts b/packages/medusa-react/src/hooks/admin/collections/index.ts index a494946b87dc5..e4266c2bc1a3b 100644 --- a/packages/medusa-react/src/hooks/admin/collections/index.ts +++ b/packages/medusa-react/src/hooks/admin/collections/index.ts @@ -1,2 +1,14 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Product Collection API Routes](https://docs.medusajs.com/api/admin#product-collections). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A product collection is used to organize products for different purposes such as marketing or discount purposes. For example, you can create a Summer Collection. + * + * @customNamespace Hooks.Admin.Product Collections + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/collections/mutations.ts b/packages/medusa-react/src/hooks/admin/collections/mutations.ts index a904ec305a60c..74168c317e28b 100644 --- a/packages/medusa-react/src/hooks/admin/collections/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/collections/mutations.ts @@ -17,6 +17,35 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminCollectionKeys } from "./queries" +/** + * This hook creates a product collection. + * + * @example + * import React from "react" + * import { useAdminCreateCollection } from "medusa-react" + * + * const CreateCollection = () => { + * const createCollection = useAdminCreateCollection() + * // ... + * + * const handleCreate = (title: string) => { + * createCollection.mutate({ + * title + * }, { + * onSuccess: ({ collection }) => { + * console.log(collection.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateCollection + * + * @customNamespace Hooks.Admin.Product Collections + * @category Mutations + */ export const useAdminCreateCollection = ( options?: UseMutationOptions< Response, @@ -33,7 +62,43 @@ export const useAdminCreateCollection = ( ) } +/** + * This hook updates a product collection's details. + * + * @example + * import React from "react" + * import { useAdminUpdateCollection } from "medusa-react" + * + * type Props = { + * collectionId: string + * } + * + * const Collection = ({ collectionId }: Props) => { + * const updateCollection = useAdminUpdateCollection(collectionId) + * // ... + * + * const handleUpdate = (title: string) => { + * updateCollection.mutate({ + * title + * }, { + * onSuccess: ({ collection }) => { + * console.log(collection.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Collection + * + * @customNamespace Hooks.Admin.Product Collections + * @category Mutations + */ export const useAdminUpdateCollection = ( + /** + * The product collection's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -54,7 +119,41 @@ export const useAdminUpdateCollection = ( ) } +/** + * This hook deletes a product collection. This does not delete associated products. + * + * @example + * import React from "react" + * import { useAdminDeleteCollection } from "medusa-react" + * + * type Props = { + * collectionId: string + * } + * + * const Collection = ({ collectionId }: Props) => { + * const deleteCollection = useAdminDeleteCollection(collectionId) + * // ... + * + * const handleDelete = (title: string) => { + * deleteCollection.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Collection + * + * @customNamespace Hooks.Admin.Product Collections + * @category Mutations + */ export const useAdminDeleteCollection = ( + /** + * The product collection's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -71,12 +170,42 @@ export const useAdminDeleteCollection = ( } /** - * Hook returns function for adding multiple products to a collection. - * - * @param id - id of the collection in which products are being added - * @param options + * This hook adds products to a collection. + * + * @example + * import React from "react" + * import { useAdminAddProductsToCollection } from "medusa-react" + * + * type Props = { + * collectionId: string + * } + * + * const Collection = ({ collectionId }: Props) => { + * const addProducts = useAdminAddProductsToCollection(collectionId) + * // ... + * + * const handleAddProducts = (productIds: string[]) => { + * addProducts.mutate({ + * product_ids: productIds + * }, { + * onSuccess: ({ collection }) => { + * console.log(collection.products) + * } + * }) + * } + * + * // ... + * } + * + * export default Collection + * + * @customNamespace Hooks.Admin.Product Collections + * @category Mutations */ export const useAdminAddProductsToCollection = ( + /** + * The product collection's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -99,12 +228,43 @@ export const useAdminAddProductsToCollection = ( } /** - * Hook returns function for removal of multiple products from a collection. - * - * @param id - id of the collection from which products will be removed - * @param options + * This hook removes a list of products from a collection. This would not delete the product, + * only the association between the product and the collection. + * + * @example + * import React from "react" + * import { useAdminRemoveProductsFromCollection } from "medusa-react" + * + * type Props = { + * collectionId: string + * } + * + * const Collection = ({ collectionId }: Props) => { + * const removeProducts = useAdminRemoveProductsFromCollection(collectionId) + * // ... + * + * const handleRemoveProducts = (productIds: string[]) => { + * removeProducts.mutate({ + * product_ids: productIds + * }, { + * onSuccess: ({ id, object, removed_products }) => { + * console.log(removed_products) + * } + * }) + * } + * + * // ... + * } + * + * export default Collection + * + * @customNamespace Hooks.Admin.Product Collections + * @category Mutations */ export const useAdminRemoveProductsFromCollection = ( + /** + * The product collection's ID. + */ id: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/collections/queries.ts b/packages/medusa-react/src/hooks/admin/collections/queries.ts index 09bd410bc413b..24c92c1f5974c 100644 --- a/packages/medusa-react/src/hooks/admin/collections/queries.ts +++ b/packages/medusa-react/src/hooks/admin/collections/queries.ts @@ -15,7 +15,79 @@ export const adminCollectionKeys = queryKeysFactory(ADMIN_COLLECTIONS_QUERY_KEY) type CollectionsQueryKey = typeof adminCollectionKeys +/** + * This hook retrieves a list of product collections. The product collections can be filtered by fields such as `handle` or `title`. + * The collections can also be sorted or paginated. + * + * @example + * To list product collections: + * + * ```tsx + * import React from "react" + * import { useAdminCollections } from "medusa-react" + * + * const Collections = () => { + * const { collections, isLoading } = useAdminCollections() + * + * return ( + *
+ * {isLoading && Loading...} + * {collections && !collections.length && + * No Product Collections + * } + * {collections && collections.length > 0 && ( + *
    + * {collections.map((collection) => ( + *
  • {collection.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Collections + * ``` + * + * By default, only the first `10` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminCollections } from "medusa-react" + * + * const Collections = () => { + * const { collections, limit, offset, isLoading } = useAdminCollections({ + * limit: 15, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {collections && !collections.length && + * No Product Collections + * } + * {collections && collections.length > 0 && ( + *
    + * {collections.map((collection) => ( + *
  • {collection.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Collections + * ``` + * + * @customNamespace Hooks.Admin.Product Collections + * @category Queries + */ export const useAdminCollections = ( + /** + * Filters and pagination configurations to apply on the retrieved product collections. + */ query?: AdminGetCollectionsParams, options?: UseQueryOptionsWrapper< Response, @@ -32,7 +104,37 @@ export const useAdminCollections = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a product collection by its ID. The products associated with it are expanded and returned as well. + * + * @example + * import React from "react" + * import { useAdminCollection } from "medusa-react" + * + * type Props = { + * collectionId: string + * } + * + * const Collection = ({ collectionId }: Props) => { + * const { collection, isLoading } = useAdminCollection(collectionId) + * + * return ( + *
+ * {isLoading && Loading...} + * {collection && {collection.title}} + *
+ * ) + * } + * + * export default Collection + * + * @customNamespace Hooks.Admin.Product Collections + * @category Queries + */ export const useAdminCollection = ( + /** + * The product collection's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/currencies/index.ts b/packages/medusa-react/src/hooks/admin/currencies/index.ts index 97c3d1d4b8b69..5242a3f4b0f4a 100644 --- a/packages/medusa-react/src/hooks/admin/currencies/index.ts +++ b/packages/medusa-react/src/hooks/admin/currencies/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Currency API Routes](https://docs.medusajs.com/api/admin#currencies). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A store can use unlimited currencies, and each region must be associated with at least one currency. + * Currencies are defined within the Medusa backend. The methods in this class allow admins to list and update currencies. + * + * Related Guide: [How to manage currencies](https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-currencies). + * + * @customNamespace Hooks.Admin.Currencies + */ + export * from "./mutations" export * from "./queries" diff --git a/packages/medusa-react/src/hooks/admin/currencies/mutations.ts b/packages/medusa-react/src/hooks/admin/currencies/mutations.ts index 857db90a0315a..f287ab152adf0 100644 --- a/packages/medusa-react/src/hooks/admin/currencies/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/currencies/mutations.ts @@ -12,7 +12,43 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminCurrenciesKeys } from "./queries" +/** + * This hook updates a currency's details. + * + * @example + * import React from "react" + * import { useAdminUpdateCurrency } from "medusa-react" + * + * type Props = { + * currencyCode: string + * } + * + * const Currency = ({ currencyCode }: Props) => { + * const updateCurrency = useAdminUpdateCurrency(currencyCode) + * // ... + * + * const handleUpdate = (includes_tax: boolean) => { + * updateCurrency.mutate({ + * includes_tax, + * }, { + * onSuccess: ({ currency }) => { + * console.log(currency) + * } + * }) + * } + * + * // ... + * } + * + * export default Currency + * + * @customNamespace Hooks.Admin.Currencies + * @category Mutations + */ export const useAdminUpdateCurrency = ( + /** + * The currency's code. + */ code: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/currencies/queries.ts b/packages/medusa-react/src/hooks/admin/currencies/queries.ts index 7c13a25755035..8ac1ea672a06c 100644 --- a/packages/medusa-react/src/hooks/admin/currencies/queries.ts +++ b/packages/medusa-react/src/hooks/admin/currencies/queries.ts @@ -14,7 +14,79 @@ export const adminCurrenciesKeys = queryKeysFactory(ADMIN_CURRENCIES_QUERY_KEY) type CurrenciesQueryKey = typeof adminCurrenciesKeys +/** + * This hook retrieves a list of currencies. The currencies can be filtered by fields such as `code`. + * The currencies can also be sorted or paginated. + * + * @example + * To list currencies: + * + * ```ts + * import React from "react" + * import { useAdminCurrencies } from "medusa-react" + * + * const Currencies = () => { + * const { currencies, isLoading } = useAdminCurrencies() + * + * return ( + *
+ * {isLoading && Loading...} + * {currencies && !currencies.length && ( + * No Currencies + * )} + * {currencies && currencies.length > 0 && ( + *
    + * {currencies.map((currency) => ( + *
  • {currency.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Currencies + * ``` + * + * By default, only the first `20` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```ts + * import React from "react" + * import { useAdminCurrencies } from "medusa-react" + * + * const Currencies = () => { + * const { currencies, limit, offset, isLoading } = useAdminCurrencies({ + * limit: 10, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {currencies && !currencies.length && ( + * No Currencies + * )} + * {currencies && currencies.length > 0 && ( + *
    + * {currencies.map((currency) => ( + *
  • {currency.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Currencies + * ``` + * + * @customNamespace Hooks.Admin.Currencies + * @category Queries + */ export const useAdminCurrencies = ( + /** + * Filters and pagination configurations to apply on retrieved currencies. + */ query?: AdminGetCurrenciesParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/custom/index.ts b/packages/medusa-react/src/hooks/admin/custom/index.ts index 1173b2a3e0140..7ab3f97440337 100644 --- a/packages/medusa-react/src/hooks/admin/custom/index.ts +++ b/packages/medusa-react/src/hooks/admin/custom/index.ts @@ -1,2 +1,11 @@ +/** + * @packageDocumentation + * + * This class is used to send requests custom API Routes. All its method + * are available in the JS Client under the `medusa.admin.custom` property. + * + * @customNamespace Hooks.Admin.Custom + */ + export { useAdminCustomDelete, useAdminCustomPost } from "./mutations" export { useAdminCustomQuery } from "./queries" diff --git a/packages/medusa-react/src/hooks/admin/custom/mutations.ts b/packages/medusa-react/src/hooks/admin/custom/mutations.ts index f23839519e570..a93d3f489e42c 100644 --- a/packages/medusa-react/src/hooks/admin/custom/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/custom/mutations.ts @@ -91,12 +91,69 @@ export const buildCustomOptions = < } } +/** + * This hook sends a `POST` request to a custom API Route. + * + * @typeParam TPayload - The type of accepted body parameters which defaults to `Record`. + * @typeParam TResponse - The type of response, which defaults to `any`. + * @typeParamDefinition TResponse - The response based on the specified type for `TResponse`. + * @typeParamDefinition TPayload - The payload based on the specified type for `TPayload`. + * + * @example + * import React from "react" + * import { useAdminCustomPost } from "medusa-react" + * import Post from "./models/Post" + * + * type PostRequest = { + * title: string + * } + * type PostResponse = { + * post: Post + * } + * + * const Custom = () => { + * const customPost = useAdminCustomPost + * ( + * "/blog/posts", + * ["posts"] + * ) + * + * // ... + * + * const handleAction = (title: string) => { + * customPost.mutate({ + * title + * }, { + * onSuccess: ({ post }) => { + * console.log(post) + * } + * }) + * } + * + * // ... + * } + * + * export default Custom + * + * @customNamespace Hooks.Admin.Custom + * @category Mutations + */ export const useAdminCustomPost = < TPayload extends Record, TResponse >( + /** + * The path to the custom endpoint. + */ path: string, + /** + * A list of query keys, used to invalidate data. + */ queryKey: QueryKey, + /** + * A list of related domains that should be invalidated and refetch when the mutation + * function is invoked. + */ relatedDomains?: RelatedDomains, options?: UseMutationOptions, Error, TPayload> ) => { @@ -110,9 +167,57 @@ export const useAdminCustomPost = < ) } +/** + * This hook sends a `DELETE` request to a custom API Route. + * + * @typeParam TResponse - The response's type which defaults to `any`. + * @typeParamDefinition TResponse - The response based on the type provided for `TResponse`. + * + * @example + * import React from "react" + * import { useAdminCustomDelete } from "medusa-react" + * + * type Props = { + * customId: string + * } + * + * const Custom = ({ customId }: Props) => { + * const customDelete = useAdminCustomDelete( + * `/blog/posts/${customId}`, + * ["posts"] + * ) + * + * // ... + * + * const handleAction = (title: string) => { + * customDelete.mutate(void 0, { + * onSuccess: () => { + * // Delete action successful + * } + * }) + * } + * + * // ... + * } + * + * export default Custom + * + * @customNamespace Hooks.Admin.Custom + * @category Mutations + */ export const useAdminCustomDelete = ( + /** + * The path to the custom endpoint. + */ path: string, + /** + * A list of query keys, used to invalidate data. + */ queryKey: QueryKey, + /** + * A list of related domains that should be invalidated and refetch when the mutation + * function is invoked. + */ relatedDomains?: RelatedDomains, options?: UseMutationOptions, Error, void> ) => { diff --git a/packages/medusa-react/src/hooks/admin/custom/queries.ts b/packages/medusa-react/src/hooks/admin/custom/queries.ts index a56da2e594438..d71a44f05f78d 100644 --- a/packages/medusa-react/src/hooks/admin/custom/queries.ts +++ b/packages/medusa-react/src/hooks/admin/custom/queries.ts @@ -3,12 +3,74 @@ import { QueryKey, useQuery } from "@tanstack/react-query" import { useMedusa } from "../../../contexts" import { UseQueryOptionsWrapper } from "../../../types" +/** + * This hook sends a `GET` request to a custom API Route. + * + * @typeParam TQuery - The type of accepted query parameters which defaults to `Record`. + * @typeParam TResponse - The type of response which defaults to `any`. + * @typeParamDefinition TQuery - The query parameters based on the type specified for `TQuery`. + * @typeParamDefinition TResponse - The response based on the type specified for `TResponse`. + * + * @example + * import React from "react" + * import { useAdminCustomQuery } from "medusa-react" + * import Post from "./models/Post" + * + * type RequestQuery = { + * title: string + * } + * + * type ResponseData = { + * posts: Post + * } + * + * const Custom = () => { + * const { data, isLoading } = useAdminCustomQuery + * ( + * "/blog/posts", + * ["posts"], + * { + * title: "My post" + * } + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {data?.posts && !data.posts.length && ( + * No Post + * )} + * {data?.posts && data.posts?.length > 0 && ( + *
    + * {data.posts.map((post) => ( + *
  • {post.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Custom + * + * @customNamespace Hooks.Admin.Custom + * @category Mutations + */ export const useAdminCustomQuery = < TQuery extends Record, TResponse = any >( + /** + * The path to the custom endpoint. + */ path: string, + /** + * A list of query keys, used to invalidate data. + */ queryKey: QueryKey, + /** + * Query parameters to pass to the request. + */ query?: TQuery, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/customer-groups/index.ts b/packages/medusa-react/src/hooks/admin/customer-groups/index.ts index a494946b87dc5..09022b31c862d 100644 --- a/packages/medusa-react/src/hooks/admin/customer-groups/index.ts +++ b/packages/medusa-react/src/hooks/admin/customer-groups/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Customer Group API Routes](https://docs.medusajs.com/api/admin#customer-groups). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Customer Groups can be used to organize customers that share similar data or attributes into dedicated groups. + * This can be useful for different purposes such as setting a different price for a specific customer group. + * + * Related Guide: [How to manage customer groups](https://docs.medusajs.com/modules/customers/admin/manage-customer-groups). + * + * @customNamespace Hooks.Admin.Customer Groups + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts b/packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts index 906a9f26124bb..25b2e0e56e28e 100644 --- a/packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/customer-groups/mutations.ts @@ -18,9 +18,29 @@ import { buildOptions } from "../../utils/buildOptions" import { adminCustomerGroupKeys } from "./queries" /** - * Hook returns functions for creating customer groups. - * - * @param options + * This hook creates a customer group. + * + * @example + * import React from "react" + * import { useAdminCreateCustomerGroup } from "medusa-react" + * + * const CreateCustomerGroup = () => { + * const createCustomerGroup = useAdminCreateCustomerGroup() + * // ... + * + * const handleCreate = (name: string) => { + * createCustomerGroup.mutate({ + * name, + * }) + * } + * + * // ... + * } + * + * export default CreateCustomerGroup + * + * @customNamespace Hooks.Admin.Customer Groups + * @category Mutations */ export const useAdminCreateCustomerGroup = ( options?: UseMutationOptions< @@ -40,12 +60,40 @@ export const useAdminCreateCustomerGroup = ( } /** - * Hook return functions for updating a customer group. - * - * @param id - id of the customer group that is being updated - * @param options + * This hook updates a customer group's details. + * + * @example + * import React from "react" + * import { useAdminUpdateCustomerGroup } from "medusa-react" + * + * type Props = { + * customerGroupId: string + * } + * + * const CustomerGroup = ({ customerGroupId }: Props) => { + * const updateCustomerGroup = useAdminUpdateCustomerGroup( + * customerGroupId + * ) + * // .. + * + * const handleUpdate = (name: string) => { + * updateCustomerGroup.mutate({ + * name, + * }) + * } + * + * // ... + * } + * + * export default CustomerGroup + * + * @customNamespace Hooks.Admin.Customer Groups + * @category Mutations */ export const useAdminUpdateCustomerGroup = ( + /** + * The customer group's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -68,12 +116,38 @@ export const useAdminUpdateCustomerGroup = ( } /** - * Hook return functions for deleting a customer group. + * This hook deletes a customer group. This doesn't delete the customers associated with the customer group. * - * @param id - id of the customer group that is being deleted - * @param options + * @example + * import React from "react" + * import { useAdminDeleteCustomerGroup } from "medusa-react" + * + * type Props = { + * customerGroupId: string + * } + * + * const CustomerGroup = ({ customerGroupId }: Props) => { + * const deleteCustomerGroup = useAdminDeleteCustomerGroup( + * customerGroupId + * ) + * // ... + * + * const handleDeleteCustomerGroup = () => { + * deleteCustomerGroup.mutate() + * } + * + * // ... + * } + * + * export default CustomerGroup + * + * @customNamespace Hooks.Admin.Customer Groups + * @category Mutations */ export const useAdminDeleteCustomerGroup = ( + /** + * The customer group's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -95,12 +169,46 @@ export const useAdminDeleteCustomerGroup = ( } /** - * Hook returns functions for addition of multiple customers to a customer group. + * The hook adds a list of customers to a customer group. * - * @param id - id of the customer group in which customers are being added - * @param options + * @example + * import React from "react" + * import { + * useAdminAddCustomersToCustomerGroup, + * } from "medusa-react" + * + * type Props = { + * customerGroupId: string + * } + * + * const CustomerGroup = ({ customerGroupId }: Props) => { + * const addCustomers = useAdminAddCustomersToCustomerGroup( + * customerGroupId + * ) + * // ... + * + * const handleAddCustomers= (customerId: string) => { + * addCustomers.mutate({ + * customer_ids: [ + * { + * id: customerId, + * }, + * ], + * }) + * } + * + * // ... + * } + * + * export default CustomerGroup + * + * @customNamespace Hooks.Admin.Customer Groups + * @category Mutations */ export const useAdminAddCustomersToCustomerGroup = ( + /** + * The customer group's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -126,12 +234,48 @@ export const useAdminAddCustomersToCustomerGroup = ( } /** - * Hook returns function for removal of multiple customers from a customer group. - * - * @param id - id of a group from which customers will be removed - * @param options + * This hook removes a list of customers from a customer group. This doesn't delete the customer, + * only the association between the customer and the customer group. + * + * @example + * import React from "react" + * import { + * useAdminRemoveCustomersFromCustomerGroup, + * } from "medusa-react" + * + * type Props = { + * customerGroupId: string + * } + * + * const CustomerGroup = ({ customerGroupId }: Props) => { + * const removeCustomers = + * useAdminRemoveCustomersFromCustomerGroup( + * customerGroupId + * ) + * // ... + * + * const handleRemoveCustomer = (customerId: string) => { + * removeCustomers.mutate({ + * customer_ids: [ + * { + * id: customerId, + * }, + * ], + * }) + * } + * + * // ... + * } + * + * export default CustomerGroup + * + * @customNamespace Hooks.Admin.Customer Groups + * @category Mutations */ export const useAdminRemoveCustomersFromCustomerGroup = ( + /** + * The customer group's ID. + */ id: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/customer-groups/queries.ts b/packages/medusa-react/src/hooks/admin/customer-groups/queries.ts index dc142d74a2aa4..f559b2cf25ea8 100644 --- a/packages/medusa-react/src/hooks/admin/customer-groups/queries.ts +++ b/packages/medusa-react/src/hooks/admin/customer-groups/queries.ts @@ -15,6 +15,9 @@ import { queryKeysFactory } from "../../utils" const ADMIN_CUSTOMER_GROUPS_QUERY_KEY = `admin_customer_groups` as const +/** + * @ignore + */ export const adminCustomerGroupKeys = { ...queryKeysFactory(ADMIN_CUSTOMER_GROUPS_QUERY_KEY), detailCustomer(id: string, query?: AdminGetCustomersParams) { @@ -25,14 +28,43 @@ export const adminCustomerGroupKeys = { type CustomerGroupQueryKeys = typeof adminCustomerGroupKeys /** - * Hook retrieves a customer group by id. - * - * @param id - customer group id - * @param query - query params - * @param options + * This hook retrieves a customer group by its ID. You can expand the customer group's relations or + * select the fields that should be returned. + * + * @example + * import React from "react" + * import { useAdminCustomerGroup } from "medusa-react" + * + * type Props = { + * customerGroupId: string + * } + * + * const CustomerGroup = ({ customerGroupId }: Props) => { + * const { customer_group, isLoading } = useAdminCustomerGroup( + * customerGroupId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {customer_group && {customer_group.name}} + *
+ * ) + * } + * + * export default CustomerGroup + * + * @customNamespace Hooks.Admin.Customer Groups + * @category Queries */ export const useAdminCustomerGroup = ( + /** + * The customer group's ID. + */ id: string, + /** + * Configurations to apply on the retrieved customer group. + */ query?: AdminGetCustomerGroupsGroupParams, options?: UseQueryOptionsWrapper< Response, @@ -50,12 +82,133 @@ export const useAdminCustomerGroup = ( } /** - * Hook retrieves a list of customer groups. - * - * @param query - pagination/filtering params - * @param options + * This hook retrieves a list of customer groups. The customer groups can be filtered by fields such as `name` or `id`. + * The customer groups can also be sorted or paginated. + * + * @example + * To list customer groups: + * + * ```tsx + * import React from "react" + * import { useAdminCustomerGroups } from "medusa-react" + * + * const CustomerGroups = () => { + * const { + * customer_groups, + * isLoading, + * } = useAdminCustomerGroups() + * + * return ( + *
+ * {isLoading && Loading...} + * {customer_groups && !customer_groups.length && ( + * No Customer Groups + * )} + * {customer_groups && customer_groups.length > 0 && ( + *
    + * {customer_groups.map( + * (customerGroup) => ( + *
  • + * {customerGroup.name} + *
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default CustomerGroups + * ``` + * + * To specify relations that should be retrieved within the customer groups: + * + * ```tsx + * import React from "react" + * import { useAdminCustomerGroups } from "medusa-react" + * + * const CustomerGroups = () => { + * const { + * customer_groups, + * isLoading, + * } = useAdminCustomerGroups({ + * expand: "customers" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {customer_groups && !customer_groups.length && ( + * No Customer Groups + * )} + * {customer_groups && customer_groups.length > 0 && ( + *
    + * {customer_groups.map( + * (customerGroup) => ( + *
  • + * {customerGroup.name} + *
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default CustomerGroups + * ``` + * + * By default, only the first `10` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminCustomerGroups } from "medusa-react" + * + * const CustomerGroups = () => { + * const { + * customer_groups, + * limit, + * offset, + * isLoading, + * } = useAdminCustomerGroups({ + * expand: "customers", + * limit: 15, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {customer_groups && !customer_groups.length && ( + * No Customer Groups + * )} + * {customer_groups && customer_groups.length > 0 && ( + *
    + * {customer_groups.map( + * (customerGroup) => ( + *
  • + * {customerGroup.name} + *
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default CustomerGroups + * ``` + * + * @customNamespace Hooks.Admin.Customer Groups + * @category Queries */ export const useAdminCustomerGroups = ( + /** + * Filters and pagination configurations to apply on the retrieved customer groups. + */ query?: AdminGetCustomerGroupsParams, options?: UseQueryOptionsWrapper< Response, @@ -73,14 +226,55 @@ export const useAdminCustomerGroups = ( } /** - * Hook retrieves a list of customers that belong to provided groups. - * - * @param id - customer group id - * @param query - pagination/filtering params - * @param options + * This hook retrieves a list of customers in a customer group. The customers can be filtered + * by the `query` field. The customers can also be paginated. + * + * @example + * import React from "react" + * import { useAdminCustomerGroupCustomers } from "medusa-react" + * + * type Props = { + * customerGroupId: string + * } + * + * const CustomerGroup = ({ customerGroupId }: Props) => { + * const { + * customers, + * isLoading, + * } = useAdminCustomerGroupCustomers( + * customerGroupId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {customers && !customers.length && ( + * No customers + * )} + * {customers && customers.length > 0 && ( + *
    + * {customers.map((customer) => ( + *
  • {customer.first_name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default CustomerGroup + * + * @customNamespace Hooks.Admin.Customer Groups + * @category Queries */ export const useAdminCustomerGroupCustomers = ( + /** + * The customer group's ID. + */ id: string, + /** + * Filters and pagination configurations to apply on the retrieved customers. + */ query?: AdminGetCustomersParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/customers/index.ts b/packages/medusa-react/src/hooks/admin/customers/index.ts index a494946b87dc5..91ed416ef11b4 100644 --- a/packages/medusa-react/src/hooks/admin/customers/index.ts +++ b/packages/medusa-react/src/hooks/admin/customers/index.ts @@ -1,2 +1,14 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Customer API Routes](https://docs.medusajs.com/api/admin#customers). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Related Guide: [How to manage customers](https://docs.medusajs.com/modules/customers/admin/manage-customers). + * + * @customNamespace Hooks.Admin.Customers + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/customers/mutations.ts b/packages/medusa-react/src/hooks/admin/customers/mutations.ts index 7b4e8202ee12f..495075cd85258 100644 --- a/packages/medusa-react/src/hooks/admin/customers/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/customers/mutations.ts @@ -15,6 +15,40 @@ import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" import { adminCustomerKeys } from "./queries" +/** + * This hook creates a customer as an admin. + * + * @example + * import React from "react" + * import { useAdminCreateCustomer } from "medusa-react" + * + * type CustomerData = { + * first_name: string + * last_name: string + * email: string + * password: string + * } + * + * const CreateCustomer = () => { + * const createCustomer = useAdminCreateCustomer() + * // ... + * + * const handleCreate = (customerData: CustomerData) => { + * createCustomer.mutate(customerData, { + * onSuccess: ({ customer }) => { + * console.log(customer.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateCustomer + * + * @customNamespace Hooks.Admin.Customers + * @category Mutations + */ export const useAdminCreateCustomer = ( options?: UseMutationOptions< Response, @@ -31,7 +65,44 @@ export const useAdminCreateCustomer = ( ) } +/** + * This hook updates a customer's details. + * + * @example + * import React from "react" + * import { useAdminUpdateCustomer } from "medusa-react" + * + * type CustomerData = { + * first_name: string + * last_name: string + * email: string + * password: string + * } + * + * type Props = { + * customerId: string + * } + * + * const Customer = ({ customerId }: Props) => { + * const updateCustomer = useAdminUpdateCustomer(customerId) + * // ... + * + * const handleUpdate = (customerData: CustomerData) => { + * updateCustomer.mutate(customerData) + * } + * + * // ... + * } + * + * export default Customer + * + * @customNamespace Hooks.Admin.Customers + * @category Mutations + */ export const useAdminUpdateCustomer = ( + /** + * The customer's ID. + */ id: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/customers/queries.ts b/packages/medusa-react/src/hooks/admin/customers/queries.ts index c890a0d577740..c59a03cb92c49 100644 --- a/packages/medusa-react/src/hooks/admin/customers/queries.ts +++ b/packages/medusa-react/src/hooks/admin/customers/queries.ts @@ -15,7 +15,86 @@ export const adminCustomerKeys = queryKeysFactory(ADMIN_CUSTOMERS_QUERY_KEY) type CustomerQueryKeys = typeof adminCustomerKeys +/** + * This hook retrieves a list of Customers. The customers can be filtered by fields such as + * `q` or `groups`. The customers can also be paginated. + * + * @example + * To list customers: + * + * ```tsx + * import React from "react" + * import { useAdminCustomers } from "medusa-react" + * + * const Customers = () => { + * const { customers, isLoading } = useAdminCustomers() + * + * return ( + *
+ * {isLoading && Loading...} + * {customers && !customers.length && ( + * No customers + * )} + * {customers && customers.length > 0 && ( + *
    + * {customers.map((customer) => ( + *
  • {customer.first_name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Customers + * ``` + * + * You can specify relations to be retrieved within each customer. In addition, by default, only the first `50` records are retrieved. + * You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminCustomers } from "medusa-react" + * + * const Customers = () => { + * const { + * customers, + * limit, + * offset, + * isLoading + * } = useAdminCustomers({ + * expand: "billing_address", + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {customers && !customers.length && ( + * No customers + * )} + * {customers && customers.length > 0 && ( + *
    + * {customers.map((customer) => ( + *
  • {customer.first_name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Customers + * ``` + * + * @customNamespace Hooks.Admin.Customers + * @category Queries + */ export const useAdminCustomers = ( + /** + * Filters and pagination configurations to apply on the retrieved customers. + */ query?: AdminGetCustomersParams, options?: UseQueryOptionsWrapper< Response, @@ -32,7 +111,39 @@ export const useAdminCustomers = ( return { ...data, ...rest } as const } +/** + * This hook retrieves the details of a customer. + * + * @example + * import React from "react" + * import { useAdminCustomer } from "medusa-react" + * + * type Props = { + * customerId: string + * } + * + * const Customer = ({ customerId }: Props) => { + * const { customer, isLoading } = useAdminCustomer( + * customerId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {customer && {customer.first_name}} + *
+ * ) + * } + * + * export default Customer + * + * @customNamespace Hooks.Admin.Customers + * @category Queries + */ export const useAdminCustomer = ( + /** + * The customer's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/discounts/index.ts b/packages/medusa-react/src/hooks/admin/discounts/index.ts index a494946b87dc5..4f50d4431a67a 100644 --- a/packages/medusa-react/src/hooks/admin/discounts/index.ts +++ b/packages/medusa-react/src/hooks/admin/discounts/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Discount API Routes](https://docs.medusajs.com/api/admin#discounts). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Admins can create discounts with conditions and rules, providing them with advanced settings for variety of cases. + * The methods in this class can be used to manage discounts, their conditions, resources, and more. + * + * Related Guide: [How to manage discounts](https://docs.medusajs.com/modules/discounts/admin/manage-discounts). + * + * @customNamespace Hooks.Admin.Discounts + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/discounts/mutations.ts b/packages/medusa-react/src/hooks/admin/discounts/mutations.ts index ffdc9d0515505..47e2ab664bb86 100644 --- a/packages/medusa-react/src/hooks/admin/discounts/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/discounts/mutations.ts @@ -20,9 +20,115 @@ import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" import { adminDiscountKeys } from "./queries" +/** + * This hook adds a batch of resources to a discount condition. The type of resource depends on the type of discount condition. + * For example, if the discount condition's type is `products`, the resources being added should be products. + * + * @example + * To add resources to a discount condition: + * + * ```tsx + * import React from "react" + * import { + * useAdminAddDiscountConditionResourceBatch + * } from "medusa-react" + * + * type Props = { + * discountId: string + * conditionId: string + * } + * + * const DiscountCondition = ({ + * discountId, + * conditionId + * }: Props) => { + * const addConditionResources = useAdminAddDiscountConditionResourceBatch( + * discountId, + * conditionId + * ) + * // ... + * + * const handleAdd = (itemId: string) => { + * addConditionResources.mutate({ + * resources: [ + * { + * id: itemId + * } + * ] + * }, { + * onSuccess: ({ discount }) => { + * console.log(discount.id) + * } + * }) + * } + * + * // ... + * } + * + * export default DiscountCondition + * ``` + * + * To specify relations to include in the returned discount: + * + * ```tsx + * import React from "react" + * import { + * useAdminAddDiscountConditionResourceBatch + * } from "medusa-react" + * + * type Props = { + * discountId: string + * conditionId: string + * } + * + * const DiscountCondition = ({ + * discountId, + * conditionId + * }: Props) => { + * const addConditionResources = useAdminAddDiscountConditionResourceBatch( + * discountId, + * conditionId, + * { + * expand: "rule" + * } + * ) + * // ... + * + * const handleAdd = (itemId: string) => { + * addConditionResources.mutate({ + * resources: [ + * { + * id: itemId + * } + * ] + * }, { + * onSuccess: ({ discount }) => { + * console.log(discount.id) + * } + * }) + * } + * + * // ... + * } + * + * export default DiscountCondition + * ``` + * + * @customNamespace Hooks.Admin.Discounts + * @category Mutations + */ export const useAdminAddDiscountConditionResourceBatch = ( + /** + * The ID of the discount the condition belongs to. + */ discountId: string, + /** + * The discount condition's ID. + */ conditionId: string, + /** + * Configurations to apply on the retrieved discount. + */ query?: AdminPostDiscountsDiscountConditionsConditionBatchParams, options?: UseMutationOptions< Response, @@ -44,8 +150,61 @@ export const useAdminAddDiscountConditionResourceBatch = ( ) } +/** + * This hook remove a batch of resources from a discount condition. This will only remove the association between the resource and + * the discount condition, not the resource itself. + * + * @example + * import React from "react" + * import { + * useAdminDeleteDiscountConditionResourceBatch + * } from "medusa-react" + * + * type Props = { + * discountId: string + * conditionId: string + * } + * + * const DiscountCondition = ({ + * discountId, + * conditionId + * }: Props) => { + * const deleteConditionResource = useAdminDeleteDiscountConditionResourceBatch( + * discountId, + * conditionId, + * ) + * // ... + * + * const handleDelete = (itemId: string) => { + * deleteConditionResource.mutate({ + * resources: [ + * { + * id: itemId + * } + * ] + * }, { + * onSuccess: ({ discount }) => { + * console.log(discount.id) + * } + * }) + * } + * + * // ... + * } + * + * export default DiscountCondition + * + * @customNamespace Hooks.Admin.Discounts + * @category Mutations + */ export const useAdminDeleteDiscountConditionResourceBatch = ( + /** + * The ID of the discount the condition belongs to. + */ discountId: string, + /** + * The discount condition's ID. + */ conditionId: string, options?: UseMutationOptions< Response, @@ -67,6 +226,51 @@ export const useAdminDeleteDiscountConditionResourceBatch = ( ) } +/** + * This hook creates a discount with a given set of rules that defines how the discount is applied. + * + * @example + * import React from "react" + * import { + * useAdminCreateDiscount, + * } from "medusa-react" + * import { + * AllocationType, + * DiscountRuleType, + * } from "@medusajs/medusa" + * + * const CreateDiscount = () => { + * const createDiscount = useAdminCreateDiscount() + * // ... + * + * const handleCreate = ( + * currencyCode: string, + * regionId: string + * ) => { + * // ... + * createDiscount.mutate({ + * code: currencyCode, + * rule: { + * type: DiscountRuleType.FIXED, + * value: 10, + * allocation: AllocationType.ITEM, + * }, + * regions: [ + * regionId, + * ], + * is_dynamic: false, + * is_disabled: false, + * }) + * } + * + * // ... + * } + * + * export default CreateDiscount + * + * @customNamespace Hooks.Admin.Discounts + * @category Mutations + */ export const useAdminCreateDiscount = ( options?: UseMutationOptions< Response, @@ -82,7 +286,39 @@ export const useAdminCreateDiscount = ( ) } +/** + * This hook updates a discount with a given set of rules that define how the discount is applied. + * + * @example + * import React from "react" + * import { useAdminUpdateDiscount } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const updateDiscount = useAdminUpdateDiscount(discountId) + * // ... + * + * const handleUpdate = (isDisabled: boolean) => { + * updateDiscount.mutate({ + * is_disabled: isDisabled, + * }) + * } + * + * // ... + * } + * + * export default Discount + * + * @customNamespace Hooks.Admin.Discounts + * @category Mutations + */ export const useAdminUpdateDiscount = ( + /** + * The discount's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -99,7 +335,33 @@ export const useAdminUpdateDiscount = ( ) } +/** + * This hook deletes a discount. Deleting the discount will make it unavailable for customers to use. + * + * @example + * import React from "react" + * import { useAdminDeleteDiscount } from "medusa-react" + * + * const Discount = () => { + * const deleteDiscount = useAdminDeleteDiscount(discount_id) + * // ... + * + * const handleDelete = () => { + * deleteDiscount.mutate() + * } + * + * // ... + * } + * + * export default Discount + * + * @customNamespace Hooks.Admin.Discounts + * @category Mutations + */ export const useAdminDeleteDiscount = ( + /** + * The discount's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -111,7 +373,43 @@ export const useAdminDeleteDiscount = ( ) } +/** + * This hook adds a Region to the list of Regions a Discount can be used in. + * + * @typeParamDefinition string - The ID of the region to add. + * + * @example + * import React from "react" + * import { useAdminDiscountAddRegion } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const addRegion = useAdminDiscountAddRegion(discountId) + * // ... + * + * const handleAdd = (regionId: string) => { + * addRegion.mutate(regionId, { + * onSuccess: ({ discount }) => { + * console.log(discount.regions) + * } + * }) + * } + * + * // ... + * } + * + * export default Discount + * + * @customNamespace Hooks.Admin.Discounts + * @category Mutations + */ export const useAdminDiscountAddRegion = ( + /** + * The discount's ID. + */ id: string, options?: UseMutationOptions, Error, string> ) => { @@ -123,7 +421,44 @@ export const useAdminDiscountAddRegion = ( ) } +/** + * This hook removes a Region from the list of Regions that a Discount can be used in. + * This does not delete a region, only the association between it and the discount. + * + * @typeParamDefinition string - The ID of the region to remove. + * + * @example + * import React from "react" + * import { useAdminDiscountRemoveRegion } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const deleteRegion = useAdminDiscountRemoveRegion(discountId) + * // ... + * + * const handleDelete = (regionId: string) => { + * deleteRegion.mutate(regionId, { + * onSuccess: ({ discount }) => { + * console.log(discount.regions) + * } + * }) + * } + * + * // ... + * } + * + * export default Discount + * + * @customNamespace Hooks.Admin.Discounts + * @category Mutations + */ export const useAdminDiscountRemoveRegion = ( + /** + * The discount's ID. + */ id: string, options?: UseMutationOptions, Error, string> ) => { @@ -135,7 +470,48 @@ export const useAdminDiscountRemoveRegion = ( ) } +/** + * This hook creates a dynamic unique code that can map to a parent discount. This is useful if you want to + * automatically generate codes with the same rules and conditions. + * + * @example + * import React from "react" + * import { useAdminCreateDynamicDiscountCode } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const createDynamicDiscount = useAdminCreateDynamicDiscountCode(discountId) + * // ... + * + * const handleCreate = ( + * code: string, + * usageLimit: number + * ) => { + * createDynamicDiscount.mutate({ + * code, + * usage_limit: usageLimit + * }, { + * onSuccess: ({ discount }) => { + * console.log(discount.is_dynamic) + * } + * }) + * } + * + * // ... + * } + * + * export default Discount + * + * @customNamespace Hooks.Admin.Discounts + * @category Mutations + */ export const useAdminCreateDynamicDiscountCode = ( + /** + * The discount's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -156,7 +532,43 @@ export const useAdminCreateDynamicDiscountCode = ( ) } +/** + * This hook deletes a dynamic code from a discount. + * + * @typeParamDefinition string - The code of the dynamic discount to delete. + * + * @example + * import React from "react" + * import { useAdminDeleteDynamicDiscountCode } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const deleteDynamicDiscount = useAdminDeleteDynamicDiscountCode(discountId) + * // ... + * + * const handleDelete = (code: string) => { + * deleteDynamicDiscount.mutate(code, { + * onSuccess: ({ discount }) => { + * console.log(discount.is_dynamic) + * } + * }) + * } + * + * // ... + * } + * + * export default Discount + * + * @customNamespace Hooks.Admin.Discounts + * @category Mutations + */ export const useAdminDeleteDynamicDiscountCode = ( + /** + * The discount's ID. + */ id: string, options?: UseMutationOptions, Error, string> ) => { @@ -172,7 +584,50 @@ export const useAdminDeleteDynamicDiscountCode = ( ) } +/** + * This hook creates a discount condition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` + * should be provided in the `payload` parameter, based on the type of discount condition. For example, if the discount condition's type is `products`, + * the `products` field should be provided in the `payload` parameter. + * + * @example + * import React from "react" + * import { DiscountConditionOperator } from "@medusajs/medusa" + * import { useAdminDiscountCreateCondition } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const createCondition = useAdminDiscountCreateCondition(discountId) + * // ... + * + * const handleCreateCondition = ( + * operator: DiscountConditionOperator, + * products: string[] + * ) => { + * createCondition.mutate({ + * operator, + * products + * }, { + * onSuccess: ({ discount }) => { + * console.log(discount.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Discount + * + * @customNamespace Hooks.Admin.Discounts + * @category Mutations + */ export const useAdminDiscountCreateCondition = ( + /** + * The discount's ID. + */ discountId: string, options?: UseMutationOptions< Response, @@ -189,8 +644,58 @@ export const useAdminDiscountCreateCondition = ( ) } +/** + * Update a discount condition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` + * should be provided in the `payload` parameter, based on the type of discount condition. For example, if the discount condition's + * type is `products`, the `products` field should be provided in the `payload` parameter. + * + * @example + * import React from "react" + * import { useAdminDiscountUpdateCondition } from "medusa-react" + * + * type Props = { + * discountId: string + * conditionId: string + * } + * + * const DiscountCondition = ({ + * discountId, + * conditionId + * }: Props) => { + * const update = useAdminDiscountUpdateCondition( + * discountId, + * conditionId + * ) + * // ... + * + * const handleUpdate = ( + * products: string[] + * ) => { + * update.mutate({ + * products + * }, { + * onSuccess: ({ discount }) => { + * console.log(discount.id) + * } + * }) + * } + * + * // ... + * } + * + * export default DiscountCondition + * + * @customNamespace Hooks.Admin.Discounts + * @category Mutations + */ export const useAdminDiscountUpdateCondition = ( + /** + * The discount's ID. + */ discountId: string, + /** + * The discount condition's ID. + */ conditionId: string, options?: UseMutationOptions< Response, @@ -207,7 +712,47 @@ export const useAdminDiscountUpdateCondition = ( ) } +/** + * This hook deletes a discount condition. This doesn't delete resources associated to the discount condition. + * + * @typeParamDefinition string - The ID of the condition to delete. + * + * @example + * import React from "react" + * import { useAdminDiscountRemoveCondition } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const deleteCondition = useAdminDiscountRemoveCondition( + * discountId + * ) + * // ... + * + * const handleDelete = ( + * conditionId: string + * ) => { + * deleteCondition.mutate(conditionId, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(deleted) + * } + * }) + * } + * + * // ... + * } + * + * export default Discount + * + * @customNamespace Hooks.Admin.Discounts + * @category Mutations + */ export const useAdminDiscountRemoveCondition = ( + /** + * The discount's ID. + */ discountId: string, options?: UseMutationOptions, Error, string> ) => { diff --git a/packages/medusa-react/src/hooks/admin/discounts/queries.ts b/packages/medusa-react/src/hooks/admin/discounts/queries.ts index c147496585451..720a5c4945a09 100644 --- a/packages/medusa-react/src/hooks/admin/discounts/queries.ts +++ b/packages/medusa-react/src/hooks/admin/discounts/queries.ts @@ -27,7 +27,116 @@ export const adminDiscountKeys = { type DiscountQueryKeys = typeof adminDiscountKeys +/** + * This hook retrieves a list of Discounts. The discounts can be filtered by fields such as `rule` or `is_dynamic`. + * The discounts can also be paginated. + * + * @example + * To list discounts: + * + * ```tsx + * import React from "react" + * import { useAdminDiscounts } from "medusa-react" + * + * const Discounts = () => { + * const { discounts, isLoading } = useAdminDiscounts() + * + * return ( + *
+ * {isLoading && Loading...} + * {discounts && !discounts.length && ( + * No customers + * )} + * {discounts && discounts.length > 0 && ( + *
    + * {discounts.map((discount) => ( + *
  • {discount.code}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Discounts + * ``` + * + * To specify relations that should be retrieved within the discounts: + * + * ```tsx + * import React from "react" + * import { useAdminDiscounts } from "medusa-react" + * + * const Discounts = () => { + * const { discounts, isLoading } = useAdminDiscounts({ + * expand: "rule" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {discounts && !discounts.length && ( + * No customers + * )} + * {discounts && discounts.length > 0 && ( + *
    + * {discounts.map((discount) => ( + *
  • {discount.code}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Discounts + * ``` + * + * By default, only the first `20` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminDiscounts } from "medusa-react" + * + * const Discounts = () => { + * const { + * discounts, + * limit, + * offset, + * isLoading + * } = useAdminDiscounts({ + * expand: "rule", + * limit: 10, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {discounts && !discounts.length && ( + * No customers + * )} + * {discounts && discounts.length > 0 && ( + *
    + * {discounts.map((discount) => ( + *
  • {discount.code}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Discounts + * ``` + * + * @customNamespace Hooks.Admin.Discounts + * @category Queries + */ export const useAdminDiscounts = ( + /** + * Filters and pagination configurations to apply on the retrieved discounts. + */ query?: AdminGetDiscountsParams, options?: UseQueryOptionsWrapper< Response, @@ -44,8 +153,43 @@ export const useAdminDiscounts = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a discount. + * + * @example + * import React from "react" + * import { useAdminDiscount } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const { discount, isLoading } = useAdminDiscount( + * discountId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {discount && {discount.code}} + *
+ * ) + * } + * + * export default Discount + * + * @customNamespace Hooks.Admin.Discounts + * @category Queries + */ export const useAdminDiscount = ( + /** + * The discount's ID. + */ id: string, + /** + * Configurations to apply on the retrieved discount. + */ query?: AdminGetDiscountParams, options?: UseQueryOptionsWrapper< Response, @@ -62,7 +206,40 @@ export const useAdminDiscount = ( return { ...data, ...rest } as const } +/** + * This hook adds a batch of resources to a discount condition. The type of resource depends on the type of discount condition. For example, if the discount condition's type is `products`, + * the resources being added should be products. + * + * @example + * import React from "react" + * import { useAdminGetDiscountByCode } from "medusa-react" + * + * type Props = { + * discountCode: string + * } + * + * const Discount = ({ discountCode }: Props) => { + * const { discount, isLoading } = useAdminGetDiscountByCode( + * discountCode + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {discount && {discount.code}} + *
+ * ) + * } + * + * export default Discount + * + * @customNamespace Hooks.Admin.Discounts + * @category Queries + */ export const useAdminGetDiscountByCode = ( + /** + * The code of the discount. + */ code: string, options?: UseQueryOptionsWrapper< Response, @@ -79,9 +256,57 @@ export const useAdminGetDiscountByCode = ( return { ...data, ...rest } as const } +/** + * This hook retries a Discount Condition's details. + * + * @example + * import React from "react" + * import { useAdminGetDiscountCondition } from "medusa-react" + * + * type Props = { + * discountId: string + * discountConditionId: string + * } + * + * const DiscountCondition = ({ + * discountId, + * discountConditionId + * }: Props) => { + * const { + * discount_condition, + * isLoading + * } = useAdminGetDiscountCondition( + * discountId, + * discountConditionId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {discount_condition && ( + * {discount_condition.type} + * )} + *
+ * ) + * } + * + * export default DiscountCondition + * + * @customNamespace Hooks.Admin.Discounts + * @category Queries + */ export const useAdminGetDiscountCondition = ( + /** + * The ID of the discount the condition belongs to. + */ id: string, + /** + * The discount condition's ID. + */ conditionId: string, + /** + * Configurations to apply on the retrieved discount condition. + */ query?: AdminGetDiscountsDiscountConditionsConditionParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/draft-orders/index.ts b/packages/medusa-react/src/hooks/admin/draft-orders/index.ts index a494946b87dc5..ffd53780a7dbd 100644 --- a/packages/medusa-react/src/hooks/admin/draft-orders/index.ts +++ b/packages/medusa-react/src/hooks/admin/draft-orders/index.ts @@ -1,2 +1,16 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Draft Order API Routes](https://docs.medusajs.com/api/admin#draft-orders). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A draft order is an order created manually by the admin. It allows admins to create orders without direct involvement from the customer. + * + * Related Guide: [How to manage draft orders](https://docs.medusajs.com/modules/orders/admin/manage-draft-orders). + * + * @customNamespace Hooks.Admin.Draft Orders + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts b/packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts index e87cf572f1097..089dcc5286336 100644 --- a/packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/draft-orders/mutations.ts @@ -17,6 +17,46 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminDraftOrderKeys } from "./queries" +/** + * This hook creates a Draft Order. A draft order is not transformed into an order until payment is captured. + * + * @example + * import React from "react" + * import { useAdminCreateDraftOrder } from "medusa-react" + * + * type DraftOrderData = { + * email: string + * region_id: string + * items: { + * quantity: number, + * variant_id: string + * }[] + * shipping_methods: { + * option_id: string + * price: number + * }[] + * } + * + * const CreateDraftOrder = () => { + * const createDraftOrder = useAdminCreateDraftOrder() + * // ... + * + * const handleCreate = (data: DraftOrderData) => { + * createDraftOrder.mutate(data, { + * onSuccess: ({ draft_order }) => { + * console.log(draft_order.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateDraftOrder + * + * @customNamespace Hooks.Admin.Draft Orders + * @category Mutations + */ export const useAdminCreateDraftOrder = ( options?: UseMutationOptions< Response, @@ -33,7 +73,45 @@ export const useAdminCreateDraftOrder = ( ) } +/** + * This hook updates a Draft Order's details. + * + * @example + * import React from "react" + * import { useAdminUpdateDraftOrder } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const updateDraftOrder = useAdminUpdateDraftOrder( + * draftOrderId + * ) + * // ... + * + * const handleUpdate = (email: string) => { + * updateDraftOrder.mutate({ + * email, + * }, { + * onSuccess: ({ draft_order }) => { + * console.log(draft_order.id) + * } + * }) + * } + * + * // ... + * } + * + * export default DraftOrder + * + * @customNamespace Hooks.Admin.Draft Orders + * @category Mutations + */ export const useAdminUpdateDraftOrder = ( + /** + * The draft order's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -54,7 +132,43 @@ export const useAdminUpdateDraftOrder = ( ) } +/** + * This hook deletes a Draft Order. + * + * @example + * import React from "react" + * import { useAdminDeleteDraftOrder } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const deleteDraftOrder = useAdminDeleteDraftOrder( + * draftOrderId + * ) + * // ... + * + * const handleDelete = () => { + * deleteDraftOrder.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default DraftOrder + * + * @customNamespace Hooks.Admin.Draft Orders + * @category Mutations + */ export const useAdminDeleteDraftOrder = ( + /** + * The draft order's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -70,7 +184,44 @@ export const useAdminDeleteDraftOrder = ( ) } +/** + * This hook capture the draft order's payment. This will also set the draft order's status to `completed` and create an order from the draft order. The payment is captured through Medusa's system payment, + * which is manual payment that isn't integrated with any third-party payment provider. It is assumed that the payment capturing is handled manually by the admin. + * + * @example + * import React from "react" + * import { useAdminDraftOrderRegisterPayment } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const registerPayment = useAdminDraftOrderRegisterPayment( + * draftOrderId + * ) + * // ... + * + * const handlePayment = () => { + * registerPayment.mutate(void 0, { + * onSuccess: ({ order }) => { + * console.log(order.id) + * } + * }) + * } + * + * // ... + * } + * + * export default DraftOrder + * + * @customNamespace Hooks.Admin.Draft Orders + * @category Mutations + */ export const useAdminDraftOrderRegisterPayment = ( + /** + * The draft order's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -86,7 +237,45 @@ export const useAdminDraftOrderRegisterPayment = ( ) } +/** + * This hook creates a Line Item in the Draft Order. + * + * @example + * import React from "react" + * import { useAdminDraftOrderAddLineItem } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const addLineItem = useAdminDraftOrderAddLineItem( + * draftOrderId + * ) + * // ... + * + * const handleAdd = (quantity: number) => { + * addLineItem.mutate({ + * quantity, + * }, { + * onSuccess: ({ draft_order }) => { + * console.log(draft_order.cart) + * } + * }) + * } + * + * // ... + * } + * + * export default DraftOrder + * + * @customNamespace Hooks.Admin.Draft Orders + * @category Mutations + */ export const useAdminDraftOrderAddLineItem = ( + /** + * The draft order's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -103,7 +292,45 @@ export const useAdminDraftOrderAddLineItem = ( ) } +/** + * This hook deletes a Line Item from a Draft Order. + * + * @typeParamDefinition string - The ID of the line item to remove. + * + * @example + * import React from "react" + * import { useAdminDraftOrderRemoveLineItem } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const deleteLineItem = useAdminDraftOrderRemoveLineItem( + * draftOrderId + * ) + * // ... + * + * const handleDelete = (itemId: string) => { + * deleteLineItem.mutate(itemId, { + * onSuccess: ({ draft_order }) => { + * console.log(draft_order.cart) + * } + * }) + * } + * + * // ... + * } + * + * export default DraftOrder + * + * @customNamespace Hooks.Admin.Draft Orders + * @category Mutations + */ export const useAdminDraftOrderRemoveLineItem = ( + /** + * The draft order's ID. + */ id: string, options?: UseMutationOptions, Error, string> ) => { @@ -115,12 +342,60 @@ export const useAdminDraftOrderRemoveLineItem = ( ) } +/** + * The details to update of the line item. + */ +export type AdminDraftOrderUpdateLineItemReq = AdminPostDraftOrdersDraftOrderLineItemsItemReq & { + /** + * The line item's ID to update. + */ + item_id: string +} + +/** + * This hook updates a Line Item in a Draft Order. + * + * @example + * import React from "react" + * import { useAdminDraftOrderUpdateLineItem } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const updateLineItem = useAdminDraftOrderUpdateLineItem( + * draftOrderId + * ) + * // ... + * + * const handleUpdate = ( + * itemId: string, + * quantity: number + * ) => { + * updateLineItem.mutate({ + * item_id: itemId, + * quantity, + * }) + * } + * + * // ... + * } + * + * export default DraftOrder + * + * @customNamespace Hooks.Admin.Draft Orders + * @category Mutations + */ export const useAdminDraftOrderUpdateLineItem = ( + /** + * The draft order's ID. + */ id: string, options?: UseMutationOptions< Response, Error, - AdminPostDraftOrdersDraftOrderLineItemsItemReq & { item_id: string } + AdminDraftOrderUpdateLineItemReq > ) => { const { client } = useMedusa() @@ -129,7 +404,7 @@ export const useAdminDraftOrderUpdateLineItem = ( ({ item_id, ...payload - }: AdminPostDraftOrdersDraftOrderLineItemsItemReq & { item_id: string }) => + }: AdminDraftOrderUpdateLineItemReq) => client.admin.draftOrders.updateLineItem(id, item_id, payload), buildOptions(queryClient, adminDraftOrderKeys.detail(id), options) ) diff --git a/packages/medusa-react/src/hooks/admin/draft-orders/queries.ts b/packages/medusa-react/src/hooks/admin/draft-orders/queries.ts index e3c68c92171df..5c7315a4000ec 100644 --- a/packages/medusa-react/src/hooks/admin/draft-orders/queries.ts +++ b/packages/medusa-react/src/hooks/admin/draft-orders/queries.ts @@ -17,7 +17,83 @@ export const adminDraftOrderKeys = queryKeysFactory( type DraftOrderQueryKeys = typeof adminDraftOrderKeys +/** + * This hook retrieves an list of Draft Orders. The draft orders can be filtered by parameters such as `query`. The draft orders can also paginated. + * + * @example + * To list draft orders: + * + * ```tsx + * import React from "react" + * import { useAdminDraftOrders } from "medusa-react" + * + * const DraftOrders = () => { + * const { draft_orders, isLoading } = useAdminDraftOrders() + * + * return ( + *
+ * {isLoading && Loading...} + * {draft_orders && !draft_orders.length && ( + * No Draft Orders + * )} + * {draft_orders && draft_orders.length > 0 && ( + *
    + * {draft_orders.map((order) => ( + *
  • {order.display_id}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default DraftOrders + * ``` + * + * By default, only the first `50` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminDraftOrders } from "medusa-react" + * + * const DraftOrders = () => { + * const { + * draft_orders, + * limit, + * offset, + * isLoading + * } = useAdminDraftOrders({ + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {draft_orders && !draft_orders.length && ( + * No Draft Orders + * )} + * {draft_orders && draft_orders.length > 0 && ( + *
    + * {draft_orders.map((order) => ( + *
  • {order.display_id}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default DraftOrders + * ``` + * + * @customNamespace Hooks.Admin.Draft Orders + * @category Queries + */ export const useAdminDraftOrders = ( + /** + * Filters and pagination configurations to apply on the retrieved draft orders. + */ query?: AdminGetDraftOrdersParams, options?: UseQueryOptionsWrapper< Response, @@ -34,7 +110,41 @@ export const useAdminDraftOrders = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a Draft Order's details. + * + * @example + * import React from "react" + * import { useAdminDraftOrder } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const { + * draft_order, + * isLoading, + * } = useAdminDraftOrder(draftOrderId) + * + * return ( + *
+ * {isLoading && Loading...} + * {draft_order && {draft_order.display_id}} + * + *
+ * ) + * } + * + * export default DraftOrder + * + * @customNamespace Hooks.Admin.Draft Orders + * @category Queries + */ export const useAdminDraftOrder = ( + /** + * The draft order's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/gift-cards/index.ts b/packages/medusa-react/src/hooks/admin/gift-cards/index.ts index a494946b87dc5..0be7ee8e00839 100644 --- a/packages/medusa-react/src/hooks/admin/gift-cards/index.ts +++ b/packages/medusa-react/src/hooks/admin/gift-cards/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Gift Card API Routes](https://docs.medusajs.com/api/admin#gift-cards). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Admins can create gift cards and send them directly to customers, specifying options like their balance, region, and more. + * These gift cards are different than the saleable gift cards in a store, which are created and managed through {@link Hooks.Admin.Products.useAdminCreateProduct | useAdminCreateProduct}. + * + * Related Guide: [How to manage gift cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-custom-gift-cards). + * + * @customNamespace Hooks.Admin.Gift Cards + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts b/packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts index ea48da48779c7..cffc32353e2b2 100644 --- a/packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/gift-cards/mutations.ts @@ -14,6 +14,39 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminGiftCardKeys } from "./queries" +/** + * This hook creates a gift card that can redeemed by its unique code. The Gift Card is only valid within one region. + * + * @example + * import React from "react" + * import { useAdminCreateGiftCard } from "medusa-react" + * + * const CreateCustomGiftCards = () => { + * const createGiftCard = useAdminCreateGiftCard() + * // ... + * + * const handleCreate = ( + * regionId: string, + * value: number + * ) => { + * createGiftCard.mutate({ + * region_id: regionId, + * value, + * }, { + * onSuccess: ({ gift_card }) => { + * console.log(gift_card.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateCustomGiftCards + * + * @customNamespace Hooks.Admin.Gift Cards + * @category Mutations + */ export const useAdminCreateGiftCard = ( options?: UseMutationOptions< Response, @@ -29,7 +62,45 @@ export const useAdminCreateGiftCard = ( ) } +/** + * This hook updates a gift card's details. + * + * @example + * import React from "react" + * import { useAdminUpdateGiftCard } from "medusa-react" + * + * type Props = { + * customGiftCardId: string + * } + * + * const CustomGiftCard = ({ customGiftCardId }: Props) => { + * const updateGiftCard = useAdminUpdateGiftCard( + * customGiftCardId + * ) + * // ... + * + * const handleUpdate = (regionId: string) => { + * updateGiftCard.mutate({ + * region_id: regionId, + * }, { + * onSuccess: ({ gift_card }) => { + * console.log(gift_card.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CustomGiftCard + * + * @customNamespace Hooks.Admin.Gift Cards + * @category Mutations + */ export const useAdminUpdateGiftCard = ( + /** + * The gift card's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -51,7 +122,43 @@ export const useAdminUpdateGiftCard = ( ) } +/** + * This hook deletes a gift card. Once deleted, it can't be used by customers. + * + * @example + * import React from "react" + * import { useAdminDeleteGiftCard } from "medusa-react" + * + * type Props = { + * customGiftCardId: string + * } + * + * const CustomGiftCard = ({ customGiftCardId }: Props) => { + * const deleteGiftCard = useAdminDeleteGiftCard( + * customGiftCardId + * ) + * // ... + * + * const handleDelete = () => { + * deleteGiftCard.mutate(void 0, { + * onSuccess: ({ id, object, deleted}) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default CustomGiftCard + * + * @customNamespace Hooks.Admin.Gift Cards + * @category Mutations + */ export const useAdminDeleteGiftCard = ( + /** + * The gift card's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { diff --git a/packages/medusa-react/src/hooks/admin/gift-cards/queries.ts b/packages/medusa-react/src/hooks/admin/gift-cards/queries.ts index bd1ad0618d6d1..ae9c446308607 100644 --- a/packages/medusa-react/src/hooks/admin/gift-cards/queries.ts +++ b/packages/medusa-react/src/hooks/admin/gift-cards/queries.ts @@ -15,7 +15,84 @@ export const adminGiftCardKeys = queryKeysFactory(ADMIN_GIFT_CARDS_QUERY_KEY) type GiftCardQueryKeys = typeof adminGiftCardKeys +/** + * This hook retrieves a list of gift cards. The gift cards can be filtered by fields such as `q` passed in the `query` + * parameter. The gift cards can also paginated. + * + * @example + * To list gift cards: + * + * ```tsx + * import React from "react" + * import { useAdminGiftCards } from "medusa-react" + * + * const CustomGiftCards = () => { + * const { gift_cards, isLoading } = useAdminGiftCards() + * + * return ( + *
+ * {isLoading && Loading...} + * {gift_cards && !gift_cards.length && ( + * No custom gift cards... + * )} + * {gift_cards && gift_cards.length > 0 && ( + *
    + * {gift_cards.map((giftCard) => ( + *
  • {giftCard.code}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default CustomGiftCards + * ``` + * + * By default, only the first `50` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminGiftCards } from "medusa-react" + * + * const CustomGiftCards = () => { + * const { + * gift_cards, + * limit, + * offset, + * isLoading + * } = useAdminGiftCards({ + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {gift_cards && !gift_cards.length && ( + * No custom gift cards... + * )} + * {gift_cards && gift_cards.length > 0 && ( + *
    + * {gift_cards.map((giftCard) => ( + *
  • {giftCard.code}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default CustomGiftCards + * ``` + * + * @customNamespace Hooks.Admin.Gift Cards + * @category Queries + */ export const useAdminGiftCards = ( + /** + * Filters and pagination configurations to apply on the retrieved gift cards. + */ query?: AdminGetGiftCardsParams, options?: UseQueryOptionsWrapper< Response, @@ -32,7 +109,37 @@ export const useAdminGiftCards = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a gift card's details. + * + * @example + * import React from "react" + * import { useAdminGiftCard } from "medusa-react" + * + * type Props = { + * giftCardId: string + * } + * + * const CustomGiftCard = ({ giftCardId }: Props) => { + * const { gift_card, isLoading } = useAdminGiftCard(giftCardId) + * + * return ( + *
+ * {isLoading && Loading...} + * {gift_card && {gift_card.code}} + *
+ * ) + * } + * + * export default CustomGiftCard + * + * @customNamespace Hooks.Admin.Gift Cards + * @category Queries + */ export const useAdminGiftCard = ( + /** + * The gift card's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/inventory-item/index.ts b/packages/medusa-react/src/hooks/admin/inventory-item/index.ts index a494946b87dc5..cef82cb3bcc76 100644 --- a/packages/medusa-react/src/hooks/admin/inventory-item/index.ts +++ b/packages/medusa-react/src/hooks/admin/inventory-item/index.ts @@ -1,2 +1,19 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Inventory Item API Routes](https://docs.medusajs.com/api/admin#inventory-items). + * To use these hooks, make sure to install the + * [@medusajs/inventory](https://docs.medusajs.com/modules/multiwarehouse/install-modules#inventory-module) module in your Medusa backend. + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Inventory items, provided by the [Inventory Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module), can be + * used to manage the inventory of saleable items in your store. + * + * Related Guide: [How to manage inventory items](https://docs.medusajs.com/modules/multiwarehouse/admin/manage-inventory-items). + * + * @customNamespace Hooks.Admin.Inventory Items + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts b/packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts index 289f7a94f2376..3ba9d96cd5d68 100644 --- a/packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts @@ -17,9 +17,35 @@ import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" import { adminInventoryItemsKeys } from "./queries" -// inventory item - -// create inventory item +/** + * This hook creates an Inventory Item for a product variant. + * + * @example + * import React from "react" + * import { useAdminCreateInventoryItem } from "medusa-react" + * + * const CreateInventoryItem = () => { + * const createInventoryItem = useAdminCreateInventoryItem() + * // ... + * + * const handleCreate = (variantId: string) => { + * createInventoryItem.mutate({ + * variant_id: variantId, + * }, { + * onSuccess: ({ inventory_item }) => { + * console.log(inventory_item.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateInventoryItem + * + * @customNamespace Hooks.Admin.Inventory Items + * @category Mutations + */ export const useAdminCreateInventoryItem = ( options?: UseMutationOptions< Response, @@ -42,8 +68,45 @@ export const useAdminCreateInventoryItem = ( } -// update inventory item +/** + * This hook updates an Inventory Item's details. + * + * @example + * import React from "react" + * import { useAdminUpdateInventoryItem } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const updateInventoryItem = useAdminUpdateInventoryItem( + * inventoryItemId + * ) + * // ... + * + * const handleUpdate = (origin_country: string) => { + * updateInventoryItem.mutate({ + * origin_country, + * }, { + * onSuccess: ({ inventory_item }) => { + * console.log(inventory_item.origin_country) + * } + * }) + * } + * + * // ... + * } + * + * export default InventoryItem + * + * @customNamespace Hooks.Admin.Inventory Items + * @category Mutations + */ export const useAdminUpdateInventoryItem = ( + /** + * The inventory item's ID. + */ inventoryItemId: string, options?: UseMutationOptions< Response, @@ -65,8 +128,39 @@ export const useAdminUpdateInventoryItem = ( ) } -// delete inventory item +/** + * This hook deletes an Inventory Item. This does not delete the associated product variant. + * + * @example + * import React from "react" + * import { useAdminDeleteInventoryItem } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const deleteInventoryItem = useAdminDeleteInventoryItem( + * inventoryItemId + * ) + * // ... + * + * const handleDelete = () => { + * deleteInventoryItem.mutate() + * } + * + * // ... + * } + * + * export default InventoryItem + * + * @customNamespace Hooks.Admin.Inventory Items + * @category Mutations + */ export const useAdminDeleteInventoryItem = ( + /** + * The inventory item's ID. + */ inventoryItemId: string, options?: UseMutationOptions< Response, @@ -87,15 +181,61 @@ export const useAdminDeleteInventoryItem = ( ) } -// location level +export type AdminUpdateLocationLevelReq = AdminPostInventoryItemsItemLocationLevelsLevelReq & { + /** + * The ID of the location level to update. + */ + stockLocationId: string +} + +/** + * This hook updates a location level's details for a given inventory item. + * + * @example + * import React from "react" + * import { useAdminUpdateLocationLevel } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const updateLocationLevel = useAdminUpdateLocationLevel( + * inventoryItemId + * ) + * // ... + * + * const handleUpdate = ( + * stockLocationId: string, + * stockedQuantity: number + * ) => { + * updateLocationLevel.mutate({ + * stockLocationId, + * stocked_quantity: stockedQuantity, + * }, { + * onSuccess: ({ inventory_item }) => { + * console.log(inventory_item.id) + * } + * }) + * } + * + * // ... + * } + * + * export default InventoryItem + * + * @customNamespace Hooks.Admin.Inventory Items + * @category Mutations + */ export const useAdminUpdateLocationLevel = ( + /** + * The inventory item's ID. + */ inventoryItemId: string, options?: UseMutationOptions< Response, Error, - AdminPostInventoryItemsItemLocationLevelsLevelReq & { - stockLocationId: string - } + AdminUpdateLocationLevelReq > ) => { const { client } = useMedusa() @@ -103,9 +243,7 @@ export const useAdminUpdateLocationLevel = ( return useMutation( ( - payload: AdminPostInventoryItemsItemLocationLevelsLevelReq & { - stockLocationId: string - } + payload: AdminUpdateLocationLevelReq ) => client.admin.inventoryItems.updateLocationLevel( inventoryItemId, @@ -126,7 +264,43 @@ export const useAdminUpdateLocationLevel = ( ) } +/** + * This hook deletes a location level of an Inventory Item. + * + * @typeParamDefinition string - The ID of the location level to delete. + * + * @example + * import React from "react" + * import { useAdminDeleteLocationLevel } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const deleteLocationLevel = useAdminDeleteLocationLevel( + * inventoryItemId + * ) + * // ... + * + * const handleDelete = ( + * locationId: string + * ) => { + * deleteLocationLevel.mutate(locationId) + * } + * + * // ... + * } + * + * export default InventoryItem + * + * @customNamespace Hooks.Admin.Inventory Items + * @category Mutations + */ export const useAdminDeleteLocationLevel = ( + /** + * The inventory item's ID. + */ inventoryItemId: string, options?: UseMutationOptions, Error, string> ) => { @@ -150,7 +324,49 @@ export const useAdminDeleteLocationLevel = ( ) } +/** + * This hook creates a Location Level for a given Inventory Item. + * + * @example + * import React from "react" + * import { useAdminCreateLocationLevel } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const createLocationLevel = useAdminCreateLocationLevel( + * inventoryItemId + * ) + * // ... + * + * const handleCreateLocationLevel = ( + * locationId: string, + * stockedQuantity: number + * ) => { + * createLocationLevel.mutate({ + * location_id: locationId, + * stocked_quantity: stockedQuantity, + * }, { + * onSuccess: ({ inventory_item }) => { + * console.log(inventory_item.id) + * } + * }) + * } + * + * // ... + * } + * + * export default InventoryItem + * + * @customNamespace Hooks.Admin.Inventory Items + * @category Mutations + */ export const useAdminCreateLocationLevel = ( + /** + * The inventory item's ID. + */ inventoryItemId: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/inventory-item/queries.ts b/packages/medusa-react/src/hooks/admin/inventory-item/queries.ts index 8f41a7e400869..2ffa41b34b3ae 100644 --- a/packages/medusa-react/src/hooks/admin/inventory-item/queries.ts +++ b/packages/medusa-react/src/hooks/admin/inventory-item/queries.ts @@ -21,7 +21,91 @@ export const adminInventoryItemsKeys = queryKeysFactory( type InventoryItemsQueryKeys = typeof adminInventoryItemsKeys +/** + * This hook retrieves a list of inventory items. The inventory items can be filtered by fields such as `q` or `location_id` passed in the `query` parameter. + * The inventory items can also be paginated. + * + * @example + * To list inventory items: + * + * ```tsx + * import React from "react" + * import { useAdminInventoryItems } from "medusa-react" + * + * function InventoryItems() { + * const { + * inventory_items, + * isLoading + * } = useAdminInventoryItems() + * + * return ( + *
+ * {isLoading && Loading...} + * {inventory_items && !inventory_items.length && ( + * No Items + * )} + * {inventory_items && inventory_items.length > 0 && ( + *
    + * {inventory_items.map( + * (item) => ( + *
  • {item.id}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default InventoryItems + * ``` + * + * By default, only the first `20` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminInventoryItems } from "medusa-react" + * + * function InventoryItems() { + * const { + * inventory_items, + * limit, + * offset, + * isLoading + * } = useAdminInventoryItems({ + * limit: 10, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {inventory_items && !inventory_items.length && ( + * No Items + * )} + * {inventory_items && inventory_items.length > 0 && ( + *
    + * {inventory_items.map( + * (item) => ( + *
  • {item.id}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default InventoryItems + * ``` + * + * @customNamespace Hooks.Admin.Inventory Items + * @category Queries + */ export const useAdminInventoryItems = ( + /** + * Filters and pagination configurations applied on the retrieved inventory items. + */ query?: AdminGetInventoryItemsParams, options?: UseQueryOptionsWrapper< Response, @@ -40,8 +124,46 @@ export const useAdminInventoryItems = ( return { ...data, ...rest } as const } +/** + * This hook retrieves an Inventory Item's details. + * + * @example + * import React from "react" + * import { useAdminInventoryItem } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const { + * inventory_item, + * isLoading + * } = useAdminInventoryItem(inventoryItemId) + * + * return ( + *
+ * {isLoading && Loading...} + * {inventory_item && ( + * {inventory_item.sku} + * )} + *
+ * ) + * } + * + * export default InventoryItem + * + * @customNamespace Hooks.Admin.Inventory Items + * @category Queries + */ export const useAdminInventoryItem = ( + /** + * The inventory item's ID. + */ inventoryItemId: string, + /** + * Configurations applied on the retrieved inventory item. + */ query?: AdminGetStockLocationsParams, options?: UseQueryOptionsWrapper< Response, @@ -60,8 +182,53 @@ export const useAdminInventoryItem = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a list of inventory levels of an inventory item. The inventory levels can be filtered by fields + * such as `location_id` passed in the `query` parameter. + * + * @example + * import React from "react" + * import { + * useAdminInventoryItemLocationLevels, + * } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const { + * inventory_item, + * isLoading, + * } = useAdminInventoryItemLocationLevels(inventoryItemId) + * + * return ( + *
+ * {isLoading && Loading...} + * {inventory_item && ( + *
    + * {inventory_item.location_levels.map((level) => ( + * {level.stocked_quantity} + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default InventoryItem + * + * @customNamespace Hooks.Admin.Inventory Items + * @category Queries + */ export const useAdminInventoryItemLocationLevels = ( + /** + * The ID of the inventory item that the location levels belong to. + */ inventoryItemId: string, + /** + * Filters to apply on the retrieved location levels. + */ query?: AdminGetInventoryItemsItemLocationLevelsParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/invites/index.ts b/packages/medusa-react/src/hooks/admin/invites/index.ts index a494946b87dc5..1444fbf0a0587 100644 --- a/packages/medusa-react/src/hooks/admin/invites/index.ts +++ b/packages/medusa-react/src/hooks/admin/invites/index.ts @@ -1,2 +1,16 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Invite API Routes](https://docs.medusajs.com/api/admin#invites). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * An admin can invite new users to manage their team. This would allow new users to authenticate as admins and perform admin functionalities. + * + * Related Guide: [How to manage invites](https://docs.medusajs.com/modules/users/admin/manage-invites). + * + * @customNamespace Hooks.Admin.Invites + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/invites/mutations.ts b/packages/medusa-react/src/hooks/admin/invites/mutations.ts index c34fdb4f728b8..ab4dfe31ad13f 100644 --- a/packages/medusa-react/src/hooks/admin/invites/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/invites/mutations.ts @@ -12,6 +12,46 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminInviteKeys } from "./queries" +/** + * This hook accepts an Invite. This will also delete the invite and create a new user that can log in and perform admin functionalities. + * The user will have the email associated with the invite, and the password provided in the mutation function's parameter. + * + * @example + * import React from "react" + * import { useAdminAcceptInvite } from "medusa-react" + * + * const AcceptInvite = () => { + * const acceptInvite = useAdminAcceptInvite() + * // ... + * + * const handleAccept = ( + * token: string, + * firstName: string, + * lastName: string, + * password: string + * ) => { + * acceptInvite.mutate({ + * token, + * user: { + * first_name: firstName, + * last_name: lastName, + * password, + * }, + * }, { + * onSuccess: () => { + * // invite accepted successfully. + * } + * }) + * } + * + * // ... + * } + * + * export default AcceptInvite + * + * @customNamespace Hooks.Admin.Invites + * @category Mutations + */ export const useAdminAcceptInvite = ( options?: UseMutationOptions< Response, @@ -29,7 +69,43 @@ export const useAdminAcceptInvite = ( ) } +/** + * This hook resends an invite. This renews the expiry date by seven days and generates a new token for the invite. It also triggers the `invite.created` event, + * so if you have a Notification Provider installed that handles this event, a notification should be sent to the email associated with the + * invite to allow them to accept the invite. + * + * @example + * import React from "react" + * import { useAdminResendInvite } from "medusa-react" + * + * type Props = { + * inviteId: string + * } + * + * const ResendInvite = ({ inviteId }: Props) => { + * const resendInvite = useAdminResendInvite(inviteId) + * // ... + * + * const handleResend = () => { + * resendInvite.mutate(void 0, { + * onSuccess: () => { + * // invite resent successfully + * } + * }) + * } + * + * // ... + * } + * + * export default ResendInvite + * + * @customNamespace Hooks.Admin.Invites + * @category Mutations + */ export const useAdminResendInvite = ( + /** + * The invite's ID. + */ id: string, options?: UseMutationOptions ) => { @@ -49,7 +125,41 @@ export const useAdminCreateInvite = ( ) } +/** + * This hook deletes an invite. Only invites that weren't accepted can be deleted. + * + * @example + * import React from "react" + * import { useAdminDeleteInvite } from "medusa-react" + * + * type Props = { + * inviteId: string + * } + * + * const DeleteInvite = ({ inviteId }: Props) => { + * const deleteInvite = useAdminDeleteInvite(inviteId) + * // ... + * + * const handleDelete = () => { + * deleteInvite.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Invite + * + * @customNamespace Hooks.Admin.Invites + * @category Mutations + */ export const useAdminDeleteInvite = ( + /** + * The invite's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { diff --git a/packages/medusa-react/src/hooks/admin/invites/queries.ts b/packages/medusa-react/src/hooks/admin/invites/queries.ts index 591d68f9cd50c..7aab357db1db5 100644 --- a/packages/medusa-react/src/hooks/admin/invites/queries.ts +++ b/packages/medusa-react/src/hooks/admin/invites/queries.ts @@ -11,6 +11,38 @@ export const adminInviteKeys = queryKeysFactory(ADMIN_INVITES_QUERY_KEY) type InviteQueryKeys = typeof adminInviteKeys +/** + * This hook retrieves a list of invites. + * + * @example + * import React from "react" + * import { useAdminInvites } from "medusa-react" + * + * const Invites = () => { + * const { invites, isLoading } = useAdminInvites() + * + * return ( + *
+ * {isLoading && Loading...} + * {invites && !invites.length && ( + * No Invites) + * } + * {invites && invites.length > 0 && ( + *
    + * {invites.map((invite) => ( + *
  • {invite.user_email}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Invites + * + * @customNamespace Hooks.Admin.Invites + * @category Queries + */ export const useAdminInvites = ( options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/notes/index.ts b/packages/medusa-react/src/hooks/admin/notes/index.ts index a494946b87dc5..023f0d35176a9 100644 --- a/packages/medusa-react/src/hooks/admin/notes/index.ts +++ b/packages/medusa-react/src/hooks/admin/notes/index.ts @@ -1,2 +1,14 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Note API Routes](https://docs.medusajs.com/api/admin#notes). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Notes are created by admins and can be associated with any resource. For example, an admin can add a note to an order for additional details or remarks. + * + * @customNamespace Hooks.Admin.Notes + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/notes/mutations.ts b/packages/medusa-react/src/hooks/admin/notes/mutations.ts index 1f452b78c4ea9..d28178aa3c20a 100644 --- a/packages/medusa-react/src/hooks/admin/notes/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/notes/mutations.ts @@ -14,6 +14,37 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminNoteKeys } from "./queries" +/** + * This hook creates a Note which can be associated with any resource. + * + * @example + * import React from "react" + * import { useAdminCreateNote } from "medusa-react" + * + * const CreateNote = () => { + * const createNote = useAdminCreateNote() + * // ... + * + * const handleCreate = () => { + * createNote.mutate({ + * resource_id: "order_123", + * resource_type: "order", + * value: "We delivered this order" + * }, { + * onSuccess: ({ note }) => { + * console.log(note.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateNote + * + * @customNamespace Hooks.Admin.Notes + * @category Mutations + */ export const useAdminCreateNote = ( options?: UseMutationOptions< Response, @@ -29,7 +60,45 @@ export const useAdminCreateNote = ( ) } +/** + * This hook updates a Note's details. + * + * @example + * import React from "react" + * import { useAdminUpdateNote } from "medusa-react" + * + * type Props = { + * noteId: string + * } + * + * const Note = ({ noteId }: Props) => { + * const updateNote = useAdminUpdateNote(noteId) + * // ... + * + * const handleUpdate = ( + * value: string + * ) => { + * updateNote.mutate({ + * value + * }, { + * onSuccess: ({ note }) => { + * console.log(note.value) + * } + * }) + * } + * + * // ... + * } + * + * export default Note + * + * @customNamespace Hooks.Admin.Notes + * @category Mutations + */ export const useAdminUpdateNote = ( + /** + * The note's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -50,7 +119,37 @@ export const useAdminUpdateNote = ( ) } +/** + * This hook deletes a Note. + * + * @example + * import React from "react" + * import { useAdminDeleteNote } from "medusa-react" + * + * type Props = { + * noteId: string + * } + * + * const Note = ({ noteId }: Props) => { + * const deleteNote = useAdminDeleteNote(noteId) + * // ... + * + * const handleDelete = () => { + * deleteNote.mutate() + * } + * + * // ... + * } + * + * export default Note + * + * @customNamespace Hooks.Admin.Notes + * @category Mutations + */ export const useAdminDeleteNote = ( + /** + * The note's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { diff --git a/packages/medusa-react/src/hooks/admin/notes/queries.ts b/packages/medusa-react/src/hooks/admin/notes/queries.ts index 44b9ddd085e2a..cc78d5a6a73d1 100644 --- a/packages/medusa-react/src/hooks/admin/notes/queries.ts +++ b/packages/medusa-react/src/hooks/admin/notes/queries.ts @@ -15,7 +15,80 @@ export const adminNoteKeys = queryKeysFactory(ADMIN_NOTE_QUERY_KEY) type NoteQueryKeys = typeof adminNoteKeys +/** + * This hook retrieves a list of notes. The notes can be filtered by fields such as `resource_id` passed in + * the `query` parameter. The notes can also be paginated. + * + * @example + * To list notes: + * + * ```tsx + * import React from "react" + * import { useAdminNotes } from "medusa-react" + * + * const Notes = () => { + * const { notes, isLoading } = useAdminNotes() + * + * return ( + *
+ * {isLoading && Loading...} + * {notes && !notes.length && No Notes} + * {notes && notes.length > 0 && ( + *
    + * {notes.map((note) => ( + *
  • {note.resource_type}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Notes + * ``` + * + * By default, only the first `50` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminNotes } from "medusa-react" + * + * const Notes = () => { + * const { + * notes, + * limit, + * offset, + * isLoading + * } = useAdminNotes({ + * limit: 40, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {notes && !notes.length && No Notes} + * {notes && notes.length > 0 && ( + *
    + * {notes.map((note) => ( + *
  • {note.resource_type}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Notes + * ``` + * + * @customNamespace Hooks.Admin.Notes + * @category Queries + */ export const useAdminNotes = ( + /** + * Filters and pagination configurations applied on retrieved notes. + */ query?: AdminGetNotesParams, options?: UseQueryOptionsWrapper< Response, @@ -32,7 +105,37 @@ export const useAdminNotes = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a note's details. + * + * @example + * import React from "react" + * import { useAdminNote } from "medusa-react" + * + * type Props = { + * noteId: string + * } + * + * const Note = ({ noteId }: Props) => { + * const { note, isLoading } = useAdminNote(noteId) + * + * return ( + *
+ * {isLoading && Loading...} + * {note && {note.resource_type}} + *
+ * ) + * } + * + * export default Note + * + * @customNamespace Hooks.Admin.Notes + * @category Queries + */ export const useAdminNote = ( + /** + * The note's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/notifications/index.ts b/packages/medusa-react/src/hooks/admin/notifications/index.ts index a494946b87dc5..963466c20c88f 100644 --- a/packages/medusa-react/src/hooks/admin/notifications/index.ts +++ b/packages/medusa-react/src/hooks/admin/notifications/index.ts @@ -1,2 +1,15 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Notification API Routes](https://docs.medusajs.com/api/admin#notifications). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Notifications are sent to customers to inform them of new updates. For example, a notification can be sent to the customer when their order is place or its state is updated. + * The notification's type, such as an email or SMS, is determined by the notification provider installed on the Medusa backend. + * + * @customNamespace Hooks.Admin.Notifications + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/notifications/mutations.ts b/packages/medusa-react/src/hooks/admin/notifications/mutations.ts index a77e868e40611..9cc787ab63e7c 100644 --- a/packages/medusa-react/src/hooks/admin/notifications/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/notifications/mutations.ts @@ -12,7 +12,43 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminNotificationKeys } from "./queries" +/** + * This hook resends a previously sent notifications, with the same data but optionally to a different address. + * + * @example + * import React from "react" + * import { useAdminResendNotification } from "medusa-react" + * + * type Props = { + * notificationId: string + * } + * + * const Notification = ({ notificationId }: Props) => { + * const resendNotification = useAdminResendNotification( + * notificationId + * ) + * // ... + * + * const handleResend = () => { + * resendNotification.mutate({}, { + * onSuccess: ({ notification }) => { + * console.log(notification.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Notification + * + * @customNamespace Hooks.Admin.Notifications + * @category Mutations + */ export const useAdminResendNotification = ( + /** + * The ID of the notification. + */ id: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/notifications/queries.ts b/packages/medusa-react/src/hooks/admin/notifications/queries.ts index 6d07ac247c921..ffc6e06328c39 100644 --- a/packages/medusa-react/src/hooks/admin/notifications/queries.ts +++ b/packages/medusa-react/src/hooks/admin/notifications/queries.ts @@ -16,7 +16,116 @@ export const adminNotificationKeys = queryKeysFactory( type NotificationQueryKeys = typeof adminNotificationKeys +/** + * This hook retrieves a list of notifications. The notifications can be filtered by fields such as `event_name` or `resource_type` passed in the `query` parameter. + * The notifications can also be paginated. + * + * @example + * To list notifications: + * + * ```tsx + * import React from "react" + * import { useAdminNotifications } from "medusa-react" + * + * const Notifications = () => { + * const { notifications, isLoading } = useAdminNotifications() + * + * return ( + *
+ * {isLoading && Loading...} + * {notifications && !notifications.length && ( + * No Notifications + * )} + * {notifications && notifications.length > 0 && ( + *
    + * {notifications.map((notification) => ( + *
  • {notification.to}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Notifications + * ``` + * + * To specify relations that should be retrieved within the notifications: + * + * ```tsx + * import React from "react" + * import { useAdminNotifications } from "medusa-react" + * + * const Notifications = () => { + * const { notifications, isLoading } = useAdminNotifications({ + * expand: "provider" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {notifications && !notifications.length && ( + * No Notifications + * )} + * {notifications && notifications.length > 0 && ( + *
    + * {notifications.map((notification) => ( + *
  • {notification.to}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Notifications + * ``` + * + * By default, only the first `50` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminNotifications } from "medusa-react" + * + * const Notifications = () => { + * const { + * notifications, + * limit, + * offset, + * isLoading + * } = useAdminNotifications({ + * expand: "provider", + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {notifications && !notifications.length && ( + * No Notifications + * )} + * {notifications && notifications.length > 0 && ( + *
    + * {notifications.map((notification) => ( + *
  • {notification.to}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Notifications + * ``` + * + * @customNamespace Hooks.Admin.Notifications + * @category Queries + */ export const useAdminNotifications = ( + /** + * Filters and pagination configurations applied to the retrieved notifications. + */ query?: AdminGetNotificationsParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/order-edits/index.ts b/packages/medusa-react/src/hooks/admin/order-edits/index.ts index a494946b87dc5..eb52fb09386d5 100644 --- a/packages/medusa-react/src/hooks/admin/order-edits/index.ts +++ b/packages/medusa-react/src/hooks/admin/order-edits/index.ts @@ -1,2 +1,16 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Order Edit API Routes](https://docs.medusajs.com/api/admin#order-edits). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * An admin can edit an order to remove, add, or update an item's quantity. When an admin edits an order, they're stored as an `OrderEdit`. + * + * Related Guide: [How to edit an order](https://docs.medusajs.com/modules/orders/admin/edit-order). + * + * @customNamespace Hooks.Admin.Order Edits + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/order-edits/mutations.ts b/packages/medusa-react/src/hooks/admin/order-edits/mutations.ts index 67e24a6774c98..dd2b6b8bfeca1 100644 --- a/packages/medusa-react/src/hooks/admin/order-edits/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/order-edits/mutations.ts @@ -20,6 +20,34 @@ import { buildOptions } from "../../utils/buildOptions" import { adminOrderKeys } from "../orders" import { adminOrderEditsKeys } from "./queries" +/** + * This hook creates an order edit. + * + * @example + * import React from "react" + * import { useAdminCreateOrderEdit } from "medusa-react" + * + * const CreateOrderEdit = () => { + * const createOrderEdit = useAdminCreateOrderEdit() + * + * const handleCreateOrderEdit = (orderId: string) => { + * createOrderEdit.mutate({ + * order_id: orderId, + * }, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateOrderEdit + * + * @customNamespace Hooks.Admin.Order Edits + * @category Mutations + */ export const useAdminCreateOrderEdit = ( options?: UseMutationOptions< Response, @@ -40,7 +68,42 @@ export const useAdminCreateOrderEdit = ( ) } +/** + * This hook deletes an order edit. Only order edits that have the status `created` can be deleted. + * + * @example + * import React from "react" + * import { useAdminDeleteOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const deleteOrderEdit = useAdminDeleteOrderEdit( + * orderEditId + * ) + * + * const handleDelete = () => { + * deleteOrderEdit.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit + * + * @customNamespace Hooks.Admin.Order Edits + * @category Mutations + */ export const useAdminDeleteOrderEdit = ( + /** + * Order Edit's ID + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -61,8 +124,51 @@ export const useAdminDeleteOrderEdit = ( ) } +/** + * This hook deletes a line item change that indicates the addition, deletion, or update of a line item in the original order. + * + * @example + * import React from "react" + * import { useAdminDeleteOrderEditItemChange } from "medusa-react" + * + * type Props = { + * orderEditId: string + * itemChangeId: string + * } + * + * const OrderEditItemChange = ({ + * orderEditId, + * itemChangeId + * }: Props) => { + * const deleteItemChange = useAdminDeleteOrderEditItemChange( + * orderEditId, + * itemChangeId + * ) + * + * const handleDeleteItemChange = () => { + * deleteItemChange.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEditItemChange + * + * @customNamespace Hooks.Admin.Order Edits + * @category Mutations + */ export const useAdminDeleteOrderEditItemChange = ( + /** + * The order edit's ID. + */ orderEditId: string, + /** + * The line item change's ID. + */ itemChangeId: string, options?: UseMutationOptions< Response, @@ -83,8 +189,54 @@ export const useAdminDeleteOrderEditItemChange = ( ) } +/** + * This hook creates or updates a line item change in the order edit that indicates addition, deletion, or update of a line item + * into an original order. Line item changes are only reflected on the original order after the order edit is confirmed. + * + * @example + * import React from "react" + * import { useAdminOrderEditUpdateLineItem } from "medusa-react" + * + * type Props = { + * orderEditId: string + * itemId: string + * } + * + * const OrderEditItemChange = ({ + * orderEditId, + * itemId + * }: Props) => { + * const updateLineItem = useAdminOrderEditUpdateLineItem( + * orderEditId, + * itemId + * ) + * + * const handleUpdateLineItem = (quantity: number) => { + * updateLineItem.mutate({ + * quantity, + * }, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.items) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEditItemChange + * + * @customNamespace Hooks.Admin.Order Edits + * @category Mutations + */ export const useAdminOrderEditUpdateLineItem = ( + /** + * The order edit's ID. + */ orderEditId: string, + /** + * The line item's ID. + */ itemId: string, options?: UseMutationOptions< Response, @@ -106,8 +258,52 @@ export const useAdminOrderEditUpdateLineItem = ( ) } +/** + * This hook creates a line item change in the order edit that indicates deleting an item in the original order. + * The item in the original order will not be deleted until the order edit is confirmed. + * + * @example + * import React from "react" + * import { useAdminOrderEditDeleteLineItem } from "medusa-react" + * + * type Props = { + * orderEditId: string + * itemId: string + * } + * + * const OrderEditLineItem = ({ + * orderEditId, + * itemId + * }: Props) => { + * const removeLineItem = useAdminOrderEditDeleteLineItem( + * orderEditId, + * itemId + * ) + * + * const handleRemoveLineItem = () => { + * removeLineItem.mutate(void 0, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.changes) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEditLineItem + * + * @customNamespace Hooks.Admin.Order Edits + * @category Mutations + */ export const useAdminOrderEditDeleteLineItem = ( + /** + * The order edit's ID. + */ orderEditId: string, + /** + * The line item's ID. + */ itemId: string, options?: UseMutationOptions, Error> ) => { @@ -124,7 +320,46 @@ export const useAdminOrderEditDeleteLineItem = ( ) } +/** + * This hook updates an Order Edit's details. + * + * @example + * import React from "react" + * import { useAdminUpdateOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const updateOrderEdit = useAdminUpdateOrderEdit( + * orderEditId, + * ) + * + * const handleUpdate = ( + * internalNote: string + * ) => { + * updateOrderEdit.mutate({ + * internal_note: internalNote + * }, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.internal_note) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit + * + * @customNamespace Hooks.Admin.Order Edits + * @category Mutations + */ export const useAdminUpdateOrderEdit = ( + /** + * The order edit's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -150,7 +385,47 @@ export const useAdminUpdateOrderEdit = ( ) } +/** + * This hook creates a line item change in the order edit that indicates adding an item in the original order. + * The item will not be added to the original order until the order edit is confirmed. + * + * @example + * import React from "react" + * import { useAdminOrderEditAddLineItem } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const addLineItem = useAdminOrderEditAddLineItem( + * orderEditId + * ) + * + * const handleAddLineItem = + * (quantity: number, variantId: string) => { + * addLineItem.mutate({ + * quantity, + * variant_id: variantId, + * }, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.changes) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit + * + * @customNamespace Hooks.Admin.Order Edits + * @category Mutations + */ export const useAdminOrderEditAddLineItem = ( + /** + * The order edit's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -171,7 +446,49 @@ export const useAdminOrderEditAddLineItem = ( ) } +/** + * This hook requests customer confirmation of an order edit. This would emit the event `order-edit.requested` which Notification Providers listen to and send + * a notification to the customer about the order edit. + * + * @example + * import React from "react" + * import { + * useAdminRequestOrderEditConfirmation, + * } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const requestOrderConfirmation = + * useAdminRequestOrderEditConfirmation( + * orderEditId + * ) + * + * const handleRequestConfirmation = () => { + * requestOrderConfirmation.mutate(void 0, { + * onSuccess: ({ order_edit }) => { + * console.log( + * order_edit.requested_at, + * order_edit.requested_by + * ) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit + * + * @customNamespace Hooks.Admin.Order Edits + * @category Mutations + */ export const useAdminRequestOrderEditConfirmation = ( + /** + * The order edit's ID. + */ id: string, options?: UseMutationOptions, Error> ) => { @@ -192,7 +509,47 @@ export const useAdminRequestOrderEditConfirmation = ( ) } +/** + * This hook cancels an order edit. + * + * @example + * import React from "react" + * import { + * useAdminCancelOrderEdit, + * } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const cancelOrderEdit = + * useAdminCancelOrderEdit( + * orderEditId + * ) + * + * const handleCancel = () => { + * cancelOrderEdit.mutate(void 0, { + * onSuccess: ({ order_edit }) => { + * console.log( + * order_edit.id + * ) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit + * + * @customNamespace Hooks.Admin.Order Edits + * @category Mutations + */ export const useAdminCancelOrderEdit = ( + /** + * The order edit's ID. + */ id: string, options?: UseMutationOptions, Error> ) => { @@ -213,7 +570,45 @@ export const useAdminCancelOrderEdit = ( ) } +/** + * This hook confirms an order edit. This will reflect the changes in the order edit on the associated order. + * + * @example + * import React from "react" + * import { useAdminConfirmOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const confirmOrderEdit = useAdminConfirmOrderEdit( + * orderEditId + * ) + * + * const handleConfirmOrderEdit = () => { + * confirmOrderEdit.mutate(void 0, { + * onSuccess: ({ order_edit }) => { + * console.log( + * order_edit.confirmed_at, + * order_edit.confirmed_by + * ) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit + * + * @customNamespace Hooks.Admin.Order Edits + * @category Mutations + */ export const useAdminConfirmOrderEdit = ( + /** + * The order edit's ID. + */ id: string, options?: UseMutationOptions, Error> ) => { diff --git a/packages/medusa-react/src/hooks/admin/order-edits/queries.ts b/packages/medusa-react/src/hooks/admin/order-edits/queries.ts index f2e6539317631..1b387ac3e8d05 100644 --- a/packages/medusa-react/src/hooks/admin/order-edits/queries.ts +++ b/packages/medusa-react/src/hooks/admin/order-edits/queries.ts @@ -15,8 +15,80 @@ const ADMIN_ORDER_EDITS_QUERY_KEY = `admin_order_edits` as const export const adminOrderEditsKeys = queryKeysFactory(ADMIN_ORDER_EDITS_QUERY_KEY) type OrderEditQueryKeys = typeof adminOrderEditsKeys +/** + * This hook retrieves an order edit's details. + * + * @example + * A simple example that retrieves an order edit by its ID: + * + * ```tsx + * import React from "react" + * import { useAdminOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const { + * order_edit, + * isLoading, + * } = useAdminOrderEdit(orderEditId) + * + * return ( + *
+ * {isLoading && Loading...} + * {order_edit && {order_edit.status}} + *
+ * ) + * } + * + * export default OrderEdit + * ``` + * + * To specify relations that should be retrieved: + * + * ```tsx + * import React from "react" + * import { useAdminOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const { + * order_edit, + * isLoading, + * } = useAdminOrderEdit( + * orderEditId, + * { + * expand: "order" + * } + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {order_edit && {order_edit.status}} + *
+ * ) + * } + * + * export default OrderEdit + * ``` + * + * @customNamespace Hooks.Admin.Order Edits + * @category Queries + */ export const useAdminOrderEdit = ( + /** + * The order edit's ID. + */ id: string, + /** + * Configurations to apply on the retrieved order edit. + */ query?: GetOrderEditsOrderEditParams, options?: UseQueryOptionsWrapper< Response, @@ -33,7 +105,122 @@ export const useAdminOrderEdit = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a list of order edits. The order edits can be filtered by fields such as `q` or `order_id` passed to the `query` parameter. + * The order edits can also be paginated. + * + * @example + * To list order edits: + * + * ```tsx + * import React from "react" + * import { useAdminOrderEdits } from "medusa-react" + * + * const OrderEdits = () => { + * const { order_edits, isLoading } = useAdminOrderEdits() + * + * return ( + *
+ * {isLoading && Loading...} + * {order_edits && !order_edits.length && ( + * No Order Edits + * )} + * {order_edits && order_edits.length > 0 && ( + *
    + * {order_edits.map((orderEdit) => ( + *
  • + * {orderEdit.status} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default OrderEdits + * ``` + * + * To specify relations that should be retrieved within the order edits: + * + * ```tsx + * import React from "react" + * import { useAdminOrderEdits } from "medusa-react" + * + * const OrderEdits = () => { + * const { order_edits, isLoading } = useAdminOrderEdits({ + * expand: "order" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {order_edits && !order_edits.length && ( + * No Order Edits + * )} + * {order_edits && order_edits.length > 0 && ( + *
    + * {order_edits.map((orderEdit) => ( + *
  • + * {orderEdit.status} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default OrderEdits + * ``` + * + * By default, only the first `50` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminOrderEdits } from "medusa-react" + * + * const OrderEdits = () => { + * const { + * order_edits, + * limit, + * offset, + * isLoading + * } = useAdminOrderEdits({ + * expand: "order", + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {order_edits && !order_edits.length && ( + * No Order Edits + * )} + * {order_edits && order_edits.length > 0 && ( + *
    + * {order_edits.map((orderEdit) => ( + *
  • + * {orderEdit.status} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default OrderEdits + * ``` + * + * @customNamespace Hooks.Admin.Order Edits + * @category Queries + */ export const useAdminOrderEdits = ( + /** + * Filters and pagination configurations applied to retrieved order edits. + */ query?: GetOrderEditsParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/orders/index.ts b/packages/medusa-react/src/hooks/admin/orders/index.ts index a494946b87dc5..19ed3736d179a 100644 --- a/packages/medusa-react/src/hooks/admin/orders/index.ts +++ b/packages/medusa-react/src/hooks/admin/orders/index.ts @@ -1,2 +1,16 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Order API Routes](https://docs.medusajs.com/api/admin#orders). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Orders are purchases made by customers, typically through a storefront using cart. Managing orders include managing fulfillment, payment, claims, reservations, and more. + * + * Related Guide: [How to manage orders](https://docs.medusajs.com/modules/orders/admin/manage-orders). + * + * @customNamespace Hooks.Admin.Orders + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/orders/mutations.ts b/packages/medusa-react/src/hooks/admin/orders/mutations.ts index 578b1c3b76da6..9a6a2be581560 100644 --- a/packages/medusa-react/src/hooks/admin/orders/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/orders/mutations.ts @@ -19,7 +19,46 @@ import { adminProductKeys } from "../products" import { adminVariantKeys } from "../variants" import { adminOrderKeys } from "./queries" +/** + * This hook updates an order's details. + * + * @example + * import React from "react" + * import { useAdminUpdateOrder } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const updateOrder = useAdminUpdateOrder( + * orderId + * ) + * + * const handleUpdate = ( + * email: string + * ) => { + * updateOrder.mutate({ + * email, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.email) + * } + * }) + * } + * + * // ... + * } + * + * export default Order + * + * @customNamespace Hooks.Admin.Orders + * @category Mutations + */ export const useAdminUpdateOrder = ( + /** + * The order's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -41,7 +80,44 @@ export const useAdminUpdateOrder = ( ) } +/** + * This hook cancels 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 is unable to cancel the payment/fulfillment. + * + * @example + * import React from "react" + * import { useAdminCancelOrder } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const cancelOrder = useAdminCancelOrder( + * orderId + * ) + * // ... + * + * const handleCancel = () => { + * cancelOrder.mutate(void 0, { + * onSuccess: ({ order }) => { + * console.log(order.status) + * } + * }) + * } + * + * // ... + * } + * + * export default Order + * + * @customNamespace Hooks.Admin.Orders + * @category Mutations + */ export const useAdminCancelOrder = ( + /** + * The order's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -58,7 +134,43 @@ export const useAdminCancelOrder = ( ) } +/** + * This hook completes an order and change its status. A canceled order can't be completed. + * + * @example + * import React from "react" + * import { useAdminCompleteOrder } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const completeOrder = useAdminCompleteOrder( + * orderId + * ) + * // ... + * + * const handleComplete = () => { + * completeOrder.mutate(void 0, { + * onSuccess: ({ order }) => { + * console.log(order.status) + * } + * }) + * } + * + * // ... + * } + * + * export default Order + * + * @customNamespace Hooks.Admin.Orders + * @category Mutations + */ export const useAdminCompleteOrder = ( + /** + * The order's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -75,7 +187,43 @@ export const useAdminCompleteOrder = ( ) } +/** + * This hook captures all the payments associated with an order. The payment of canceled orders can't be captured. + * + * @example + * import React from "react" + * import { useAdminCapturePayment } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const capturePayment = useAdminCapturePayment( + * orderId + * ) + * // ... + * + * const handleCapture = () => { + * capturePayment.mutate(void 0, { + * onSuccess: ({ order }) => { + * console.log(order.status) + * } + * }) + * } + * + * // ... + * } + * + * export default Order + * + * @customNamespace Hooks.Admin.Orders + * @category Mutations + */ export const useAdminCapturePayment = ( + /** + * The order's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -92,7 +240,49 @@ export const useAdminCapturePayment = ( ) } +/** + * This hook refunds an amount for an order. The amount must be less than or equal the `refundable_amount` of the order. + * + * @example + * import React from "react" + * import { useAdminRefundPayment } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const refundPayment = useAdminRefundPayment( + * orderId + * ) + * // ... + * + * const handleRefund = ( + * amount: number, + * reason: string + * ) => { + * refundPayment.mutate({ + * amount, + * reason, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.refunds) + * } + * }) + * } + * + * // ... + * } + * + * export default Order + * + * @customNamespace Hooks.Admin.Orders + * @category Mutations + */ export const useAdminRefundPayment = ( + /** + * The order's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -114,7 +304,55 @@ export const useAdminRefundPayment = ( ) } +/** + * This hook creates a Fulfillment of an Order using the fulfillment provider, and change the order's + * fulfillment status to either `partially_fulfilled` or `fulfilled`, depending on + * whether all the items were fulfilled. + * + * @example + * import React from "react" + * import { useAdminCreateFulfillment } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const createFulfillment = useAdminCreateFulfillment( + * orderId + * ) + * // ... + * + * const handleCreateFulfillment = ( + * itemId: string, + * quantity: number + * ) => { + * createFulfillment.mutate({ + * items: [ + * { + * item_id: itemId, + * quantity, + * }, + * ], + * }, { + * onSuccess: ({ order }) => { + * console.log(order.fulfillments) + * } + * }) + * } + * + * // ... + * } + * + * export default Order + * + * @customNamespace Hooks.Admin.Orders + * @category Mutations + */ export const useAdminCreateFulfillment = ( + /** + * The order's ID. + */ orderId: string, options?: UseMutationOptions< Response, @@ -141,7 +379,47 @@ export const useAdminCreateFulfillment = ( ) } +/** + * This hook cancels an order's fulfillment and change its fulfillment status to `canceled`. + * + * @typeParamDefinition string - The fulfillment's ID. + * + * @example + * import React from "react" + * import { useAdminCancelFulfillment } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const cancelFulfillment = useAdminCancelFulfillment( + * orderId + * ) + * // ... + * + * const handleCancel = ( + * fulfillmentId: string + * ) => { + * cancelFulfillment.mutate(fulfillmentId, { + * onSuccess: ({ order }) => { + * console.log(order.fulfillments) + * } + * }) + * } + * + * // ... + * } + * + * export default Order + * + * @customNamespace Hooks.Admin.Orders + * @category Mutations + */ export const useAdminCancelFulfillment = ( + /** + * The order's ID. + */ orderId: string, options?: UseMutationOptions, Error, string> ) => { @@ -159,7 +437,48 @@ export const useAdminCancelFulfillment = ( ) } +/** + * This hook creates a shipment and mark a fulfillment as shipped. This changes the order's fulfillment status to either + * `partially_shipped` or `shipped`, depending on whether all the items were shipped. + * + * @example + * import React from "react" + * import { useAdminCreateShipment } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const createShipment = useAdminCreateShipment( + * orderId + * ) + * // ... + * + * const handleCreate = ( + * fulfillmentId: string + * ) => { + * createShipment.mutate({ + * fulfillment_id: fulfillmentId, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.fulfillment_status) + * } + * }) + * } + * + * // ... + * } + * + * export default Order + * + * @customNamespace Hooks.Admin.Orders + * @category Mutations + */ export const useAdminCreateShipment = ( + /** + * The order's ID. + */ orderId: string, options?: UseMutationOptions< Response, @@ -177,7 +496,53 @@ export const useAdminCreateShipment = ( ) } +/** + * This hook requests and create a return for items in an order. If the return shipping method is specified, it will be automatically fulfilled. + * + * @example + * import React from "react" + * import { useAdminRequestReturn } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const requestReturn = useAdminRequestReturn( + * orderId + * ) + * // ... + * + * const handleRequestingReturn = ( + * itemId: string, + * quantity: number + * ) => { + * requestReturn.mutate({ + * items: [ + * { + * item_id: itemId, + * quantity + * } + * ] + * }, { + * onSuccess: ({ order }) => { + * console.log(order.returns) + * } + * }) + * } + * + * // ... + * } + * + * export default Order + * + * @customNamespace Hooks.Admin.Orders + * @category Mutations + */ export const useAdminRequestReturn = ( + /** + * The order's ID. + */ orderId: string, options?: UseMutationOptions< Response, @@ -195,7 +560,49 @@ export const useAdminRequestReturn = ( ) } +/** + * This hook adds a shipping method to an order. If another shipping method exists with the same shipping profile, the previous shipping method will be replaced. + * + * @example + * import React from "react" + * import { useAdminAddShippingMethod } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const addShippingMethod = useAdminAddShippingMethod( + * orderId + * ) + * // ... + * + * const handleAddShippingMethod = ( + * optionId: string, + * price: number + * ) => { + * addShippingMethod.mutate({ + * option_id: optionId, + * price + * }, { + * onSuccess: ({ order }) => { + * console.log(order.shipping_methods) + * } + * }) + * } + * + * // ... + * } + * + * export default Order + * + * @customNamespace Hooks.Admin.Orders + * @category Mutations + */ export const useAdminAddShippingMethod = ( + /** + * The order's ID. + */ orderId: string, options?: UseMutationOptions< Response, @@ -213,7 +620,43 @@ export const useAdminAddShippingMethod = ( ) } +/** + * The hook archives an order and change its status. + * + * @example + * import React from "react" + * import { useAdminArchiveOrder } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const archiveOrder = useAdminArchiveOrder( + * orderId + * ) + * // ... + * + * const handleArchivingOrder = () => { + * archiveOrder.mutate(void 0, { + * onSuccess: ({ order }) => { + * console.log(order.status) + * } + * }) + * } + * + * // ... + * } + * + * export default Order + * + * @customNamespace Hooks.Admin.Orders + * @category Mutations + */ export const useAdminArchiveOrder = ( + /** + * The order's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { diff --git a/packages/medusa-react/src/hooks/admin/orders/queries.ts b/packages/medusa-react/src/hooks/admin/orders/queries.ts index abe5bf8072d9b..2af90cc7be1a6 100644 --- a/packages/medusa-react/src/hooks/admin/orders/queries.ts +++ b/packages/medusa-react/src/hooks/admin/orders/queries.ts @@ -21,7 +21,82 @@ export const adminOrderKeys = { type OrderQueryKeys = typeof adminOrderKeys +/** + * This hook retrieves 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. + * + * @example + * To list orders: + * + * ```tsx + * import React from "react" + * import { useAdminOrders } from "medusa-react" + * + * const Orders = () => { + * const { orders, isLoading } = useAdminOrders() + * + * return ( + *
+ * {isLoading && Loading...} + * {orders && !orders.length && No Orders} + * {orders && orders.length > 0 && ( + *
    + * {orders.map((order) => ( + *
  • {order.display_id}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Orders + * ``` + * + * You can use the `query` parameter to pass filters and specify relations that should be retrieved within the orders. In addition, + * By default, only the first `50` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminOrders } from "medusa-react" + * + * const Orders = () => { + * const { + * orders, + * limit, + * offset, + * isLoading + * } = useAdminOrders({ + * expand: "customers", + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {orders && !orders.length && No Orders} + * {orders && orders.length > 0 && ( + *
    + * {orders.map((order) => ( + *
  • {order.display_id}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Orders + * ``` + * + * @customNamespace Hooks.Admin.Orders + * @category Queries + */ export const useAdminOrders = ( + /** + * Filters and pagination configurations applied on the retrieved orders. + */ query?: AdminGetOrdersParams, options?: UseQueryOptionsWrapper< Response, @@ -38,8 +113,77 @@ export const useAdminOrders = ( return { ...data, ...rest } as const } +/** + * This hook retrieve an order's details. + * + * @example + * A simple example that retrieves an order by its ID: + * + * ```tsx + * import React from "react" + * import { useAdminOrder } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const { + * order, + * isLoading, + * } = useAdminOrder(orderId) + * + * return ( + *
+ * {isLoading && Loading...} + * {order && {order.display_id}} + * + *
+ * ) + * } + * + * export default Order + * ``` + * + * To specify relations that should be retrieved: + * + * ```tsx + * import React from "react" + * import { useAdminOrder } from "medusa-react" + * + * const Order = ( + * orderId: string + * ) => { + * const { + * order, + * isLoading, + * } = useAdminOrder(orderId, { + * expand: "customer" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {order && {order.display_id}} + * + *
+ * ) + * } + * + * export default Order + * ``` + * + * @customNamespace Hooks.Admin.Orders + * @category Queries + */ export const useAdminOrder = ( + /** + * The order's ID. + */ id: string, + /** + * Configurations to apply on the retrieved order. + */ query?: FindParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/payment-collections/index.ts b/packages/medusa-react/src/hooks/admin/payment-collections/index.ts index a494946b87dc5..46d9d45298a03 100644 --- a/packages/medusa-react/src/hooks/admin/payment-collections/index.ts +++ b/packages/medusa-react/src/hooks/admin/payment-collections/index.ts @@ -1,2 +1,14 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Payment Collection API Routes](https://docs.medusajs.com/api/admin#payment-collections). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments. + * + * @customNamespace Hooks.Admin.Payment Collections + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts b/packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts index fe0b1bdcbd7b0..da0950e78010b 100644 --- a/packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/payment-collections/mutations.ts @@ -15,7 +15,43 @@ import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" import { adminPaymentCollectionQueryKeys } from "./queries" +/** + * This hook deletes a payment collection. Only payment collections with the statuses `canceled` or `not_paid` can be deleted. + * + * @example + * import React from "react" + * import { useAdminDeletePaymentCollection } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ paymentCollectionId }: Props) => { + * const deleteCollection = useAdminDeletePaymentCollection( + * paymentCollectionId + * ) + * // ... + * + * const handleDelete = () => { + * deleteCollection.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection + * + * @customNamespace Hooks.Admin.Payment Collections + * @category Mutations + */ export const useAdminDeletePaymentCollection = ( + /** + * The payment collection's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -39,7 +75,47 @@ export const useAdminDeletePaymentCollection = ( ) } +/** + * This hook updates a payment collection's details. + * + * @example + * import React from "react" + * import { useAdminUpdatePaymentCollection } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ paymentCollectionId }: Props) => { + * const updateCollection = useAdminUpdatePaymentCollection( + * paymentCollectionId + * ) + * // ... + * + * const handleUpdate = ( + * description: string + * ) => { + * updateCollection.mutate({ + * description + * }, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.description) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection + * + * @customNamespace Hooks.Admin.Payment Collections + * @category Mutations + */ export const useAdminUpdatePaymentCollection = ( + /** + * The payment collection's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -64,7 +140,43 @@ export const useAdminUpdatePaymentCollection = ( ) } +/** + * This hook sets the status of a payment collection as `authorized`. This will also change the `authorized_amount` of the payment collection. + * + * @example + * import React from "react" + * import { useAdminMarkPaymentCollectionAsAuthorized } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ paymentCollectionId }: Props) => { + * const markAsAuthorized = useAdminMarkPaymentCollectionAsAuthorized( + * paymentCollectionId + * ) + * // ... + * + * const handleAuthorization = () => { + * markAsAuthorized.mutate(void 0, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.status) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection + * + * @customNamespace Hooks.Admin.Payment Collections + * @category Mutations + */ export const useAdminMarkPaymentCollectionAsAuthorized = ( + /** + * The payment collection's ID. + */ id: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/payment-collections/queries.ts b/packages/medusa-react/src/hooks/admin/payment-collections/queries.ts index f2f93d8887abb..17a7a9f055695 100644 --- a/packages/medusa-react/src/hooks/admin/payment-collections/queries.ts +++ b/packages/medusa-react/src/hooks/admin/payment-collections/queries.ts @@ -13,7 +13,43 @@ export const adminPaymentCollectionQueryKeys = queryKeysFactory< type AdminPaymentCollectionKey = typeof adminPaymentCollectionQueryKeys +/** + * This hook retrieves a Payment Collection's details. + * + * @example + * import React from "react" + * import { useAdminPaymentCollection } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ paymentCollectionId }: Props) => { + * const { + * payment_collection, + * isLoading, + * } = useAdminPaymentCollection(paymentCollectionId) + * + * return ( + *
+ * {isLoading && Loading...} + * {payment_collection && ( + * {payment_collection.status} + * )} + * + *
+ * ) + * } + * + * export default PaymentCollection + * + * @customNamespace Hooks.Admin.Payment Collections + * @category Queries + */ export const useAdminPaymentCollection = ( + /** + * The payment collection's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/payments/index.ts b/packages/medusa-react/src/hooks/admin/payments/index.ts index a494946b87dc5..334dc544c0944 100644 --- a/packages/medusa-react/src/hooks/admin/payments/index.ts +++ b/packages/medusa-react/src/hooks/admin/payments/index.ts @@ -1,2 +1,14 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Payment API Routes](https://docs.medusajs.com/api/admin#payments). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A payment can be related to an order, swap, return, or more. It can be captured or refunded. + * + * @customNamespace Hooks.Admin.Payments + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/payments/mutations.ts b/packages/medusa-react/src/hooks/admin/payments/mutations.ts index cc799c55afb95..05b7082ac09d7 100644 --- a/packages/medusa-react/src/hooks/admin/payments/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/payments/mutations.ts @@ -15,7 +15,43 @@ import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" import { adminPaymentQueryKeys } from "./queries" +/** + * This hook captures a payment. + * + * @example + * import React from "react" + * import { useAdminPaymentsCapturePayment } from "medusa-react" + * + * type Props = { + * paymentId: string + * } + * + * const Payment = ({ paymentId }: Props) => { + * const capture = useAdminPaymentsCapturePayment( + * paymentId + * ) + * // ... + * + * const handleCapture = () => { + * capture.mutate(void 0, { + * onSuccess: ({ payment }) => { + * console.log(payment.amount) + * } + * }) + * } + * + * // ... + * } + * + * export default Payment + * + * @customNamespace Hooks.Admin.Payments + * @category Mutations + */ export const useAdminPaymentsCapturePayment = ( + /** + * The payment's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -32,7 +68,52 @@ export const useAdminPaymentsCapturePayment = ( ) } +/** + * This hook refunds a payment. The payment must be captured first. + * + * @example + * import React from "react" + * import { RefundReason } from "@medusajs/medusa" + * import { useAdminPaymentsRefundPayment } from "medusa-react" + * + * type Props = { + * paymentId: string + * } + * + * const Payment = ({ paymentId }: Props) => { + * const refund = useAdminPaymentsRefundPayment( + * paymentId + * ) + * // ... + * + * const handleRefund = ( + * amount: number, + * reason: RefundReason, + * note: string + * ) => { + * refund.mutate({ + * amount, + * reason, + * note + * }, { + * onSuccess: ({ refund }) => { + * console.log(refund.amount) + * } + * }) + * } + * + * // ... + * } + * + * export default Payment + * + * @customNamespace Hooks.Admin.Payments + * @category Mutations + */ export const useAdminPaymentsRefundPayment = ( + /** + * The payment's ID. + */ id: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/payments/queries.ts b/packages/medusa-react/src/hooks/admin/payments/queries.ts index 9a41a47451763..fa9000128ae50 100644 --- a/packages/medusa-react/src/hooks/admin/payments/queries.ts +++ b/packages/medusa-react/src/hooks/admin/payments/queries.ts @@ -12,7 +12,41 @@ export const adminPaymentQueryKeys = type AdminPaymentKey = typeof adminPaymentQueryKeys +/** + * This hook retrieves a payment's details. + * + * @example + * import React from "react" + * import { useAdminPayment } from "medusa-react" + * + * type Props = { + * paymentId: string + * } + * + * const Payment = ({ paymentId }: Props) => { + * const { + * payment, + * isLoading, + * } = useAdminPayment(paymentId) + * + * return ( + *
+ * {isLoading && Loading...} + * {payment && {payment.amount}} + * + *
+ * ) + * } + * + * export default Payment + * + * @customNamespace Hooks.Admin.Payments + * @category Queries + */ export const useAdminPayment = ( + /** + * The payment's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/price-lists/index.ts b/packages/medusa-react/src/hooks/admin/price-lists/index.ts index a494946b87dc5..e63f8da6d8e1b 100644 --- a/packages/medusa-react/src/hooks/admin/price-lists/index.ts +++ b/packages/medusa-react/src/hooks/admin/price-lists/index.ts @@ -1,2 +1,16 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Price List API Routes](https://docs.medusajs.com/api/admin#price-lists). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A price list are special prices applied to products based on a set of conditions, such as customer group. + * + * Related Guide: [How to manage price lists](https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists). + * + * @customNamespace Hooks.Admin.Price Lists + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/price-lists/mutations.ts b/packages/medusa-react/src/hooks/admin/price-lists/mutations.ts index 97f70a9edaec3..5c735fb6ac69a 100644 --- a/packages/medusa-react/src/hooks/admin/price-lists/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/price-lists/mutations.ts @@ -22,6 +22,52 @@ import { adminProductKeys } from "../products" import { adminVariantKeys } from "../variants" import { adminPriceListKeys } from "./queries" +/** + * This hook creates a price list. + * + * @example + * import React from "react" + * import { + * PriceListStatus, + * PriceListType, + * } from "@medusajs/medusa" + * import { useAdminCreatePriceList } from "medusa-react" + * + * type CreateData = { + * name: string + * description: string + * type: PriceListType + * status: PriceListStatus + * prices: { + * amount: number + * variant_id: string + * currency_code: string + * max_quantity: number + * }[] + * } + * + * const CreatePriceList = () => { + * const createPriceList = useAdminCreatePriceList() + * // ... + * + * const handleCreate = ( + * data: CreateData + * ) => { + * createPriceList.mutate(data, { + * onSuccess: ({ price_list }) => { + * console.log(price_list.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreatePriceList + * + * @customNamespace Hooks.Admin.Price Lists + * @category Mutations + */ export const useAdminCreatePriceList = ( options?: UseMutationOptions< Response, @@ -38,7 +84,47 @@ export const useAdminCreatePriceList = ( ) } +/** + * This hook updates a price list's details. + * + * @example + * import React from "react" + * import { useAdminUpdatePriceList } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceList = ({ + * priceListId + * }: Props) => { + * const updatePriceList = useAdminUpdatePriceList(priceListId) + * // ... + * + * const handleUpdate = ( + * endsAt: Date + * ) => { + * updatePriceList.mutate({ + * ends_at: endsAt, + * }, { + * onSuccess: ({ price_list }) => { + * console.log(price_list.ends_at) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceList + * + * @customNamespace Hooks.Admin.Price Lists + * @category Mutations + */ export const useAdminUpdatePriceList = ( + /** + * The price list's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -64,7 +150,43 @@ export const useAdminUpdatePriceList = ( ) } +/** + * This hook deletes a price list and its associated prices. + * + * @example + * import React from "react" + * import { useAdminDeletePriceList } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceList = ({ + * priceListId + * }: Props) => { + * const deletePriceList = useAdminDeletePriceList(priceListId) + * // ... + * + * const handleDelete = () => { + * deletePriceList.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceList + * + * @customNamespace Hooks.Admin.Price Lists + * @category Mutations + */ export const useAdminDeletePriceList = ( + /** + * The price list's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -81,7 +203,51 @@ export const useAdminDeletePriceList = ( ) } +/** + * This hook adds or updates a list of prices in a price list. + * + * @example + * import React from "react" + * import { useAdminCreatePriceListPrices } from "medusa-react" + * + * type PriceData = { + * amount: number + * variant_id: string + * currency_code: string + * } + * + * type Props = { + * priceListId: string + * } + * + * const PriceList = ({ + * priceListId + * }: Props) => { + * const addPrices = useAdminCreatePriceListPrices(priceListId) + * // ... + * + * const handleAddPrices = (prices: PriceData[]) => { + * addPrices.mutate({ + * prices + * }, { + * onSuccess: ({ price_list }) => { + * console.log(price_list.prices) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceList + * + * @customNamespace Hooks.Admin.Price Lists + * @category Mutations + */ export const useAdminCreatePriceListPrices = ( + /** + * The price list's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -106,7 +272,45 @@ export const useAdminCreatePriceListPrices = ( ) } +/** + * This hook deletes a list of prices in a price list. + * + * @example + * import React from "react" + * import { useAdminDeletePriceListPrices } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceList = ({ + * priceListId + * }: Props) => { + * const deletePrices = useAdminDeletePriceListPrices(priceListId) + * // ... + * + * const handleDeletePrices = (priceIds: string[]) => { + * deletePrices.mutate({ + * price_ids: priceIds + * }, { + * onSuccess: ({ ids, deleted, object }) => { + * console.log(ids) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceList + * + * @customNamespace Hooks.Admin.Price Lists + * @category Mutations + */ export const useAdminDeletePriceListPrices = ( + /** + * The price list's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -132,7 +336,47 @@ export const useAdminDeletePriceListPrices = ( ) } +/** + * This hook deletes all the prices associated with multiple products in a price list. + * + * @example + * import React from "react" + * import { useAdminDeletePriceListProductsPrices } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceList = ({ + * priceListId + * }: Props) => { + * const deleteProductsPrices = useAdminDeletePriceListProductsPrices( + * priceListId + * ) + * // ... + * + * const handleDeleteProductsPrices = (productIds: string[]) => { + * deleteProductsPrices.mutate({ + * product_ids: productIds + * }, { + * onSuccess: ({ ids, deleted, object }) => { + * console.log(ids) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceList + * + * @customNamespace Hooks.Admin.Price Lists + * @category Mutations + */ export const useAdminDeletePriceListProductsPrices = ( + /** + * The price list's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -154,8 +398,54 @@ export const useAdminDeletePriceListProductsPrices = ( ) } +/** + * This hook deletes all the prices related to a specific product in a price list. + * + * @example + * import React from "react" + * import { + * useAdminDeletePriceListProductPrices + * } from "medusa-react" + * + * type Props = { + * priceListId: string + * productId: string + * } + * + * const PriceListProduct = ({ + * priceListId, + * productId + * }: Props) => { + * const deleteProductPrices = useAdminDeletePriceListProductPrices( + * priceListId, + * productId + * ) + * // ... + * + * const handleDeleteProductPrices = () => { + * deleteProductPrices.mutate(void 0, { + * onSuccess: ({ ids, deleted, object }) => { + * console.log(ids) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceListProduct + * + * @customNamespace Hooks.Admin.Price Lists + * @category Mutations + */ export const useAdminDeletePriceListProductPrices = ( + /** + * The price list's ID. + */ id: string, + /** + * The product's ID. + */ productId: string, options?: UseMutationOptions< Response, @@ -179,8 +469,54 @@ export const useAdminDeletePriceListProductPrices = ( ) } +/** + * This hook deletes all the prices related to a specific product variant in a price list. + * + * @example + * import React from "react" + * import { + * useAdminDeletePriceListVariantPrices + * } from "medusa-react" + * + * type Props = { + * priceListId: string + * variantId: string + * } + * + * const PriceListVariant = ({ + * priceListId, + * variantId + * }: Props) => { + * const deleteVariantPrices = useAdminDeletePriceListVariantPrices( + * priceListId, + * variantId + * ) + * // ... + * + * const handleDeleteVariantPrices = () => { + * deleteVariantPrices.mutate(void 0, { + * onSuccess: ({ ids, deleted, object }) => { + * console.log(ids) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceListVariant + * + * @customNamespace Hooks.Admin.Price Lists + * @category Mutations + */ export const useAdminDeletePriceListVariantPrices = ( + /** + * The price list's ID. + */ id: string, + /** + * The product variant's ID. + */ variantId: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/price-lists/queries.ts b/packages/medusa-react/src/hooks/admin/price-lists/queries.ts index 022c7a8d40643..a3bf0559059fe 100644 --- a/packages/medusa-react/src/hooks/admin/price-lists/queries.ts +++ b/packages/medusa-react/src/hooks/admin/price-lists/queries.ts @@ -26,7 +26,116 @@ export const adminPriceListKeys = { type PriceListQueryKeys = typeof adminPriceListKeys +/** + * This hook retrieves a list of price lists. The price lists can be filtered by fields such as `q` or `status` passed + * in the `query` parameter. The price lists can also be sorted or paginated. + * + * @example + * To list price lists: + * + * ```tsx + * import React from "react" + * import { useAdminPriceLists } from "medusa-react" + * + * const PriceLists = () => { + * const { price_lists, isLoading } = useAdminPriceLists() + * + * return ( + *
+ * {isLoading && Loading...} + * {price_lists && !price_lists.length && ( + * No Price Lists + * )} + * {price_lists && price_lists.length > 0 && ( + *
    + * {price_lists.map((price_list) => ( + *
  • {price_list.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default PriceLists + * ``` + * + * To specify relations that should be retrieved within the price lists: + * + * ```tsx + * import React from "react" + * import { useAdminPriceLists } from "medusa-react" + * + * const PriceLists = () => { + * const { price_lists, isLoading } = useAdminPriceLists({ + * expand: "prices" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {price_lists && !price_lists.length && ( + * No Price Lists + * )} + * {price_lists && price_lists.length > 0 && ( + *
    + * {price_lists.map((price_list) => ( + *
  • {price_list.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default PriceLists + * ``` + * + * By default, only the first `10` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminPriceLists } from "medusa-react" + * + * const PriceLists = () => { + * const { + * price_lists, + * limit, + * offset, + * isLoading + * } = useAdminPriceLists({ + * expand: "prices", + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {price_lists && !price_lists.length && ( + * No Price Lists + * )} + * {price_lists && price_lists.length > 0 && ( + *
    + * {price_lists.map((price_list) => ( + *
  • {price_list.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default PriceLists + * ``` + * + * @customNamespace Hooks.Admin.Price Lists + * @category Queries + */ export const useAdminPriceLists = ( + /** + * Filters and pagination configurations to apply on the retrieved price lists. + */ query?: AdminGetPriceListPaginationParams, options?: UseQueryOptionsWrapper< Response, @@ -43,8 +152,146 @@ export const useAdminPriceLists = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a price list's products. The products can be filtered by fields such as `q` or `status` + * passed in the `query` parameter. The products can also be sorted or paginated. + * + * @example + * To list products in a price list: + * + * ```tsx + * import React from "react" + * import { useAdminPriceListProducts } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceListProducts = ({ + * priceListId + * }: Props) => { + * const { products, isLoading } = useAdminPriceListProducts( + * priceListId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {products && !products.length && ( + * No Price Lists + * )} + * {products && products.length > 0 && ( + *
    + * {products.map((product) => ( + *
  • {product.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default PriceListProducts + * ``` + * + * To specify relations that should be retrieved within the products: + * + * ```tsx + * import React from "react" + * import { useAdminPriceListProducts } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceListProducts = ({ + * priceListId + * }: Props) => { + * const { products, isLoading } = useAdminPriceListProducts( + * priceListId, + * { + * expand: "variants" + * } + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {products && !products.length && ( + * No Price Lists + * )} + * {products && products.length > 0 && ( + *
    + * {products.map((product) => ( + *
  • {product.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default PriceListProducts + * ``` + * + * By default, only the first `50` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminPriceListProducts } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceListProducts = ({ + * priceListId + * }: Props) => { + * const { + * products, + * limit, + * offset, + * isLoading + * } = useAdminPriceListProducts( + * priceListId, + * { + * expand: "variants", + * limit: 20, + * offset: 0 + * } + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {products && !products.length && ( + * No Price Lists + * )} + * {products && products.length > 0 && ( + *
    + * {products.map((product) => ( + *
  • {product.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default PriceListProducts + * ``` + * + * @customNamespace Hooks.Admin.Price Lists + * @category Queries + */ export const useAdminPriceListProducts = ( + /** + * The ID of the associated price list. + */ id: string, + /** + * Filters and pagination configurations applied on the retrieved products. + */ query?: AdminGetPriceListsPriceListProductsParams, options?: UseQueryOptionsWrapper< Response, @@ -61,7 +308,42 @@ export const useAdminPriceListProducts = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a price list's details. + * + * @example + * import React from "react" + * import { useAdminPriceList } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceList = ({ + * priceListId + * }: Props) => { + * const { + * price_list, + * isLoading, + * } = useAdminPriceList(priceListId) + * + * return ( + *
+ * {isLoading && Loading...} + * {price_list && {price_list.name}} + *
+ * ) + * } + * + * export default PriceList + * + * @customNamespace Hooks.Admin.Price Lists + * @category Queries + */ export const useAdminPriceList = ( + /** + * The price list's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/product-categories/index.ts b/packages/medusa-react/src/hooks/admin/product-categories/index.ts index a494946b87dc5..d0323b3478435 100644 --- a/packages/medusa-react/src/hooks/admin/product-categories/index.ts +++ b/packages/medusa-react/src/hooks/admin/product-categories/index.ts @@ -1,2 +1,18 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Product Category API Routes](https://docs.medusajs.com/api/admin#product-categories). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Products can be categoriezed into categories. A product can be added into more than one category. + * + * Related Guide: [How to manage product categories](https://docs.medusajs.com/modules/products/admin/manage-categories). + * + * @featureFlag product_categories + * + * @customNamespace Hooks.Admin.Product Categories + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/product-categories/mutations.ts b/packages/medusa-react/src/hooks/admin/product-categories/mutations.ts index 3caf98f856c47..ae328ce9c9d8f 100644 --- a/packages/medusa-react/src/hooks/admin/product-categories/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/product-categories/mutations.ts @@ -19,10 +19,35 @@ import { adminProductCategoryKeys } from "./queries" import { adminProductKeys } from "../products" /** - * Hook provides a mutation function for creating product categories. - * - * @experimental This feature is under development and may change in the future. - * To use this feature please enable the corresponding feature flag in your medusa backend project. + * This hook creates a product category. + * + * @example + * import React from "react" + * import { useAdminCreateProductCategory } from "medusa-react" + * + * const CreateCategory = () => { + * const createCategory = useAdminCreateProductCategory() + * // ... + * + * const handleCreate = ( + * name: string + * ) => { + * createCategory.mutate({ + * name, + * }, { + * onSuccess: ({ product_category }) => { + * console.log(product_category.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateCategory + * + * @customNamespace Hooks.Admin.Product Categories + * @category Mutations */ export const useAdminCreateProductCategory = ( options?: UseMutationOptions< @@ -45,14 +70,49 @@ export const useAdminCreateProductCategory = ( ) } -/** Update a product category - * - * @experimental This feature is under development and may change in the future. - * To use this feature please enable feature flag `product_categories` in your medusa backend project. - * @description updates a product category - * @returns the updated medusa product category +/** + * This hook updates a product category. + * + * @example + * import React from "react" + * import { useAdminUpdateProductCategory } from "medusa-react" + * + * type Props = { + * productCategoryId: string + * } + * + * const Category = ({ + * productCategoryId + * }: Props) => { + * const updateCategory = useAdminUpdateProductCategory( + * productCategoryId + * ) + * // ... + * + * const handleUpdate = ( + * name: string + * ) => { + * updateCategory.mutate({ + * name, + * }, { + * onSuccess: ({ product_category }) => { + * console.log(product_category.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Category + * + * @customNamespace Hooks.Admin.Product Categories + * @category Mutations */ export const useAdminUpdateProductCategory = ( + /** + * The product category's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -78,14 +138,44 @@ export const useAdminUpdateProductCategory = ( } /** - * Delete a product category - * - * @experimental This feature is under development and may change in the future. - * To use this feature please enable featureflag `product_categories` in your medusa backend project. - * @param id - * @param options + * This hook deletes a product category. This does not delete associated products. + * + * @example + * import React from "react" + * import { useAdminDeleteProductCategory } from "medusa-react" + * + * type Props = { + * productCategoryId: string + * } + * + * const Category = ({ + * productCategoryId + * }: Props) => { + * const deleteCategory = useAdminDeleteProductCategory( + * productCategoryId + * ) + * // ... + * + * const handleDelete = () => { + * deleteCategory.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Category + * + * @customNamespace Hooks.Admin.Product Categories + * @category Mutations */ export const useAdminDeleteProductCategory = ( + /** + * The product category's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -111,15 +201,52 @@ export const useAdminDeleteProductCategory = ( } /** - * Add products to a product category - * - * @experimental This feature is under development and may change in the future. - * To use this feature please enable featureflag `product_categories` in your medusa backend project. - * @description Add products to a product category - * @param id - * @param options + * This hook adds a list of products to a product category. + * + * @example + * import React from "react" + * import { useAdminAddProductsToCategory } from "medusa-react" + * + * type ProductsData = { + * id: string + * } + * + * type Props = { + * productCategoryId: string + * } + * + * const Category = ({ + * productCategoryId + * }: Props) => { + * const addProducts = useAdminAddProductsToCategory( + * productCategoryId + * ) + * // ... + * + * const handleAddProducts = ( + * productIds: ProductsData[] + * ) => { + * addProducts.mutate({ + * product_ids: productIds + * }, { + * onSuccess: ({ product_category }) => { + * console.log(product_category.products) + * } + * }) + * } + * + * // ... + * } + * + * export default Category + * + * @customNamespace Hooks.Admin.Product Categories + * @category Mutations */ export const useAdminAddProductsToCategory = ( + /** + * The product category's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -146,14 +273,52 @@ export const useAdminAddProductsToCategory = ( } /** - * Remove products from a product category - * @experimental This feature is under development and may change in the future. - * To use this feature please enable featureflag `product_categories` in your medusa backend project. - * @description remove products from a product category - * @param id - * @param options + * This hook removes a list of products from a product category. + * + * @example + * import React from "react" + * import { useAdminDeleteProductsFromCategory } from "medusa-react" + * + * type ProductsData = { + * id: string + * } + * + * type Props = { + * productCategoryId: string + * } + * + * const Category = ({ + * productCategoryId + * }: Props) => { + * const deleteProducts = useAdminDeleteProductsFromCategory( + * productCategoryId + * ) + * // ... + * + * const handleDeleteProducts = ( + * productIds: ProductsData[] + * ) => { + * deleteProducts.mutate({ + * product_ids: productIds + * }, { + * onSuccess: ({ product_category }) => { + * console.log(product_category.products) + * } + * }) + * } + * + * // ... + * } + * + * export default Category + * + * @customNamespace Hooks.Admin.Product Categories + * @category Mutations */ export const useAdminDeleteProductsFromCategory = ( + /** + * The product category's ID. + */ id: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/product-categories/queries.ts b/packages/medusa-react/src/hooks/admin/product-categories/queries.ts index c907414377b6e..1e08f456c2d1b 100644 --- a/packages/medusa-react/src/hooks/admin/product-categories/queries.ts +++ b/packages/medusa-react/src/hooks/admin/product-categories/queries.ts @@ -17,7 +17,127 @@ export const adminProductCategoryKeys = queryKeysFactory( ) type ProductCategoryQueryKeys = typeof adminProductCategoryKeys +/** + * This hook + * + * @example + * To list product categories: + * + * ```tsx + * import React from "react" + * import { useAdminProductCategories } from "medusa-react" + * + * function Categories() { + * const { + * product_categories, + * isLoading + * } = useAdminProductCategories() + * + * return ( + *
+ * {isLoading && Loading...} + * {product_categories && !product_categories.length && ( + * No Categories + * )} + * {product_categories && product_categories.length > 0 && ( + *
    + * {product_categories.map( + * (category) => ( + *
  • {category.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Categories + * ``` + * + * To specify relations that should be retrieved within the product category: + * + * ```tsx + * import React from "react" + * import { useAdminProductCategories } from "medusa-react" + * + * function Categories() { + * const { + * product_categories, + * isLoading + * } = useAdminProductCategories({ + * expand: "category_children" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_categories && !product_categories.length && ( + * No Categories + * )} + * {product_categories && product_categories.length > 0 && ( + *
    + * {product_categories.map( + * (category) => ( + *
  • {category.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Categories + * ``` + * + * By default, only the first `100` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminProductCategories } from "medusa-react" + * + * function Categories() { + * const { + * product_categories, + * limit, + * offset, + * isLoading + * } = useAdminProductCategories({ + * expand: "category_children", + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_categories && !product_categories.length && ( + * No Categories + * )} + * {product_categories && product_categories.length > 0 && ( + *
    + * {product_categories.map( + * (category) => ( + *
  • {category.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Categories + * ``` + * + * @customNamespace Hooks.Admin.Product Categories + * @category Queries + */ export const useAdminProductCategories = ( + /** + * Filters and pagination configurations to apply on the retrieved product categories. + */ query?: AdminGetProductCategoriesParams, options?: UseQueryOptionsWrapper< Response, @@ -34,8 +154,87 @@ export const useAdminProductCategories = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a product category's details. + * + * @example + * A simple example that retrieves an order by its ID: + * + * ```tsx + * import React from "react" + * import { useAdminProductCategory } from "medusa-react" + * + * type Props = { + * productCategoryId: string + * } + * + * const Category = ({ + * productCategoryId + * }: Props) => { + * const { + * product_category, + * isLoading, + * } = useAdminProductCategory(productCategoryId) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_category && ( + * {product_category.name} + * )} + * + *
+ * ) + * } + * + * export default Category + * ``` + * + * To specify relations that should be retrieved: + * + * ```tsx + * import React from "react" + * import { useAdminProductCategory } from "medusa-react" + * + * type Props = { + * productCategoryId: string + * } + * + * const Category = ({ + * productCategoryId + * }: Props) => { + * const { + * product_category, + * isLoading, + * } = useAdminProductCategory(productCategoryId, { + * expand: "category_children" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_category && ( + * {product_category.name} + * )} + * + *
+ * ) + * } + * + * export default Category + * ``` + * + * @customNamespace Hooks.Admin.Product Categories + * @category Queries + */ export const useAdminProductCategory = ( + /** + * The product category's ID. + */ id: string, + /** + * Configurations to apply on the retrieved product category. + */ query?: AdminGetProductCategoryParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/product-tags/index.ts b/packages/medusa-react/src/hooks/admin/product-tags/index.ts index f3593df2df13b..5b817c84458fc 100644 --- a/packages/medusa-react/src/hooks/admin/product-tags/index.ts +++ b/packages/medusa-react/src/hooks/admin/product-tags/index.ts @@ -1 +1,14 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Product Tag API Routes](https://docs.medusajs.com/api/admin#product-tags). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Product tags are string values created when you create or update a product with a new tag. + * Products can have more than one tag, and products can share tags. This allows admins to associate products to similar tags that can be used to filter products. + * + * @customNamespace Hooks.Admin.Product Tags + */ + export * from "./queries" diff --git a/packages/medusa-react/src/hooks/admin/product-tags/queries.ts b/packages/medusa-react/src/hooks/admin/product-tags/queries.ts index b42582e916b71..185a27cecb86e 100644 --- a/packages/medusa-react/src/hooks/admin/product-tags/queries.ts +++ b/packages/medusa-react/src/hooks/admin/product-tags/queries.ts @@ -16,7 +16,91 @@ export const adminProductTagKeys = queryKeysFactory( type ProductQueryKeys = typeof adminProductTagKeys +/** + * This hook retrieves a list of product tags. The product tags can be filtered by fields such as `q` or `value` passed + * in the `query` parameter. The product tags can also be sorted or paginated. + * + * @example + * To list product tags: + * + * ```tsx + * import React from "react" + * import { useAdminProductTags } from "medusa-react" + * + * function ProductTags() { + * const { + * product_tags, + * isLoading + * } = useAdminProductTags() + * + * return ( + *
+ * {isLoading && Loading...} + * {product_tags && !product_tags.length && ( + * No Product Tags + * )} + * {product_tags && product_tags.length > 0 && ( + *
    + * {product_tags.map( + * (tag) => ( + *
  • {tag.value}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default ProductTags + * ``` + * + * By default, only the first `10` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminProductTags } from "medusa-react" + * + * function ProductTags() { + * const { + * product_tags, + * limit, + * offset, + * isLoading + * } = useAdminProductTags({ + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_tags && !product_tags.length && ( + * No Product Tags + * )} + * {product_tags && product_tags.length > 0 && ( + *
    + * {product_tags.map( + * (tag) => ( + *
  • {tag.value}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default ProductTags + * ``` + * + * @customNamespace Hooks.Admin.Product Tags + * @category Queries + */ export const useAdminProductTags = ( + /** + * Filters and pagination configurations to apply on the retrieved product tags. + */ query?: AdminGetProductTagsParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/product-types/index.ts b/packages/medusa-react/src/hooks/admin/product-types/index.ts index f3593df2df13b..7c2fc525c9487 100644 --- a/packages/medusa-react/src/hooks/admin/product-types/index.ts +++ b/packages/medusa-react/src/hooks/admin/product-types/index.ts @@ -1 +1,14 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Product Type API Routes](https://docs.medusajs.com/api/admin#product-types). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Product types are string values created when you create or update a product with a new type. + * Products can have one type, and products can share types. This allows admins to associate products with a type that can be used to filter products. + * + * @customNamespace Hooks.Admin.Product Types + */ + export * from "./queries" diff --git a/packages/medusa-react/src/hooks/admin/product-types/queries.ts b/packages/medusa-react/src/hooks/admin/product-types/queries.ts index 027f1ed5e4156..8ed69b69e8631 100644 --- a/packages/medusa-react/src/hooks/admin/product-types/queries.ts +++ b/packages/medusa-react/src/hooks/admin/product-types/queries.ts @@ -16,7 +16,91 @@ export const adminProductTypeKeys = queryKeysFactory( type ProductTypesQueryKeys = typeof adminProductTypeKeys +/** + * This hook retrieves a list of product types. The product types can be filtered by fields such as `q` or `value` passed in the `query` parameter. + * The product types can also be sorted or paginated. + * + * @example + * To list product types: + * + * ```tsx + * import React from "react" + * import { useAdminProductTypes } from "medusa-react" + * + * function ProductTypes() { + * const { + * product_types, + * isLoading + * } = useAdminProductTypes() + * + * return ( + *
+ * {isLoading && Loading...} + * {product_types && !product_types.length && ( + * No Product Tags + * )} + * {product_types && product_types.length > 0 && ( + *
    + * {product_types.map( + * (type) => ( + *
  • {type.value}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default ProductTypes + * ``` + * + * By default, only the first `20` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminProductTypes } from "medusa-react" + * + * function ProductTypes() { + * const { + * product_types, + * limit, + * offset, + * isLoading + * } = useAdminProductTypes({ + * limit: 10, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_types && !product_types.length && ( + * No Product Tags + * )} + * {product_types && product_types.length > 0 && ( + *
    + * {product_types.map( + * (type) => ( + *
  • {type.value}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default ProductTypes + * ``` + * + * @customNamespace Hooks.Admin.Product Types + * @category Queries + */ export const useAdminProductTypes = ( + /** + * Filters and pagination configurations to apply on the retrieved product types. + */ query?: AdminGetProductTypesParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/products/index.ts b/packages/medusa-react/src/hooks/admin/products/index.ts index a494946b87dc5..3a526ea996d7b 100644 --- a/packages/medusa-react/src/hooks/admin/products/index.ts +++ b/packages/medusa-react/src/hooks/admin/products/index.ts @@ -1,2 +1,16 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Product API Routes](https://docs.medusajs.com/api/admin#products). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Products are saleable items in a store. This also includes [saleable gift cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-gift-card-product) in a store. + * + * Related Guide: [How to manage products](https://docs.medusajs.com/modules/products/admin/manage-products). + * + * @customNamespace Hooks.Admin.Products + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/products/mutations.ts b/packages/medusa-react/src/hooks/admin/products/mutations.ts index 7977e8f4c5a2a..4da1796cb1942 100644 --- a/packages/medusa-react/src/hooks/admin/products/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/products/mutations.ts @@ -20,6 +20,62 @@ import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" import { adminProductKeys } from "./queries" +/** + * This hook creates a new Product. This hook can also be used to create a gift card if the `is_giftcard` field is set to `true`. + * + * @example + * import React from "react" + * import { useAdminCreateProduct } from "medusa-react" + * + * type CreateProductData = { + * title: string + * is_giftcard: boolean + * discountable: boolean + * options: { + * title: string + * }[] + * variants: { + * title: string + * prices: { + * amount: number + * currency_code :string + * }[] + * options: { + * value: string + * }[] + * }[], + * collection_id: string + * categories: { + * id: string + * }[] + * type: { + * value: string + * } + * tags: { + * value: string + * }[] + * } + * + * const CreateProduct = () => { + * const createProduct = useAdminCreateProduct() + * // ... + * + * const handleCreate = (productData: CreateProductData) => { + * createProduct.mutate(productData, { + * onSuccess: ({ product }) => { + * console.log(product.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateProduct + * + * @customNamespace Hooks.Admin.Products + * @category Mutations + */ export const useAdminCreateProduct = ( options?: UseMutationOptions< Response, @@ -35,7 +91,47 @@ export const useAdminCreateProduct = ( ) } +/** + * This hook updates a Product's details. + * + * @example + * import React from "react" + * import { useAdminUpdateProduct } from "medusa-react" + * + * type Props = { + * productId: string + * } + * + * const Product = ({ productId }: Props) => { + * const updateProduct = useAdminUpdateProduct( + * productId + * ) + * // ... + * + * const handleUpdate = ( + * title: string + * ) => { + * updateProduct.mutate({ + * title, + * }, { + * onSuccess: ({ product }) => { + * console.log(product.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Product + * + * @customNamespace Hooks.Admin.Products + * @category Mutations + */ export const useAdminUpdateProduct = ( + /** + * The product's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -57,7 +153,43 @@ export const useAdminUpdateProduct = ( ) } +/** + * This hook deletes a product and its associated product variants and options. + * + * @example + * import React from "react" + * import { useAdminDeleteProduct } from "medusa-react" + * + * type Props = { + * productId: string + * } + * + * const Product = ({ productId }: Props) => { + * const deleteProduct = useAdminDeleteProduct( + * productId + * ) + * // ... + * + * const handleDelete = () => { + * deleteProduct.mutate(void 0, { + * onSuccess: ({ id, object, deleted}) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Product + * + * @customNamespace Hooks.Admin.Products + * @category Mutations + */ export const useAdminDeleteProduct = ( + /** + * The product's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -74,7 +206,57 @@ export const useAdminDeleteProduct = ( ) } +/** + * This hook creates a product variant associated with a product. Each product variant must have a unique combination of product option values. + * + * @example + * import React from "react" + * import { useAdminCreateVariant } from "medusa-react" + * + * type CreateVariantData = { + * title: string + * prices: { + * amount: number + * currency_code: string + * }[] + * options: { + * option_id: string + * value: string + * }[] + * } + * + * type Props = { + * productId: string + * } + * + * const CreateProductVariant = ({ productId }: Props) => { + * const createVariant = useAdminCreateVariant( + * productId + * ) + * // ... + * + * const handleCreate = ( + * variantData: CreateVariantData + * ) => { + * createVariant.mutate(variantData, { + * onSuccess: ({ product }) => { + * console.log(product.variants) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateProductVariant + * + * @customNamespace Hooks.Admin.Products + * @category Mutations + */ export const useAdminCreateVariant = ( + /** + * The product's ID. + */ productId: string, options?: UseMutationOptions< Response, @@ -96,12 +278,62 @@ export const useAdminCreateVariant = ( ) } +export type AdminUpdateVariantReq = AdminPostProductsProductVariantsVariantReq & { + /** + * The product variant's ID. + */ + variant_id: string +} + +/** + * This hook updates a product variant's details. + * + * @example + * import React from "react" + * import { useAdminUpdateVariant } from "medusa-react" + * + * type Props = { + * productId: string + * variantId: string + * } + * + * const ProductVariant = ({ + * productId, + * variantId + * }: Props) => { + * const updateVariant = useAdminUpdateVariant( + * productId + * ) + * // ... + * + * const handleUpdate = (title: string) => { + * updateVariant.mutate({ + * variant_id: variantId, + * title, + * }, { + * onSuccess: ({ product }) => { + * console.log(product.variants) + * } + * }) + * } + * + * // ... + * } + * + * export default ProductVariant + * + * @customNamespace Hooks.Admin.Products + * @category Mutations + */ export const useAdminUpdateVariant = ( + /** + * The product's ID. + */ productId: string, options?: UseMutationOptions< Response, Error, - AdminPostProductsProductVariantsVariantReq & { variant_id: string } + AdminUpdateVariantReq > ) => { const { client } = useMedusa() @@ -111,7 +343,7 @@ export const useAdminUpdateVariant = ( ({ variant_id, ...payload - }: AdminPostProductsProductVariantsVariantReq & { variant_id: string }) => + }: AdminUpdateVariantReq) => client.admin.products.updateVariant(productId, variant_id, payload), buildOptions( queryClient, @@ -121,7 +353,49 @@ export const useAdminUpdateVariant = ( ) } +/** + * This hook deletes a product variant. + * + * @typeParamDefinition string - The ID of the product variant to delete. + * + * @example + * import React from "react" + * import { useAdminDeleteVariant } from "medusa-react" + * + * type Props = { + * productId: string + * variantId: string + * } + * + * const ProductVariant = ({ + * productId, + * variantId + * }: Props) => { + * const deleteVariant = useAdminDeleteVariant( + * productId + * ) + * // ... + * + * const handleDelete = () => { + * deleteVariant.mutate(variantId, { + * onSuccess: ({ variant_id, object, deleted, product }) => { + * console.log(product.variants) + * } + * }) + * } + * + * // ... + * } + * + * export default ProductVariant + * + * @customNamespace Hooks.Admin.Products + * @category Mutations + */ export const useAdminDeleteVariant = ( + /** + * The product's ID. + */ productId: string, options?: UseMutationOptions< Response, @@ -143,7 +417,47 @@ export const useAdminDeleteVariant = ( ) } +/** + * This hook adds a product option to a product. + * + * @example + * import React from "react" + * import { useAdminCreateProductOption } from "medusa-react" + * + * type Props = { + * productId: string + * } + * + * const CreateProductOption = ({ productId }: Props) => { + * const createOption = useAdminCreateProductOption( + * productId + * ) + * // ... + * + * const handleCreate = ( + * title: string + * ) => { + * createOption.mutate({ + * title + * }, { + * onSuccess: ({ product }) => { + * console.log(product.options) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateProductOption + * + * @customNamespace Hooks.Admin.Products + * @category Mutations + */ export const useAdminCreateProductOption = ( + /** + * The product's ID. + */ productId: string, options?: UseMutationOptions< Response, @@ -161,12 +475,64 @@ export const useAdminCreateProductOption = ( ) } +export type AdminUpdateProductOptionReq = AdminPostProductsProductOptionsOption & { + /** + * The ID of the product option to update. + */ + option_id: string +} + +/** + * This hook updates a product option's details. + * + * @example + * import React from "react" + * import { useAdminUpdateProductOption } from "medusa-react" + * + * type Props = { + * productId: string + * optionId: string + * } + * + * const ProductOption = ({ + * productId, + * optionId + * }: Props) => { + * const updateOption = useAdminUpdateProductOption( + * productId + * ) + * // ... + * + * const handleUpdate = ( + * title: string + * ) => { + * updateOption.mutate({ + * option_id: optionId, + * title, + * }, { + * onSuccess: ({ product }) => { + * console.log(product.options) + * } + * }) + * } + * + * // ... + * } + * + * export default ProductOption + * + * @customNamespace Hooks.Admin.Products + * @category Mutations + */ export const useAdminUpdateProductOption = ( + /** + * The product's ID. + */ productId: string, options?: UseMutationOptions< Response, Error, - AdminPostProductsProductOptionsOption & { option_id: string } + AdminUpdateProductOptionReq > ) => { const { client } = useMedusa() @@ -176,13 +542,56 @@ export const useAdminUpdateProductOption = ( ({ option_id, ...payload - }: AdminPostProductsProductOptionsOption & { option_id: string }) => + }: AdminUpdateProductOptionReq) => client.admin.products.updateOption(productId, option_id, payload), buildOptions(queryClient, adminProductKeys.detail(productId), options) ) } +/** + * This hook deletes a product option. If there are product variants that use this product option, + * they must be deleted before deleting the product option. + * + * @typeParamDefinition string - The ID of the product option to delete. + * + * @example + * import React from "react" + * import { useAdminDeleteProductOption } from "medusa-react" + * + * type Props = { + * productId: string + * optionId: string + * } + * + * const ProductOption = ({ + * productId, + * optionId + * }: Props) => { + * const deleteOption = useAdminDeleteProductOption( + * productId + * ) + * // ... + * + * const handleDelete = () => { + * deleteOption.mutate(optionId, { + * onSuccess: ({ option_id, object, deleted, product }) => { + * console.log(product.options) + * } + * }) + * } + * + * // ... + * } + * + * export default ProductOption + * + * @customNamespace Hooks.Admin.Products + * @category Mutations + */ export const useAdminDeleteProductOption = ( + /** + * The product's ID. + */ productId: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/products/queries.ts b/packages/medusa-react/src/hooks/admin/products/queries.ts index 448391b30bf3d..b559ec174e5c6 100644 --- a/packages/medusa-react/src/hooks/admin/products/queries.ts +++ b/packages/medusa-react/src/hooks/admin/products/queries.ts @@ -17,7 +17,110 @@ export const adminProductKeys = queryKeysFactory(ADMIN_PRODUCTS_QUERY_KEY) type ProductQueryKeys = typeof adminProductKeys +/** + * This hook retrieves a list of products. The products can be filtered by fields such as `q` or `status` passed in + * the `query` parameter. The products can also be sorted or paginated. + * + * @example + * To list products: + * + * ```tsx + * import React from "react" + * import { useAdminProducts } from "medusa-react" + * + * const Products = () => { + * const { products, isLoading } = useAdminProducts() + * + * return ( + *
+ * {isLoading && Loading...} + * {products && !products.length && No Products} + * {products && products.length > 0 && ( + *
    + * {products.map((product) => ( + *
  • {product.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Products + * ``` + * + * To specify relations that should be retrieved within the products: + * + * ```tsx + * import React from "react" + * import { useAdminProducts } from "medusa-react" + * + * const Products = () => { + * const { products, isLoading } = useAdminProducts({ + * expand: "images" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {products && !products.length && No Products} + * {products && products.length > 0 && ( + *
    + * {products.map((product) => ( + *
  • {product.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Products + * ``` + * + * By default, only the first `50` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminProducts } from "medusa-react" + * + * const Products = () => { + * const { + * products, + * limit, + * offset, + * isLoading + * } = useAdminProducts({ + * expand: "images", + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {products && !products.length && No Products} + * {products && products.length > 0 && ( + *
    + * {products.map((product) => ( + *
  • {product.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Products + * ``` + * + * @customNamespace Hooks.Admin.Products + * @category Queries + */ export const useAdminProducts = ( + /** + * Filters and pagination configurations to apply on the retrieved products. + */ query?: AdminGetProductsParams, options?: UseQueryOptionsWrapper< Response, @@ -34,8 +137,45 @@ export const useAdminProducts = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a product's details. + * + * @example + * import React from "react" + * import { useAdminProduct } from "medusa-react" + * + * type Props = { + * productId: string + * } + * + * const Product = ({ productId }: Props) => { + * const { + * product, + * isLoading, + * } = useAdminProduct(productId) + * + * return ( + *
+ * {isLoading && Loading...} + * {product && {product.title}} + * + *
+ * ) + * } + * + * export default Product + * + * @customNamespace Hooks.Admin.Products + * @category Queries + */ export const useAdminProduct = ( + /** + * The product's ID. + */ id: string, + /** + * Configurations to apply on the retrieved product. + */ query?: AdminGetProductParams, options?: UseQueryOptionsWrapper< Response, @@ -52,6 +192,36 @@ export const useAdminProduct = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a list of Product Tags with how many times each is used in products. + * + * @example + * import React from "react" + * import { useAdminProductTagUsage } from "medusa-react" + * + * const ProductTags = (productId: string) => { + * const { tags, isLoading } = useAdminProductTagUsage() + * + * return ( + *
+ * {isLoading && Loading...} + * {tags && !tags.length && No Product Tags} + * {tags && tags.length > 0 && ( + *
    + * {tags.map((tag) => ( + *
  • {tag.value} - {tag.usage_count}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ProductTags + * + * @customNamespace Hooks.Admin.Products + * @category Queries + */ export const useAdminProductTagUsage = ( options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/publishable-api-keys/index.ts b/packages/medusa-react/src/hooks/admin/publishable-api-keys/index.ts index a494946b87dc5..d893bbfb0fa36 100644 --- a/packages/medusa-react/src/hooks/admin/publishable-api-keys/index.ts +++ b/packages/medusa-react/src/hooks/admin/publishable-api-keys/index.ts @@ -1,2 +1,22 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Publishable API Key API Routes](https://docs.medusajs.com/api/admin#publishable-api-keys). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Publishable API Keys can be used to scope Store API calls with an API key, determining what resources are retrieved when querying the API. + * For example, a publishable API key can be associated with one or more sales channels. + * + * When it is passed in the header of a request to the List Product store API Route, + * the sales channels are inferred from the key and only products associated with those sales channels are retrieved. + * + * Admins can manage publishable API keys and their associated resources. Currently, only Sales Channels are supported as a resource. + * + * Related Guide: [How to manage publishable API keys](https://docs.medusajs.com/development/publishable-api-keys/admin/manage-publishable-api-keys). + * + * @customNamespace Hooks.Admin.Publishable API Keys + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts b/packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts index 129728e756973..1ae616a14068d 100644 --- a/packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/publishable-api-keys/mutations.ts @@ -6,6 +6,7 @@ import { } from "@tanstack/react-query" import { + AdminDeletePublishableApiKeySalesChannelsBatchReq, AdminPostPublishableApiKeySalesChannelsBatchReq, AdminPostPublishableApiKeysPublishableApiKeyReq, AdminPostPublishableApiKeysReq, @@ -17,6 +18,35 @@ import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" import { adminPublishableApiKeysKeys } from "./queries" +/** + * This hook creates a publishable API key. + * + * @example + * import React from "react" + * import { useAdminCreatePublishableApiKey } from "medusa-react" + * + * const CreatePublishableApiKey = () => { + * const createKey = useAdminCreatePublishableApiKey() + * // ... + * + * const handleCreate = (title: string) => { + * createKey.mutate({ + * title, + * }, { + * onSuccess: ({ publishable_api_key }) => { + * console.log(publishable_api_key.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreatePublishableApiKey + * + * @customNamespace Hooks.Admin.Publishable API Keys + * @category Mutations + */ export const useAdminCreatePublishableApiKey = ( options?: UseMutationOptions< Response, @@ -33,7 +63,47 @@ export const useAdminCreatePublishableApiKey = ( ) } +/** + * This hook updates a publishable API key's details. + * + * @example + * import React from "react" + * import { useAdminUpdatePublishableApiKey } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const PublishableApiKey = ({ + * publishableApiKeyId + * }: Props) => { + * const updateKey = useAdminUpdatePublishableApiKey( + * publishableApiKeyId + * ) + * // ... + * + * const handleUpdate = (title: string) => { + * updateKey.mutate({ + * title, + * }, { + * onSuccess: ({ publishable_api_key }) => { + * console.log(publishable_api_key.id) + * } + * }) + * } + * + * // ... + * } + * + * export default PublishableApiKey + * + * @customNamespace Hooks.Admin.Publishable API Keys + * @category Mutations + */ export const useAdminUpdatePublishableApiKey = ( + /** + * The publishable API key's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -59,7 +129,45 @@ export const useAdminUpdatePublishableApiKey = ( ) } +/** + * This hook deletes a publishable API key. Associated resources, such as sales channels, are not deleted. + * + * @example + * import React from "react" + * import { useAdminDeletePublishableApiKey } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const PublishableApiKey = ({ + * publishableApiKeyId + * }: Props) => { + * const deleteKey = useAdminDeletePublishableApiKey( + * publishableApiKeyId + * ) + * // ... + * + * const handleDelete = () => { + * deleteKey.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default PublishableApiKey + * + * @customNamespace Hooks.Admin.Publishable API Keys + * @category Mutations + */ export const useAdminDeletePublishableApiKey = ( + /** + * The publishable API key's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -83,7 +191,45 @@ export const useAdminDeletePublishableApiKey = ( ) } +/** + * This hook revokes a publishable API key. Revoking the publishable API Key can't be undone, and the key can't be used in future requests. + * + * @example + * import React from "react" + * import { useAdminRevokePublishableApiKey } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const PublishableApiKey = ({ + * publishableApiKeyId + * }: Props) => { + * const revokeKey = useAdminRevokePublishableApiKey( + * publishableApiKeyId + * ) + * // ... + * + * const handleRevoke = () => { + * revokeKey.mutate(void 0, { + * onSuccess: ({ publishable_api_key }) => { + * console.log(publishable_api_key.revoked_at) + * } + * }) + * } + * + * // ... + * } + * + * export default PublishableApiKey + * + * @customNamespace Hooks.Admin.Publishable API Keys + * @category Mutations + */ export const useAdminRevokePublishableApiKey = ( + /** + * The publishable API key's ID. + */ id: string, options?: UseMutationOptions, Error> ) => { @@ -103,7 +249,54 @@ export const useAdminRevokePublishableApiKey = ( ) } +/** + * This hook adds a list of sales channels to a publishable API key. + * + * @example + * import React from "react" + * import { + * useAdminAddPublishableKeySalesChannelsBatch, + * } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const PublishableApiKey = ({ + * publishableApiKeyId + * }: Props) => { + * const addSalesChannels = + * useAdminAddPublishableKeySalesChannelsBatch( + * publishableApiKeyId + * ) + * // ... + * + * const handleAdd = (salesChannelId: string) => { + * addSalesChannels.mutate({ + * sales_channel_ids: [ + * { + * id: salesChannelId, + * }, + * ], + * }, { + * onSuccess: ({ publishable_api_key }) => { + * console.log(publishable_api_key.id) + * } + * }) + * } + * + * // ... + * } + * + * export default PublishableApiKey + * + * @customNamespace Hooks.Admin.Publishable API Keys + * @category Mutations + */ export const useAdminAddPublishableKeySalesChannelsBatch = ( + /** + * The publishable API key's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -125,19 +318,67 @@ export const useAdminAddPublishableKeySalesChannelsBatch = ( ) } +/** + * This hook removes a list of sales channels from a publishable API key. This doesn't delete the sales channels and only + * removes the association between them and the publishable API key. + * + * @example + * import React from "react" + * import { + * useAdminRemovePublishableKeySalesChannelsBatch, + * } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const PublishableApiKey = ({ + * publishableApiKeyId + * }: Props) => { + * const deleteSalesChannels = + * useAdminRemovePublishableKeySalesChannelsBatch( + * publishableApiKeyId + * ) + * // ... + * + * const handleDelete = (salesChannelId: string) => { + * deleteSalesChannels.mutate({ + * sales_channel_ids: [ + * { + * id: salesChannelId, + * }, + * ], + * }, { + * onSuccess: ({ publishable_api_key }) => { + * console.log(publishable_api_key.id) + * } + * }) + * } + * + * // ... + * } + * + * export default PublishableApiKey + * + * @customNamespace Hooks.Admin.Publishable API Keys + * @category Mutations + */ export const useAdminRemovePublishableKeySalesChannelsBatch = ( + /** + * The publishable API key's ID. + */ id: string, options?: UseMutationOptions< Response, Error, - AdminPostPublishableApiKeySalesChannelsBatchReq + AdminDeletePublishableApiKeySalesChannelsBatchReq > ) => { const { client } = useMedusa() const queryClient = useQueryClient() return useMutation( - (payload: AdminPostPublishableApiKeySalesChannelsBatchReq) => + (payload: AdminDeletePublishableApiKeySalesChannelsBatchReq) => client.admin.publishableApiKeys.deleteSalesChannelsBatch(id, payload), buildOptions( queryClient, diff --git a/packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts b/packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts index bcc521dd39547..331a9717801fe 100644 --- a/packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts +++ b/packages/medusa-react/src/hooks/admin/publishable-api-keys/queries.ts @@ -28,9 +28,46 @@ export const adminPublishableApiKeysKeys = { type PublishableApiKeyQueryKeys = typeof adminPublishableApiKeysKeys +/** + * This hook retrieves a publishable API key's details. + * + * @example + * import React from "react" + * import { + * useAdminPublishableApiKey, + * } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const PublishableApiKey = ({ + * publishableApiKeyId + * }: Props) => { + * const { publishable_api_key, isLoading } = + * useAdminPublishableApiKey( + * publishableApiKeyId + * ) + * + * + * return ( + *
+ * {isLoading && Loading...} + * {publishable_api_key && {publishable_api_key.title}} + *
+ * ) + * } + * + * export default PublishableApiKey + * + * @customNamespace Hooks.Admin.Publishable API Keys + * @category Queries + */ export const useAdminPublishableApiKey = ( + /** + * The publishable API key's ID. + */ id: string, - query?: GetPublishableApiKeysParams, options?: UseQueryOptionsWrapper< Response, Error, @@ -40,13 +77,104 @@ export const useAdminPublishableApiKey = ( const { client } = useMedusa() const { data, ...rest } = useQuery( adminPublishableApiKeysKeys.detail(id), - () => client.admin.publishableApiKeys.retrieve(id, query), + () => client.admin.publishableApiKeys.retrieve(id), options ) return { ...data, ...rest } as const } +/** + * This hook retrieves a list of publishable API keys. The publishable API keys can be filtered by fields such as `q` passed in `query`. + * The publishable API keys can also be paginated. + * + * @example + * To list publishable API keys: + * + * ```tsx + * import React from "react" + * import { PublishableApiKey } from "@medusajs/medusa" + * import { useAdminPublishableApiKeys } from "medusa-react" + * + * const PublishableApiKeys = () => { + * const { publishable_api_keys, isLoading } = + * useAdminPublishableApiKeys() + * + * return ( + *
+ * {isLoading && Loading...} + * {publishable_api_keys && !publishable_api_keys.length && ( + * No Publishable API Keys + * )} + * {publishable_api_keys && + * publishable_api_keys.length > 0 && ( + *
    + * {publishable_api_keys.map( + * (publishableApiKey: PublishableApiKey) => ( + *
  • + * {publishableApiKey.title} + *
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default PublishableApiKeys + * ``` + * + * By default, only the first `20` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { PublishableApiKey } from "@medusajs/medusa" + * import { useAdminPublishableApiKeys } from "medusa-react" + * + * const PublishableApiKeys = () => { + * const { + * publishable_api_keys, + * limit, + * offset, + * isLoading + * } = + * useAdminPublishableApiKeys({ + * limit: 50, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {publishable_api_keys && !publishable_api_keys.length && ( + * No Publishable API Keys + * )} + * {publishable_api_keys && + * publishable_api_keys.length > 0 && ( + *
    + * {publishable_api_keys.map( + * (publishableApiKey: PublishableApiKey) => ( + *
  • + * {publishableApiKey.title} + *
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default PublishableApiKeys + * ``` + * + * @customNamespace Hooks.Admin.Publishable API Keys + * @category Queries + */ export const useAdminPublishableApiKeys = ( + /** + * Filters and pagination configurations to apply on the retrieved publishable API keys. + */ query?: GetPublishableApiKeysParams, options?: UseQueryOptionsWrapper< Response, @@ -63,8 +191,58 @@ export const useAdminPublishableApiKeys = ( return { ...data, ...rest } as const } +/** + * This hook lists the sales channels associated with a publishable API key. The sales channels can be + * filtered by fields such as `q` passed in the `query` parameter. + * + * @example + * import React from "react" + * import { + * useAdminPublishableApiKeySalesChannels, + * } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const SalesChannels = ({ + * publishableApiKeyId + * }: Props) => { + * const { sales_channels, isLoading } = + * useAdminPublishableApiKeySalesChannels( + * publishableApiKeyId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {sales_channels && !sales_channels.length && ( + * No Sales Channels + * )} + * {sales_channels && sales_channels.length > 0 && ( + *
    + * {sales_channels.map((salesChannel) => ( + *
  • {salesChannel.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default SalesChannels + * + * @customNamespace Hooks.Admin.Publishable API Keys + * @category Queries + */ export const useAdminPublishableApiKeySalesChannels = ( + /** + * The publishable API Key's ID. + */ id: string, + /** + * Filters to apply on the retrieved sales channels. + */ query?: GetPublishableApiKeySalesChannelsParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/regions/index.ts b/packages/medusa-react/src/hooks/admin/regions/index.ts index a494946b87dc5..5c5b12abe49c3 100644 --- a/packages/medusa-react/src/hooks/admin/regions/index.ts +++ b/packages/medusa-react/src/hooks/admin/regions/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Region API Routes](https://docs.medusajs.com/api/admin#regions). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Regions are different countries or geographical regions that the commerce store serves customers in. + * Admins can manage these regions, their providers, and more. + * + * Related Guide: [How to manage regions](https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions). + * + * @customNamespace Hooks.Admin.Regions + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/regions/mutations.ts b/packages/medusa-react/src/hooks/admin/regions/mutations.ts index f0ebe9a9f8589..20a88f6087e58 100644 --- a/packages/medusa-react/src/hooks/admin/regions/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/regions/mutations.ts @@ -17,6 +17,42 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminRegionKeys } from "./queries" +/** + * This hook creates a region. + * + * @example + * import React from "react" + * import { useAdminCreateRegion } from "medusa-react" + * + * type CreateData = { + * name: string + * currency_code: string + * tax_rate: number + * payment_providers: string[] + * fulfillment_providers: string[] + * countries: string[] + * } + * + * const CreateRegion = () => { + * const createRegion = useAdminCreateRegion() + * // ... + * + * const handleCreate = (regionData: CreateData) => { + * createRegion.mutate(regionData, { + * onSuccess: ({ region }) => { + * console.log(region.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateRegion + * + * @customNamespace Hooks.Admin.Regions + * @category Mutations + */ export const useAdminCreateRegion = ( options?: UseMutationOptions< Response, @@ -33,7 +69,47 @@ export const useAdminCreateRegion = ( ) } +/** + * This hook updates a region's details. + * + * @example + * import React from "react" + * import { useAdminUpdateRegion } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const updateRegion = useAdminUpdateRegion(regionId) + * // ... + * + * const handleUpdate = ( + * countries: string[] + * ) => { + * updateRegion.mutate({ + * countries, + * }, { + * onSuccess: ({ region }) => { + * console.log(region.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Region + * + * @customNamespace Hooks.Admin.Regions + * @category Mutations + */ export const useAdminUpdateRegion = ( + /** + * The region's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -55,7 +131,43 @@ export const useAdminUpdateRegion = ( ) } +/** + * This hook deletes a region. Associated resources, such as providers or currencies are not deleted. Associated tax rates are deleted. + * + * @example + * import React from "react" + * import { useAdminDeleteRegion } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const deleteRegion = useAdminDeleteRegion(regionId) + * // ... + * + * const handleDelete = () => { + * deleteRegion.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Region + * + * @customNamespace Hooks.Admin.Regions + * @category Mutations + */ export const useAdminDeleteRegion = ( + /** + * The region's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -72,7 +184,47 @@ export const useAdminDeleteRegion = ( ) } +/** + * This hook adds a country to the list of countries in a region. + * + * @example + * import React from "react" + * import { useAdminRegionAddCountry } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const addCountry = useAdminRegionAddCountry(regionId) + * // ... + * + * const handleAddCountry = ( + * countryCode: string + * ) => { + * addCountry.mutate({ + * country_code: countryCode + * }, { + * onSuccess: ({ region }) => { + * console.log(region.countries) + * } + * }) + * } + * + * // ... + * } + * + * export default Region + * + * @customNamespace Hooks.Admin.Regions + * @category Mutations + */ export const useAdminRegionAddCountry = ( + /** + * The region's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -90,7 +242,47 @@ export const useAdminRegionAddCountry = ( ) } +/** + * This hook deletes a country from the list of countries in a region. The country will still be available in the system, and it can be used in other regions. + * + * @typeParamDefinition string - The code of the country to delete from the region. + * + * @example + * import React from "react" + * import { useAdminRegionRemoveCountry } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const removeCountry = useAdminRegionRemoveCountry(regionId) + * // ... + * + * const handleRemoveCountry = ( + * countryCode: string + * ) => { + * removeCountry.mutate(countryCode, { + * onSuccess: ({ region }) => { + * console.log(region.countries) + * } + * }) + * } + * + * // ... + * } + * + * export default Region + * + * @customNamespace Hooks.Admin.Regions + * @category Mutations + */ export const useAdminRegionRemoveCountry = ( + /** + * The region's ID. + */ id: string, options?: UseMutationOptions, Error, string> ) => { @@ -104,7 +296,50 @@ export const useAdminRegionRemoveCountry = ( ) } +/** + * This hook adds a fulfillment provider to the list of fulfullment providers in a region. + * + * @example + * import React from "react" + * import { + * useAdminRegionAddFulfillmentProvider + * } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const addFulfillmentProvider = + * useAdminRegionAddFulfillmentProvider(regionId) + * // ... + * + * const handleAddFulfillmentProvider = ( + * providerId: string + * ) => { + * addFulfillmentProvider.mutate({ + * provider_id: providerId + * }, { + * onSuccess: ({ region }) => { + * console.log(region.fulfillment_providers) + * } + * }) + * } + * + * // ... + * } + * + * export default Region + * + * @customNamespace Hooks.Admin.Regions + * @category Mutations + */ export const useAdminRegionAddFulfillmentProvider = ( + /** + * The region's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -122,7 +357,50 @@ export const useAdminRegionAddFulfillmentProvider = ( ) } +/** + * This hook deletes a fulfillment provider from a region. The fulfillment provider will still be available for usage in other regions. + * + * @typeParamDefinition string - The fulfillment provider's ID to delete from the region. + * + * @example + * import React from "react" + * import { + * useAdminRegionDeleteFulfillmentProvider + * } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const removeFulfillmentProvider = + * useAdminRegionDeleteFulfillmentProvider(regionId) + * // ... + * + * const handleRemoveFulfillmentProvider = ( + * providerId: string + * ) => { + * removeFulfillmentProvider.mutate(providerId, { + * onSuccess: ({ region }) => { + * console.log(region.fulfillment_providers) + * } + * }) + * } + * + * // ... + * } + * + * export default Region + * + * @customNamespace Hooks.Admin.Regions + * @category Mutations + */ export const useAdminRegionDeleteFulfillmentProvider = ( + /** + * The region's ID. + */ id: string, options?: UseMutationOptions, Error, string> ) => { @@ -136,7 +414,50 @@ export const useAdminRegionDeleteFulfillmentProvider = ( ) } +/** + * This hook adds a payment provider to the list of payment providers in a region. + * + * @example + * import React from "react" + * import { + * useAdminRegionAddPaymentProvider + * } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const addPaymentProvider = + * useAdminRegionAddPaymentProvider(regionId) + * // ... + * + * const handleAddPaymentProvider = ( + * providerId: string + * ) => { + * addPaymentProvider.mutate({ + * provider_id: providerId + * }, { + * onSuccess: ({ region }) => { + * console.log(region.payment_providers) + * } + * }) + * } + * + * // ... + * } + * + * export default Region + * + * @customNamespace Hooks.Admin.Regions + * @category Mutations + */ export const useAdminRegionAddPaymentProvider = ( + /** + * The region's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -154,7 +475,50 @@ export const useAdminRegionAddPaymentProvider = ( ) } +/** + * This hook deletes a payment provider from a region. The payment provider will still be available for usage in other regions. + * + * @typeParamDefinition string - The ID of the payment provider to delete from the region. + * + * @example + * import React from "react" + * import { + * useAdminRegionDeletePaymentProvider + * } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const removePaymentProvider = + * useAdminRegionDeletePaymentProvider(regionId) + * // ... + * + * const handleRemovePaymentProvider = ( + * providerId: string + * ) => { + * removePaymentProvider.mutate(providerId, { + * onSuccess: ({ region }) => { + * console.log(region.payment_providers) + * } + * }) + * } + * + * // ... + * } + * + * export default Region + * + * @customNamespace Hooks.Admin.Regions + * @category Mutations + */ export const useAdminRegionDeletePaymentProvider = ( + /** + * The region's ID. + */ id: string, options?: UseMutationOptions, Error, string> ) => { diff --git a/packages/medusa-react/src/hooks/admin/regions/queries.ts b/packages/medusa-react/src/hooks/admin/regions/queries.ts index 25c2899bc3351..61b9c57d8efa8 100644 --- a/packages/medusa-react/src/hooks/admin/regions/queries.ts +++ b/packages/medusa-react/src/hooks/admin/regions/queries.ts @@ -16,7 +16,80 @@ export const adminRegionKeys = queryKeysFactory(ADMIN_REGIONS_QUERY_KEY) type RegionQueryKeys = typeof adminRegionKeys +/** + * This hook retrieves a list of Regions. The regions can be filtered by fields such as `created_at` passed in the `query` parameter. + * The regions can also be paginated. + * + * @example + * To list regions: + * + * ```tsx + * import React from "react" + * import { useAdminRegions } from "medusa-react" + * + * const Regions = () => { + * const { regions, isLoading } = useAdminRegions() + * + * return ( + *
+ * {isLoading && Loading...} + * {regions && !regions.length && No Regions} + * {regions && regions.length > 0 && ( + *
    + * {regions.map((region) => ( + *
  • {region.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Regions + * ``` + * + * By default, only the first `50` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminRegions } from "medusa-react" + * + * const Regions = () => { + * const { + * regions, + * limit, + * offset, + * isLoading + * } = useAdminRegions({ + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {regions && !regions.length && No Regions} + * {regions && regions.length > 0 && ( + *
    + * {regions.map((region) => ( + *
  • {region.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Regions + * ``` + * + * @customNamespace Hooks.Admin.Regions + * @category Queries + */ export const useAdminRegions = ( + /** + * Filters and pagination configurations to apply on the retrieved regions. + */ query?: AdminGetRegionsParams, options?: UseQueryOptionsWrapper< Response, @@ -33,7 +106,41 @@ export const useAdminRegions = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a region's details. + * + * @example + * import React from "react" + * import { useAdminRegion } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const { region, isLoading } = useAdminRegion( + * regionId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {region && {region.name}} + *
+ * ) + * } + * + * export default Region + * + * @customNamespace Hooks.Admin.Regions + * @category Queries + */ export const useAdminRegion = ( + /** + * The region's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, @@ -50,7 +157,58 @@ export const useAdminRegion = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a list of fulfillment options available in a region. + * + * @example + * import React from "react" + * import { + * useAdminRegionFulfillmentOptions + * } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const { + * fulfillment_options, + * isLoading + * } = useAdminRegionFulfillmentOptions( + * regionId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {fulfillment_options && !fulfillment_options.length && ( + * No Regions + * )} + * {fulfillment_options && + * fulfillment_options.length > 0 && ( + *
    + * {fulfillment_options.map((option) => ( + *
  • + * {option.provider_id} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Region + * + * @customNamespace Hooks.Admin.Regions + * @category Queries + */ export const useAdminRegionFulfillmentOptions = ( + /** + * The region's ID. + */ regionId: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/reservations/index.ts b/packages/medusa-react/src/hooks/admin/reservations/index.ts index 97c3d1d4b8b69..fc48b511b0bed 100644 --- a/packages/medusa-react/src/hooks/admin/reservations/index.ts +++ b/packages/medusa-react/src/hooks/admin/reservations/index.ts @@ -1,2 +1,20 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Reservation API Routes](https://docs.medusajs.com/api/admin#reservations). + * To use these hooks, make sure to install the + * [@medusajs/inventory](https://docs.medusajs.com/modules/multiwarehouse/install-modules#inventory-module) module in your Medusa backend. + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Reservations, provided by the [Inventory Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module), + * are quantities of an item that are reserved, typically when an order is placed but not yet fulfilled. + * Reservations can be associated with any resources, but commonly with line items of an order. + * + * Related Guide: [How to manage item allocations in orders](https://docs.medusajs.com/modules/multiwarehouse/admin/manage-item-allocations-in-orders). + * + * @customNamespace Hooks.Admin.Reservations + */ + export * from "./mutations" export * from "./queries" diff --git a/packages/medusa-react/src/hooks/admin/reservations/mutations.ts b/packages/medusa-react/src/hooks/admin/reservations/mutations.ts index 73a4218abd538..6f1813c10ba61 100644 --- a/packages/medusa-react/src/hooks/admin/reservations/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/reservations/mutations.ts @@ -17,6 +17,41 @@ import { adminInventoryItemsKeys } from "../inventory-item" import { adminVariantKeys } from "../variants" import { adminReservationsKeys } from "./queries" +/** + * This hook creates a reservation which can be associated with any resource, such as an order's line item. + * + * @example + * import React from "react" + * import { useAdminCreateReservation } from "medusa-react" + * + * const CreateReservation = () => { + * const createReservation = useAdminCreateReservation() + * // ... + * + * const handleCreate = ( + * locationId: string, + * inventoryItemId: string, + * quantity: number + * ) => { + * createReservation.mutate({ + * location_id: locationId, + * inventory_item_id: inventoryItemId, + * quantity, + * }, { + * onSuccess: ({ reservation }) => { + * console.log(reservation.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateReservation + * + * @customNamespace Hooks.Admin.Reservations + * @category Mutations + */ export const useAdminCreateReservation = ( options?: UseMutationOptions< Response, @@ -38,7 +73,43 @@ export const useAdminCreateReservation = ( ) } +/** + * This hook updates a reservation's details. + * + * @example + * import React from "react" + * import { useAdminUpdateReservation } from "medusa-react" + * + * type Props = { + * reservationId: string + * } + * + * const Reservation = ({ reservationId }: Props) => { + * const updateReservation = useAdminUpdateReservation( + * reservationId + * ) + * // ... + * + * const handleUpdate = ( + * quantity: number + * ) => { + * updateReservation.mutate({ + * quantity, + * }) + * } + * + * // ... + * } + * + * export default Reservation + * + * @customNamespace Hooks.Admin.Reservations + * @category Mutations + */ export const useAdminUpdateReservation = ( + /** + * The reservation's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -65,7 +136,43 @@ export const useAdminUpdateReservation = ( ) } +/** + * This hook deletes a reservation. Associated resources, such as the line item, will not be deleted. + * + * @example + * import React from "react" + * import { useAdminDeleteReservation } from "medusa-react" + * + * type Props = { + * reservationId: string + * } + * + * const Reservation = ({ reservationId }: Props) => { + * const deleteReservation = useAdminDeleteReservation( + * reservationId + * ) + * // ... + * + * const handleDelete = () => { + * deleteReservation.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Reservation + * + * @customNamespace Hooks.Admin.Reservations + * @category Mutations + */ export const useAdminDeleteReservation = ( + /** + * The reservation's ID. + */ id: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/reservations/queries.ts b/packages/medusa-react/src/hooks/admin/reservations/queries.ts index da4184b2b3c49..785a082596fc1 100644 --- a/packages/medusa-react/src/hooks/admin/reservations/queries.ts +++ b/packages/medusa-react/src/hooks/admin/reservations/queries.ts @@ -17,7 +17,119 @@ export const adminReservationsKeys = queryKeysFactory( type ReservationsQueryKeys = typeof adminReservationsKeys +/** + * This hook retrieves a list of reservations. The reservations can be filtered by fields such as `location_id` or `quantity` + * passed in the `query` parameter. The reservations can also be paginated. + * + * @example + * To list reservations: + * + * ```tsx + * import React from "react" + * import { useAdminReservations } from "medusa-react" + * + * const Reservations = () => { + * const { reservations, isLoading } = useAdminReservations() + * + * return ( + *
+ * {isLoading && Loading...} + * {reservations && !reservations.length && ( + * No Reservations + * )} + * {reservations && reservations.length > 0 && ( + *
    + * {reservations.map((reservation) => ( + *
  • {reservation.quantity}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Reservations + * ``` + * + * To specify relations that should be retrieved within the reservations: + * + * ```tsx + * import React from "react" + * import { useAdminReservations } from "medusa-react" + * + * const Reservations = () => { + * const { + * reservations, + * isLoading + * } = useAdminReservations({ + * expand: "location" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {reservations && !reservations.length && ( + * No Reservations + * )} + * {reservations && reservations.length > 0 && ( + *
    + * {reservations.map((reservation) => ( + *
  • {reservation.quantity}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Reservations + * ``` + * + * By default, only the first `20` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminReservations } from "medusa-react" + * + * const Reservations = () => { + * const { + * reservations, + * limit, + * offset, + * isLoading + * } = useAdminReservations({ + * expand: "location", + * limit: 10, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {reservations && !reservations.length && ( + * No Reservations + * )} + * {reservations && reservations.length > 0 && ( + *
    + * {reservations.map((reservation) => ( + *
  • {reservation.quantity}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Reservations + * ``` + * + * @customNamespace Hooks.Admin.Reservations + * @category Queries + */ export const useAdminReservations = ( + /** + * Filters and pagination parameters to apply on the retrieved reservations. + */ query?: AdminGetReservationsParams, options?: UseQueryOptionsWrapper< Response, @@ -36,7 +148,41 @@ export const useAdminReservations = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a reservation's details. + * + * @example + * import React from "react" + * import { useAdminReservation } from "medusa-react" + * + * type Props = { + * reservationId: string + * } + * + * const Reservation = ({ reservationId }: Props) => { + * const { reservation, isLoading } = useAdminReservation( + * reservationId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {reservation && ( + * {reservation.inventory_item_id} + * )} + *
+ * ) + * } + * + * export default Reservation + * + * @customNamespace Hooks.Admin.Reservations + * @category Queries + */ export const useAdminReservation = ( + /** + * The reservation's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/return-reasons/index.ts b/packages/medusa-react/src/hooks/admin/return-reasons/index.ts index a494946b87dc5..1e038c375b972 100644 --- a/packages/medusa-react/src/hooks/admin/return-reasons/index.ts +++ b/packages/medusa-react/src/hooks/admin/return-reasons/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Return Reason API Routes](https://docs.medusajs.com/api/admin#return-reasons). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Return reasons are key-value pairs that are used to specify why an order return is being created. + * Admins can manage available return reasons, and they can be used by both admins and customers when creating a return. + * + * Related Guide: [How to manage return reasons](https://docs.medusajs.com/modules/orders/admin/manage-returns#manage-return-reasons). + * + * @customNamespace Hooks.Admin.Return Reasons + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts b/packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts index 0b4a42fd547df..bd3f608ff8d1b 100644 --- a/packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/return-reasons/mutations.ts @@ -13,6 +13,39 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminReturnReasonKeys } from "./queries" +/** + * This hook creates a return reason. + * + * @example + * import React from "react" + * import { useAdminCreateReturnReason } from "medusa-react" + * + * const CreateReturnReason = () => { + * const createReturnReason = useAdminCreateReturnReason() + * // ... + * + * const handleCreate = ( + * label: string, + * value: string + * ) => { + * createReturnReason.mutate({ + * label, + * value, + * }, { + * onSuccess: ({ return_reason }) => { + * console.log(return_reason.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateReturnReason + * + * @customNamespace Hooks.Admin.Return Reasons + * @category Mutations + */ export const useAdminCreateReturnReason = ( options?: UseMutationOptions< Response, @@ -30,7 +63,47 @@ export const useAdminCreateReturnReason = ( ) } +/** + * This hook updates a return reason's details. + * + * @example + * import React from "react" + * import { useAdminUpdateReturnReason } from "medusa-react" + * + * type Props = { + * returnReasonId: string + * } + * + * const ReturnReason = ({ returnReasonId }: Props) => { + * const updateReturnReason = useAdminUpdateReturnReason( + * returnReasonId + * ) + * // ... + * + * const handleUpdate = ( + * label: string + * ) => { + * updateReturnReason.mutate({ + * label, + * }, { + * onSuccess: ({ return_reason }) => { + * console.log(return_reason.label) + * } + * }) + * } + * + * // ... + * } + * + * export default ReturnReason + * + * @customNamespace Hooks.Admin.Return Reasons + * @category Mutations + */ export const useAdminUpdateReturnReason = ( + /** + * The return reason's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -52,7 +125,43 @@ export const useAdminUpdateReturnReason = ( ) } +/** + * This hook deletes a return reason. + * + * @example + * import React from "react" + * import { useAdminDeleteReturnReason } from "medusa-react" + * + * type Props = { + * returnReasonId: string + * } + * + * const ReturnReason = ({ returnReasonId }: Props) => { + * const deleteReturnReason = useAdminDeleteReturnReason( + * returnReasonId + * ) + * // ... + * + * const handleDelete = () => { + * deleteReturnReason.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default ReturnReason + * + * @customNamespace Hooks.Admin.Return Reasons + * @category Mutations + */ export const useAdminDeleteReturnReason = ( + /** + * The return reason's ID. + */ id: string, options?: UseMutationOptions ) => { diff --git a/packages/medusa-react/src/hooks/admin/return-reasons/queries.ts b/packages/medusa-react/src/hooks/admin/return-reasons/queries.ts index 6ca3fc4b4184f..e070214684931 100644 --- a/packages/medusa-react/src/hooks/admin/return-reasons/queries.ts +++ b/packages/medusa-react/src/hooks/admin/return-reasons/queries.ts @@ -16,6 +16,40 @@ export const adminReturnReasonKeys = queryKeysFactory( type ReturnReasonQueryKeys = typeof adminReturnReasonKeys +/** + * This hook retrieves a list of return reasons. + * + * @example + * import React from "react" + * import { useAdminReturnReasons } from "medusa-react" + * + * const ReturnReasons = () => { + * const { return_reasons, isLoading } = useAdminReturnReasons() + * + * return ( + *
+ * {isLoading && Loading...} + * {return_reasons && !return_reasons.length && ( + * No Return Reasons + * )} + * {return_reasons && return_reasons.length > 0 && ( + *
    + * {return_reasons.map((reason) => ( + *
  • + * {reason.label}: {reason.value} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ReturnReasons + * + * @customNamespace Hooks.Admin.Return Reasons + * @category Queries + */ export const useAdminReturnReasons = ( options?: UseQueryOptionsWrapper< Response, @@ -32,7 +66,39 @@ export const useAdminReturnReasons = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a return reason's details. + * + * @example + * import React from "react" + * import { useAdminReturnReason } from "medusa-react" + * + * type Props = { + * returnReasonId: string + * } + * + * const ReturnReason = ({ returnReasonId }: Props) => { + * const { return_reason, isLoading } = useAdminReturnReason( + * returnReasonId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {return_reason && {return_reason.label}} + *
+ * ) + * } + * + * export default ReturnReason + * + * @customNamespace Hooks.Admin.Return Reasons + * @category Queries + */ export const useAdminReturnReason = ( + /** + * The return reason's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/returns/index.ts b/packages/medusa-react/src/hooks/admin/returns/index.ts index a494946b87dc5..065434d59a1ce 100644 --- a/packages/medusa-react/src/hooks/admin/returns/index.ts +++ b/packages/medusa-react/src/hooks/admin/returns/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Return API Routes](https://docs.medusajs.com/api/admin#returns). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A return can be created by a customer or an admin to return items in an order. + * Admins can manage these returns and change their state. + * + * Related Guide: [How to manage returns](https://docs.medusajs.com/modules/orders/admin/manage-returns). + * + * @customNamespace Hooks.Admin.Returns + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/returns/mutations.ts b/packages/medusa-react/src/hooks/admin/returns/mutations.ts index 835659f991c8f..6dceb63c543be 100644 --- a/packages/medusa-react/src/hooks/admin/returns/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/returns/mutations.ts @@ -13,7 +13,50 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminReturnKeys } from "./queries" +/** + * This hook marks a return as received. This also updates the status of associated order, claim, or swap accordingly. + * + * @example + * import React from "react" + * import { useAdminReceiveReturn } from "medusa-react" + * + * type ReceiveReturnData = { + * items: { + * item_id: string + * quantity: number + * }[] + * } + * + * type Props = { + * returnId: string + * } + * + * const Return = ({ returnId }: Props) => { + * const receiveReturn = useAdminReceiveReturn( + * returnId + * ) + * // ... + * + * const handleReceive = (data: ReceiveReturnData) => { + * receiveReturn.mutate(data, { + * onSuccess: ({ return: dataReturn }) => { + * console.log(dataReturn.status) + * } + * }) + * } + * + * // ... + * } + * + * export default Return + * + * @customNamespace Hooks.Admin.Returns + * @category Mutations + */ export const useAdminReceiveReturn = ( + /** + * The return's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -34,7 +77,43 @@ export const useAdminReceiveReturn = ( ) } +/** + * This hook registers a return as canceled. The return can be associated with an order, claim, or swap. + * + * @example + * import React from "react" + * import { useAdminCancelReturn } from "medusa-react" + * + * type Props = { + * returnId: string + * } + * + * const Return = ({ returnId }: Props) => { + * const cancelReturn = useAdminCancelReturn( + * returnId + * ) + * // ... + * + * const handleCancel = () => { + * cancelReturn.mutate(void 0, { + * onSuccess: ({ order }) => { + * console.log(order.returns) + * } + * }) + * } + * + * // ... + * } + * + * export default Return + * + * @customNamespace Hooks.Admin.Returns + * @category Mutations + */ export const useAdminCancelReturn = ( + /** + * The return's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { diff --git a/packages/medusa-react/src/hooks/admin/returns/queries.ts b/packages/medusa-react/src/hooks/admin/returns/queries.ts index 927c9d73b32d1..e226117031350 100644 --- a/packages/medusa-react/src/hooks/admin/returns/queries.ts +++ b/packages/medusa-react/src/hooks/admin/returns/queries.ts @@ -11,6 +11,40 @@ export const adminReturnKeys = queryKeysFactory(ADMIN_RETURNS_QUERY_KEY) type ReturnQueryKeys = typeof adminReturnKeys +/** + * This hook retrieves a list of Returns. The returns can be paginated. + * + * @example + * import React from "react" + * import { useAdminReturns } from "medusa-react" + * + * const Returns = () => { + * const { returns, isLoading } = useAdminReturns() + * + * return ( + *
+ * {isLoading && Loading...} + * {returns && !returns.length && ( + * No Returns + * )} + * {returns && returns.length > 0 && ( + *
    + * {returns.map((returnData) => ( + *
  • + * {returnData.status} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Returns + * + * @customNamespace Hooks.Admin.Returns + * @category Queries + */ export const useAdminReturns = ( options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/sales-channels/index.ts b/packages/medusa-react/src/hooks/admin/sales-channels/index.ts index a494946b87dc5..154e17823b304 100644 --- a/packages/medusa-react/src/hooks/admin/sales-channels/index.ts +++ b/packages/medusa-react/src/hooks/admin/sales-channels/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Sales Channel API Routes](https://docs.medusajs.com/api/admin#sales-channels). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A sales channel indicates a channel where products can be sold in. For example, a webshop or a mobile app. + * Admins can manage sales channels and the products available in them. + * + * Related Guide: [How to manage sales channels](https://docs.medusajs.com/modules/sales-channels/admin/manage). + * + * @customNamespace Hooks.Admin.Sales Channels + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts b/packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts index 69254f85e0a31..53f327bb3d724 100644 --- a/packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts @@ -20,10 +20,34 @@ import { adminStockLocationsKeys } from "../stock-locations" import { adminSalesChannelsKeys } from "./queries" /** - * Hook provides a mutation function for creating sales channel. - * - * @experimental This feature is under development and may change in the future. - * To use this feature please enable the corresponding feature flag in your medusa backend project. + * This hook creates a sales channel. + * + * @example + * import React from "react" + * import { useAdminCreateSalesChannel } from "medusa-react" + * + * const CreateSalesChannel = () => { + * const createSalesChannel = useAdminCreateSalesChannel() + * // ... + * + * const handleCreate = (name: string, description: string) => { + * createSalesChannel.mutate({ + * name, + * description, + * }, { + * onSuccess: ({ sales_channel }) => { + * console.log(sales_channel.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateSalesChannel + * + * @customNamespace Hooks.Admin.Sales Channels + * @category Mutations */ export const useAdminCreateSalesChannel = ( options?: UseMutationOptions< @@ -42,13 +66,47 @@ export const useAdminCreateSalesChannel = ( ) } -/** update a sales channel - * @experimental This feature is under development and may change in the future. - * To use this feature please enable feature flag `sales_channels` in your medusa backend project. - * @description updates a sales channel - * @returns the updated medusa sales channel +/** + * This hook updates a sales channel's details. + * + * @example + * import React from "react" + * import { useAdminUpdateSalesChannel } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const updateSalesChannel = useAdminUpdateSalesChannel( + * salesChannelId + * ) + * // ... + * + * const handleUpdate = ( + * is_disabled: boolean + * ) => { + * updateSalesChannel.mutate({ + * is_disabled, + * }, { + * onSuccess: ({ sales_channel }) => { + * console.log(sales_channel.is_disabled) + * } + * }) + * } + * + * // ... + * } + * + * export default SalesChannel + * + * @customNamespace Hooks.Admin.Sales Channels + * @category Mutations */ export const useAdminUpdateSalesChannel = ( + /** + * The sales channel's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -70,13 +128,42 @@ export const useAdminUpdateSalesChannel = ( } /** - * Delete a sales channel - * @experimental This feature is under development and may change in the future. - * To use this feature please enable featureflag `sales_channels` in your medusa backend project. - * @param id - * @param options + * This hook deletes a sales channel. Associated products, stock locations, and other resources are not deleted. + * + * @example + * import React from "react" + * import { useAdminDeleteSalesChannel } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const deleteSalesChannel = useAdminDeleteSalesChannel( + * salesChannelId + * ) + * // ... + * + * const handleDelete = () => { + * deleteSalesChannel.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default SalesChannel + * + * @customNamespace Hooks.Admin.Sales Channels + * @category Mutations */ export const useAdminDeleteSalesChannel = ( + /** + * The sales channel's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -97,14 +184,51 @@ export const useAdminDeleteSalesChannel = ( } /** - * Remove products from a sales channel - * @experimental This feature is under development and may change in the future. - * To use this feature please enable featureflag `sales_channels` in your medusa backend project. - * @description remove products from a sales channel - * @param id - * @param options + * This hook removes a list of products from a sales channel. This doesn't delete the product. It only removes the + * association between the product and the sales channel. + * + * @example + * import React from "react" + * import { + * useAdminDeleteProductsFromSalesChannel, + * } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const deleteProducts = useAdminDeleteProductsFromSalesChannel( + * salesChannelId + * ) + * // ... + * + * const handleDeleteProducts = (productId: string) => { + * deleteProducts.mutate({ + * product_ids: [ + * { + * id: productId, + * }, + * ], + * }, { + * onSuccess: ({ sales_channel }) => { + * console.log(sales_channel.id) + * } + * }) + * } + * + * // ... + * } + * + * export default SalesChannel + * + * @customNamespace Hooks.Admin.Sales Channels + * @category Mutations */ export const useAdminDeleteProductsFromSalesChannel = ( + /** + * The sales channel's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -131,14 +255,48 @@ export const useAdminDeleteProductsFromSalesChannel = ( } /** - * Add products to a sales channel - * @experimental This feature is under development and may change in the future. - * To use this feature please enable featureflag `sales_channels` in your medusa backend project. - * @description Add products to a sales channel - * @param id - * @param options + * This hook adds a list of products to a sales channel. + * + * @example + * import React from "react" + * import { useAdminAddProductsToSalesChannel } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const addProducts = useAdminAddProductsToSalesChannel( + * salesChannelId + * ) + * // ... + * + * const handleAddProducts = (productId: string) => { + * addProducts.mutate({ + * product_ids: [ + * { + * id: productId, + * }, + * ], + * }, { + * onSuccess: ({ sales_channel }) => { + * console.log(sales_channel.id) + * } + * }) + * } + * + * // ... + * } + * + * export default SalesChannel + * + * @customNamespace Hooks.Admin.Sales Channels + * @category Mutations */ export const useAdminAddProductsToSalesChannel = ( + /** + * The sales channel's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -165,18 +323,55 @@ export const useAdminAddProductsToSalesChannel = ( } /** - * Add a location to a sales channel - * @experimental This feature is under development and may change in the future. - * To use this feature please install the stock location in your medusa backend project. - * @description Add a location to a sales channel - * @param options + * This hook associates a stock location with a sales channel. It requires the + * [@medusajs/stock-location](https://docs.medusajs.com/modules/multiwarehouse/install-modules#stock-location-module) module to be installed in + * your Medusa backend. + * + * @example + * import React from "react" + * import { + * useAdminAddLocationToSalesChannel + * } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const addLocation = useAdminAddLocationToSalesChannel() + * // ... + * + * const handleAddLocation = (locationId: string) => { + * addLocation.mutate({ + * sales_channel_id: salesChannelId, + * location_id: locationId + * }, { + * onSuccess: ({ sales_channel }) => { + * console.log(sales_channel.locations) + * } + * }) + * } + * + * // ... + * } + * + * export default SalesChannel + * + * @customNamespace Hooks.Admin.Sales Channels + * @category Mutations */ export const useAdminAddLocationToSalesChannel = ( options?: UseMutationOptions< Response, Error, { + /** + * The sales channel's ID. + */ sales_channel_id: string + /** + * The location's ID. + */ location_id: string } > @@ -200,18 +395,56 @@ export const useAdminAddLocationToSalesChannel = ( } /** - * Remove a location from a sales channel - * @experimental This feature is under development and may change in the future. - * To use this feature please install the stock location in your medusa backend project. - * @description Remove a location from a sales channel - * @param options + * This hook removes a stock location from a sales channel. This only removes the association between the stock + * location and the sales channel. It does not delete the stock location. This hook requires the + * [@medusajs/stock-location](https://docs.medusajs.com/modules/multiwarehouse/install-modules#stock-location-module) module to be installed in + * your Medusa backend. + * + * @example + * import React from "react" + * import { + * useAdminRemoveLocationFromSalesChannel + * } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const removeLocation = useAdminRemoveLocationFromSalesChannel() + * // ... + * + * const handleRemoveLocation = (locationId: string) => { + * removeLocation.mutate({ + * sales_channel_id: salesChannelId, + * location_id: locationId + * }, { + * onSuccess: ({ sales_channel }) => { + * console.log(sales_channel.locations) + * } + * }) + * } + * + * // ... + * } + * + * export default SalesChannel + * + * @customNamespace Hooks.Admin.Sales Channels + * @category Mutations */ export const useAdminRemoveLocationFromSalesChannel = ( options?: UseMutationOptions< Response, Error, { + /** + * The sales channel's ID. + */ sales_channel_id: string + /** + * The location's ID. + */ location_id: string } > diff --git a/packages/medusa-react/src/hooks/admin/sales-channels/queries.ts b/packages/medusa-react/src/hooks/admin/sales-channels/queries.ts index db02f606be888..dc5cfb8440d31 100644 --- a/packages/medusa-react/src/hooks/admin/sales-channels/queries.ts +++ b/packages/medusa-react/src/hooks/admin/sales-channels/queries.ts @@ -17,13 +17,40 @@ export const adminSalesChannelsKeys = queryKeysFactory( type SalesChannelsQueryKeys = typeof adminSalesChannelsKeys -/** retrieve a sales channel - * @experimental This feature is under development and may change in the future. - * To use this feature please enable feature flag `sales_channels` in your medusa backend project. - * @description gets a sales channel - * @returns a medusa sales channel +/** + * This hook retrieves a sales channel's details. + * + * @example + * import React from "react" + * import { useAdminSalesChannel } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const { + * sales_channel, + * isLoading, + * } = useAdminSalesChannel(salesChannelId) + * + * return ( + *
+ * {isLoading && Loading...} + * {sales_channel && {sales_channel.name}} + *
+ * ) + * } + * + * export default SalesChannel + * + * @customNamespace Hooks.Admin.Sales Channels + * @category Queries */ export const useAdminSalesChannel = ( + /** + * The sales channel's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, @@ -41,13 +68,118 @@ export const useAdminSalesChannel = ( } /** - * retrieve a list of sales channels - * @experimental This feature is under development and may change in the future. - * To use this feature please enable feature flag `sales_channels` in your medusa backend project. - * @description Retrieve a list of sales channel - * @returns a list of sales channel as well as the pagination properties + * This hook retrieves a list of sales channels. The sales channels can be filtered by fields such as `q` or `name` + * passed in the `query` parameter. The sales channels can also be sorted or paginated. + * + * @example + * To list sales channels: + * + * ```tsx + * import React from "react" + * import { useAdminSalesChannels } from "medusa-react" + * + * const SalesChannels = () => { + * const { sales_channels, isLoading } = useAdminSalesChannels() + * + * return ( + *
+ * {isLoading && Loading...} + * {sales_channels && !sales_channels.length && ( + * No Sales Channels + * )} + * {sales_channels && sales_channels.length > 0 && ( + *
    + * {sales_channels.map((salesChannel) => ( + *
  • {salesChannel.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default SalesChannels + * ``` + * + * To specify relations that should be retrieved within the sales channels: + * + * ```tsx + * import React from "react" + * import { useAdminSalesChannels } from "medusa-react" + * + * const SalesChannels = () => { + * const { + * sales_channels, + * isLoading + * } = useAdminSalesChannels({ + * expand: "locations" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {sales_channels && !sales_channels.length && ( + * No Sales Channels + * )} + * {sales_channels && sales_channels.length > 0 && ( + *
    + * {sales_channels.map((salesChannel) => ( + *
  • {salesChannel.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default SalesChannels + * ``` + * + * By default, only the first `20` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminSalesChannels } from "medusa-react" + * + * const SalesChannels = () => { + * const { + * sales_channels, + * limit, + * offset, + * isLoading + * } = useAdminSalesChannels({ + * expand: "locations", + * limit: 10, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {sales_channels && !sales_channels.length && ( + * No Sales Channels + * )} + * {sales_channels && sales_channels.length > 0 && ( + *
    + * {sales_channels.map((salesChannel) => ( + *
  • {salesChannel.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default SalesChannels + * ``` + * + * @customNamespace Hooks.Admin.Sales Channels + * @category Queries */ export const useAdminSalesChannels = ( + /** + * Filters and pagination configurations applied on the retrieved sales channels. + */ query?: AdminGetSalesChannelsParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/shipping-options/index.ts b/packages/medusa-react/src/hooks/admin/shipping-options/index.ts index a494946b87dc5..071b28020f57e 100644 --- a/packages/medusa-react/src/hooks/admin/shipping-options/index.ts +++ b/packages/medusa-react/src/hooks/admin/shipping-options/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Shipping Option API Routes](https://docs.medusajs.com/api/admin#shipping-options). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A shipping option is used to define the available shipping methods during checkout or when creating a return. + * Admins can create an unlimited number of shipping options, each associated with a shipping profile and fulfillment provider, among other resources. + * + * Related Guide: [Shipping Option architecture](https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option). + * + * @customNamespace Hooks.Admin.Shipping Options + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts b/packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts index d79b1ee0fc728..5ff5600f13524 100644 --- a/packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/shipping-options/mutations.ts @@ -13,6 +13,50 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminShippingOptionKeys } from "./queries" +/** + * This hook creates a shipping option. + * + * @example + * import React from "react" + * import { useAdminCreateShippingOption } from "medusa-react" + * + * type CreateShippingOption = { + * name: string + * provider_id: string + * data: Record + * price_type: string + * amount: number + * } + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ regionId }: Props) => { + * const createShippingOption = useAdminCreateShippingOption() + * // ... + * + * const handleCreate = ( + * data: CreateShippingOption + * ) => { + * createShippingOption.mutate({ + * ...data, + * region_id: regionId + * }, { + * onSuccess: ({ shipping_option }) => { + * console.log(shipping_option.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Region + * + * @customNamespace Hooks.Admin.Shipping Options + * @category Mutations + */ export const useAdminCreateShippingOption = ( options?: UseMutationOptions< Response, @@ -30,7 +74,53 @@ export const useAdminCreateShippingOption = ( ) } +/** + * This hook updates a shipping option's details. + * + * @example + * import React from "react" + * import { useAdminUpdateShippingOption } from "medusa-react" + * + * type Props = { + * shippingOptionId: string + * } + * + * const ShippingOption = ({ shippingOptionId }: Props) => { + * const updateShippingOption = useAdminUpdateShippingOption( + * shippingOptionId + * ) + * // ... + * + * const handleUpdate = ( + * name: string, + * requirements: { + * id: string, + * type: string, + * amount: number + * }[] + * ) => { + * updateShippingOption.mutate({ + * name, + * requirements + * }, { + * onSuccess: ({ shipping_option }) => { + * console.log(shipping_option.requirements) + * } + * }) + * } + * + * // ... + * } + * + * export default ShippingOption + * + * @customNamespace Hooks.Admin.Shipping Options + * @category Mutations + */ export const useAdminUpdateShippingOption = ( + /** + * The shipping option's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -52,7 +142,43 @@ export const useAdminUpdateShippingOption = ( ) } +/** + * This hook deletes a shipping option. Once deleted, it can't be used when creating orders or returns. + * + * @example + * import React from "react" + * import { useAdminDeleteShippingOption } from "medusa-react" + * + * type Props = { + * shippingOptionId: string + * } + * + * const ShippingOption = ({ shippingOptionId }: Props) => { + * const deleteShippingOption = useAdminDeleteShippingOption( + * shippingOptionId + * ) + * // ... + * + * const handleDelete = () => { + * deleteShippingOption.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default ShippingOption + * + * @customNamespace Hooks.Admin.Shipping Options + * @category Mutations + */ export const useAdminDeleteShippingOption = ( + /** + * The shipping option's ID. + */ id: string, options?: UseMutationOptions ) => { diff --git a/packages/medusa-react/src/hooks/admin/shipping-options/queries.ts b/packages/medusa-react/src/hooks/admin/shipping-options/queries.ts index c62cf34a53ea3..04c1ef1fc2fbc 100644 --- a/packages/medusa-react/src/hooks/admin/shipping-options/queries.ts +++ b/packages/medusa-react/src/hooks/admin/shipping-options/queries.ts @@ -17,7 +17,46 @@ export const adminShippingOptionKeys = queryKeysFactory( type ShippingOptionQueryKeys = typeof adminShippingOptionKeys +/** + * This hook retrieves a list of shipping options. The shipping options can be filtered by fields such as `region_id` + * or `is_return` passed in the `query` parameter. + * + * @example + * import React from "react" + * import { useAdminShippingOptions } from "medusa-react" + * + * const ShippingOptions = () => { + * const { + * shipping_options, + * isLoading + * } = useAdminShippingOptions() + * + * return ( + *
+ * {isLoading && Loading...} + * {shipping_options && !shipping_options.length && ( + * No Shipping Options + * )} + * {shipping_options && shipping_options.length > 0 && ( + *
    + * {shipping_options.map((option) => ( + *
  • {option.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ShippingOptions + * + * @customNamespace Hooks.Admin.Shipping Options + * @category Queries + */ export const useAdminShippingOptions = ( + /** + * Filters to apply on the retrieved shipping options. + */ query?: AdminGetShippingOptionsParams, options?: UseQueryOptionsWrapper< Response, @@ -34,7 +73,42 @@ export const useAdminShippingOptions = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a shipping option's details. + * + * @example + * import React from "react" + * import { useAdminShippingOption } from "medusa-react" + * + * type Props = { + * shippingOptionId: string + * } + * + * const ShippingOption = ({ shippingOptionId }: Props) => { + * const { + * shipping_option, + * isLoading + * } = useAdminShippingOption( + * shippingOptionId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {shipping_option && {shipping_option.name}} + *
+ * ) + * } + * + * export default ShippingOption + * + * @customNamespace Hooks.Admin.Shipping Options + * @category Queries + */ export const useAdminShippingOption = ( + /** + * The shipping option's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/shipping-profiles/index.ts b/packages/medusa-react/src/hooks/admin/shipping-profiles/index.ts index a494946b87dc5..76f5aaf3b90ae 100644 --- a/packages/medusa-react/src/hooks/admin/shipping-profiles/index.ts +++ b/packages/medusa-react/src/hooks/admin/shipping-profiles/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Shipping Profile API Routes](https://docs.medusajs.com/api/admin#shipping-profiles). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A shipping profile is used to group products that can be shipped in the same manner. + * They are created by the admin and they're not associated with a fulfillment provider. + * + * Related Guide: [Shipping Profile architecture](https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-profile). + * + * @customNamespace Hooks.Admin.Shipping Profiles + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts b/packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts index 075de5c902b07..b441d1a185418 100644 --- a/packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/shipping-profiles/mutations.ts @@ -1,5 +1,6 @@ import { AdminDeleteShippingProfileRes, + AdminPostShippingProfilesProfileReq, AdminPostShippingProfilesReq, AdminShippingProfilesRes, } from "@medusajs/medusa" @@ -13,6 +14,40 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminShippingProfileKeys } from "./queries" +/** + * This hook creates a shipping profile. + * + * @example + * import React from "react" + * import { ShippingProfileType } from "@medusajs/medusa" + * import { useAdminCreateShippingProfile } from "medusa-react" + * + * const CreateShippingProfile = () => { + * const createShippingProfile = useAdminCreateShippingProfile() + * // ... + * + * const handleCreate = ( + * name: string, + * type: ShippingProfileType + * ) => { + * createShippingProfile.mutate({ + * name, + * type + * }, { + * onSuccess: ({ shipping_profile }) => { + * console.log(shipping_profile.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateShippingProfile + * + * @customNamespace Hooks.Admin.Shipping Profiles + * @category Mutations + */ export const useAdminCreateShippingProfile = ( options?: UseMutationOptions< Response, @@ -29,19 +64,62 @@ export const useAdminCreateShippingProfile = ( ) } +/** + * This hook updates a shipping profile's details. + * + * @example + * import React from "react" + * import { ShippingProfileType } from "@medusajs/medusa" + * import { useAdminUpdateShippingProfile } from "medusa-react" + * + * type Props = { + * shippingProfileId: string + * } + * + * const ShippingProfile = ({ shippingProfileId }: Props) => { + * const updateShippingProfile = useAdminUpdateShippingProfile( + * shippingProfileId + * ) + * // ... + * + * const handleUpdate = ( + * name: string, + * type: ShippingProfileType + * ) => { + * updateShippingProfile.mutate({ + * name, + * type + * }, { + * onSuccess: ({ shipping_profile }) => { + * console.log(shipping_profile.name) + * } + * }) + * } + * + * // ... + * } + * + * export default ShippingProfile + * + * @customNamespace Hooks.Admin.Shipping Profiles + * @category Mutations + */ export const useAdminUpdateShippingProfile = ( + /** + * The shipping profile's ID. + */ id: string, options?: UseMutationOptions< Response, Error, - AdminPostShippingProfilesReq + AdminPostShippingProfilesProfileReq > ) => { const { client } = useMedusa() const queryClient = useQueryClient() return useMutation( - (payload: AdminPostShippingProfilesReq) => + (payload: AdminPostShippingProfilesProfileReq) => client.admin.shippingProfiles.update(id, payload), buildOptions( queryClient, @@ -51,7 +129,43 @@ export const useAdminUpdateShippingProfile = ( ) } +/** + * This hook deletes a shipping profile. Associated shipping options are deleted as well. + * + * @example + * import React from "react" + * import { useAdminDeleteShippingProfile } from "medusa-react" + * + * type Props = { + * shippingProfileId: string + * } + * + * const ShippingProfile = ({ shippingProfileId }: Props) => { + * const deleteShippingProfile = useAdminDeleteShippingProfile( + * shippingProfileId + * ) + * // ... + * + * const handleDelete = () => { + * deleteShippingProfile.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default ShippingProfile + * + * @customNamespace Hooks.Admin.Shipping Profiles + * @category Mutations + */ export const useAdminDeleteShippingProfile = ( + /** + * The shipping profile's ID. + */ id: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts b/packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts index 8988426a2071d..f70f6a8742f36 100644 --- a/packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts +++ b/packages/medusa-react/src/hooks/admin/shipping-profiles/queries.ts @@ -16,6 +16,41 @@ export const adminShippingProfileKeys = queryKeysFactory( type ShippingProfileQueryKeys = typeof adminShippingProfileKeys +/** + * This hook retrieves a list of shipping profiles. + * + * @example + * import React from "react" + * import { useAdminShippingProfiles } from "medusa-react" + * + * const ShippingProfiles = () => { + * const { + * shipping_profiles, + * isLoading + * } = useAdminShippingProfiles() + * + * return ( + *
+ * {isLoading && Loading...} + * {shipping_profiles && !shipping_profiles.length && ( + * No Shipping Profiles + * )} + * {shipping_profiles && shipping_profiles.length > 0 && ( + *
    + * {shipping_profiles.map((profile) => ( + *
  • {profile.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ShippingProfiles + * + * @customNamespace Hooks.Admin.Shipping Profiles + * @category Queries + */ export const useAdminShippingProfiles = ( options?: UseQueryOptionsWrapper< Response, @@ -32,7 +67,44 @@ export const useAdminShippingProfiles = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a shipping profile's details. + * + * @example + * import React from "react" + * import { useAdminShippingProfile } from "medusa-react" + * + * type Props = { + * shippingProfileId: string + * } + * + * const ShippingProfile = ({ shippingProfileId }: Props) => { + * const { + * shipping_profile, + * isLoading + * } = useAdminShippingProfile( + * shippingProfileId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {shipping_profile && ( + * {shipping_profile.name} + * )} + *
+ * ) + * } + * + * export default ShippingProfile + * + * @customNamespace Hooks.Admin.Shipping Profiles + * @category Queries + */ export const useAdminShippingProfile = ( + /** + * The shipping option's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/stock-locations/index.ts b/packages/medusa-react/src/hooks/admin/stock-locations/index.ts index a494946b87dc5..4dd98aed56c80 100644 --- a/packages/medusa-react/src/hooks/admin/stock-locations/index.ts +++ b/packages/medusa-react/src/hooks/admin/stock-locations/index.ts @@ -1,2 +1,20 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Stock Location API Routes](https://docs.medusajs.com/api/admin#stock-locations). + * To use these hooks, make sure to install the + * [@medusajs/stock-location](https://docs.medusajs.com/modules/multiwarehouse/install-modules#stock-location-module) module in your Medusa backend. + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A stock location, provided by the [Stock Location module](https://docs.medusajs.com/modules/multiwarehouse/stock-location-module), + * indicates a physical address that stock-kept items, such as physical products, can be stored in. + * An admin can create and manage available stock locations. + * + * Related Guide: [How to manage stock locations](https://docs.medusajs.com/modules/multiwarehouse/admin/manage-stock-locations). + * + * @customNamespace Hooks.Admin.Stock Locations + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts b/packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts index c64b68274cda5..3ace5d1e9c2c2 100644 --- a/packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts @@ -1,4 +1,5 @@ import { + AdminPostStockLocationsLocationReq, AdminPostStockLocationsReq, AdminStockLocationsDeleteRes, AdminStockLocationsRes, @@ -15,6 +16,35 @@ import { adminProductKeys } from "../products" import { adminVariantKeys } from "../variants" import { adminStockLocationsKeys } from "./queries" +/** + * This hook creates a stock location. + * + * @example + * import React from "react" + * import { useAdminCreateStockLocation } from "medusa-react" + * + * const CreateStockLocation = () => { + * const createStockLocation = useAdminCreateStockLocation() + * // ... + * + * const handleCreate = (name: string) => { + * createStockLocation.mutate({ + * name, + * }, { + * onSuccess: ({ stock_location }) => { + * console.log(stock_location.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateStockLocation + * + * @customNamespace Hooks.Admin.Stock Locations + * @category Mutations + */ export const useAdminCreateStockLocation = ( options?: UseMutationOptions< Response, @@ -32,19 +62,57 @@ export const useAdminCreateStockLocation = ( ) } +/** + * This hook updates a stock location's details. + * + * @example + * import React from "react" + * import { useAdminUpdateStockLocation } from "medusa-react" + * + * type Props = { + * stockLocationId: string + * } + * + * const StockLocation = ({ stockLocationId }: Props) => { + * const updateLocation = useAdminUpdateStockLocation( + * stockLocationId + * ) + * // ... + * + * const handleUpdate = ( + * name: string + * ) => { + * updateLocation.mutate({ + * name + * }, { + * onSuccess: ({ stock_location }) => { + * console.log(stock_location.name) + * } + * }) + * } + * } + * + * export default StockLocation + * + * @customNamespace Hooks.Admin.Stock Locations + * @category Mutations + */ export const useAdminUpdateStockLocation = ( + /** + * The stock location's ID. + */ id: string, options?: UseMutationOptions< Response, Error, - AdminPostStockLocationsReq + AdminPostStockLocationsLocationReq > ) => { const { client } = useMedusa() const queryClient = useQueryClient() return useMutation( - (payload: AdminPostStockLocationsReq) => + (payload: AdminPostStockLocationsLocationReq) => client.admin.stockLocations.update(id, payload), buildOptions( queryClient, @@ -54,7 +122,41 @@ export const useAdminUpdateStockLocation = ( ) } +/** + * This hook deletes a stock location. + * + * @example + * import React from "react" + * import { useAdminDeleteStockLocation } from "medusa-react" + * + * type Props = { + * stockLocationId: string + * } + * + * const StockLocation = ({ stockLocationId }: Props) => { + * const deleteLocation = useAdminDeleteStockLocation( + * stockLocationId + * ) + * // ... + * + * const handleDelete = () => { + * deleteLocation.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * } + * + * export default StockLocation + * + * @customNamespace Hooks.Admin.Stock Locations + * @category Mutations + */ export const useAdminDeleteStockLocation = ( + /** + * The stock location's ID. + */ id: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/stock-locations/queries.ts b/packages/medusa-react/src/hooks/admin/stock-locations/queries.ts index 7b34d50603d19..a5db2582fa46e 100644 --- a/packages/medusa-react/src/hooks/admin/stock-locations/queries.ts +++ b/packages/medusa-react/src/hooks/admin/stock-locations/queries.ts @@ -17,7 +17,128 @@ export const adminStockLocationsKeys = queryKeysFactory( type StockLocationsQueryKeys = typeof adminStockLocationsKeys +/** + * This hook retrieves a list of stock locations. The stock locations can be filtered by fields such as `name` or `created_at` passed in the `query` parameter. + * The stock locations can also be sorted or paginated. + * + * @example + * To list stock locations: + * + * ```tsx + * import React from "react" + * import { useAdminStockLocations } from "medusa-react" + * + * function StockLocations() { + * const { + * stock_locations, + * isLoading + * } = useAdminStockLocations() + * + * return ( + *
+ * {isLoading && Loading...} + * {stock_locations && !stock_locations.length && ( + * No Locations + * )} + * {stock_locations && stock_locations.length > 0 && ( + *
    + * {stock_locations.map( + * (location) => ( + *
  • {location.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default StockLocations + * ``` + * + * To specify relations that should be retrieved within the stock locations: + * + * ```tsx + * import React from "react" + * import { useAdminStockLocations } from "medusa-react" + * + * function StockLocations() { + * const { + * stock_locations, + * isLoading + * } = useAdminStockLocations({ + * expand: "address" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {stock_locations && !stock_locations.length && ( + * No Locations + * )} + * {stock_locations && stock_locations.length > 0 && ( + *
    + * {stock_locations.map( + * (location) => ( + *
  • {location.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default StockLocations + * ``` + * + * By default, only the first `20` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminStockLocations } from "medusa-react" + * + * function StockLocations() { + * const { + * stock_locations, + * limit, + * offset, + * isLoading + * } = useAdminStockLocations({ + * expand: "address", + * limit: 10, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {stock_locations && !stock_locations.length && ( + * No Locations + * )} + * {stock_locations && stock_locations.length > 0 && ( + *
    + * {stock_locations.map( + * (location) => ( + *
  • {location.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default StockLocations + * ``` + * + * @customNamespace Hooks.Admin.Stock Locations + * @category Queries + */ export const useAdminStockLocations = ( + /** + * Filters and pagination configurations to apply on the retrieved stock locations. + */ query?: AdminGetStockLocationsParams, options?: UseQueryOptionsWrapper< Response, @@ -36,7 +157,42 @@ export const useAdminStockLocations = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a stock location's details. + * + * @example + * import React from "react" + * import { useAdminStockLocation } from "medusa-react" + * + * type Props = { + * stockLocationId: string + * } + * + * const StockLocation = ({ stockLocationId }: Props) => { + * const { + * stock_location, + * isLoading + * } = useAdminStockLocation(stockLocationId) + * + * return ( + *
+ * {isLoading && Loading...} + * {stock_location && ( + * {stock_location.name} + * )} + *
+ * ) + * } + * + * export default StockLocation + * + * @customNamespace Hooks.Admin.Stock Locations + * @category Queries + */ export const useAdminStockLocation = ( + /** + * The stock location's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/store/index.ts b/packages/medusa-react/src/hooks/admin/store/index.ts index a494946b87dc5..8654acfe30fa8 100644 --- a/packages/medusa-react/src/hooks/admin/store/index.ts +++ b/packages/medusa-react/src/hooks/admin/store/index.ts @@ -1,2 +1,15 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Store API Routes](https://docs.medusajs.com/api/admin#store). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A store indicates the general configurations and details about the commerce store. By default, there's only one store in the Medusa backend. + * Admins can manage the store and its details or configurations. + * + * @customNamespace Hooks.Admin.Stores + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/store/mutations.ts b/packages/medusa-react/src/hooks/admin/store/mutations.ts index b941d4bde8f6f..1f3e1db1e56bf 100644 --- a/packages/medusa-react/src/hooks/admin/store/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/store/mutations.ts @@ -9,6 +9,35 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminStoreKeys } from "./queries" +/** + * This hook updates the store's details. + * + * @example + * import React from "react" + * import { useAdminUpdateStore } from "medusa-react" + * + * function Store() { + * const updateStore = useAdminUpdateStore() + * // ... + * + * const handleUpdate = ( + * name: string + * ) => { + * updateStore.mutate({ + * name + * }, { + * onSuccess: ({ store }) => { + * console.log(store.name) + * } + * }) + * } + * } + * + * export default Store + * + * @customNamespace Hooks.Admin.Stores + * @category Mutations + */ export const useAdminUpdateStore = ( options?: UseMutationOptions< Response, @@ -25,6 +54,36 @@ export const useAdminUpdateStore = ( ) } +/** + * This hook adds a currency code to the available currencies in a store. This doesn't create new currencies, as currencies are defined within the Medusa backend. + * To create a currency, you can [create a migration](https://docs.medusajs.com/development/entities/migrations/create) that inserts the currency into the database. + * + * @typeParamDefinition string - The code of the currency to add to the store. + * + * @example + * import React from "react" + * import { useAdminAddStoreCurrency } from "medusa-react" + * + * const Store = () => { + * const addCurrency = useAdminAddStoreCurrency() + * // ... + * + * const handleAdd = (code: string) => { + * addCurrency.mutate(code, { + * onSuccess: ({ store }) => { + * console.log(store.currencies) + * } + * }) + * } + * + * // ... + * } + * + * export default Store + * + * @customNamespace Hooks.Admin.Stores + * @category Mutations + */ export const useAdminAddStoreCurrency = ( options?: UseMutationOptions, Error, string> ) => { @@ -37,6 +96,36 @@ export const useAdminAddStoreCurrency = ( ) } +/** + * This hook deletes a currency code from the available currencies in a store. This doesn't completely + * delete the currency and it can be added again later to the store. + * + * @typeParamDefinition string - The code of the currency to remove from the store. + * + * @example + * import React from "react" + * import { useAdminDeleteStoreCurrency } from "medusa-react" + * + * const Store = () => { + * const deleteCurrency = useAdminDeleteStoreCurrency() + * // ... + * + * const handleAdd = (code: string) => { + * deleteCurrency.mutate(code, { + * onSuccess: ({ store }) => { + * console.log(store.currencies) + * } + * }) + * } + * + * // ... + * } + * + * export default Store + * + * @customNamespace Hooks.Admin.Stores + * @category Mutations + */ export const useAdminDeleteStoreCurrency = ( options?: UseMutationOptions, Error, string> ) => { diff --git a/packages/medusa-react/src/hooks/admin/store/queries.ts b/packages/medusa-react/src/hooks/admin/store/queries.ts index 825e347cfe830..b07439c8f734f 100644 --- a/packages/medusa-react/src/hooks/admin/store/queries.ts +++ b/packages/medusa-react/src/hooks/admin/store/queries.ts @@ -15,6 +15,42 @@ export const adminStoreKeys = queryKeysFactory(ADMIN_STORE_QUERY_KEY) type StoreQueryKeys = typeof adminStoreKeys +/** + * This hook retrieves a list of available payment providers in a store. + * + * @example + * import React from "react" + * import { useAdminStorePaymentProviders } from "medusa-react" + * + * const PaymentProviders = () => { + * const { + * payment_providers, + * isLoading + * } = useAdminStorePaymentProviders() + * + * return ( + *
+ * {isLoading && Loading...} + * {payment_providers && !payment_providers.length && ( + * No Payment Providers + * )} + * {payment_providers && + * payment_providers.length > 0 &&( + *
    + * {payment_providers.map((provider) => ( + *
  • {provider.id}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default PaymentProviders + * + * @customNamespace Hooks.Admin.Stores + * @category Queries + */ export const useAdminStorePaymentProviders = ( options?: UseQueryOptionsWrapper< Response, @@ -31,6 +67,42 @@ export const useAdminStorePaymentProviders = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a list of available tax providers in a store. + * + * @example + * import React from "react" + * import { useAdminStoreTaxProviders } from "medusa-react" + * + * const TaxProviders = () => { + * const { + * tax_providers, + * isLoading + * } = useAdminStoreTaxProviders() + * + * return ( + *
+ * {isLoading && Loading...} + * {tax_providers && !tax_providers.length && ( + * No Tax Providers + * )} + * {tax_providers && + * tax_providers.length > 0 &&( + *
    + * {tax_providers.map((provider) => ( + *
  • {provider.id}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default TaxProviders + * + * @customNamespace Hooks.Admin.Stores + * @category Queries + */ export const useAdminStoreTaxProviders = ( options?: UseQueryOptionsWrapper< Response, @@ -47,6 +119,32 @@ export const useAdminStoreTaxProviders = ( return { ...data, ...rest } as const } +/** + * This hook retrieves the store's details. + * + * @example + * import React from "react" + * import { useAdminStore } from "medusa-react" + * + * const Store = () => { + * const { + * store, + * isLoading + * } = useAdminStore() + * + * return ( + *
+ * {isLoading && Loading...} + * {store && {store.name}} + *
+ * ) + * } + * + * export default Store + * + * @customNamespace Hooks.Admin.Stores + * @category Queries + */ export const useAdminStore = ( options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/swaps/index.ts b/packages/medusa-react/src/hooks/admin/swaps/index.ts index a494946b87dc5..0b4942db3c807 100644 --- a/packages/medusa-react/src/hooks/admin/swaps/index.ts +++ b/packages/medusa-react/src/hooks/admin/swaps/index.ts @@ -1,2 +1,17 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Swap API Routes](https://docs.medusajs.com/api/admin#swaps). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A swap is created by a customer or an admin to exchange an item with a new one. + * Creating a swap implicitely includes creating a return for the item being exchanged. + * + * Related Guide: [How to manage swaps](https://docs.medusajs.com/modules/orders/admin/manage-swaps) + * + * @customNamespace Hooks.Admin.Swaps + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/swaps/mutations.ts b/packages/medusa-react/src/hooks/admin/swaps/mutations.ts index e0a49a9c2f02c..01feca30e96ca 100644 --- a/packages/medusa-react/src/hooks/admin/swaps/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/swaps/mutations.ts @@ -15,7 +15,48 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminSwapKeys } from "./queries" +/** + * This hook creates a swap for an order. This includes creating a return that is associated with the swap. + * + * @example + * import React from "react" + * import { useAdminCreateSwap } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const CreateSwap = ({ orderId }: Props) => { + * const createSwap = useAdminCreateSwap(orderId) + * // ... + * + * const handleCreate = ( + * returnItems: { + * item_id: string, + * quantity: number + * }[] + * ) => { + * createSwap.mutate({ + * return_items: returnItems + * }, { + * onSuccess: ({ order }) => { + * console.log(order.swaps) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateSwap + * + * @customNamespace Hooks.Admin.Swaps + * @category Mutations + */ export const useAdminCreateSwap = ( + /** + * The associated order's ID. + */ orderId: string, options?: UseMutationOptions< Response, @@ -36,7 +77,49 @@ export const useAdminCreateSwap = ( ) } +/** + * This hook cancels a swap and change its status. + * + * @typeParamDefinition string - The swap's ID. + * + * @example + * import React from "react" + * import { useAdminCancelSwap } from "medusa-react" + * + * type Props = { + * orderId: string, + * swapId: string + * } + * + * const Swap = ({ + * orderId, + * swapId + * }: Props) => { + * const cancelSwap = useAdminCancelSwap( + * orderId + * ) + * // ... + * + * const handleCancel = () => { + * cancelSwap.mutate(swapId, { + * onSuccess: ({ order }) => { + * console.log(order.swaps) + * } + * }) + * } + * + * // ... + * } + * + * export default Swap + * + * @customNamespace Hooks.Admin.Swaps + * @category Mutations + */ export const useAdminCancelSwap = ( + /** + * The associated order's ID. + */ orderId: string, options?: UseMutationOptions, Error, string> ) => { @@ -53,12 +136,62 @@ export const useAdminCancelSwap = ( ) } +export type AdminFulfillSwapReq = AdminPostOrdersOrderSwapsSwapFulfillmentsReq & { + /** + * The swap's ID. + */ + swap_id: string +} + +/** + * This hook creates a Fulfillment for a Swap and change its fulfillment status to `fulfilled`. If it requires any additional actions, + * its fulfillment status may change to `requires_action`. + * + * @example + * import React from "react" + * import { useAdminFulfillSwap } from "medusa-react" + * + * type Props = { + * orderId: string, + * swapId: string + * } + * + * const Swap = ({ + * orderId, + * swapId + * }: Props) => { + * const fulfillSwap = useAdminFulfillSwap( + * orderId + * ) + * // ... + * + * const handleFulfill = () => { + * fulfillSwap.mutate({ + * swap_id: swapId, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.swaps) + * } + * }) + * } + * + * // ... + * } + * + * export default Swap + * + * @customNamespace Hooks.Admin.Swaps + * @category Mutations + */ export const useAdminFulfillSwap = ( + /** + * The associated order's ID. + */ orderId: string, options?: UseMutationOptions< Response, Error, - AdminPostOrdersOrderSwapsSwapFulfillmentsReq & { swap_id: string } + AdminFulfillSwapReq > ) => { const { client } = useMedusa() @@ -68,7 +201,7 @@ export const useAdminFulfillSwap = ( ({ swap_id, ...payload - }: AdminPostOrdersOrderSwapsSwapFulfillmentsReq & { swap_id: string }) => + }: AdminFulfillSwapReq) => client.admin.orders.fulfillSwap(orderId, swap_id, payload), buildOptions( queryClient, @@ -83,12 +216,65 @@ export const useAdminFulfillSwap = ( ) } +export type AdminCreateSwapShipmentReq = AdminPostOrdersOrderSwapsSwapShipmentsReq & { + /** + * The swap's ID. + */ + swap_id: string +} + +/** + * This hook creates 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 whether all the items were shipped. + * + * @example + * import React from "react" + * import { useAdminCreateSwapShipment } from "medusa-react" + * + * type Props = { + * orderId: string, + * swapId: string + * } + * + * const Swap = ({ + * orderId, + * swapId + * }: Props) => { + * const createShipment = useAdminCreateSwapShipment( + * orderId + * ) + * // ... + * + * const handleCreateShipment = ( + * fulfillmentId: string + * ) => { + * createShipment.mutate({ + * swap_id: swapId, + * fulfillment_id: fulfillmentId, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.swaps) + * } + * }) + * } + * + * // ... + * } + * + * export default Swap + * + * @customNamespace Hooks.Admin.Swaps + * @category Mutations + */ export const useAdminCreateSwapShipment = ( + /** + * The associated order's ID. + */ orderId: string, options?: UseMutationOptions< Response, Error, - AdminPostOrdersOrderSwapsSwapShipmentsReq & { swap_id: string } + AdminCreateSwapShipmentReq > ) => { const { client } = useMedusa() @@ -98,13 +284,56 @@ export const useAdminCreateSwapShipment = ( ({ swap_id, ...payload - }: AdminPostOrdersOrderSwapsSwapShipmentsReq & { swap_id: string }) => + }: AdminCreateSwapShipmentReq) => client.admin.orders.createSwapShipment(orderId, swap_id, payload), buildOptions(queryClient, adminOrderKeys.detail(orderId), options) ) } +/** + * This hook 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. If `difference_due` is positive, the amount is captured. + * + * @typeParamDefinition string - The swap's ID. + * + * @example + * import React from "react" + * import { useAdminProcessSwapPayment } from "medusa-react" + * + * type Props = { + * orderId: string, + * swapId: string + * } + * + * const Swap = ({ + * orderId, + * swapId + * }: Props) => { + * const processPayment = useAdminProcessSwapPayment( + * orderId + * ) + * // ... + * + * const handleProcessPayment = () => { + * processPayment.mutate(swapId, { + * onSuccess: ({ order }) => { + * console.log(order.swaps) + * } + * }) + * } + * + * // ... + * } + * + * export default Swap + * + * @customNamespace Hooks.Admin.Swaps + * @category Mutations + */ export const useAdminProcessSwapPayment = ( + /** + * The associated order's ID. + */ orderId: string, options?: UseMutationOptions, Error, string> ) => { @@ -121,7 +350,62 @@ export const useAdminProcessSwapPayment = ( ) } +/** + * The details of the swap's fulfillment to cancel. + */ +export type AdminCancelSwapFulfillmentReq = { + /** + * The swap's ID. + */ + swap_id: string + /** + * The fulfillment's ID. + */ + fulfillment_id: string +} + +/** + * This hook cancels a swap's fulfillment and change its fulfillment status to `canceled`. + * + * @example + * import React from "react" + * import { useAdminCancelSwapFulfillment } from "medusa-react" + * + * type Props = { + * orderId: string, + * swapId: string + * } + * + * const Swap = ({ + * orderId, + * swapId + * }: Props) => { + * const cancelFulfillment = useAdminCancelSwapFulfillment( + * orderId + * ) + * // ... + * + * const handleCancelFulfillment = ( + * fulfillmentId: string + * ) => { + * cancelFulfillment.mutate({ + * swap_id: swapId, + * fulfillment_id: fulfillmentId, + * }) + * } + * + * // ... + * } + * + * export default Swap + * + * @customNamespace Hooks.Admin.Swaps + * @category Mutations + */ export const useAdminCancelSwapFulfillment = ( + /** + * The associated order's ID. + */ orderId: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/swaps/queries.ts b/packages/medusa-react/src/hooks/admin/swaps/queries.ts index 9c4eb3e76a337..50c93748777bc 100644 --- a/packages/medusa-react/src/hooks/admin/swaps/queries.ts +++ b/packages/medusa-react/src/hooks/admin/swaps/queries.ts @@ -15,7 +15,79 @@ export const adminSwapKeys = queryKeysFactory(ADMIN_SWAPS_QUERY_KEY) type SwapsQueryKey = typeof adminSwapKeys +/** + * This hook retrieves a list of swaps. The swaps can be paginated. + * + * @example + * To list swaps: + * + * ```tsx + * import React from "react" + * import { useAdminSwaps } from "medusa-react" + * + * const Swaps = () => { + * const { swaps, isLoading } = useAdminSwaps() + * + * return ( + *
+ * {isLoading && Loading...} + * {swaps && !swaps.length && No Swaps} + * {swaps && swaps.length > 0 && ( + *
    + * {swaps.map((swap) => ( + *
  • {swap.payment_status}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Swaps + * ``` + * + * By default, only the first `50` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminSwaps } from "medusa-react" + * + * const Swaps = () => { + * const { + * swaps, + * limit, + * offset, + * isLoading + * } = useAdminSwaps({ + * limit: 10, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {swaps && !swaps.length && No Swaps} + * {swaps && swaps.length > 0 && ( + *
    + * {swaps.map((swap) => ( + *
  • {swap.payment_status}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Swaps + * ``` + * + * @customNamespace Hooks.Admin.Swaps + * @category Queries + */ export const useAdminSwaps = ( + /** + * Pagination configurations to apply on the retrieved swaps. + */ query?: AdminGetSwapsParams, options?: UseQueryOptionsWrapper< Response, @@ -32,7 +104,37 @@ export const useAdminSwaps = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a swap's details. + * + * @example + * import React from "react" + * import { useAdminSwap } from "medusa-react" + * + * type Props = { + * swapId: string + * } + * + * const Swap = ({ swapId }: Props) => { + * const { swap, isLoading } = useAdminSwap(swapId) + * + * return ( + *
+ * {isLoading && Loading...} + * {swap && {swap.id}} + *
+ * ) + * } + * + * export default Swap + * + * @customNamespace Hooks.Admin.Swaps + * @category Queries + */ export const useAdminSwap = ( + /** + * The swap's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/tax-rates/index.ts b/packages/medusa-react/src/hooks/admin/tax-rates/index.ts index a494946b87dc5..193ac9e48cd22 100644 --- a/packages/medusa-react/src/hooks/admin/tax-rates/index.ts +++ b/packages/medusa-react/src/hooks/admin/tax-rates/index.ts @@ -1,2 +1,16 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin Tax Rate API Routes](https://docs.medusajs.com/api/admin#tax-rates). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Each region has at least a default tax rate. Admins can create and manage additional tax rates that can be applied for certain conditions, such as for specific product types. + * + * Related Guide: [How to manage tax rates](https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates). + * + * @customNamespace Hooks.Admin.Tax Rates + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts b/packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts index 3d8c2d4f82c0d..5968aaa111aad 100644 --- a/packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/tax-rates/mutations.ts @@ -20,6 +20,46 @@ import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" import { adminTaxRateKeys } from "./queries" +/** + * This hook creates a tax rate. + * + * @example + * import React from "react" + * import { useAdminCreateTaxRate } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const CreateTaxRate = ({ regionId }: Props) => { + * const createTaxRate = useAdminCreateTaxRate() + * // ... + * + * const handleCreate = ( + * code: string, + * name: string, + * rate: number + * ) => { + * createTaxRate.mutate({ + * code, + * name, + * region_id: regionId, + * rate, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateTaxRate + * + * @customNamespace Hooks.Admin.Tax Rates + * @category Mutations + */ export const useAdminCreateTaxRate = ( options?: UseMutationOptions< Response, @@ -35,7 +75,45 @@ export const useAdminCreateTaxRate = ( ) } +/** + * This hook updates a tax rate's details. + * + * @example + * import React from "react" + * import { useAdminUpdateTaxRate } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const updateTaxRate = useAdminUpdateTaxRate(taxRateId) + * // ... + * + * const handleUpdate = ( + * name: string + * ) => { + * updateTaxRate.mutate({ + * name + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.name) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate + * + * @customNamespace Hooks.Admin.Tax Rates + * @category Mutations + */ export const useAdminUpdateTaxRate = ( + /** + * The tax rate's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -57,7 +135,41 @@ export const useAdminUpdateTaxRate = ( ) } +/** + * This hook deletes a tax rate. Resources associated with the tax rate, such as products or product types, are not deleted. + * + * @example + * import React from "react" + * import { useAdminDeleteTaxRate } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const deleteTaxRate = useAdminDeleteTaxRate(taxRateId) + * // ... + * + * const handleDelete = () => { + * deleteTaxRate.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate + * + * @customNamespace Hooks.Admin.Tax Rates + * @category Mutations + */ export const useAdminDeleteTaxRate = ( + /** + * The tax rate's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -74,7 +186,43 @@ export const useAdminDeleteTaxRate = ( ) } +/** + * This hook adds products to a tax rate. + * + * @example + * import React from "react" + * import { useAdminCreateProductTaxRates } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const addProduct = useAdminCreateProductTaxRates(taxRateId) + * // ... + * + * const handleAddProduct = (productIds: string[]) => { + * addProduct.mutate({ + * products: productIds, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.products) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate + * + * @customNamespace Hooks.Admin.Tax Rates + * @category Mutations + */ export const useAdminCreateProductTaxRates = ( + /** + * The tax rate's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -96,7 +244,43 @@ export const useAdminCreateProductTaxRates = ( ) } +/** + * This hook removes products from a tax rate. This only removes the association between the products and the tax rate. It does not delete the products. + * + * @example + * import React from "react" + * import { useAdminDeleteProductTaxRates } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const removeProduct = useAdminDeleteProductTaxRates(taxRateId) + * // ... + * + * const handleRemoveProduct = (productIds: string[]) => { + * removeProduct.mutate({ + * products: productIds, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.products) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate + * + * @customNamespace Hooks.Admin.Tax Rates + * @category Mutations + */ export const useAdminDeleteProductTaxRates = ( + /** + * The tax rate's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -118,7 +302,47 @@ export const useAdminDeleteProductTaxRates = ( ) } +/** + * This hook adds product types to a tax rate. + * + * @example + * import React from "react" + * import { + * useAdminCreateProductTypeTaxRates, + * } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const addProductTypes = useAdminCreateProductTypeTaxRates( + * taxRateId + * ) + * // ... + * + * const handleAddProductTypes = (productTypeIds: string[]) => { + * addProductTypes.mutate({ + * product_types: productTypeIds, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.product_types) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate + * + * @customNamespace Hooks.Admin.Tax Rates + * @category Mutations + */ export const useAdminCreateProductTypeTaxRates = ( + /** + * The tax rate's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -140,7 +364,50 @@ export const useAdminCreateProductTypeTaxRates = ( ) } +/** + * This hook removes product types from a tax rate. This only removes the association between the + * product types and the tax rate. It does not delete the product types. + * + * @example + * import React from "react" + * import { + * useAdminDeleteProductTypeTaxRates, + * } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const removeProductTypes = useAdminDeleteProductTypeTaxRates( + * taxRateId + * ) + * // ... + * + * const handleRemoveProductTypes = ( + * productTypeIds: string[] + * ) => { + * removeProductTypes.mutate({ + * product_types: productTypeIds, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.product_types) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate + * + * @customNamespace Hooks.Admin.Tax Rates + * @category Mutations + */ export const useAdminDeleteProductTypeTaxRates = ( + /** + * The tax rate's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -162,7 +429,47 @@ export const useAdminDeleteProductTypeTaxRates = ( ) } +/** + * This hook adds shipping options to a tax rate. + * + * @example + * import React from "react" + * import { useAdminCreateShippingTaxRates } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const addShippingOption = useAdminCreateShippingTaxRates( + * taxRateId + * ) + * // ... + * + * const handleAddShippingOptions = ( + * shippingOptionIds: string[] + * ) => { + * addShippingOption.mutate({ + * shipping_options: shippingOptionIds, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.shipping_options) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate + * + * @customNamespace Hooks.Admin.Tax Rates + * @category Mutations + */ export const useAdminCreateShippingTaxRates = ( + /** + * The tax rate's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -184,7 +491,48 @@ export const useAdminCreateShippingTaxRates = ( ) } +/** + * This hook removes shipping options from a tax rate. This only removes the association between + * the shipping options and the tax rate. It does not delete the shipping options. + * + * @example + * import React from "react" + * import { useAdminDeleteShippingTaxRates } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const removeShippingOptions = useAdminDeleteShippingTaxRates( + * taxRateId + * ) + * // ... + * + * const handleRemoveShippingOptions = ( + * shippingOptionIds: string[] + * ) => { + * removeShippingOptions.mutate({ + * shipping_options: shippingOptionIds, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.shipping_options) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate + * + * @customNamespace Hooks.Admin.Tax Rates + * @category Mutations + */ export const useAdminDeleteShippingTaxRates = ( + /** + * The tax rate's ID. + */ id: string, options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/tax-rates/queries.ts b/packages/medusa-react/src/hooks/admin/tax-rates/queries.ts index be3e451bc4dca..fdc390493e40f 100644 --- a/packages/medusa-react/src/hooks/admin/tax-rates/queries.ts +++ b/packages/medusa-react/src/hooks/admin/tax-rates/queries.ts @@ -15,7 +15,122 @@ export const adminTaxRateKeys = queryKeysFactory(ADMIN_TAX_RATES_QUERY_KEY) type TaxRateQueryKeys = typeof adminTaxRateKeys +/** + * This hook retrieves a list of tax rates. The tax rates can be filtered by fields such as `name` or `rate` + * passed in the `query` parameter. The tax rates can also be paginated. + * + * @example + * To list tax rates: + * + * ```tsx + * import React from "react" + * import { useAdminTaxRates } from "medusa-react" + * + * const TaxRates = () => { + * const { + * tax_rates, + * isLoading + * } = useAdminTaxRates() + * + * return ( + *
+ * {isLoading && Loading...} + * {tax_rates && !tax_rates.length && ( + * No Tax Rates + * )} + * {tax_rates && tax_rates.length > 0 && ( + *
    + * {tax_rates.map((tax_rate) => ( + *
  • {tax_rate.code}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default TaxRates + * ``` + * + * To specify relations that should be retrieved within the tax rates: + * + * ```tsx + * import React from "react" + * import { useAdminTaxRates } from "medusa-react" + * + * const TaxRates = () => { + * const { + * tax_rates, + * isLoading + * } = useAdminTaxRates({ + * expand: ["shipping_options"] + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {tax_rates && !tax_rates.length && ( + * No Tax Rates + * )} + * {tax_rates && tax_rates.length > 0 && ( + *
    + * {tax_rates.map((tax_rate) => ( + *
  • {tax_rate.code}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default TaxRates + * ``` + * + * By default, only the first `50` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminTaxRates } from "medusa-react" + * + * const TaxRates = () => { + * const { + * tax_rates, + * limit, + * offset, + * isLoading + * } = useAdminTaxRates({ + * expand: ["shipping_options"], + * limit: 10, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {tax_rates && !tax_rates.length && ( + * No Tax Rates + * )} + * {tax_rates && tax_rates.length > 0 && ( + *
    + * {tax_rates.map((tax_rate) => ( + *
  • {tax_rate.code}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default TaxRates + * ``` + * + * @customNamespace Hooks.Admin.Tax Rates + * @category Queries + */ export const useAdminTaxRates = ( + /** + * Filters and pagination configurations applied to the retrieved tax rates. + */ query?: AdminGetTaxRatesParams, options?: UseQueryOptionsWrapper< Response, @@ -32,8 +147,67 @@ export const useAdminTaxRates = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a tax rate's details. + * + * @example + * A simple example that retrieves a tax rate by its ID: + * + * ```tsx + * import React from "react" + * import { useAdminTaxRate } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const { tax_rate, isLoading } = useAdminTaxRate(taxRateId) + * + * return ( + *
+ * {isLoading && Loading...} + * {tax_rate && {tax_rate.code}} + *
+ * ) + * } + * + * export default TaxRate + * ``` + * + * To specify relations that should be retrieved: + * + * ```tsx + * import React from "react" + * import { useAdminTaxRate } from "medusa-react" + * + * const TaxRate = (taxRateId: string) => { + * const { tax_rate, isLoading } = useAdminTaxRate(taxRateId, { + * expand: ["shipping_options"] + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {tax_rate && {tax_rate.code}} + *
+ * ) + * } + * + * export default TaxRate + * ``` + * + * @customNamespace Hooks.Admin.Tax Rates + * @category Queries + */ export const useAdminTaxRate = ( + /** + * The tax rate's ID. + */ id: string, + /** + * Configurations to apply on retrieved tax rates. + */ query?: AdminGetTaxRatesParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/uploads/index.ts b/packages/medusa-react/src/hooks/admin/uploads/index.ts index bd086bcaef111..a80467b2fc0fe 100644 --- a/packages/medusa-react/src/hooks/admin/uploads/index.ts +++ b/packages/medusa-react/src/hooks/admin/uploads/index.ts @@ -1 +1,15 @@ +/** + * @packageDocumentation + * + * Mutations listed here are used to send requests to the [Admin Upload API Routes](https://docs.medusajs.com/api/admin#uploads). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * The methods in this class are used to upload any type of resources. For example, they can be used to upload CSV files that are used to import products into the store. + * + * Related Guide: [How to upload CSV file when importing a product](https://docs.medusajs.com/modules/products/admin/import-products#1-upload-csv-file). + * + * @customNamespace Hooks.Admin.Uploads + */ + export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/uploads/mutations.ts b/packages/medusa-react/src/hooks/admin/uploads/mutations.ts index 74da3d857dd1d..5d62c3c648a1a 100644 --- a/packages/medusa-react/src/hooks/admin/uploads/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/uploads/mutations.ts @@ -14,6 +14,33 @@ import { import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" +/** + * This hook uploads a file to a public bucket or storage. The file upload is handled by the file service installed on the Medusa backend. + * + * @example + * import React from "react" + * import { useAdminUploadFile } from "medusa-react" + * + * const UploadFile = () => { + * const uploadFile = useAdminUploadFile() + * // ... + * + * const handleFileUpload = (file: File) => { + * uploadFile.mutate(file, { + * onSuccess: ({ uploads }) => { + * console.log(uploads[0].key) + * } + * }) + * } + * + * // ... + * } + * + * export default UploadFile + * + * @customNamespace Hooks.Admin.Uploads + * @category Mutations + */ export const useAdminUploadFile = ( options?: UseMutationOptions< Response, @@ -29,6 +56,33 @@ export const useAdminUploadFile = ( }, buildOptions(queryClient, undefined, options)) } +/** + * This hook uploads a file to an ACL or a non-public bucket. The file upload is handled by the file service installed on the Medusa backend. + * + * @example + * import React from "react" + * import { useAdminUploadProtectedFile } from "medusa-react" + * + * const UploadFile = () => { + * const uploadFile = useAdminUploadProtectedFile() + * // ... + * + * const handleFileUpload = (file: File) => { + * uploadFile.mutate(file, { + * onSuccess: ({ uploads }) => { + * console.log(uploads[0].key) + * } + * }) + * } + * + * // ... + * } + * + * export default UploadFile + * + * @customNamespace Hooks.Admin.Uploads + * @category Mutations + */ export const useAdminUploadProtectedFile = ( options?: UseMutationOptions< Response, @@ -44,6 +98,35 @@ export const useAdminUploadProtectedFile = ( }, buildOptions(queryClient, undefined, options)) } +/** + * This hook creates and retrieve a presigned or public download URL for a file. The URL creation is handled by the file service installed on the Medusa backend. + * + * @example + * import React from "react" + * import { useAdminCreatePresignedDownloadUrl } from "medusa-react" + * + * const Image = () => { + * const createPresignedUrl = useAdminCreatePresignedDownloadUrl() + * // ... + * + * const handlePresignedUrl = (fileKey: string) => { + * createPresignedUrl.mutate({ + * file_key: fileKey + * }, { + * onSuccess: ({ download_url }) => { + * console.log(download_url) + * } + * }) + * } + * + * // ... + * } + * + * export default Image + * + * @customNamespace Hooks.Admin.Uploads + * @category Mutations + */ export const useAdminCreatePresignedDownloadUrl = ( options?: UseMutationOptions< Response, @@ -61,6 +144,35 @@ export const useAdminCreatePresignedDownloadUrl = ( ) } +/** + * This hook deletes an uploaded file from storage. The file is deleted using the installed file service on the Medusa backend. + * + * @example + * import React from "react" + * import { useAdminDeleteFile } from "medusa-react" + * + * const Image = () => { + * const deleteFile = useAdminDeleteFile() + * // ... + * + * const handleDeleteFile = (fileKey: string) => { + * deleteFile.mutate({ + * file_key: fileKey + * }, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Image + * + * @customNamespace Hooks.Admin.Uploads + * @category Mutations + */ export const useAdminDeleteFile = ( options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/users/index.ts b/packages/medusa-react/src/hooks/admin/users/index.ts index a494946b87dc5..21c4420b9599a 100644 --- a/packages/medusa-react/src/hooks/admin/users/index.ts +++ b/packages/medusa-react/src/hooks/admin/users/index.ts @@ -1,2 +1,16 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Admin User API Routes](https://docs.medusajs.com/api/admin#users). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * A store can have more than one user, each having the same privileges. Admins can manage users, their passwords, and more. + * + * Related Guide: [How to manage users](https://docs.medusajs.com/modules/users/admin/manage-users). + * + * @customNamespace Hooks.Admin.Users + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/admin/users/mutations.ts b/packages/medusa-react/src/hooks/admin/users/mutations.ts index d0f546d39eef8..f309cf3048893 100644 --- a/packages/medusa-react/src/hooks/admin/users/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/users/mutations.ts @@ -18,6 +18,37 @@ import { adminUserKeys } from "./queries" import { useMedusa } from "../../../contexts/medusa" import { buildOptions } from "../../utils/buildOptions" +/** + * This hook creates an admin user. The user has the same privileges as all admin users, and will be able to + * authenticate and perform admin functionalities right after creation. + * + * @example + * import React from "react" + * import { useAdminCreateUser } from "medusa-react" + * + * const CreateUser = () => { + * const createUser = useAdminCreateUser() + * // ... + * + * const handleCreateUser = () => { + * createUser.mutate({ + * email: "user@example.com", + * password: "supersecret", + * }, { + * onSuccess: ({ user }) => { + * console.log(user.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateUser + * + * @customNamespace Hooks.Admin.Users + * @category Mutations + */ export const useAdminCreateUser = ( options?: UseMutationOptions< Response, @@ -34,7 +65,45 @@ export const useAdminCreateUser = ( ) } +/** + * This hook updates an admin user's details. + * + * @example + * import React from "react" + * import { useAdminUpdateUser } from "medusa-react" + * + * type Props = { + * userId: string + * } + * + * const User = ({ userId }: Props) => { + * const updateUser = useAdminUpdateUser(userId) + * // ... + * + * const handleUpdateUser = ( + * firstName: string + * ) => { + * updateUser.mutate({ + * first_name: firstName, + * }, { + * onSuccess: ({ user }) => { + * console.log(user.first_name) + * } + * }) + * } + * + * // ... + * } + * + * export default User + * + * @customNamespace Hooks.Admin.Users + * @category Mutations + */ export const useAdminUpdateUser = ( + /** + * The user's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -55,7 +124,41 @@ export const useAdminUpdateUser = ( ) } +/** + * This hook deletes a user. Once deleted, the user will not be able to authenticate or perform admin functionalities. + * + * @example + * import React from "react" + * import { useAdminDeleteUser } from "medusa-react" + * + * type Props = { + * userId: string + * } + * + * const User = ({ userId }: Props) => { + * const deleteUser = useAdminDeleteUser(userId) + * // ... + * + * const handleDeleteUser = () => { + * deleteUser.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default User + * + * @customNamespace Hooks.Admin.Users + * @category Mutations + */ export const useAdminDeleteUser = ( + /** + * The user's ID. + */ id: string, options?: UseMutationOptions, Error, void> ) => { @@ -72,6 +175,40 @@ export const useAdminDeleteUser = ( ) } +/** + * This hook resets the password of an admin user using their reset password token. You must generate a reset password token first + * for the user using the {@link useAdminSendResetPasswordToken} hook, then use that token to reset the password in this hook. + * + * @example + * import React from "react" + * import { useAdminResetPassword } from "medusa-react" + * + * const ResetPassword = () => { + * const resetPassword = useAdminResetPassword() + * // ... + * + * const handleResetPassword = ( + * token: string, + * password: string + * ) => { + * resetPassword.mutate({ + * token, + * password, + * }, { + * onSuccess: ({ user }) => { + * console.log(user.id) + * } + * }) + * } + * + * // ... + * } + * + * export default ResetPassword + * + * @customNamespace Hooks.Admin.Users + * @category Mutations + */ export const useAdminResetPassword = ( options?: UseMutationOptions< Response, @@ -87,6 +224,39 @@ export const useAdminResetPassword = ( ) } +/** + * This hook generates a password token for an admin user with a given email. This also triggers the `user.password_reset` event. So, if you have a Notification Service installed + * that can handle this event, a notification, such as an email, will be sent to the user. The token is triggered as part of the `user.password_reset` event's payload. + * That token must be used later to reset the password using the {@link useAdminResetPassword} hook. + * + * @example + * import React from "react" + * import { useAdminSendResetPasswordToken } from "medusa-react" + * + * const Login = () => { + * const requestPasswordReset = useAdminSendResetPasswordToken() + * // ... + * + * const handleResetPassword = ( + * email: string + * ) => { + * requestPasswordReset.mutate({ + * email + * }, { + * onSuccess: () => { + * // successful + * } + * }) + * } + * + * // ... + * } + * + * export default Login + * + * @customNamespace Hooks.Admin.Users + * @category Mutations + */ export const useAdminSendResetPasswordToken = ( options?: UseMutationOptions< Response, diff --git a/packages/medusa-react/src/hooks/admin/users/queries.ts b/packages/medusa-react/src/hooks/admin/users/queries.ts index dbfe64623b9cb..f2e0e8cd8e89a 100644 --- a/packages/medusa-react/src/hooks/admin/users/queries.ts +++ b/packages/medusa-react/src/hooks/admin/users/queries.ts @@ -11,6 +11,36 @@ export const adminUserKeys = queryKeysFactory(ADMIN_USERS_QUERY_KEY) type UserQueryKeys = typeof adminUserKeys +/** + * This hook retrieves all admin users. + * + * @example + * import React from "react" + * import { useAdminUsers } from "medusa-react" + * + * const Users = () => { + * const { users, isLoading } = useAdminUsers() + * + * return ( + *
+ * {isLoading && Loading...} + * {users && !users.length && No Users} + * {users && users.length > 0 && ( + *
    + * {users.map((user) => ( + *
  • {user.email}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Users + * + * @customNamespace Hooks.Admin.Users + * @category Queries + */ export const useAdminUsers = ( options?: UseQueryOptionsWrapper< Response, @@ -27,7 +57,39 @@ export const useAdminUsers = ( return { ...data, ...rest } as const } +/** + * This hook retrieves an admin user's details. + * + * @example + * import React from "react" + * import { useAdminUser } from "medusa-react" + * + * type Props = { + * userId: string + * } + * + * const User = ({ userId }: Props) => { + * const { user, isLoading } = useAdminUser( + * userId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {user && {user.first_name} {user.last_name}} + *
+ * ) + * } + * + * export default User + * + * @customNamespace Hooks.Admin.Users + * @category Queries + */ export const useAdminUser = ( + /** + * The user's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/admin/variants/index.ts b/packages/medusa-react/src/hooks/admin/variants/index.ts index f3593df2df13b..0d96a59ec25ba 100644 --- a/packages/medusa-react/src/hooks/admin/variants/index.ts +++ b/packages/medusa-react/src/hooks/admin/variants/index.ts @@ -1 +1,15 @@ +/** + * @packageDocumentation + * + * Queries listed here are used to send requests to the [Admin Product Variant API Routes](https://docs.medusajs.com/api/admin#product-variants). + * + * All hooks listed require {@link Hooks.Admin.Auth.useAdminLogin | user authentication}. + * + * Product variants are the actual salable item in your store. Each variant is a combination of the different option values available on the product. + * + * Related Guide: [How to manage product variants](https://docs.medusajs.com/modules/products/admin/manage-products#manage-product-variants). + * + * @customNamespace Hooks.Admin.Product Variants + */ + export * from "./queries" diff --git a/packages/medusa-react/src/hooks/admin/variants/queries.ts b/packages/medusa-react/src/hooks/admin/variants/queries.ts index b0c00e1679533..b9425b5f3d0f2 100644 --- a/packages/medusa-react/src/hooks/admin/variants/queries.ts +++ b/packages/medusa-react/src/hooks/admin/variants/queries.ts @@ -17,7 +17,116 @@ export const adminVariantKeys = queryKeysFactory(ADMIN_VARIANT_QUERY_KEY) type VariantQueryKeys = typeof adminVariantKeys +/** + * This hook retrieves a list of product variants. The product variant can be filtered by fields such as `id` or `title` + * passed in the `query` parameter. The product variant can also be paginated. + * + * @example + * To list product variants: + * + * ```tsx + * import React from "react" + * import { useAdminVariants } from "medusa-react" + * + * const Variants = () => { + * const { variants, isLoading } = useAdminVariants() + * + * return ( + *
+ * {isLoading && Loading...} + * {variants && !variants.length && ( + * No Variants + * )} + * {variants && variants.length > 0 && ( + *
    + * {variants.map((variant) => ( + *
  • {variant.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Variants + * ``` + * + * To specify relations that should be retrieved within the product variants: + * + * ```tsx + * import React from "react" + * import { useAdminVariants } from "medusa-react" + * + * const Variants = () => { + * const { variants, isLoading } = useAdminVariants({ + * expand: "options" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {variants && !variants.length && ( + * No Variants + * )} + * {variants && variants.length > 0 && ( + *
    + * {variants.map((variant) => ( + *
  • {variant.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Variants + * ``` + * + * By default, only the first `100` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useAdminVariants } from "medusa-react" + * + * const Variants = () => { + * const { + * variants, + * limit, + * offset, + * isLoading + * } = useAdminVariants({ + * expand: "options", + * limit: 50, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {variants && !variants.length && ( + * No Variants + * )} + * {variants && variants.length > 0 && ( + *
    + * {variants.map((variant) => ( + *
  • {variant.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Variants + * ``` + * + * @customNamespace Hooks.Admin.Product Variants + * @category Queries + */ export const useAdminVariants = ( + /** + * Filters and pagination configurations to apply on the retrieved product variants. + */ query?: AdminGetVariantsParams, options?: UseQueryOptionsWrapper< Response, @@ -34,8 +143,75 @@ export const useAdminVariants = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a product variant's details. + * + * @example + * A simple example that retrieves a product variant by its ID: + * + * ```tsx + * import React from "react" + * import { useAdminVariant } from "medusa-react" + * + * type Props = { + * variantId: string + * } + * + * const Variant = ({ variantId }: Props) => { + * const { variant, isLoading } = useAdminVariant( + * variantId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {variant && {variant.title}} + *
+ * ) + * } + * + * export default Variant + * ``` + * + * To specify relations that should be retrieved: + * + * ```tsx + * import React from "react" + * import { useAdminVariant } from "medusa-react" + * + * type Props = { + * variantId: string + * } + * + * const Variant = ({ variantId }: Props) => { + * const { variant, isLoading } = useAdminVariant( + * variantId, { + * expand: "options" + * } + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {variant && {variant.title}} + *
+ * ) + * } + * + * export default Variant + * ``` + * + * @customNamespace Hooks.Admin.Product Variants + * @category Queries + */ export const useAdminVariant = ( + /** + * The product variant's ID. + */ id: string, + /** + * Configurations to apply on the retrieved product variant. + */ query?: AdminGetVariantParams, options?: UseQueryOptionsWrapper< Response, @@ -52,7 +228,48 @@ export const useAdminVariant = ( return { ...data, ...rest } as const } +/** + * This hook retrieves the available inventory of a product variant. + * + * @example + * import React from "react" + * import { useAdminVariantsInventory } from "medusa-react" + * + * type Props = { + * variantId: string + * } + * + * const VariantInventory = ({ variantId }: Props) => { + * const { variant, isLoading } = useAdminVariantsInventory( + * variantId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {variant && variant.inventory.length === 0 && ( + * Variant doesn't have inventory details + * )} + * {variant && variant.inventory.length > 0 && ( + *
    + * {variant.inventory.map((inventory) => ( + *
  • {inventory.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default VariantInventory + * + * @customNamespace Hooks.Admin.Product Variants + * @category Queries + */ export const useAdminVariantsInventory = ( + /** + * The product variant's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/carts/index.ts b/packages/medusa-react/src/hooks/store/carts/index.ts index a494946b87dc5..47196d64ae4c9 100644 --- a/packages/medusa-react/src/hooks/store/carts/index.ts +++ b/packages/medusa-react/src/hooks/store/carts/index.ts @@ -1,2 +1,18 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Store Cart API Routes](https://docs.medusajs.com/api/store#carts). + * + * A cart is a virtual shopping bag that customers can use to add items they want to purchase. + * A cart is then used to checkout and place an order. + * + * The hooks listed have general examples on how to use them, but it's highly recommended to use the {@link Providers.Cart.CartProvider | CartProvider} provider and + * the {@link Providers.Cart.useCart | useCart} hook to manage your cart and access the current cart across your application. + * + * Related Guide: [How to implement cart functionality in your storefront](https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart). + * + * @customNamespace Hooks.Store.Carts + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/store/carts/mutations.ts b/packages/medusa-react/src/hooks/store/carts/mutations.ts index 9d8a5f06a6ff2..94d26d53dce3f 100644 --- a/packages/medusa-react/src/hooks/store/carts/mutations.ts +++ b/packages/medusa-react/src/hooks/store/carts/mutations.ts @@ -10,6 +10,49 @@ import { import { useMutation, UseMutationOptions } from "@tanstack/react-query" import { useMedusa } from "../../../contexts/medusa" +/** + * The details of the cart to create. + */ +export type CreateCartReq = StorePostCartReq | undefined + +/** + * This hook creates a Cart. Although optional, specifying the cart's region and sales channel can affect the cart's pricing and + * the products that can be added to the cart respectively. + * + * So, make sure to set those early on and change them if necessary, such as when the customer changes their region. + * + * If a customer is logged in, make sure to pass its ID or email within the cart's details so that the cart is attached to the customer. + * + * @example + * import React from "react" + * import { useCreateCart } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Cart = ({ regionId }: Props) => { + * const createCart = useCreateCart() + * + * const handleCreate = () => { + * createCart.mutate({ + * region_id: regionId + * // creates an empty cart + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.items) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Carts + * @category Mutations + */ export const useCreateCart = ( options?: UseMutationOptions< StoreCartsRes, @@ -24,7 +67,45 @@ export const useCreateCart = ( ) } +/** + * This hook updates a Cart's details. If the cart has payment sessions and the region was not changed, + * the payment sessions are updated. The cart's totals are also recalculated. + * + * @example + * import React from "react" + * import { useUpdateCart } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const updateCart = useUpdateCart(cartId) + * + * const handleUpdate = ( + * email: string + * ) => { + * updateCart.mutate({ + * email + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.email) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Carts + * @category Mutations + */ export const useUpdateCart = ( + /** + * The cart's ID. + */ cartId: string, options?: UseMutationOptions ) => { @@ -35,7 +116,44 @@ export const useUpdateCart = ( ) } +/** + * This hook completes a cart and place an order or create a swap, based on the cart's type. This includes attempting to authorize the cart's payment. + * If authorizing the payment requires more action, the cart will not be completed and the order will not be placed or the swap will not be created. + * An idempotency key will be generated if none is provided in the header `Idempotency-Key` and added to + * the response. If an error occurs during cart completion or the request is interrupted for any reason, the cart completion can be retried by passing the idempotency + * key in the `Idempotency-Key` header. + * + * @example + * import React from "react" + * import { useCompleteCart } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const completeCart = useCompleteCart(cartId) + * + * const handleComplete = () => { + * completeCart.mutate(void 0, { + * onSuccess: ({ data, type }) => { + * console.log(data.id, type) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Carts + * @category Mutations + */ export const useCompleteCart = ( + /** + * The cart's ID. + */ cartId: string, options?: UseMutationOptions ) => { @@ -43,7 +161,41 @@ export const useCompleteCart = ( return useMutation(() => client.carts.complete(cartId), options) } +/** + * This hook creates Payment Sessions for each of the available Payment Providers in the Cart's Region. If there's only one payment session created, + * it will be selected by default. The creation of the payment session uses the payment provider and may require sending requests to third-party services. + * + * @example + * import React from "react" + * import { useCreatePaymentSession } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const createPaymentSession = useCreatePaymentSession(cartId) + * + * const handleComplete = () => { + * createPaymentSession.mutate(void 0, { + * onSuccess: ({ cart }) => { + * console.log(cart.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Carts + * @category Mutations + */ export const useCreatePaymentSession = ( + /** + * The cart's ID. + */ cartId: string, options?: UseMutationOptions ) => { @@ -51,12 +203,57 @@ export const useCreatePaymentSession = ( return useMutation(() => client.carts.createPaymentSessions(cartId), options) } +/** + * 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. + * + * @example + * import React from "react" + * import { useUpdatePaymentSession } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const updatePaymentSession = useUpdatePaymentSession(cartId) + * + * const handleUpdate = ( + * providerId: string, + * data: Record + * ) => { + * updatePaymentSession.mutate({ + * provider_id: providerId, + * data + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.payment_session) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Carts + * @category Mutations + */ export const useUpdatePaymentSession = ( + /** + * The cart's ID. + */ cartId: string, options?: UseMutationOptions< StoreCartsRes, Error, - { provider_id: string } & StorePostCartsCartPaymentSessionUpdateReq + { + /** + * The payment provider's identifier. + */ + provider_id: string + } & StorePostCartsCartPaymentSessionUpdateReq > ) => { const { client } = useMedusa() @@ -67,11 +264,54 @@ export const useUpdatePaymentSession = ( ) } -type RefreshPaymentSessionMutationData = { +/** + * The details of the payment session to refresh. + */ +export type RefreshPaymentSessionMutationData = { + /** + * The payment provider's identifier. + */ provider_id: string } +/** + * This hook refreshes a Payment Session to ensure that it is in sync with the Cart. This is usually not necessary, but is provided for edge cases. + * + * @example + * import React from "react" + * import { useRefreshPaymentSession } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const refreshPaymentSession = useRefreshPaymentSession(cartId) + * + * const handleRefresh = ( + * providerId: string + * ) => { + * refreshPaymentSession.mutate({ + * provider_id: providerId, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Carts + * @category Mutations + */ export const useRefreshPaymentSession = ( + /** + * The cart's ID. + */ cartId: string, options?: UseMutationOptions< StoreCartsRes, @@ -87,14 +327,50 @@ export const useRefreshPaymentSession = ( ) } -type SetPaymentSessionMutationData = { provider_id: string } - +/** + * This hook selects the Payment Session that will be used to complete the cart. This is typically used when the customer chooses their preferred payment method during checkout. + * The totals of the cart will be recalculated. + * + * @example + * import React from "react" + * import { useSetPaymentSession } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const setPaymentSession = useSetPaymentSession(cartId) + * + * const handleSetPaymentSession = ( + * providerId: string + * ) => { + * setPaymentSession.mutate({ + * provider_id: providerId, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.payment_session) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Carts + * @category Mutations + */ export const useSetPaymentSession = ( + /** + * The cart's ID. + */ cartId: string, options?: UseMutationOptions< StoreCartsRes, Error, - SetPaymentSessionMutationData + StorePostCartsCartPaymentSessionReq > ) => { const { client } = useMedusa() @@ -105,7 +381,44 @@ export const useSetPaymentSession = ( ) } +/** + * This hook adds a shipping method to the cart. The validation of the `data` field is handled by the fulfillment provider of the chosen shipping option. + * + * @example + * import React from "react" + * import { useAddShippingMethodToCart } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const addShippingMethod = useAddShippingMethodToCart(cartId) + * + * const handleAddShippingMethod = ( + * optionId: string + * ) => { + * addShippingMethod.mutate({ + * option_id: optionId, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.shipping_methods) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Carts + * @category Mutations + */ export const useAddShippingMethodToCart = ( + /** + * The cart's ID. + */ cartId: string, options?: UseMutationOptions< StoreCartsRes, @@ -121,11 +434,54 @@ export const useAddShippingMethodToCart = ( ) } -type DeletePaymentSessionMutationData = { +/** + * The details of the payment session to delete. + */ +export type DeletePaymentSessionMutationData = { + /** + * The payment provider's identifier. + */ provider_id: string } +/** + * This hook deletes a Payment Session in a Cart. May be useful if a payment has failed. The totals will be recalculated. + * + * @example + * import React from "react" + * import { useDeletePaymentSession } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const deletePaymentSession = useDeletePaymentSession(cartId) + * + * const handleDeletePaymentSession = ( + * providerId: string + * ) => { + * deletePaymentSession.mutate({ + * provider_id: providerId, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Carts + * @category Mutations + */ export const useDeletePaymentSession = ( + /** + * The cart's ID. + */ cartId: string, options?: UseMutationOptions< StoreCartsRes, @@ -141,6 +497,39 @@ export const useDeletePaymentSession = ( ) } +/** + * This hook allows you to create a cart and set its payment session as a preparation for checkout. + * It performs the same actions as the {@link useCreateCart} and {@link useCreatePaymentSession} hooks. + * + * @example + * import React from "react" + * import { useStartCheckout } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Checkout = ({ regionId }: Props) => { + * const startCheckout = useStartCheckout() + * + * const handleCheckout = () => { + * startCheckout.mutate({ + * region_id: regionId, + * }, { + * onSuccess: (cart) => { + * console.log(cart.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default Checkout + * + * @customNamespace Hooks.Store.Carts + * @category Mutations + */ export const useStartCheckout = ( options?: UseMutationOptions ) => { diff --git a/packages/medusa-react/src/hooks/store/carts/queries.ts b/packages/medusa-react/src/hooks/store/carts/queries.ts index 280a299cec0c3..4987b0a42a3a8 100644 --- a/packages/medusa-react/src/hooks/store/carts/queries.ts +++ b/packages/medusa-react/src/hooks/store/carts/queries.ts @@ -10,7 +10,46 @@ const CARTS_QUERY_KEY = `carts` as const export const cartKeys = queryKeysFactory(CARTS_QUERY_KEY) type CartQueryKey = typeof cartKeys +/** + * This hook retrieves a Cart's details. This includes recalculating its totals. + * + * @example + * import React from "react" + * import { useGetCart } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const { cart, isLoading } = useGetCart(cartId) + * + * return ( + *
+ * {isLoading && Loading...} + * {cart && cart.items.length === 0 && ( + * Cart is empty + * )} + * {cart && cart.items.length > 0 && ( + *
    + * {cart.items.map((item) => ( + *
  • {item.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Carts + * @category Queries + */ export const useGetCart = ( + /** + * The cart's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/collections/index.ts b/packages/medusa-react/src/hooks/store/collections/index.ts index f3593df2df13b..f552cbe037737 100644 --- a/packages/medusa-react/src/hooks/store/collections/index.ts +++ b/packages/medusa-react/src/hooks/store/collections/index.ts @@ -1 +1,12 @@ +/** + * @packageDocumentation + * + * Queries listed here are used to send requests to the [Store Product Collection API Routes](https://docs.medusajs.com/api/store#product-collections). + * + * A product collection is used to organize products for different purposes such as marketing or discount purposes. For example, you can create a Summer Collection. + * Using the methods in this class, you can list or retrieve a collection's details and products. + * + * @customNamespace Hooks.Store.Product Collections + */ + export * from "./queries" diff --git a/packages/medusa-react/src/hooks/store/collections/queries.ts b/packages/medusa-react/src/hooks/store/collections/queries.ts index aa120d497c741..4598abb6f37e8 100644 --- a/packages/medusa-react/src/hooks/store/collections/queries.ts +++ b/packages/medusa-react/src/hooks/store/collections/queries.ts @@ -15,7 +15,37 @@ export const collectionKeys = queryKeysFactory(COLLECTIONS_QUERY_KEY) type CollectionQueryKey = typeof collectionKeys +/** + * This hook retrieves a product collection's details. + * + * @example + * import React from "react" + * import { useCollection } from "medusa-react" + * + * type Props = { + * collectionId: string + * } + * + * const ProductCollection = ({ collectionId }: Props) => { + * const { collection, isLoading } = useCollection(collectionId) + * + * return ( + *
+ * {isLoading && Loading...} + * {collection && {collection.title}} + *
+ * ) + * } + * + * export default ProductCollection + * + * @customNamespace Hooks.Store.Product Collections + * @category Queries + */ export const useCollection = ( + /** + * The product collection's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, @@ -32,7 +62,84 @@ export const useCollection = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a list of product collections. The product collections can be filtered by fields such as `handle` or `created_at` passed in the `query` parameter. + * The product collections can also be paginated. + * + * @example + * To list product collections: + * + * ```tsx + * import React from "react" + * import { useCollections } from "medusa-react" + * + * const ProductCollections = () => { + * const { collections, isLoading } = useCollections() + * + * return ( + *
+ * {isLoading && Loading...} + * {collections && collections.length === 0 && ( + * No Product Collections + * )} + * {collections && collections.length > 0 && ( + *
    + * {collections.map((collection) => ( + *
  • {collection.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ProductCollections + * ``` + * + * By default, only the first `10` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useCollections } from "medusa-react" + * + * const ProductCollections = () => { + * const { + * collections, + * limit, + * offset, + * isLoading + * } = useCollections({ + * limit: 20, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {collections && collections.length === 0 && ( + * No Product Collections + * )} + * {collections && collections.length > 0 && ( + *
    + * {collections.map((collection) => ( + *
  • {collection.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ProductCollections + * ``` + * + * @customNamespace Hooks.Store.Product Collections + * @category Queries + */ export const useCollections = ( + /** + * Filters and pagination configurations to apply on the retrieved product collections. + */ query?: StoreGetCollectionsParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/customers/index.ts b/packages/medusa-react/src/hooks/store/customers/index.ts index a494946b87dc5..290d0ba1d36aa 100644 --- a/packages/medusa-react/src/hooks/store/customers/index.ts +++ b/packages/medusa-react/src/hooks/store/customers/index.ts @@ -1,2 +1,14 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Store Customer API Routes](https://docs.medusajs.com/api/store#customers_postcustomers). + * + * A customer can register and manage their information such as addresses, orders, payment methods, and more. + * + * Related Guide: [How to implement customer profiles in your storefront](https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles). + * + * @customNamespace Hooks.Store.Customers + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/store/customers/mutations.ts b/packages/medusa-react/src/hooks/store/customers/mutations.ts index d9be3b4ce0554..6db225975b035 100644 --- a/packages/medusa-react/src/hooks/store/customers/mutations.ts +++ b/packages/medusa-react/src/hooks/store/customers/mutations.ts @@ -6,6 +6,42 @@ import { import { UseMutationOptions, useMutation } from "@tanstack/react-query" import { useMedusa } from "../../../contexts/medusa" +/** + * This hook registers a new customer. This will also automatically authenticate the customer and set their login session in the response Cookie header. + * Subsequent requests sent with other hooks are sent with the Cookie session automatically. + * + * @example + * import React from "react" + * import { useCreateCustomer } from "medusa-react" + * + * const RegisterCustomer = () => { + * const createCustomer = useCreateCustomer() + * // ... + * + * const handleCreate = ( + * customerData: { + * first_name: string + * last_name: string + * email: string + * password: string + * } + * ) => { + * // ... + * createCustomer.mutate(customerData, { + * onSuccess: ({ customer }) => { + * console.log(customer.id) + * } + * }) + * } + * + * // ... + * } + * + * export default RegisterCustomer + * + * @customNamespace Hooks.Store.Customers + * @category Mutations + */ export const useCreateCustomer = ( options?: UseMutationOptions ) => { @@ -16,16 +52,60 @@ export const useCreateCustomer = ( ) } +export type UpdateMeReq = StorePostCustomersCustomerReq & { + /** + * The customer's ID. + */ + id: string +} + +/** + * This hook updates the logged-in customer's details. This hook requires [customer authentication](https://docs.medusajs.com/medusa-react/overview#customer-authentication). + * + * @example + * import React from "react" + * import { useUpdateMe } from "medusa-react" + * + * type Props = { + * customerId: string + * } + * + * const Customer = ({ customerId }: Props) => { + * const updateCustomer = useUpdateMe() + * // ... + * + * const handleUpdate = ( + * firstName: string + * ) => { + * // ... + * updateCustomer.mutate({ + * id: customerId, + * first_name: firstName, + * }, { + * onSuccess: ({ customer }) => { + * console.log(customer.first_name) + * } + * }) + * } + * + * // ... + * } + * + * export default Customer + * + * @customNamespace Hooks.Store.Customers + * @category Mutations + */ export const useUpdateMe = ( options?: UseMutationOptions< StoreCustomersRes, Error, - { id: string } & StorePostCustomersCustomerReq + UpdateMeReq > ) => { const { client } = useMedusa() return useMutation( - ({ id, ...data }: { id: string } & StorePostCustomersCustomerReq) => + ({ id, ...data }: UpdateMeReq) => client.customers.update(data), options ) diff --git a/packages/medusa-react/src/hooks/store/customers/queries.ts b/packages/medusa-react/src/hooks/store/customers/queries.ts index 774bd061c90eb..77855c37412d7 100644 --- a/packages/medusa-react/src/hooks/store/customers/queries.ts +++ b/packages/medusa-react/src/hooks/store/customers/queries.ts @@ -18,6 +18,31 @@ export const customerKeys = { type CustomerQueryKey = typeof customerKeys +/** + * This hook retrieves the logged-in customer's details. It requires [customer authentication](https://docs.medusajs.com/medusa-react/overview#customer-authentication). + * + * @example + * import React from "react" + * import { useMeCustomer } from "medusa-react" + * + * const Customer = () => { + * const { customer, isLoading } = useMeCustomer() + * + * return ( + *
+ * {isLoading && Loading...} + * {customer && ( + * {customer.first_name} {customer.last_name} + * )} + *
+ * ) + * } + * + * export default Customer + * + * @customNamespace Hooks.Store.Customers + * @category Queries + */ export const useMeCustomer = ( options?: UseQueryOptionsWrapper< Response, @@ -34,7 +59,42 @@ export const useMeCustomer = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a list of the logged-in customer's orders. The orders can be filtered by fields such as `status` or `fulfillment_status`. The orders can also be paginated. + * This hook requires [customer authentication](https://docs.medusajs.com/medusa-react/overview#customer-authentication). + * + * @example + * import React from "react" + * import { useCustomerOrders } from "medusa-react" + * + * const Orders = () => { + * // refetch a function that can be used to + * // re-retrieve orders after the customer logs in + * const { orders, isLoading } = useCustomerOrders() + * + * return ( + *
+ * {isLoading && Loading orders...} + * {orders?.length && ( + *
    + * {orders.map((order) => ( + *
  • {order.display_id}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Orders + * + * @customNamespace Hooks.Store.Customers + * @category Queries + */ export const useCustomerOrders = ( + /** + * Filters and pagination configurations to apply on the retrieved orders. + */ query: StoreGetCustomersCustomerOrdersParams = { limit: 10, offset: 0 }, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/gift-cards/index.ts b/packages/medusa-react/src/hooks/store/gift-cards/index.ts index f3593df2df13b..d1f6de74ab63e 100644 --- a/packages/medusa-react/src/hooks/store/gift-cards/index.ts +++ b/packages/medusa-react/src/hooks/store/gift-cards/index.ts @@ -1 +1,13 @@ +/** + * @packageDocumentation + * + * Queries listed here are used to send requests to the [Store Gift Card API Routes](https://docs.medusajs.com/api/store#gift-cards). + * + * Customers can use gift cards during checkout to deduct the gift card's balance from the checkout total. + * + * Related Guide: [How to use gift cards in a storefront](https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards). + * + * @customNamespace Hooks.Store.Gift Cards + */ + export * from "./queries" diff --git a/packages/medusa-react/src/hooks/store/gift-cards/queries.ts b/packages/medusa-react/src/hooks/store/gift-cards/queries.ts index 6f3b54eee5246..d59d97c57576e 100644 --- a/packages/medusa-react/src/hooks/store/gift-cards/queries.ts +++ b/packages/medusa-react/src/hooks/store/gift-cards/queries.ts @@ -11,7 +11,40 @@ export const giftCardKeys = queryKeysFactory(GIFT_CARDS_QUERY_KEY) type GiftCardQueryKey = typeof giftCardKeys +/** + * This hook retrieves a Gift Card's details by its associated unique code. + * + * @example + * import React from "react" + * import { useGiftCard } from "medusa-react" + * + * type Props = { + * giftCardCode: string + * } + * + * const GiftCard = ({ giftCardCode }: Props) => { + * const { gift_card, isLoading, isError } = useGiftCard( + * giftCardCode + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {gift_card && {gift_card.value}} + * {isError && Gift Card does not exist} + *
+ * ) + * } + * + * export default GiftCard + * + * @customNamespace Hooks.Store.Gift Cards + * @category Queries + */ export const useGiftCard = ( + /** + * The gift card's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/line-items/index.ts b/packages/medusa-react/src/hooks/store/line-items/index.ts index bd086bcaef111..6de46b4444869 100644 --- a/packages/medusa-react/src/hooks/store/line-items/index.ts +++ b/packages/medusa-react/src/hooks/store/line-items/index.ts @@ -1 +1,12 @@ +/** + * @packageDocumentation + * + * Mutations listed here are used to send requests to the Line Item API Routes part of the [Store Cart API Routes](https://docs.medusajs.com/api/store#carts). + * + * The hooks listed have general examples on how to use them, but it's highly recommended to use the {@link Providers.Cart.CartProvider | CartProvider} provider and + * the {@link Providers.Cart.useCart | useCart} hook to manage your cart and access the current cart across your application. + * + * @customNamespace Hooks.Store.Line Items + */ + export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/store/line-items/mutations.ts b/packages/medusa-react/src/hooks/store/line-items/mutations.ts index 5868065f92515..fd46985197ef8 100644 --- a/packages/medusa-react/src/hooks/store/line-items/mutations.ts +++ b/packages/medusa-react/src/hooks/store/line-items/mutations.ts @@ -6,7 +6,46 @@ import { import { useMutation, UseMutationOptions } from "@tanstack/react-query" import { useMedusa } from "../../../contexts" +/** + * This hook generates a Line Item with a given Product Variant and adds it to the Cart. + * + * @example + * import React from "react" + * import { useCreateLineItem } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const createLineItem = useCreateLineItem(cartId) + * + * const handleAddItem = ( + * variantId: string, + * quantity: number + * ) => { + * createLineItem.mutate({ + * variant_id: variantId, + * quantity, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.items) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Line Items + * @category Mutations + */ export const useCreateLineItem = ( + /** + * The cart's ID. + */ cartId: string, options?: UseMutationOptions< StoreCartsRes, @@ -22,12 +61,58 @@ export const useCreateLineItem = ( ) } +export type UpdateLineItemReq = StorePostCartsCartLineItemsItemReq & { + /** + * The line item's ID. + */ + lineId: string +} + +/** + * This hook updates a line item's data. + * + * @example + * import React from "react" + * import { useUpdateLineItem } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const updateLineItem = useUpdateLineItem(cartId) + * + * const handleUpdateItem = ( + * lineItemId: string, + * quantity: number + * ) => { + * updateLineItem.mutate({ + * lineId: lineItemId, + * quantity, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.items) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Line Items + * @category Mutations + */ export const useUpdateLineItem = ( + /** + * The cart's ID. + */ cartId: string, options?: UseMutationOptions< StoreCartsRes, Error, - StorePostCartsCartLineItemsItemReq & { lineId: string } + UpdateLineItemReq > ) => { const { client } = useMedusa() @@ -35,15 +120,57 @@ export const useUpdateLineItem = ( ({ lineId, ...data - }: StorePostCartsCartLineItemsItemReq & { lineId: string }) => + }: UpdateLineItemReq) => client.carts.lineItems.update(cartId, lineId, data), options ) } +/** + * This hook deletes a line item from a cart. The payment sessions will be updated and the totals will be recalculated. + * + * @example + * import React from "react" + * import { useDeleteLineItem } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const deleteLineItem = useDeleteLineItem(cartId) + * + * const handleDeleteItem = ( + * lineItemId: string + * ) => { + * deleteLineItem.mutate({ + * lineId: lineItemId, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.items) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart + * + * @customNamespace Hooks.Store.Line Items + * @category Mutations + */ export const useDeleteLineItem = ( + /** + * The cart's ID. + */ cartId: string, - options?: UseMutationOptions + options?: UseMutationOptions ) => { const { client } = useMedusa() return useMutation( diff --git a/packages/medusa-react/src/hooks/store/order-edits/index.ts b/packages/medusa-react/src/hooks/store/order-edits/index.ts index df00f8c2bfb48..be5d5b73aaf30 100644 --- a/packages/medusa-react/src/hooks/store/order-edits/index.ts +++ b/packages/medusa-react/src/hooks/store/order-edits/index.ts @@ -1,2 +1,15 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Store Order Edits API Routes](https://docs.medusajs.com/api/store#order-edits). + * + * Order edits are changes made to items in an order such as adding, updating their quantity, or deleting them. Order edits are created by the admin. + * A customer can review order edit requests created by an admin and confirm or decline them. + * + * Related Guide: [How to handle order edits in a storefront](https://docs.medusajs.com/modules/orders/storefront/handle-order-edits). + * + * @customNamespace Hooks.Store.Order Edits + */ + export * from "./queries" export * from './mutations' \ No newline at end of file diff --git a/packages/medusa-react/src/hooks/store/order-edits/mutations.ts b/packages/medusa-react/src/hooks/store/order-edits/mutations.ts index ae87869e7f156..90ca7d94f00f4 100644 --- a/packages/medusa-react/src/hooks/store/order-edits/mutations.ts +++ b/packages/medusa-react/src/hooks/store/order-edits/mutations.ts @@ -14,7 +14,45 @@ import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" import { orderEditQueryKeys } from "./queries" +/** + * This hook declines an Order Edit. The changes are not reflected on the original order. + * + * @example + * import React from "react" + * import { useDeclineOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const declineOrderEdit = useDeclineOrderEdit(orderEditId) + * // ... + * + * const handleDeclineOrderEdit = ( + * declinedReason: string + * ) => { + * declineOrderEdit.mutate({ + * declined_reason: declinedReason, + * }, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.declined_at) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit + * + * @customNamespace Hooks.Store.Order Edits + * @category Mutations + */ export const useDeclineOrderEdit = ( + /** + * The order edit's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -36,7 +74,44 @@ export const useDeclineOrderEdit = ( ) } +/** + * This hook completes and confirms an Order Edit and reflect its changes on the original order. Any additional payment required must + * be authorized first using the {@link Hooks.Store."Payment Collections".useAuthorizePaymentSession | useAuthorizePaymentSession} hook. + * + * @example + * import React from "react" + * import { useCompleteOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const completeOrderEdit = useCompleteOrderEdit( + * orderEditId + * ) + * // ... + * + * const handleCompleteOrderEdit = () => { + * completeOrderEdit.mutate(void 0, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.confirmed_at) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit + * + * @customNamespace Hooks.Store.Order Edits + * @category Mutations + */ export const useCompleteOrderEdit = ( + /** + * The order edit's ID. + */ id: string, options?: UseMutationOptions, Error> ) => { diff --git a/packages/medusa-react/src/hooks/store/order-edits/queries.ts b/packages/medusa-react/src/hooks/store/order-edits/queries.ts index 8860cd1e699f0..733a8275f7ae8 100644 --- a/packages/medusa-react/src/hooks/store/order-edits/queries.ts +++ b/packages/medusa-react/src/hooks/store/order-edits/queries.ts @@ -13,7 +13,43 @@ export const orderEditQueryKeys = queryKeysFactory< type OrderQueryKey = typeof orderEditQueryKeys +/** + * This hook retrieves an Order Edit's details. + * + * @example + * import React from "react" + * import { useOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const { order_edit, isLoading } = useOrderEdit(orderEditId) + * + * return ( + *
+ * {isLoading && Loading...} + * {order_edit && ( + *
    + * {order_edit.changes.map((change) => ( + *
  • {change.type}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default OrderEdit + * + * @customNamespace Hooks.Store.Order Edits + * @category Queries + */ export const useOrderEdit = ( + /** + * The order edit's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/orders/index.ts b/packages/medusa-react/src/hooks/store/orders/index.ts index a494946b87dc5..8a1b603752e34 100644 --- a/packages/medusa-react/src/hooks/store/orders/index.ts +++ b/packages/medusa-react/src/hooks/store/orders/index.ts @@ -1,2 +1,15 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Store Order API Routes](https://docs.medusajs.com/api/store#orders). + * + * Orders are purchases made by customers, typically through a storefront. + * Orders are placed and created using {@link Hooks.Store.Carts | cart} hooks. The listed hooks allow retrieving and claiming orders. + * + * Related Guide: [How to retrieve order details in a storefront](https://docs.medusajs.com/modules/orders/storefront/retrieve-order-details). + * + * @customNamespace Hooks.Store.Orders + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/store/orders/mutations.ts b/packages/medusa-react/src/hooks/store/orders/mutations.ts index 58518c8b79a44..d5d3e1f6b9777 100644 --- a/packages/medusa-react/src/hooks/store/orders/mutations.ts +++ b/packages/medusa-react/src/hooks/store/orders/mutations.ts @@ -14,6 +14,42 @@ import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" import { orderKeys } from "./queries" +/** + * This hook allows the logged-in customer to claim ownership of one or more orders. This generates a token that can be used later on to verify the claim + * using the {@link useGrantOrderAccess} hook. This also emits the event `order-update-token.created`. So, if you have a notification provider installed + * that handles this event and sends the customer a notification, such as an email, the customer should receive instructions on how to + * finalize their claim ownership. + * + * @example + * import React from "react" + * import { useRequestOrderAccess } from "medusa-react" + * + * const ClaimOrder = () => { + * const claimOrder = useRequestOrderAccess() + * + * const handleClaimOrder = ( + * orderIds: string[] + * ) => { + * claimOrder.mutate({ + * order_ids: orderIds + * }, { + * onSuccess: () => { + * // successful + * }, + * onError: () => { + * // an error occurred. + * } + * }) + * } + * + * // ... + * } + * + * export default ClaimOrder + * + * @customNamespace Hooks.Store.Orders + * @category Mutations + */ export const useRequestOrderAccess = ( options?: UseMutationOptions< Response<{}>, @@ -30,6 +66,40 @@ export const useRequestOrderAccess = ( buildOptions(queryClient, [orderKeys.all], options) ) } + +/** + * This hook verifies the claim order token provided to the customer when they request ownership of an order. + * + * @example + * import React from "react" + * import { useGrantOrderAccess } from "medusa-react" + * + * const ClaimOrder = () => { + * const confirmOrderRequest = useGrantOrderAccess() + * + * const handleOrderRequestConfirmation = ( + * token: string + * ) => { + * confirmOrderRequest.mutate({ + * token + * }, { + * onSuccess: () => { + * // successful + * }, + * onError: () => { + * // an error occurred. + * } + * }) + * } + * + * // ... + * } + * + * export default ClaimOrder + * + * @customNamespace Hooks.Store.Orders + * @category Mutations + */ export const useGrantOrderAccess = ( options?: UseMutationOptions< Response<{}>, diff --git a/packages/medusa-react/src/hooks/store/orders/queries.ts b/packages/medusa-react/src/hooks/store/orders/queries.ts index 7a2c2fab44cc3..ce8057f509d99 100644 --- a/packages/medusa-react/src/hooks/store/orders/queries.ts +++ b/packages/medusa-react/src/hooks/store/orders/queries.ts @@ -16,7 +16,41 @@ export const orderKeys = { type OrderQueryKey = typeof orderKeys +/** + * This hook retrieves an Order's details. + * + * @example + * import React from "react" + * import { useOrder } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const { + * order, + * isLoading, + * } = useOrder(orderId) + * + * return ( + *
+ * {isLoading && Loading...} + * {order && {order.display_id}} + * + *
+ * ) + * } + * + * export default Order + * + * @customNamespace Hooks.Store.Orders + * @category Queries + */ export const useOrder = ( + /** + * The order's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, @@ -34,7 +68,41 @@ export const useOrder = ( return { ...data, ...rest } as const } +/** + * This hook retrieves an order's details by the ID of the cart that was used to create the order. + * + * @example + * import React from "react" + * import { useCartOrder } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Order = ({ cartId }: Props) => { + * const { + * order, + * isLoading, + * } = useCartOrder(cartId) + * + * return ( + *
+ * {isLoading && Loading...} + * {order && {order.display_id}} + * + *
+ * ) + * } + * + * export default Order + * + * @customNamespace Hooks.Store.Orders + * @category Queries + */ export const useCartOrder = ( + /** + * The cart's ID. + */ cartId: string, options?: UseQueryOptionsWrapper< Response, @@ -52,7 +120,48 @@ export const useCartOrder = ( return { ...data, ...rest } as const } +/** + * This hook looks up an order using filters. If the filters don't narrow down the results to a single order, a `404` response is returned with no orders. + * + * @example + * import React from "react" + * import { useOrders } from "medusa-react" + * + * type Props = { + * displayId: number + * email: string + * } + * + * const Order = ({ + * displayId, + * email + * }: Props) => { + * const { + * order, + * isLoading, + * } = useOrders({ + * display_id: displayId, + * email, + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {order && {order.display_id}} + * + *
+ * ) + * } + * + * export default Order + * + * @customNamespace Hooks.Store.Orders + * @category Queries + */ export const useOrders = ( + /** + * Filters used to retrieve the order. + */ query: StoreGetOrdersParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/payment-collections/index.ts b/packages/medusa-react/src/hooks/store/payment-collections/index.ts index a494946b87dc5..b9fdf95d87e97 100644 --- a/packages/medusa-react/src/hooks/store/payment-collections/index.ts +++ b/packages/medusa-react/src/hooks/store/payment-collections/index.ts @@ -1,2 +1,12 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Store Payment Collection API Routes](https://docs.medusajs.com/api/store#payment-collections). + * + * A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments. + * + * @customNamespace Hooks.Store.Payment Collections + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/store/payment-collections/mutations.ts b/packages/medusa-react/src/hooks/store/payment-collections/mutations.ts index decd273ca3fda..bfc059a2fa2f5 100644 --- a/packages/medusa-react/src/hooks/store/payment-collections/mutations.ts +++ b/packages/medusa-react/src/hooks/store/payment-collections/mutations.ts @@ -17,7 +17,100 @@ import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" import { paymentCollectionQueryKeys } from "./queries" +/** + * This hook creates, updates, or deletes a list of payment sessions of a Payment Collections. If a payment session is not provided in the `sessions` array, it's deleted. + * + * @example + * To add two new payment sessions: + * + * ```tsx + * import React from "react" + * import { useManageMultiplePaymentSessions } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const managePaymentSessions = useManageMultiplePaymentSessions( + * paymentCollectionId + * ) + * + * const handleManagePaymentSessions = () => { + * managePaymentSessions.mutate({ + * // Total amount = 10000 + * sessions: [ + * { + * provider_id: "stripe", + * amount: 5000, + * }, + * { + * provider_id: "manual", + * amount: 5000, + * }, + * ] + * }, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection + * ``` + * + * To update a payment session and another one by not including it in the payload: + * + * ```tsx + * import React from "react" + * import { useManageMultiplePaymentSessions } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const managePaymentSessions = useManageMultiplePaymentSessions( + * paymentCollectionId + * ) + * + * const handleManagePaymentSessions = () => { + * managePaymentSessions.mutate({ + * // Total amount = 10000 + * sessions: [ + * { + * provider_id: "stripe", + * amount: 10000, + * session_id: "ps_123456" + * }, + * ] + * }, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection + * ``` + * + * @customNamespace Hooks.Store.Payment Collections + * @category Mutations + */ export const useManageMultiplePaymentSessions = ( + /** + * The payment collection's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -42,7 +135,48 @@ export const useManageMultiplePaymentSessions = ( ) } +/** + * This hook creates a Payment Session for a payment provider in a Payment Collection. + * + * @example + * import React from "react" + * import { useManagePaymentSession } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const managePaymentSession = useManagePaymentSession( + * paymentCollectionId + * ) + * + * const handleManagePaymentSession = ( + * providerId: string + * ) => { + * managePaymentSession.mutate({ + * provider_id: providerId + * }, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection + * + * @customNamespace Hooks.Store.Payment Collections + * @category Mutations + */ export const useManagePaymentSession = ( + /** + * The payment collection's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -67,11 +201,54 @@ export const useManagePaymentSession = ( ) } +/** + * This hook authorizes a Payment Session of a Payment Collection. + * + * @typeParamDefinition string - The payment session's ID. + * + * @example + * import React from "react" + * import { useAuthorizePaymentSession } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const authorizePaymentSession = useAuthorizePaymentSession( + * paymentCollectionId + * ) + * // ... + * + * const handleAuthorizePayment = (paymentSessionId: string) => { + * authorizePaymentSession.mutate(paymentSessionId, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection + * + * @customNamespace Hooks.Store.Payment Collections + * @category Mutations + */ export const useAuthorizePaymentSession = ( + /** + * The payment collection's ID. + */ id: string, options?: UseMutationOptions< Response, Error, + /** + * The payment session's ID. + */ string > ) => { @@ -92,7 +269,47 @@ export const useAuthorizePaymentSession = ( ) } +/** + * This hook authorize the Payment Sessions of a Payment Collection. + * + * @example + * import React from "react" + * import { useAuthorizePaymentSessionsBatch } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const authorizePaymentSessions = useAuthorizePaymentSessionsBatch( + * paymentCollectionId + * ) + * // ... + * + * const handleAuthorizePayments = (paymentSessionIds: string[]) => { + * authorizePaymentSessions.mutate({ + * session_ids: paymentSessionIds + * }, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection + * + * @customNamespace Hooks.Store.Payment Collections + * @category Mutations + */ export const useAuthorizePaymentSessionsBatch = ( + /** + * The payment collection's ID. + */ id: string, options?: UseMutationOptions< Response, @@ -117,11 +334,54 @@ export const useAuthorizePaymentSessionsBatch = ( ) } +/** + * This hook refreshes a Payment Session's data to ensure that it is in sync with the Payment Collection. + * + * @typeParamDefinition string - The payment session's ID. + * + * @example + * import React from "react" + * import { usePaymentCollectionRefreshPaymentSession } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const refreshPaymentSession = usePaymentCollectionRefreshPaymentSession( + * paymentCollectionId + * ) + * // ... + * + * const handleRefreshPaymentSession = (paymentSessionId: string) => { + * refreshPaymentSession.mutate(paymentSessionId, { + * onSuccess: ({ payment_session }) => { + * console.log(payment_session.status) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection + * + * @customNamespace Hooks.Store.Payment Collections + * @category Mutations + */ export const usePaymentCollectionRefreshPaymentSession = ( + /** + * The payment collection's ID. + */ id: string, options?: UseMutationOptions< Response, Error, + /** + * The payment session's ID. + */ string > ) => { diff --git a/packages/medusa-react/src/hooks/store/payment-collections/queries.ts b/packages/medusa-react/src/hooks/store/payment-collections/queries.ts index 97173068499d7..64bd2e3e384cd 100644 --- a/packages/medusa-react/src/hooks/store/payment-collections/queries.ts +++ b/packages/medusa-react/src/hooks/store/payment-collections/queries.ts @@ -13,7 +13,46 @@ export const paymentCollectionQueryKeys = queryKeysFactory< type PaymentCollectionKey = typeof paymentCollectionQueryKeys +/** + * This hook retrieves a Payment Collection's details. + * + * @example + * import React from "react" + * import { usePaymentCollection } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const { + * payment_collection, + * isLoading + * } = usePaymentCollection( + * paymentCollectionId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {payment_collection && ( + * {payment_collection.status} + * )} + *
+ * ) + * } + * + * export default PaymentCollection + * + * @customNamespace Hooks.Store.Payment Collections + * @category Queries + */ export const usePaymentCollection = ( + /** + * The payment collection's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/product-categories/index.ts b/packages/medusa-react/src/hooks/store/product-categories/index.ts index f3593df2df13b..63e101bbd829e 100644 --- a/packages/medusa-react/src/hooks/store/product-categories/index.ts +++ b/packages/medusa-react/src/hooks/store/product-categories/index.ts @@ -1 +1,15 @@ +/** + * @packageDocumentation + * + * Queries listed here are used to send requests to the [Store Product Category API Routes](https://docs.medusajs.com/api/store#product-categories_getproductcategories). + * + * Products can be categoriezed into categories. A product can be associated more than one category. + * + * Related Guide: [How to use product categories in a storefront](https://docs.medusajs.com/modules/products/storefront/use-categories). + * + * @featureFlag product_categories + * + * @customNamespace Hooks.Store.Product Categories + */ + export * from "./queries" diff --git a/packages/medusa-react/src/hooks/store/product-categories/queries.ts b/packages/medusa-react/src/hooks/store/product-categories/queries.ts index 26339dbbc6c45..6e8a062467584 100644 --- a/packages/medusa-react/src/hooks/store/product-categories/queries.ts +++ b/packages/medusa-react/src/hooks/store/product-categories/queries.ts @@ -17,7 +17,171 @@ export const storeProductCategoryKeys = queryKeysFactory( ) type ProductCategoryQueryKeys = typeof storeProductCategoryKeys +/** + * This hook retrieves a list of product categories. The product categories can be filtered by fields such as `handle` or `q` passed in the `query` parameter. + * The product categories can also be paginated. This hook can also be used to retrieve a product category by its handle. + * + * @example + * To list product categories: + * + * ```tsx + * import React from "react" + * import { useProductCategories } from "medusa-react" + * + * function Categories() { + * const { + * product_categories, + * isLoading, + * } = useProductCategories() + * + * return ( + *
+ * {isLoading && Loading...} + * {product_categories && !product_categories.length && ( + * No Categories + * )} + * {product_categories && product_categories.length > 0 && ( + *
    + * {product_categories.map( + * (category) => ( + *
  • {category.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Categories + * ``` + * + * To retrieve a product category by its handle: + * + * ```tsx + * import React from "react" + * import { useProductCategories } from "medusa-react" + * + * function Categories( + * handle: string + * ) { + * const { + * product_categories, + * isLoading, + * } = useProductCategories({ + * handle + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_categories && !product_categories.length && ( + * No Categories + * )} + * {product_categories && product_categories.length > 0 && ( + *
    + * {product_categories.map( + * (category) => ( + *
  • {category.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Categories + * ``` + * + * To specify relations that should be retrieved within the product categories: + * + * ```tsx + * import React from "react" + * import { useProductCategories } from "medusa-react" + * + * function Categories( + * handle: string + * ) { + * const { + * product_categories, + * isLoading, + * } = useProductCategories({ + * handle, + * expand: "products" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_categories && !product_categories.length && ( + * No Categories + * )} + * {product_categories && product_categories.length > 0 && ( + *
    + * {product_categories.map( + * (category) => ( + *
  • {category.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Categories + * ``` + * + * By default, only the first `100` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import { useProductCategories } from "medusa-react" + * + * function Categories( + * handle: string + * ) { + * const { + * product_categories, + * limit, + * offset, + * isLoading, + * } = useProductCategories({ + * handle, + * expand: "products", + * limit: 50, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_categories && !product_categories.length && ( + * No Categories + * )} + * {product_categories && product_categories.length > 0 && ( + *
    + * {product_categories.map( + * (category) => ( + *
  • {category.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Categories + * ``` + * + * @customNamespace Hooks.Store.Product Categories + * @category Queries + */ export const useProductCategories = ( + /** + * Filters and pagination configurations to apply on the retrieved product categories. + */ query?: StoreGetProductCategoriesParams, options?: UseQueryOptionsWrapper< Response, @@ -34,8 +198,76 @@ export const useProductCategories = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a Product Category's details. + * + * @example + * A simple example that retrieves a product category by its ID: + * + * ```tsx + * import React from "react" + * import { useProductCategory } from "medusa-react" + * + * type Props = { + * categoryId: string + * } + * + * const Category = ({ categoryId }: Props) => { + * const { product_category, isLoading } = useProductCategory( + * categoryId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_category && {product_category.name}} + *
+ * ) + * } + * + * export default Category + * ``` + * + * To specify relations that should be retrieved: + * + * ```tsx + * import React from "react" + * import { useProductCategory } from "medusa-react" + * + * type Props = { + * categoryId: string + * } + * + * const Category = ({ categoryId }: Props) => { + * const { product_category, isLoading } = useProductCategory( + * categoryId, + * { + * expand: "products" + * } + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_category && {product_category.name}} + *
+ * ) + * } + * + * export default Category + * ``` + * + * @customNamespace Hooks.Store.Product Categories + * @category Queries + */ export const useProductCategory = ( + /** + * The product category's ID. + */ id: string, + /** + * Configurations to apply on the retrieved product categories. + */ query?: StoreGetProductCategoriesCategoryParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/product-tags/index.ts b/packages/medusa-react/src/hooks/store/product-tags/index.ts index f3593df2df13b..54c03683a3401 100644 --- a/packages/medusa-react/src/hooks/store/product-tags/index.ts +++ b/packages/medusa-react/src/hooks/store/product-tags/index.ts @@ -1 +1,12 @@ +/** + * @packageDocumentation + * + * Queries listed here are used to send requests to the [Store Product Tag API Routes](https://docs.medusajs.com/api/store#product-tags). + * + * Product tags are string values that can be used to filter products by. + * Products can have more than one tag, and products can share tags. + * + * @customNamespace Hooks.Store.Product Tags + */ + export * from "./queries" diff --git a/packages/medusa-react/src/hooks/store/product-tags/queries.ts b/packages/medusa-react/src/hooks/store/product-tags/queries.ts index d594b2a1be1f8..894f4595996bc 100644 --- a/packages/medusa-react/src/hooks/store/product-tags/queries.ts +++ b/packages/medusa-react/src/hooks/store/product-tags/queries.ts @@ -14,7 +14,91 @@ export const productTagKeys = queryKeysFactory(PRODUCT_TAGS_QUERY_KEY) type ProductTypesQueryKeys = typeof productTagKeys +/** + * This hook retrieves a list of product tags. The product tags can be filtered by fields such as `id` or `q` + * passed in the `query` parameter. The product tags can also be sorted or paginated. + * + * @example + * To list product tags: + * + * ```tsx + * import React from "react" + * import { useProductTags } from "medusa-react" + * + * function Tags() { + * const { + * product_tags, + * isLoading, + * } = useProductTags() + * + * return ( + *
+ * {isLoading && Loading...} + * {product_tags && !product_tags.length && ( + * No Product Tags + * )} + * {product_tags && product_tags.length > 0 && ( + *
    + * {product_tags.map( + * (tag) => ( + *
  • {tag.value}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Tags + * ``` + * + * By default, only the first `20` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useProductTags } from "medusa-react" + * + * function Tags() { + * const { + * product_tags, + * limit, + * offset, + * isLoading, + * } = useProductTags({ + * limit: 10, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_tags && !product_tags.length && ( + * No Product Tags + * )} + * {product_tags && product_tags.length > 0 && ( + *
    + * {product_tags.map( + * (tag) => ( + *
  • {tag.value}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Tags + * ``` + * + * @customNamespace Hooks.Store.Product Tags + * @category Queries + */ export const useProductTags = ( + /** + * Filters and pagination configurations to apply on the retrieved product tags. + */ query?: StoreGetProductTagsParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/product-types/index.ts b/packages/medusa-react/src/hooks/store/product-types/index.ts index f3593df2df13b..d2bd45d332b1e 100644 --- a/packages/medusa-react/src/hooks/store/product-types/index.ts +++ b/packages/medusa-react/src/hooks/store/product-types/index.ts @@ -1 +1,12 @@ +/** + * @packageDocumentation + * + * Queries listed here are used to send requests to the [Store Product Type API Routes](https://docs.medusajs.com/api/store#product-types). + * + * Product types are string values that can be used to filter products by. + * Products can have more than one tag, and products can share types. + * + * @customNamespace Hooks.Store.Product Types + */ + export * from "./queries" diff --git a/packages/medusa-react/src/hooks/store/product-types/queries.ts b/packages/medusa-react/src/hooks/store/product-types/queries.ts index fd0dea41dbba0..e0e47c26b8372 100644 --- a/packages/medusa-react/src/hooks/store/product-types/queries.ts +++ b/packages/medusa-react/src/hooks/store/product-types/queries.ts @@ -14,7 +14,91 @@ export const productTypeKeys = queryKeysFactory(PRODUCT_TYPES_QUERY_KEY) type ProductTypesQueryKeys = typeof productTypeKeys +/** + * This hook retrieves a list of product types. The product types can be filtered by fields such as `value` or `q` passed + * in the `query` parameter. The product types can also be sorted or paginated. + * + * @example + * To list product types: + * + * ```tsx + * import React from "react" + * import { useProductTypes } from "medusa-react" + * + * function Types() { + * const { + * product_types, + * isLoading, + * } = useProductTypes() + * + * return ( + *
+ * {isLoading && Loading...} + * {product_types && !product_types.length && ( + * No Product Types + * )} + * {product_types && product_types.length > 0 && ( + *
    + * {product_types.map( + * (type) => ( + *
  • {type.value}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Types + * ``` + * + * By default, only the first `20` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useProductTypes } from "medusa-react" + * + * function Types() { + * const { + * product_types, + * limit, + * offset, + * isLoading, + * } = useProductTypes({ + * limit: 10, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_types && !product_types.length && ( + * No Product Types + * )} + * {product_types && product_types.length > 0 && ( + *
    + * {product_types.map( + * (type) => ( + *
  • {type.value}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Types + * ``` + * + * @customNamespace Hooks.Store.Product Types + * @category Queries + */ export const useProductTypes = ( + /** + * Filters and pagination configurations to apply on retrieved product types. + */ query?: StoreGetProductTypesParams, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/products/index.ts b/packages/medusa-react/src/hooks/store/products/index.ts index f3593df2df13b..e65d230b98cb1 100644 --- a/packages/medusa-react/src/hooks/store/products/index.ts +++ b/packages/medusa-react/src/hooks/store/products/index.ts @@ -1 +1,14 @@ +/** + * @packageDocumentation + * + * Queries listed here are used to send requests to the [Store Product API Routes](https://docs.medusajs.com/api/store#products). + * + * Products are saleable items in a store. This also includes [saleable gift cards](https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards) in a store. + * Using the methods in this class, you can filter products by categories, collections, sales channels, and more. + * + * Related Guide: [How to show products in a storefront](https://docs.medusajs.com/modules/products/storefront/show-products). + * + * @customNamespace Hooks.Store.Products + */ + export * from "./queries" diff --git a/packages/medusa-react/src/hooks/store/products/queries.ts b/packages/medusa-react/src/hooks/store/products/queries.ts index 5f8c3edf23b54..08b07b9ddd9bd 100644 --- a/packages/medusa-react/src/hooks/store/products/queries.ts +++ b/packages/medusa-react/src/hooks/store/products/queries.ts @@ -17,7 +17,116 @@ export const productKeys = queryKeysFactory< >(PRODUCTS_QUERY_KEY) type ProductQueryKey = typeof productKeys +/** + * This hook retrieves a list of products. The products can be filtered by fields such as `id` or `q` passed in the `query` parameter. The products can also be sorted or paginated. + * This hook can also be used to retrieve a product by its handle. + * + * For accurate and correct pricing of the products based on the customer's context, it's highly recommended to pass fields such as + * `region_id`, `currency_code`, and `cart_id` when available. + * + * Passing `sales_channel_id` ensures retrieving only products available in the specified sales channel. + * You can alternatively use a publishable API key in the request header instead of passing a `sales_channel_id`. + * + * @example + * To list products: + * + * ```tsx + * import React from "react" + * import { useProducts } from "medusa-react" + * + * const Products = () => { + * const { products, isLoading } = useProducts() + * + * return ( + *
+ * {isLoading && Loading...} + * {products && !products.length && No Products} + * {products && products.length > 0 && ( + *
    + * {products.map((product) => ( + *
  • {product.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Products + * ``` + * + * To specify relations that should be retrieved within the products: + * + * ```tsx + * import React from "react" + * import { useProducts } from "medusa-react" + * + * const Products = () => { + * const { products, isLoading } = useProducts({ + * expand: "variants" + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {products && !products.length && No Products} + * {products && products.length > 0 && ( + *
    + * {products.map((product) => ( + *
  • {product.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Products + * ``` + * + * By default, only the first `100` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties: + * + * ```tsx + * import React from "react" + * import { useProducts } from "medusa-react" + * + * const Products = () => { + * const { + * products, + * limit, + * offset, + * isLoading + * } = useProducts({ + * expand: "variants", + * limit: 50, + * offset: 0 + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {products && !products.length && No Products} + * {products && products.length > 0 && ( + *
    + * {products.map((product) => ( + *
  • {product.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Products + * ``` + * + * @customNamespace Hooks.Store.Products + * @category Queries + */ export const useProducts = ( + /** + * Filters and pagination configurations to apply on the retrieved products. + */ query?: StoreGetProductsParams, options?: UseQueryOptionsWrapper< Response, @@ -34,7 +143,41 @@ export const useProducts = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a Product's details. For accurate and correct pricing of the product based on the customer's context, it's highly recommended to pass fields such as + * `region_id`, `currency_code`, and `cart_id` when available. + * + * Passing `sales_channel_id` ensures retrieving only products available in the current sales channel. + * You can alternatively use a publishable API key in the request header instead of passing a `sales_channel_id`. + * + * @example + * import React from "react" + * import { useProduct } from "medusa-react" + * + * type Props = { + * productId: string + * } + * + * const Product = ({ productId }: Props) => { + * const { product, isLoading } = useProduct(productId) + * + * return ( + *
+ * {isLoading && Loading...} + * {product && {product.title}} + *
+ * ) + * } + * + * export default Product + * + * @customNamespace Hooks.Store.Products + * @category Queries + */ export const useProduct = ( + /** + * The product's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/regions/index.ts b/packages/medusa-react/src/hooks/store/regions/index.ts index f3593df2df13b..339bc901a8bcf 100644 --- a/packages/medusa-react/src/hooks/store/regions/index.ts +++ b/packages/medusa-react/src/hooks/store/regions/index.ts @@ -1 +1,14 @@ +/** + * @packageDocumentation + * + * Queries listed here are used to send requests to the [Store Region API Routes](https://docs.medusajs.com/api/store#regions_getregions). + * + * Regions are different countries or geographical regions that the commerce store serves customers in. + * Customers can choose what region they're in, which can be used to change the prices shown based on the region and its currency. + * + * Related Guide: [How to use regions in a storefront](https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions). + * + * @customNamespace Hooks.Store.Regions + */ + export * from "./queries" diff --git a/packages/medusa-react/src/hooks/store/regions/queries.ts b/packages/medusa-react/src/hooks/store/regions/queries.ts index 985ce4ac41f77..95c9a200835c4 100644 --- a/packages/medusa-react/src/hooks/store/regions/queries.ts +++ b/packages/medusa-react/src/hooks/store/regions/queries.ts @@ -11,6 +11,37 @@ const regionsKey = queryKeysFactory(REGIONS_QUERY_KEY) type RegionQueryType = typeof regionsKey +/** + * This hook retrieves a list of regions. This hook is useful to show the customer all available regions to choose from. + * + * @example + * import React from "react" + * import { useRegions } from "medusa-react" + * + * const Regions = () => { + * const { regions, isLoading } = useRegions() + * + * return ( + *
+ * {isLoading && Loading...} + * {regions?.length && ( + *
    + * {regions.map((region) => ( + *
  • + * {region.name} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Regions + * + * @customNamespace Hooks.Store.Regions + * @category Queries + */ export const useRegions = ( options?: UseQueryOptionsWrapper< Response, @@ -27,7 +58,39 @@ export const useRegions = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a Region's details. + * + * @example + * import React from "react" + * import { useRegion } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ regionId }: Props) => { + * const { region, isLoading } = useRegion( + * regionId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {region && {region.name}} + *
+ * ) + * } + * + * export default Region + * + * @customNamespace Hooks.Store.Regions + * @category Queries + */ export const useRegion = ( + /** + * The region's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/return-reasons/index.ts b/packages/medusa-react/src/hooks/store/return-reasons/index.ts index f3593df2df13b..27af68eaedf03 100644 --- a/packages/medusa-react/src/hooks/store/return-reasons/index.ts +++ b/packages/medusa-react/src/hooks/store/return-reasons/index.ts @@ -1 +1,11 @@ +/** + * @packageDocumentation + * + * Queries listed here are used to send requests to the [Store Return Reason API Routes](https://docs.medusajs.com/api/store#return-reasons). + * + * Return reasons are key-value pairs that are used to specify why an order return is being created. + * + * @customNamespace Hooks.Store.Return Reasons + */ + export * from "./queries" diff --git a/packages/medusa-react/src/hooks/store/return-reasons/queries.ts b/packages/medusa-react/src/hooks/store/return-reasons/queries.ts index 3debd1a509bad..6717fb161f5a9 100644 --- a/packages/medusa-react/src/hooks/store/return-reasons/queries.ts +++ b/packages/medusa-react/src/hooks/store/return-reasons/queries.ts @@ -14,6 +14,40 @@ const returnReasonsKey = queryKeysFactory(RETURNS_REASONS_QUERY_KEY) type ReturnReasonsQueryKey = typeof returnReasonsKey +/** + * This hook retrieves a list of Return Reasons. This is useful when implementing a Create Return flow in the storefront. + * + * @example + * import React from "react" + * import { useReturnReasons } from "medusa-react" + * + * const ReturnReasons = () => { + * const { + * return_reasons, + * isLoading + * } = useReturnReasons() + * + * return ( + *
+ * {isLoading && Loading...} + * {return_reasons?.length && ( + *
    + * {return_reasons.map((returnReason) => ( + *
  • + * {returnReason.label} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ReturnReasons + * + * @customNamespace Hooks.Store.Return Reasons + * @category Queries + */ export const useReturnReasons = ( options?: UseQueryOptionsWrapper< Response, @@ -30,7 +64,42 @@ export const useReturnReasons = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a Return Reason's details. + * + * @example + * import React from "react" + * import { useReturnReason } from "medusa-react" + * + * type Props = { + * returnReasonId: string + * } + * + * const ReturnReason = ({ returnReasonId }: Props) => { + * const { + * return_reason, + * isLoading + * } = useReturnReason( + * returnReasonId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {return_reason && {return_reason.label}} + *
+ * ) + * } + * + * export default ReturnReason + * + * @customNamespace Hooks.Store.Return Reasons + * @category Queries + */ export const useReturnReason = ( + /** + * The return reason's ID. + */ id: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/returns/index.ts b/packages/medusa-react/src/hooks/store/returns/index.ts index bd086bcaef111..df86405a19cfa 100644 --- a/packages/medusa-react/src/hooks/store/returns/index.ts +++ b/packages/medusa-react/src/hooks/store/returns/index.ts @@ -1 +1,13 @@ +/** + * @packageDocumentation + * + * Mutations listed here are used to send requests to the [Store Return API Routes](https://docs.medusajs.com/api/store#returns). + * + * A return can be created by a customer to return items in an order. + * + * Related Guide: [How to create a return in a storefront](https://docs.medusajs.com/modules/orders/storefront/create-return). + * + * @customNamespace Hooks.Store.Returns + */ + export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/store/returns/mutations.ts b/packages/medusa-react/src/hooks/store/returns/mutations.ts index e23c85d12fe31..84bf798d1bc1a 100644 --- a/packages/medusa-react/src/hooks/store/returns/mutations.ts +++ b/packages/medusa-react/src/hooks/store/returns/mutations.ts @@ -2,6 +2,50 @@ import { StorePostReturnsReq, StoreReturnsRes } from "@medusajs/medusa" import { useMutation, UseMutationOptions } from "@tanstack/react-query" import { useMedusa } from "../../../contexts" +/** + * This hook creates a return for an order. If a return shipping method is specified, the return is automatically fulfilled. + * + * @example + * import React from "react" + * import { useCreateReturn } from "medusa-react" + * + * type CreateReturnData = { + * items: { + * item_id: string, + * quantity: number + * }[] + * return_shipping: { + * option_id: string + * } + * } + * + * type Props = { + * orderId: string + * } + * + * const CreateReturn = ({ orderId }: Props) => { + * const createReturn = useCreateReturn() + * // ... + * + * const handleCreate = (data: CreateReturnData) => { + * createReturn.mutate({ + * ...data, + * order_id: orderId + * }, { + * onSuccess: ({ return: returnData }) => { + * console.log(returnData.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateReturn + * + * @customNamespace Hooks.Store.Returns + * @category Mutations + */ export const useCreateReturn = ( options?: UseMutationOptions ) => { diff --git a/packages/medusa-react/src/hooks/store/shipping-options/index.ts b/packages/medusa-react/src/hooks/store/shipping-options/index.ts index f3593df2df13b..a4718f66c7682 100644 --- a/packages/medusa-react/src/hooks/store/shipping-options/index.ts +++ b/packages/medusa-react/src/hooks/store/shipping-options/index.ts @@ -1 +1,13 @@ +/** + * @packageDocumentation + * + * Queries listed here are used to send requests to the [Store Shipping Option API Routes](https://docs.medusajs.com/api/store#shipping-options). + * + * A shipping option is used to define the available shipping methods during checkout or when creating a return. + * + * Related Guide: [Shipping Option architecture](https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option). + * + * @customNamespace Hooks.Store.Shipping Options + */ + export * from "./queries" diff --git a/packages/medusa-react/src/hooks/store/shipping-options/queries.ts b/packages/medusa-react/src/hooks/store/shipping-options/queries.ts index 739198f3ec169..d6ebc7e5d487d 100644 --- a/packages/medusa-react/src/hooks/store/shipping-options/queries.ts +++ b/packages/medusa-react/src/hooks/store/shipping-options/queries.ts @@ -17,7 +17,45 @@ const shippingOptionKey = { type ShippingOptionQueryKey = typeof shippingOptionKey +/** + * This hook retrieves a list of shipping options. The shipping options can be filtered using the `query` parameter. + * + * @example + * import React from "react" + * import { useShippingOptions } from "medusa-react" + * + * const ShippingOptions = () => { + * const { + * shipping_options, + * isLoading, + * } = useShippingOptions() + * + * return ( + *
+ * {isLoading && Loading...} + * {shipping_options?.length && + * shipping_options?.length > 0 && ( + *
    + * {shipping_options?.map((shipping_option) => ( + *
  • + * {shipping_option.id} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ShippingOptions + * + * @customNamespace Hooks.Store.Shipping Options + * @category Queries + */ export const useShippingOptions = ( + /** + * The filters to apply on the shipping options. + */ query?: StoreGetShippingOptionsParams, options?: UseQueryOptionsWrapper< Response, @@ -34,7 +72,51 @@ export const useShippingOptions = ( return { ...data, ...rest } as const } +/** + * This hook retrieves a list of shipping options available for a cart. + * + * @example + * import React from "react" + * import { useCartShippingOptions } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const ShippingOptions = ({ cartId }: Props) => { + * const { shipping_options, isLoading } = + * useCartShippingOptions(cartId) + * + * return ( + *
+ * {isLoading && Loading...} + * {shipping_options && !shipping_options.length && ( + * No shipping options + * )} + * {shipping_options && ( + *
    + * {shipping_options.map( + * (shipping_option) => ( + *
  • + * {shipping_option.name} + *
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default ShippingOptions + * + * @customNamespace Hooks.Store.Shipping Options + * @category Queries + */ export const useCartShippingOptions = ( + /** + * The cart's ID. + */ cartId: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/hooks/store/swaps/index.ts b/packages/medusa-react/src/hooks/store/swaps/index.ts index a494946b87dc5..f6289d972ca87 100644 --- a/packages/medusa-react/src/hooks/store/swaps/index.ts +++ b/packages/medusa-react/src/hooks/store/swaps/index.ts @@ -1,2 +1,15 @@ +/** + * @packageDocumentation + * + * Queries and Mutations listed here are used to send requests to the [Store Swap API Routes](https://docs.medusajs.com/api/store#swaps). + * + * A swap is created by a customer or an admin to exchange an item with a new one. + * Creating a swap implicitely includes creating a return for the item being exchanged. + * + * Related Guide: [How to create a swap in a storefront](https://docs.medusajs.com/modules/orders/storefront/create-swap) + * + * @customNamespace Hooks.Store.Swaps + */ + export * from "./queries" export * from "./mutations" diff --git a/packages/medusa-react/src/hooks/store/swaps/mutations.ts b/packages/medusa-react/src/hooks/store/swaps/mutations.ts index 636dceabe060d..6a11540aad988 100644 --- a/packages/medusa-react/src/hooks/store/swaps/mutations.ts +++ b/packages/medusa-react/src/hooks/store/swaps/mutations.ts @@ -2,6 +2,61 @@ import { StorePostSwapsReq, StoreSwapsRes } from "@medusajs/medusa" import { useMutation, UseMutationOptions } from "@tanstack/react-query" import { useMedusa } from "../../../contexts" +/** + * This hook creates a Swap for an Order. This will also create a return and associate it with the swap. If a return shipping option is specified, the return will automatically be fulfilled. + * To complete the swap, you must use the {@link Hooks.Store.Carts.useCompleteCart | useCompleteCart} hook passing it the ID of the swap's cart. + * + * An idempotency key will be generated if none is provided in the header `Idempotency-Key` and added to + * the response. If an error occurs during swap creation or the request is interrupted for any reason, the swap creation can be retried by passing the idempotency + * key in the `Idempotency-Key` header. + * + * @example + * import React from "react" + * import { useCreateSwap } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * type CreateData = { + * return_items: { + * item_id: string + * quantity: number + * }[] + * additional_items: { + * variant_id: string + * quantity: number + * }[] + * return_shipping_option: string + * } + * + * const CreateSwap = ({ + * orderId + * }: Props) => { + * const createSwap = useCreateSwap() + * // ... + * + * const handleCreate = ( + * data: CreateData + * ) => { + * createSwap.mutate({ + * ...data, + * order_id: orderId + * }, { + * onSuccess: ({ swap }) => { + * console.log(swap.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateSwap + * + * @customNamespace Hooks.Store.Swaps + * @category Mutations + */ export const useCreateSwap = ( options?: UseMutationOptions ) => { diff --git a/packages/medusa-react/src/hooks/store/swaps/queries.ts b/packages/medusa-react/src/hooks/store/swaps/queries.ts index c516ffd764c36..58a6cf882aebc 100644 --- a/packages/medusa-react/src/hooks/store/swaps/queries.ts +++ b/packages/medusa-react/src/hooks/store/swaps/queries.ts @@ -14,7 +14,41 @@ const swapKey = { type SwapQueryKey = typeof swapKey +/** + * This hook retrieves a Swap's details by the ID of its cart. + * + * @example + * import React from "react" + * import { useCartSwap } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Swap = ({ cartId }: Props) => { + * const { + * swap, + * isLoading, + * } = useCartSwap(cartId) + * + * return ( + *
+ * {isLoading && Loading...} + * {swap && {swap.id}} + * + *
+ * ) + * } + * + * export default Swap + * + * @customNamespace Hooks.Store.Swaps + * @category Queries + */ export const useCartSwap = ( + /** + * The ID of the swap's cart. + */ cartId: string, options?: UseQueryOptionsWrapper< Response, diff --git a/packages/medusa-react/src/types.ts b/packages/medusa-react/src/types.ts index 1559be9adc2ca..b1ebdefc97b70 100644 --- a/packages/medusa-react/src/types.ts +++ b/packages/medusa-react/src/types.ts @@ -22,6 +22,7 @@ export type RegionInfo = Pick export type ProductVariant = ConvertDateToString< Omit > + export type ProductVariantInfo = Pick type ConvertDateToString = { diff --git a/packages/medusa/src/api/routes/admin/auth/create-session.ts b/packages/medusa/src/api/routes/admin/auth/create-session.ts index 64d5b8283c3c8..f427ceb7d56a2 100644 --- a/packages/medusa/src/api/routes/admin/auth/create-session.ts +++ b/packages/medusa/src/api/routes/admin/auth/create-session.ts @@ -34,6 +34,31 @@ import { validator } from "../../../../utils/validator" * .then(({ user }) => { * console.log(user.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminLogin } from "medusa-react" + * + * const Login = () => { + * const adminLogin = useAdminLogin() + * // ... + * + * const handleLogin = () => { + * adminLogin.mutate({ + * email: "user@example.com", + * password: "supersecret", + * }, { + * onSuccess: ({ user }) => { + * console.log(user) + * } + * }) + * } + * + * // ... + * } + * + * export default Login * - lang: Shell * label: cURL * source: | @@ -91,6 +116,7 @@ export default async (req, res) => { /** * @schema AdminPostAuthReq * type: object + * description: The admin's credentials used to log in. * required: * - email * - password diff --git a/packages/medusa/src/api/routes/admin/auth/delete-session.ts b/packages/medusa/src/api/routes/admin/auth/delete-session.ts index 797c8d84d8efe..5141c6c83dcdd 100644 --- a/packages/medusa/src/api/routes/admin/auth/delete-session.ts +++ b/packages/medusa/src/api/routes/admin/auth/delete-session.ts @@ -15,6 +15,28 @@ * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) * // must be previously logged in * medusa.admin.auth.deleteSession() + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteSession } from "medusa-react" + * + * const Logout = () => { + * const adminLogout = useAdminDeleteSession() + * // ... + * + * const handleLogout = () => { + * adminLogout.mutate(undefined, { + * onSuccess: () => { + * // user logged out. + * } + * }) + * } + * + * // ... + * } + * + * export default Logout * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/auth/get-session.ts b/packages/medusa/src/api/routes/admin/auth/get-session.ts index 3bddd0beb3659..4601a9d096dcb 100644 --- a/packages/medusa/src/api/routes/admin/auth/get-session.ts +++ b/packages/medusa/src/api/routes/admin/auth/get-session.ts @@ -20,6 +20,24 @@ import _ from "lodash" * .then(({ user }) => { * console.log(user.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminGetSession } from "medusa-react" + * + * const Profile = () => { + * const { user, isLoading } = useAdminGetSession() + * + * return ( + *
+ * {isLoading && Loading...} + * {user && {user.email}} + *
+ * ) + * } + * + * export default Profile * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts index dd99c00b5d40d..1a1d546cea041 100644 --- a/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts +++ b/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts @@ -22,6 +22,32 @@ import { EntityManager } from "typeorm" * .then(({ batch_job }) => { * console.log(batch_job.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCancelBatchJob } from "medusa-react" + * + * type Props = { + * batchJobId: string + * } + * + * const BatchJob = ({ batchJobId }: Props) => { + * const cancelBatchJob = useAdminCancelBatchJob(batchJobId) + * // ... + * + * const handleCancel = () => { + * cancelBatchJob.mutate(undefined, { + * onSuccess: ({ batch_job }) => { + * console.log(batch_job) + * } + * }) + * } + * + * // ... + * } + * + * export default BatchJob * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts index 40ee349680163..138ff04303c2a 100644 --- a/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts +++ b/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts @@ -22,6 +22,32 @@ import { EntityManager } from "typeorm" * .then(({ batch_job }) => { * console.log(batch_job.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminConfirmBatchJob } from "medusa-react" + * + * type Props = { + * batchJobId: string + * } + * + * const BatchJob = ({ batchJobId }: Props) => { + * const confirmBatchJob = useAdminConfirmBatchJob(batchJobId) + * // ... + * + * const handleConfirm = () => { + * confirmBatchJob.mutate(undefined, { + * onSuccess: ({ batch_job }) => { + * console.log(batch_job) + * } + * }) + * } + * + * // ... + * } + * + * export default BatchJob * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/batch/create-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/create-batch-job.ts index a73376cb70148..63a5c0b86655b 100644 --- a/packages/medusa/src/api/routes/admin/batch/create-batch-job.ts +++ b/packages/medusa/src/api/routes/admin/batch/create-batch-job.ts @@ -36,6 +36,32 @@ import { validator } from "../../../../utils/validator" * }).then((({ batch_job }) => { * console.log(batch_job.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateBatchJob } from "medusa-react" + * + * const CreateBatchJob = () => { + * const createBatchJob = useAdminCreateBatchJob() + * // ... + * + * const handleCreateBatchJob = () => { + * createBatchJob.mutate({ + * type: "publish-products", + * context: {}, + * dry_run: true + * }, { + * onSuccess: ({ batch_job }) => { + * console.log(batch_job) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateBatchJob * - lang: Shell * label: cURL * source: | @@ -96,6 +122,7 @@ export default async (req, res) => { /** * @schema AdminPostBatchesReq * type: object + * description: The details of the batch job to create. * required: * - type * - context diff --git a/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts index 32cd46e916740..72726bb022a4b 100644 --- a/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts +++ b/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts @@ -19,6 +19,28 @@ * .then(({ batch_job }) => { * console.log(batch_job.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminBatchJob } from "medusa-react" + * + * type Props = { + * batchJobId: string + * } + * + * const BatchJob = ({ batchJobId }: Props) => { + * const { batch_job, isLoading } = useAdminBatchJob(batchJobId) + * + * return ( + *
+ * {isLoading && Loading...} + * {batch_job && {batch_job.created_by}} + *
+ * ) + * } + * + * export default BatchJob * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/batch/list-batch-jobs.ts b/packages/medusa/src/api/routes/admin/batch/list-batch-jobs.ts index 711d395ffb220..e757b482a4357 100644 --- a/packages/medusa/src/api/routes/admin/batch/list-batch-jobs.ts +++ b/packages/medusa/src/api/routes/admin/batch/list-batch-jobs.ts @@ -224,6 +224,38 @@ import { isDefined } from "medusa-core-utils" * .then(({ batch_jobs, limit, offset, count }) => { * console.log(batch_jobs.length) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminBatchJobs } from "medusa-react" + * + * const BatchJobs = () => { + * const { + * batch_jobs, + * limit, + * offset, + * count, + * isLoading + * } = useAdminBatchJobs() + * + * return ( + *
+ * {isLoading && Loading...} + * {batch_jobs?.length && ( + *
    + * {batch_jobs.map((batchJob) => ( + *
  • + * {batchJob.id} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default BatchJobs * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/collections/add-products.ts b/packages/medusa/src/api/routes/admin/collections/add-products.ts index 8b903dc9c9d17..219efa2666dce 100644 --- a/packages/medusa/src/api/routes/admin/collections/add-products.ts +++ b/packages/medusa/src/api/routes/admin/collections/add-products.ts @@ -36,6 +36,34 @@ import { defaultAdminCollectionsRelations } from "./index" * .then(({ collection }) => { * console.log(collection.products) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminAddProductsToCollection } from "medusa-react" + * + * type Props = { + * collectionId: string + * } + * + * const Collection = ({ collectionId }: Props) => { + * const addProducts = useAdminAddProductsToCollection(collectionId) + * // ... + * + * const handleAddProducts = (productIds: string[]) => { + * addProducts.mutate({ + * product_ids: productIds + * }, { + * onSuccess: ({ collection }) => { + * console.log(collection.products) + * } + * }) + * } + * + * // ... + * } + * + * export default Collection * - lang: Shell * label: cURL * source: | @@ -100,6 +128,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostProductsToCollectionReq * type: object + * description: "The details of the products to add to the collection." * required: * - product_ids * properties: diff --git a/packages/medusa/src/api/routes/admin/collections/create-collection.ts b/packages/medusa/src/api/routes/admin/collections/create-collection.ts index 9e0d625dcad68..ab2d15de29517 100644 --- a/packages/medusa/src/api/routes/admin/collections/create-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/create-collection.ts @@ -30,6 +30,30 @@ import { defaultAdminCollectionsRelations } from "." * .then(({ collection }) => { * console.log(collection.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateCollection } from "medusa-react" + * + * const CreateCollection = () => { + * const createCollection = useAdminCreateCollection() + * // ... + * + * const handleCreate = (title: string) => { + * createCollection.mutate({ + * title + * }, { + * onSuccess: ({ collection }) => { + * console.log(collection.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateCollection * - lang: Shell * label: cURL * source: | @@ -89,6 +113,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostCollectionsReq * type: object + * description: The product collection's details. * required: * - title * properties: diff --git a/packages/medusa/src/api/routes/admin/collections/delete-collection.ts b/packages/medusa/src/api/routes/admin/collections/delete-collection.ts index a237090bb8a33..5055ae0140e22 100644 --- a/packages/medusa/src/api/routes/admin/collections/delete-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/delete-collection.ts @@ -24,6 +24,32 @@ import ProductCollectionService from "../../../../services/product-collection" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteCollection } from "medusa-react" + * + * type Props = { + * collectionId: string + * } + * + * const Collection = ({ collectionId }: Props) => { + * const deleteCollection = useAdminDeleteCollection(collectionId) + * // ... + * + * const handleDelete = (title: string) => { + * deleteCollection.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Collection * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/collections/get-collection.ts b/packages/medusa/src/api/routes/admin/collections/get-collection.ts index c5ed909ea8505..f547935f8f778 100644 --- a/packages/medusa/src/api/routes/admin/collections/get-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/get-collection.ts @@ -24,6 +24,28 @@ import { defaultAdminCollectionsRelations } from "." * .then(({ collection }) => { * console.log(collection.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCollection } from "medusa-react" + * + * type Props = { + * collectionId: string + * } + * + * const Collection = ({ collectionId }: Props) => { + * const { collection, isLoading } = useAdminCollection(collectionId) + * + * return ( + *
+ * {isLoading && Loading...} + * {collection && {collection.title}} + *
+ * ) + * } + * + * export default Collection * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/collections/list-collections.ts b/packages/medusa/src/api/routes/admin/collections/list-collections.ts index c7dc3b4ba41d4..afe94debbdaff 100644 --- a/packages/medusa/src/api/routes/admin/collections/list-collections.ts +++ b/packages/medusa/src/api/routes/admin/collections/list-collections.ts @@ -98,6 +98,33 @@ import { Type } from "class-transformer" * .then(({ collections, limit, offset, count }) => { * console.log(collections.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCollections } from "medusa-react" + * + * const Collections = () => { + * const { collections, isLoading } = useAdminCollections() + * + * return ( + *
+ * {isLoading && Loading...} + * {collections && !collections.length && + * No Product Collections + * } + * {collections && collections.length > 0 && ( + *
    + * {collections.map((collection) => ( + *
  • {collection.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Collections * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/collections/remove-products.ts b/packages/medusa/src/api/routes/admin/collections/remove-products.ts index 9079ef24ec2be..f9fbba8311eab 100644 --- a/packages/medusa/src/api/routes/admin/collections/remove-products.ts +++ b/packages/medusa/src/api/routes/admin/collections/remove-products.ts @@ -35,6 +35,34 @@ import ProductCollectionService from "../../../../services/product-collection" * .then(({ id, object, removed_products }) => { * console.log(removed_products) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminRemoveProductsFromCollection } from "medusa-react" + * + * type Props = { + * collectionId: string + * } + * + * const Collection = ({ collectionId }: Props) => { + * const removeProducts = useAdminRemoveProductsFromCollection(collectionId) + * // ... + * + * const handleRemoveProducts = (productIds: string[]) => { + * removeProducts.mutate({ + * product_ids: productIds + * }, { + * onSuccess: ({ id, object, removed_products }) => { + * console.log(removed_products) + * } + * }) + * } + * + * // ... + * } + * + * export default Collection * - lang: Shell * label: cURL * source: | @@ -99,6 +127,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminDeleteProductsFromCollectionReq * type: object + * description: "The details of the products to remove from the collection." * required: * - product_ids * properties: diff --git a/packages/medusa/src/api/routes/admin/collections/update-collection.ts b/packages/medusa/src/api/routes/admin/collections/update-collection.ts index 410aa1657bacf..2730345ad83a9 100644 --- a/packages/medusa/src/api/routes/admin/collections/update-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/update-collection.ts @@ -32,6 +32,34 @@ import { defaultAdminCollectionsRelations } from "." * .then(({ collection }) => { * console.log(collection.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateCollection } from "medusa-react" + * + * type Props = { + * collectionId: string + * } + * + * const Collection = ({ collectionId }: Props) => { + * const updateCollection = useAdminUpdateCollection(collectionId) + * // ... + * + * const handleUpdate = (title: string) => { + * updateCollection.mutate({ + * title + * }, { + * onSuccess: ({ collection }) => { + * console.log(collection.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Collection * - lang: Shell * label: cURL * source: | @@ -94,6 +122,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostCollectionsCollectionReq * type: object + * description: The product collection's details to update. * properties: * title: * type: string diff --git a/packages/medusa/src/api/routes/admin/currencies/list-currencies.ts b/packages/medusa/src/api/routes/admin/currencies/list-currencies.ts index a39c4820ef4c3..4889ac05250bd 100644 --- a/packages/medusa/src/api/routes/admin/currencies/list-currencies.ts +++ b/packages/medusa/src/api/routes/admin/currencies/list-currencies.ts @@ -37,6 +37,33 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators * .then(({ currencies, count, offset, limit }) => { * console.log(currencies.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCurrencies } from "medusa-react" + * + * const Currencies = () => { + * const { currencies, isLoading } = useAdminCurrencies() + * + * return ( + *
+ * {isLoading && Loading...} + * {currencies && !currencies.length && ( + * No Currencies + * )} + * {currencies && currencies.length > 0 && ( + *
    + * {currencies.map((currency) => ( + *
  • {currency.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Currencies * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/currencies/update-currency.ts b/packages/medusa/src/api/routes/admin/currencies/update-currency.ts index f8faebf4ee6ac..6d446841bca41 100644 --- a/packages/medusa/src/api/routes/admin/currencies/update-currency.ts +++ b/packages/medusa/src/api/routes/admin/currencies/update-currency.ts @@ -34,6 +34,34 @@ import { EntityManager } from "typeorm" * .then(({ currency }) => { * console.log(currency.code); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateCurrency } from "medusa-react" + * + * type Props = { + * currencyCode: string + * } + * + * const Currency = ({ currencyCode }: Props) => { + * const updateCurrency = useAdminUpdateCurrency(currencyCode) + * // ... + * + * const handleUpdate = (includes_tax: boolean) => { + * updateCurrency.mutate({ + * includes_tax, + * }, { + * onSuccess: ({ currency }) => { + * console.log(currency) + * } + * }) + * } + * + * // ... + * } + * + * export default Currency * - lang: Shell * label: cURL * source: | @@ -87,6 +115,7 @@ export default async (req: ExtendedRequest, res) => { /** * @schema AdminPostCurrenciesCurrencyReq * type: object + * description: "The details to update in the currency" * properties: * includes_tax: * type: boolean diff --git a/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts b/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts index dd18f2322a778..80db05c8f6a35 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts @@ -39,6 +39,38 @@ import { validator } from "../../../../utils/validator" * .then(({ customer_group }) => { * console.log(customer_group.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminAddCustomersToCustomerGroup, + * } from "medusa-react" + * + * type Props = { + * customerGroupId: string + * } + * + * const CustomerGroup = ({ customerGroupId }: Props) => { + * const addCustomers = useAdminAddCustomersToCustomerGroup( + * customerGroupId + * ) + * // ... + * + * const handleAddCustomers= (customerId: string) => { + * addCustomers.mutate({ + * customer_ids: [ + * { + * id: customerId, + * }, + * ], + * }) + * } + * + * // ... + * } + * + * export default CustomerGroup * - lang: Shell * label: cURL * source: | @@ -108,6 +140,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostCustomerGroupsGroupCustomersBatchReq * type: object + * description: "The customers to add to the customer group." * required: * - customer_ids * properties: diff --git a/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts index 0052abcc0d54d..d63af297f8248 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts @@ -31,6 +31,26 @@ import { validator } from "../../../../utils/validator" * .then(({ customer_group }) => { * console.log(customer_group.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateCustomerGroup } from "medusa-react" + * + * const CreateCustomerGroup = () => { + * const createCustomerGroup = useAdminCreateCustomerGroup() + * // ... + * + * const handleCreate = (name: string) => { + * createCustomerGroup.mutate({ + * name, + * }) + * } + * + * // ... + * } + * + * export default CreateCustomerGroup * - lang: Shell * label: cURL * source: | @@ -89,6 +109,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostCustomerGroupsReq * type: object + * description: "The details of the customer group to create." * required: * - name * properties: diff --git a/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts index 1d8d47c67eef9..9af8f0d5ed2e0 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts @@ -24,6 +24,30 @@ import { EntityManager } from "typeorm" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteCustomerGroup } from "medusa-react" + * + * type Props = { + * customerGroupId: string + * } + * + * const CustomerGroup = ({ customerGroupId }: Props) => { + * const deleteCustomerGroup = useAdminDeleteCustomerGroup( + * customerGroupId + * ) + * // ... + * + * const handleDeleteCustomerGroup = () => { + * deleteCustomerGroup.mutate() + * } + * + * // ... + * } + * + * export default CustomerGroup * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts b/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts index e421f84a82e21..2c94a016431c5 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts @@ -39,6 +39,39 @@ import { validator } from "../../../../utils/validator" * .then(({ customer_group }) => { * console.log(customer_group.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminRemoveCustomersFromCustomerGroup, + * } from "medusa-react" + * + * type Props = { + * customerGroupId: string + * } + * + * const CustomerGroup = ({ customerGroupId }: Props) => { + * const removeCustomers = + * useAdminRemoveCustomersFromCustomerGroup( + * customerGroupId + * ) + * // ... + * + * const handleRemoveCustomer = (customerId: string) => { + * removeCustomers.mutate({ + * customer_ids: [ + * { + * id: customerId, + * }, + * ], + * }) + * } + * + * // ... + * } + * + * export default CustomerGroup * - lang: Shell * label: cURL * source: | @@ -108,6 +141,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminDeleteCustomerGroupsGroupCustomerBatchReq * type: object + * description: "The customers to remove from the customer group." * required: * - customer_ids * properties: diff --git a/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group-customers.ts b/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group-customers.ts index 692fd351b5dbf..8770f31514ef8 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group-customers.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group-customers.ts @@ -30,6 +30,42 @@ import { Type } from "class-transformer" * .then(({ customers }) => { * console.log(customers.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCustomerGroupCustomers } from "medusa-react" + * + * type Props = { + * customerGroupId: string + * } + * + * const CustomerGroup = ({ customerGroupId }: Props) => { + * const { + * customers, + * isLoading, + * } = useAdminCustomerGroupCustomers( + * customerGroupId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {customers && !customers.length && ( + * No customers + * )} + * {customers && customers.length > 0 && ( + *
    + * {customers.map((customer) => ( + *
  • {customer.first_name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default CustomerGroup * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts index 887573579680b..6a87b6ca2828e 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts @@ -27,6 +27,30 @@ import { FindParams } from "../../../../types/common" * .then(({ customer_group }) => { * console.log(customer_group.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCustomerGroup } from "medusa-react" + * + * type Props = { + * customerGroupId: string + * } + * + * const CustomerGroup = ({ customerGroupId }: Props) => { + * const { customer_group, isLoading } = useAdminCustomerGroup( + * customerGroupId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {customer_group && {customer_group.name}} + *
+ * ) + * } + * + * export default CustomerGroup * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts b/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts index be978f2170437..755f9ce0c74bc 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts @@ -114,6 +114,40 @@ import { Type } from "class-transformer" * .then(({ customer_groups, limit, offset, count }) => { * console.log(customer_groups.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCustomerGroups } from "medusa-react" + * + * const CustomerGroups = () => { + * const { + * customer_groups, + * isLoading, + * } = useAdminCustomerGroups() + * + * return ( + *
+ * {isLoading && Loading...} + * {customer_groups && !customer_groups.length && ( + * No Customer Groups + * )} + * {customer_groups && customer_groups.length > 0 && ( + *
    + * {customer_groups.map( + * (customerGroup) => ( + *
  • + * {customerGroup.name} + *
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default CustomerGroups * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts index b947ac4007197..7ddcbe9c20d29 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts @@ -35,6 +35,32 @@ import { validator } from "../../../../utils/validator" * .then(({ customer_group }) => { * console.log(customer_group.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateCustomerGroup } from "medusa-react" + * + * type Props = { + * customerGroupId: string + * } + * + * const CustomerGroup = ({ customerGroupId }: Props) => { + * const updateCustomerGroup = useAdminUpdateCustomerGroup( + * customerGroupId + * ) + * // .. + * + * const handleUpdate = (name: string) => { + * updateCustomerGroup.mutate({ + * name, + * }) + * } + * + * // ... + * } + * + * export default CustomerGroup * - lang: Shell * label: cURL * source: | @@ -110,6 +136,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostCustomerGroupsGroupReq * type: object + * description: "The details to update in the customer group." * properties: * name: * description: "Name of the customer group" diff --git a/packages/medusa/src/api/routes/admin/customers/create-customer.ts b/packages/medusa/src/api/routes/admin/customers/create-customer.ts index af5832b36d963..861f729a2fbf2 100644 --- a/packages/medusa/src/api/routes/admin/customers/create-customer.ts +++ b/packages/medusa/src/api/routes/admin/customers/create-customer.ts @@ -33,6 +33,35 @@ import { EntityManager } from "typeorm" * .then(({ customer }) => { * console.log(customer.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateCustomer } from "medusa-react" + * + * type CustomerData = { + * first_name: string + * last_name: string + * email: string + * password: string + * } + * + * const CreateCustomer = () => { + * const createCustomer = useAdminCreateCustomer() + * // ... + * + * const handleCreate = (customerData: CustomerData) => { + * createCustomer.mutate(customerData, { + * onSuccess: ({ customer }) => { + * console.log(customer.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateCustomer * - lang: Shell * label: cURL * source: | @@ -87,6 +116,7 @@ export default async (req, res) => { /** * @schema AdminPostCustomersReq * type: object + * description: "The details of the customer to create." * required: * - email * - first_name diff --git a/packages/medusa/src/api/routes/admin/customers/get-customer.ts b/packages/medusa/src/api/routes/admin/customers/get-customer.ts index 32f88994f4f78..4f8969bb7493f 100644 --- a/packages/medusa/src/api/routes/admin/customers/get-customer.ts +++ b/packages/medusa/src/api/routes/admin/customers/get-customer.ts @@ -26,6 +26,30 @@ import { validator } from "../../../../utils/validator" * .then(({ customer }) => { * console.log(customer.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCustomer } from "medusa-react" + * + * type Props = { + * customerId: string + * } + * + * const Customer = ({ customerId }: Props) => { + * const { customer, isLoading } = useAdminCustomer( + * customerId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {customer && {customer.first_name}} + *
+ * ) + * } + * + * export default Customer * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/customers/list-customers.ts b/packages/medusa/src/api/routes/admin/customers/list-customers.ts index 3d90ee7643f21..553bc5a6bcec7 100644 --- a/packages/medusa/src/api/routes/admin/customers/list-customers.ts +++ b/packages/medusa/src/api/routes/admin/customers/list-customers.ts @@ -38,6 +38,33 @@ import customerController from "../../../../controllers/customers" * .then(({ customers, limit, offset, count }) => { * console.log(customers.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCustomers } from "medusa-react" + * + * const Customers = () => { + * const { customers, isLoading } = useAdminCustomers() + * + * return ( + *
+ * {isLoading && Loading...} + * {customers && !customers.length && ( + * No customers + * )} + * {customers && customers.length > 0 && ( + *
    + * {customers.map((customer) => ( + *
  • {customer.first_name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Customers * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/customers/update-customer.ts b/packages/medusa/src/api/routes/admin/customers/update-customer.ts index a7b69c0e0bc9c..4fb089fc2e23d 100644 --- a/packages/medusa/src/api/routes/admin/customers/update-customer.ts +++ b/packages/medusa/src/api/routes/admin/customers/update-customer.ts @@ -45,6 +45,35 @@ import { validator } from "../../../../utils/validator" * .then(({ customer }) => { * console.log(customer.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateCustomer } from "medusa-react" + * + * type CustomerData = { + * first_name: string + * last_name: string + * email: string + * password: string + * } + * + * type Props = { + * customerId: string + * } + * + * const Customer = ({ customerId }: Props) => { + * const updateCustomer = useAdminUpdateCustomer(customerId) + * // ... + * + * const handleUpdate = (customerData: CustomerData) => { + * updateCustomer.mutate(customerData) + * } + * + * // ... + * } + * + * export default Customer * - lang: Shell * label: cURL * source: | @@ -128,6 +157,7 @@ class Group { /** * @schema AdminPostCustomersCustomerReq * type: object + * description: "The details of the customer to update." * properties: * email: * type: string diff --git a/packages/medusa/src/api/routes/admin/discounts/add-region.ts b/packages/medusa/src/api/routes/admin/discounts/add-region.ts index b0978c2f4b396..bbfcdf6812167 100644 --- a/packages/medusa/src/api/routes/admin/discounts/add-region.ts +++ b/packages/medusa/src/api/routes/admin/discounts/add-region.ts @@ -26,6 +26,32 @@ import { EntityManager } from "typeorm" * .then(({ discount }) => { * console.log(discount.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDiscountAddRegion } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const addRegion = useAdminDiscountAddRegion(discountId) + * // ... + * + * const handleAdd = (regionId: string) => { + * addRegion.mutate(regionId, { + * onSuccess: ({ discount }) => { + * console.log(discount.regions) + * } + * }) + * } + * + * // ... + * } + * + * export default Discount * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/discounts/add-resources-to-condition-batch.ts b/packages/medusa/src/api/routes/admin/discounts/add-resources-to-condition-batch.ts index eacffd6089ef0..aa6e2dbc71be1 100644 --- a/packages/medusa/src/api/routes/admin/discounts/add-resources-to-condition-batch.ts +++ b/packages/medusa/src/api/routes/admin/discounts/add-resources-to-condition-batch.ts @@ -42,6 +42,47 @@ import { FindParams } from "../../../../types/common" * .then(({ discount }) => { * console.log(discount.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminAddDiscountConditionResourceBatch + * } from "medusa-react" + * + * type Props = { + * discountId: string + * conditionId: string + * } + * + * const DiscountCondition = ({ + * discountId, + * conditionId + * }: Props) => { + * const addConditionResources = useAdminAddDiscountConditionResourceBatch( + * discountId, + * conditionId + * ) + * // ... + * + * const handleAdd = (itemId: string) => { + * addConditionResources.mutate({ + * resources: [ + * { + * id: itemId + * } + * ] + * }, { + * onSuccess: ({ discount }) => { + * console.log(discount.id) + * } + * }) + * } + * + * // ... + * } + * + * export default DiscountCondition * - lang: Shell * label: cURL * source: | @@ -116,6 +157,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostDiscountsDiscountConditionsConditionBatchReq * type: object + * description: "The details of the resources to add." * required: * - resources * properties: diff --git a/packages/medusa/src/api/routes/admin/discounts/create-condition.ts b/packages/medusa/src/api/routes/admin/discounts/create-condition.ts index c362c4fb5b84e..08c419983cb32 100644 --- a/packages/medusa/src/api/routes/admin/discounts/create-condition.ts +++ b/packages/medusa/src/api/routes/admin/discounts/create-condition.ts @@ -42,6 +42,39 @@ import { FindParams } from "../../../../types/common" * .then(({ discount }) => { * console.log(discount.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { DiscountConditionOperator } from "@medusajs/medusa" + * import { useAdminDiscountCreateCondition } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const createCondition = useAdminDiscountCreateCondition(discountId) + * // ... + * + * const handleCreateCondition = ( + * operator: DiscountConditionOperator, + * products: string[] + * ) => { + * createCondition.mutate({ + * operator, + * products + * }, { + * onSuccess: ({ discount }) => { + * console.log(discount.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Discount * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/discounts/create-discount.ts b/packages/medusa/src/api/routes/admin/discounts/create-discount.ts index ad322d610e2c7..724db7f3f189d 100644 --- a/packages/medusa/src/api/routes/admin/discounts/create-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/create-discount.ts @@ -64,6 +64,46 @@ import { FindParams } from "../../../../types/common" * .then(({ discount }) => { * console.log(discount.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminCreateDiscount, + * } from "medusa-react" + * import { + * AllocationType, + * DiscountRuleType, + * } from "@medusajs/medusa" + * + * const CreateDiscount = () => { + * const createDiscount = useAdminCreateDiscount() + * // ... + * + * const handleCreate = ( + * currencyCode: string, + * regionId: string + * ) => { + * // ... + * createDiscount.mutate({ + * code: currencyCode, + * rule: { + * type: DiscountRuleType.FIXED, + * value: 10, + * allocation: AllocationType.ITEM, + * }, + * regions: [ + * regionId, + * ], + * is_dynamic: false, + * is_disabled: false, + * }) + * } + * + * // ... + * } + * + * export default CreateDiscount * - lang: Shell * label: cURL * source: | @@ -127,6 +167,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostDiscountsReq * type: object + * description: "The details of the discount to create." * required: * - code * - rule diff --git a/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts b/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts index 4c3f83573ff59..7d65352002835 100644 --- a/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts +++ b/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts @@ -40,6 +40,38 @@ import { EntityManager } from "typeorm" * .then(({ discount }) => { * console.log(discount.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateDynamicDiscountCode } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const createDynamicDiscount = useAdminCreateDynamicDiscountCode(discountId) + * // ... + * + * const handleCreate = ( + * code: string, + * usageLimit: number + * ) => { + * createDynamicDiscount.mutate({ + * code, + * usage_limit: usageLimit + * }, { + * onSuccess: ({ discount }) => { + * console.log(discount.is_dynamic) + * } + * }) + * } + * + * // ... + * } + * + * export default Discount * - lang: Shell * label: cURL * source: | @@ -100,6 +132,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostDiscountsDiscountDynamicCodesReq * type: object + * description: "The details of the dynamic discount to create." * required: * - code * properties: diff --git a/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts b/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts index 2831f9d09a391..587e87cbab567 100644 --- a/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts +++ b/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts @@ -29,6 +29,38 @@ import { FindParams } from "../../../../types/common" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminDiscountRemoveCondition + * } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const deleteCondition = useAdminDiscountRemoveCondition( + * discountId + * ) + * // ... + * + * const handleDelete = ( + * conditionId: string + * ) => { + * deleteCondition.mutate(conditionId, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(deleted) + * } + * }) + * } + * + * // ... + * } + * + * export default Discount * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/discounts/delete-discount.ts b/packages/medusa/src/api/routes/admin/discounts/delete-discount.ts index 2d504d1460676..404e178f7596f 100644 --- a/packages/medusa/src/api/routes/admin/discounts/delete-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/delete-discount.ts @@ -22,6 +22,24 @@ import { EntityManager } from "typeorm" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteDiscount } from "medusa-react" + * + * const Discount = () => { + * const deleteDiscount = useAdminDeleteDiscount(discount_id) + * // ... + * + * const handleDelete = () => { + * deleteDiscount.mutate() + * } + * + * // ... + * } + * + * export default Discount * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/discounts/delete-dynamic-code.ts b/packages/medusa/src/api/routes/admin/discounts/delete-dynamic-code.ts index 5b8abd14f4fe4..26a4a25e899e8 100644 --- a/packages/medusa/src/api/routes/admin/discounts/delete-dynamic-code.ts +++ b/packages/medusa/src/api/routes/admin/discounts/delete-dynamic-code.ts @@ -25,6 +25,32 @@ import { EntityManager } from "typeorm" * .then(({ discount }) => { * console.log(discount.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteDynamicDiscountCode } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const deleteDynamicDiscount = useAdminDeleteDynamicDiscountCode(discountId) + * // ... + * + * const handleDelete = (code: string) => { + * deleteDynamicDiscount.mutate(code, { + * onSuccess: ({ discount }) => { + * console.log(discount.is_dynamic) + * } + * }) + * } + * + * // ... + * } + * + * export default Discount * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/discounts/delete-resources-from-condition-batch.ts b/packages/medusa/src/api/routes/admin/discounts/delete-resources-from-condition-batch.ts index 47db14ca18efa..4b91203a94934 100644 --- a/packages/medusa/src/api/routes/admin/discounts/delete-resources-from-condition-batch.ts +++ b/packages/medusa/src/api/routes/admin/discounts/delete-resources-from-condition-batch.ts @@ -39,6 +39,47 @@ import { FindParams } from "../../../../types/common" * .then(({ discount }) => { * console.log(discount.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminDeleteDiscountConditionResourceBatch + * } from "medusa-react" + * + * type Props = { + * discountId: string + * conditionId: string + * } + * + * const DiscountCondition = ({ + * discountId, + * conditionId + * }: Props) => { + * const deleteConditionResource = useAdminDeleteDiscountConditionResourceBatch( + * discountId, + * conditionId, + * ) + * // ... + * + * const handleDelete = (itemId: string) => { + * deleteConditionResource.mutate({ + * resources: [ + * { + * id: itemId + * } + * ] + * }, { + * onSuccess: ({ discount }) => { + * console.log(discount.id) + * } + * }) + * } + * + * // ... + * } + * + * export default DiscountCondition * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/discounts/get-condition.ts b/packages/medusa/src/api/routes/admin/discounts/get-condition.ts index f1c5518e5bd02..e977afac6b7a0 100644 --- a/packages/medusa/src/api/routes/admin/discounts/get-condition.ts +++ b/packages/medusa/src/api/routes/admin/discounts/get-condition.ts @@ -27,6 +27,40 @@ import { FindParams } from "../../../../types/common" * .then(({ discount_condition }) => { * console.log(discount_condition.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminGetDiscountCondition } from "medusa-react" + * + * type Props = { + * discountId: string + * discountConditionId: string + * } + * + * const DiscountCondition = ({ + * discountId, + * discountConditionId + * }: Props) => { + * const { + * discount_condition, + * isLoading + * } = useAdminGetDiscountCondition( + * discountId, + * discountConditionId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {discount_condition && ( + * {discount_condition.type} + * )} + *
+ * ) + * } + * + * export default DiscountCondition * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/discounts/get-discount-by-code.ts b/packages/medusa/src/api/routes/admin/discounts/get-discount-by-code.ts index 9596c8f3db213..6e723e099f32e 100644 --- a/packages/medusa/src/api/routes/admin/discounts/get-discount-by-code.ts +++ b/packages/medusa/src/api/routes/admin/discounts/get-discount-by-code.ts @@ -26,6 +26,30 @@ import { FindParams } from "../../../../types/common" * .then(({ discount }) => { * console.log(discount.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminGetDiscountByCode } from "medusa-react" + * + * type Props = { + * discountCode: string + * } + * + * const Discount = ({ discountCode }: Props) => { + * const { discount, isLoading } = useAdminGetDiscountByCode( + * discountCode + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {discount && {discount.code}} + *
+ * ) + * } + * + * export default Discount * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/discounts/get-discount.ts b/packages/medusa/src/api/routes/admin/discounts/get-discount.ts index 06e66cce20e5c..3980cfb6502f2 100644 --- a/packages/medusa/src/api/routes/admin/discounts/get-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/get-discount.ts @@ -26,6 +26,30 @@ import { FindParams } from "../../../../types/common" * .then(({ discount }) => { * console.log(discount.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDiscount } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const { discount, isLoading } = useAdminDiscount( + * discountId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {discount && {discount.code}} + *
+ * ) + * } + * + * export default Discount * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/discounts/list-discounts.ts b/packages/medusa/src/api/routes/admin/discounts/list-discounts.ts index 3f44bfab6e643..bce231e7c26b3 100644 --- a/packages/medusa/src/api/routes/admin/discounts/list-discounts.ts +++ b/packages/medusa/src/api/routes/admin/discounts/list-discounts.ts @@ -53,6 +53,33 @@ import { optionalBooleanMapper } from "../../../../utils/validators/is-boolean" * .then(({ discounts, limit, offset, count }) => { * console.log(discounts.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDiscounts } from "medusa-react" + * + * const Discounts = () => { + * const { discounts, isLoading } = useAdminDiscounts() + * + * return ( + *
+ * {isLoading && Loading...} + * {discounts && !discounts.length && ( + * No customers + * )} + * {discounts && discounts.length > 0 && ( + *
    + * {discounts.map((discount) => ( + *
  • {discount.code}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Discounts * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/discounts/remove-region.ts b/packages/medusa/src/api/routes/admin/discounts/remove-region.ts index 3d0f2391e7f90..99034570fec62 100644 --- a/packages/medusa/src/api/routes/admin/discounts/remove-region.ts +++ b/packages/medusa/src/api/routes/admin/discounts/remove-region.ts @@ -25,6 +25,32 @@ import { EntityManager } from "typeorm" * .then(({ discount }) => { * console.log(discount.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDiscountRemoveRegion } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const deleteRegion = useAdminDiscountRemoveRegion(discountId) + * // ... + * + * const handleDelete = (regionId: string) => { + * deleteRegion.mutate(regionId, { + * onSuccess: ({ discount }) => { + * console.log(discount.regions) + * } + * }) + * } + * + * // ... + * } + * + * export default Discount * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/discounts/update-condition.ts b/packages/medusa/src/api/routes/admin/discounts/update-condition.ts index bbe2fd13c697a..8526874a7f584 100644 --- a/packages/medusa/src/api/routes/admin/discounts/update-condition.ts +++ b/packages/medusa/src/api/routes/admin/discounts/update-condition.ts @@ -40,6 +40,43 @@ import { FindParams } from "../../../../types/common" * .then(({ discount }) => { * console.log(discount.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDiscountUpdateCondition } from "medusa-react" + * + * type Props = { + * discountId: string + * conditionId: string + * } + * + * const DiscountCondition = ({ + * discountId, + * conditionId + * }: Props) => { + * const update = useAdminDiscountUpdateCondition( + * discountId, + * conditionId + * ) + * // ... + * + * const handleUpdate = ( + * products: string[] + * ) => { + * update.mutate({ + * products + * }, { + * onSuccess: ({ discount }) => { + * console.log(discount.id) + * } + * }) + * } + * + * // ... + * } + * + * export default DiscountCondition * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/discounts/update-discount.ts b/packages/medusa/src/api/routes/admin/discounts/update-discount.ts index 3ee56e5c9adaf..17bfbc4354af0 100644 --- a/packages/medusa/src/api/routes/admin/discounts/update-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/update-discount.ts @@ -53,6 +53,30 @@ import { FindParams } from "../../../../types/common" * .then(({ discount }) => { * console.log(discount.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateDiscount } from "medusa-react" + * + * type Props = { + * discountId: string + * } + * + * const Discount = ({ discountId }: Props) => { + * const updateDiscount = useAdminUpdateDiscount(discountId) + * // ... + * + * const handleUpdate = (isDisabled: boolean) => { + * updateDiscount.mutate({ + * is_disabled: isDisabled, + * }) + * } + * + * // ... + * } + * + * export default Discount * - lang: Shell * label: cURL * source: | @@ -111,6 +135,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostDiscountsDiscountReq * type: object + * description: "The details of the discount to update." * properties: * code: * type: string diff --git a/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts index 5409a2d192279..166eca6473515 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts @@ -64,6 +64,41 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ draft_order }) => { * console.log(draft_order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateDraftOrder } from "medusa-react" + * + * type DraftOrderData = { + * email: string + * region_id: string + * items: { + * quantity: number, + * variant_id: string + * }[] + * shipping_methods: { + * option_id: string + * price: number + * }[] + * } + * + * const CreateDraftOrder = () => { + * const createDraftOrder = useAdminCreateDraftOrder() + * // ... + * + * const handleCreate = (data: DraftOrderData) => { + * createDraftOrder.mutate(data, { + * onSuccess: ({ draft_order }) => { + * console.log(draft_order.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateDraftOrder * - lang: Shell * label: cURL * source: | @@ -167,6 +202,7 @@ enum Status { /** * @schema AdminPostDraftOrdersReq * type: object + * description: "The details of the draft order to create." * required: * - email * - region_id diff --git a/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts b/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts index a52d35b5a46d0..5766102e9b007 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts @@ -49,6 +49,36 @@ import { validator } from "../../../../utils/validator" * .then(({ draft_order }) => { * console.log(draft_order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDraftOrderAddLineItem } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const addLineItem = useAdminDraftOrderAddLineItem( + * draftOrderId + * ) + * // ... + * + * const handleAdd = (quantity: number) => { + * addLineItem.mutate({ + * quantity, + * }, { + * onSuccess: ({ draft_order }) => { + * console.log(draft_order.cart) + * } + * }) + * } + * + * // ... + * } + * + * export default DraftOrder * - lang: Shell * label: cURL * source: | @@ -161,6 +191,7 @@ export default async (req, res) => { /** * @schema AdminPostDraftOrdersDraftOrderLineItemsReq * type: object + * description: "The details of the line item to create." * required: * - quantity * properties: diff --git a/packages/medusa/src/api/routes/admin/draft-orders/delete-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/delete-draft-order.ts index a9b6e7b976401..d71c8eaf96d69 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/delete-draft-order.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/delete-draft-order.ts @@ -22,6 +22,34 @@ import { EntityManager } from "typeorm" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteDraftOrder } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const deleteDraftOrder = useAdminDeleteDraftOrder( + * draftOrderId + * ) + * // ... + * + * const handleDelete = () => { + * deleteDraftOrder.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default DraftOrder * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/draft-orders/delete-line-item.ts b/packages/medusa/src/api/routes/admin/draft-orders/delete-line-item.ts index 52572965ca359..ed58af0e1cee0 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/delete-line-item.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/delete-line-item.ts @@ -32,6 +32,34 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ draft_order }) => { * console.log(draft_order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDraftOrderRemoveLineItem } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const deleteLineItem = useAdminDraftOrderRemoveLineItem( + * draftOrderId + * ) + * // ... + * + * const handleDelete = (itemId: string) => { + * deleteLineItem.mutate(itemId, { + * onSuccess: ({ draft_order }) => { + * console.log(draft_order.cart) + * } + * }) + * } + * + * // ... + * } + * + * export default DraftOrder * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts index 9252f20d8b05a..30b91b15359b2 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts @@ -30,6 +30,32 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ draft_order }) => { * console.log(draft_order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDraftOrder } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const { + * draft_order, + * isLoading, + * } = useAdminDraftOrder(draftOrderId) + * + * return ( + *
+ * {isLoading && Loading...} + * {draft_order && {draft_order.display_id}} + * + *
+ * ) + * } + * + * export default DraftOrder * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/draft-orders/list-draft-orders.ts b/packages/medusa/src/api/routes/admin/draft-orders/list-draft-orders.ts index 7b242b4f0fe4c..15dd5dee934d6 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/list-draft-orders.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/list-draft-orders.ts @@ -35,6 +35,33 @@ import { validator } from "../../../../utils/validator" * .then(({ draft_orders, limit, offset, count }) => { * console.log(draft_orders.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDraftOrders } from "medusa-react" + * + * const DraftOrders = () => { + * const { draft_orders, isLoading } = useAdminDraftOrders() + * + * return ( + *
+ * {isLoading && Loading...} + * {draft_orders && !draft_orders.length && ( + * No Draft Orders + * )} + * {draft_orders && draft_orders.length > 0 && ( + *
    + * {draft_orders.map((order) => ( + *
  • {order.display_id}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default DraftOrders * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts b/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts index 3d0445fcc2d5e..9724226521e42 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts @@ -38,6 +38,34 @@ import { promiseAll } from "@medusajs/utils" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDraftOrderRegisterPayment } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const registerPayment = useAdminDraftOrderRegisterPayment( + * draftOrderId + * ) + * // ... + * + * const handlePayment = () => { + * registerPayment.mutate(void 0, { + * onSuccess: ({ order }) => { + * console.log(order.id) + * } + * }) + * } + * + * // ... + * } + * + * export default DraftOrder * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts index 323e63fd3e1a8..54c87f3a099f3 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts @@ -49,6 +49,36 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ draft_order }) => { * console.log(draft_order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateDraftOrder } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const updateDraftOrder = useAdminUpdateDraftOrder( + * draftOrderId + * ) + * // ... + * + * const handleUpdate = (email: string) => { + * updateDraftOrder.mutate({ + * email, + * }, { + * onSuccess: ({ draft_order }) => { + * console.log(draft_order.id) + * } + * }) + * } + * + * // ... + * } + * + * export default DraftOrder * - lang: Shell * label: cURL * source: | @@ -145,6 +175,7 @@ export default async (req, res) => { /** * @schema AdminPostDraftOrdersDraftOrderReq * type: object + * description: "The details of the draft order to update." * properties: * region_id: * type: string diff --git a/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts b/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts index d085533800c04..977bd17997f84 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts @@ -42,6 +42,36 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ draft_order }) => { * console.log(draft_order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDraftOrderUpdateLineItem } from "medusa-react" + * + * type Props = { + * draftOrderId: string + * } + * + * const DraftOrder = ({ draftOrderId }: Props) => { + * const updateLineItem = useAdminDraftOrderUpdateLineItem( + * draftOrderId + * ) + * // ... + * + * const handleUpdate = ( + * itemId: string, + * quantity: number + * ) => { + * updateLineItem.mutate({ + * item_id: itemId, + * quantity, + * }) + * } + * + * // ... + * } + * + * export default DraftOrder * - lang: Shell * label: cURL * source: | @@ -150,6 +180,7 @@ export default async (req, res) => { /** * @schema AdminPostDraftOrdersDraftOrderLineItemsItemReq * type: object + * description: "The details to update of the line item." * properties: * unit_price: * description: The custom price of the line item. If a `variant_id` is supplied, the price provided here will override the variant's price. diff --git a/packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts b/packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts index 805fe2bc7592c..a796e1ea89347 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts +++ b/packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts @@ -31,6 +31,34 @@ import { EntityManager } from "typeorm" * .then(({ gift_card }) => { * console.log(gift_card.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateGiftCard } from "medusa-react" + * + * const CreateCustomGiftCards = () => { + * const createGiftCard = useAdminCreateGiftCard() + * // ... + * + * const handleCreate = ( + * regionId: string, + * value: number + * ) => { + * createGiftCard.mutate({ + * region_id: regionId, + * value, + * }, { + * onSuccess: ({ gift_card }) => { + * console.log(gift_card.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateCustomGiftCards * - lang: Shell * label: cURL * source: | @@ -90,6 +118,7 @@ export default async (req, res) => { /** * @schema AdminPostGiftCardsReq * type: object + * description: "The details of the gift card to create." * required: * - region_id * properties: diff --git a/packages/medusa/src/api/routes/admin/gift-cards/delete-gift-card.ts b/packages/medusa/src/api/routes/admin/gift-cards/delete-gift-card.ts index f596145dce286..0ccbd896a2ae6 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/delete-gift-card.ts +++ b/packages/medusa/src/api/routes/admin/gift-cards/delete-gift-card.ts @@ -21,6 +21,34 @@ import { EntityManager } from "typeorm" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteGiftCard } from "medusa-react" + * + * type Props = { + * customGiftCardId: string + * } + * + * const CustomGiftCard = ({ customGiftCardId }: Props) => { + * const deleteGiftCard = useAdminDeleteGiftCard( + * customGiftCardId + * ) + * // ... + * + * const handleDelete = () => { + * deleteGiftCard.mutate(void 0, { + * onSuccess: ({ id, object, deleted}) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default CustomGiftCard * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts b/packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts index 540c8d6eaf91e..336eff95b3ca8 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts +++ b/packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts @@ -21,6 +21,28 @@ import { defaultAdminGiftCardFields, defaultAdminGiftCardRelations } from "./" * .then(({ gift_card }) => { * console.log(gift_card.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminGiftCard } from "medusa-react" + * + * type Props = { + * giftCardId: string + * } + * + * const CustomGiftCard = ({ giftCardId }: Props) => { + * const { gift_card, isLoading } = useAdminGiftCard(giftCardId) + * + * return ( + *
+ * {isLoading && Loading...} + * {gift_card && {gift_card.code}} + *
+ * ) + * } + * + * export default CustomGiftCard * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/gift-cards/list-gift-cards.ts b/packages/medusa/src/api/routes/admin/gift-cards/list-gift-cards.ts index 77e6f1ebb04d0..ac1fed962e1c6 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/list-gift-cards.ts +++ b/packages/medusa/src/api/routes/admin/gift-cards/list-gift-cards.ts @@ -30,6 +30,34 @@ import { isDefined } from "medusa-core-utils" * .then(({ gift_cards, limit, offset, count }) => { * console.log(gift_cards.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { GiftCard } from "@medusajs/medusa" + * import { useAdminGiftCards } from "medusa-react" + * + * const CustomGiftCards = () => { + * const { gift_cards, isLoading } = useAdminGiftCards() + * + * return ( + *
+ * {isLoading && Loading...} + * {gift_cards && !gift_cards.length && ( + * No custom gift cards... + * )} + * {gift_cards && gift_cards.length > 0 && ( + *
    + * {gift_cards.map((giftCard: GiftCard) => ( + *
  • {giftCard.code}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default CustomGiftCards * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts b/packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts index f85a949ffc37b..5a0fc6ee6a110 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts +++ b/packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts @@ -34,6 +34,36 @@ import { validator } from "../../../../utils/validator" * .then(({ gift_card }) => { * console.log(gift_card.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateGiftCard } from "medusa-react" + * + * type Props = { + * customGiftCardId: string + * } + * + * const CustomGiftCard = ({ customGiftCardId }: Props) => { + * const updateGiftCard = useAdminUpdateGiftCard( + * customGiftCardId + * ) + * // ... + * + * const handleUpdate = (regionId: string) => { + * updateGiftCard.mutate({ + * region_id: regionId, + * }, { + * onSuccess: ({ gift_card }) => { + * console.log(gift_card.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CustomGiftCard * - lang: Shell * label: cURL * source: | @@ -94,6 +124,7 @@ export default async (req, res) => { /** * @schema AdminPostGiftCardsGiftCardReq * type: object + * description: "The details to update of the gift card." * properties: * balance: * type: integer diff --git a/packages/medusa/src/api/routes/admin/inventory-items/create-inventory-item.ts b/packages/medusa/src/api/routes/admin/inventory-items/create-inventory-item.ts index fbc2df8d60a66..7b67fe9473281 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/create-inventory-item.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/create-inventory-item.ts @@ -43,6 +43,30 @@ import { FindParams } from "../../../../types/common" * .then(({ inventory_item }) => { * console.log(inventory_item.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateInventoryItem } from "medusa-react" + * + * const CreateInventoryItem = () => { + * const createInventoryItem = useAdminCreateInventoryItem() + * // ... + * + * const handleCreate = (variantId: string) => { + * createInventoryItem.mutate({ + * variant_id: variantId, + * }, { + * onSuccess: ({ inventory_item }) => { + * console.log(inventory_item.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateInventoryItem * - lang: Shell * label: cURL * source: | @@ -185,6 +209,7 @@ function generateAttachInventoryToVariantHandler( /** * @schema AdminPostInventoryItemsReq * type: object + * description: "The details of the inventory item to create." * required: * - variant_id * properties: diff --git a/packages/medusa/src/api/routes/admin/inventory-items/create-location-level.ts b/packages/medusa/src/api/routes/admin/inventory-items/create-location-level.ts index e76fbb85c31e6..7f48b54abbe35 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/create-location-level.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/create-location-level.ts @@ -35,6 +35,40 @@ import { FindParams } from "../../../../types/common" * .then(({ inventory_item }) => { * console.log(inventory_item.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateLocationLevel } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const createLocationLevel = useAdminCreateLocationLevel( + * inventoryItemId + * ) + * // ... + * + * const handleCreateLocationLevel = ( + * locationId: string, + * stockedQuantity: number + * ) => { + * createLocationLevel.mutate({ + * location_id: locationId, + * stocked_quantity: stockedQuantity, + * }, { + * onSuccess: ({ inventory_item }) => { + * console.log(inventory_item.id) + * } + * }) + * } + * + * // ... + * } + * + * export default InventoryItem * - lang: Shell * label: cURL * source: | @@ -107,6 +141,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostInventoryItemsItemLocationLevelsReq * type: object + * description: "The details of the location level to create." * required: * - location_id * - stocked_quantity diff --git a/packages/medusa/src/api/routes/admin/inventory-items/delete-inventory-item.ts b/packages/medusa/src/api/routes/admin/inventory-items/delete-inventory-item.ts index 4558f2cc6bef8..df439c5eea72c 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/delete-inventory-item.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/delete-inventory-item.ts @@ -24,6 +24,30 @@ import { ProductVariantInventoryService } from "../../../../services" * .then(({ id, object, deleted }) => { * console.log(id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteInventoryItem } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const deleteInventoryItem = useAdminDeleteInventoryItem( + * inventoryItemId + * ) + * // ... + * + * const handleDelete = () => { + * deleteInventoryItem.mutate() + * } + * + * // ... + * } + * + * export default InventoryItem * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/inventory-items/delete-location-level.ts b/packages/medusa/src/api/routes/admin/inventory-items/delete-location-level.ts index 572cc3341b97c..6ea718823293f 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/delete-location-level.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/delete-location-level.ts @@ -25,6 +25,32 @@ import { EntityManager } from "typeorm" * .then(({ inventory_item }) => { * console.log(inventory_item.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteLocationLevel } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const deleteLocationLevel = useAdminDeleteLocationLevel( + * inventoryItemId + * ) + * // ... + * + * const handleDelete = ( + * locationId: string + * ) => { + * deleteLocationLevel.mutate(locationId) + * } + * + * // ... + * } + * + * export default InventoryItem * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/inventory-items/get-inventory-item.ts b/packages/medusa/src/api/routes/admin/inventory-items/get-inventory-item.ts index e18dcf7bc1601..92aa730a53294 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/get-inventory-item.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/get-inventory-item.ts @@ -27,6 +27,33 @@ import { joinLevels } from "./utils/join-levels" * .then(({ inventory_item }) => { * console.log(inventory_item.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminInventoryItem } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const { + * inventory_item, + * isLoading + * } = useAdminInventoryItem(inventoryItemId) + * + * return ( + *
+ * {isLoading && Loading...} + * {inventory_item && ( + * {inventory_item.sku} + * )} + *
+ * ) + * } + * + * export default InventoryItem * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/inventory-items/list-inventory-items.ts b/packages/medusa/src/api/routes/admin/inventory-items/list-inventory-items.ts index 7b546d3a31c13..b96f371ea3e09 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/list-inventory-items.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/list-inventory-items.ts @@ -77,6 +77,38 @@ import { Transform } from "class-transformer" * .then(({ inventory_items, count, offset, limit }) => { * console.log(inventory_items.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminInventoryItems } from "medusa-react" + * + * function InventoryItems() { + * const { + * inventory_items, + * isLoading + * } = useAdminInventoryItems() + * + * return ( + *
+ * {isLoading && Loading...} + * {inventory_items && !inventory_items.length && ( + * No Items + * )} + * {inventory_items && inventory_items.length > 0 && ( + *
    + * {inventory_items.map( + * (item) => ( + *
  • {item.id}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default InventoryItems * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/inventory-items/list-location-levels.ts b/packages/medusa/src/api/routes/admin/inventory-items/list-location-levels.ts index 9c919211caef9..bb7c86e23950a 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/list-location-levels.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/list-location-levels.ts @@ -38,6 +38,39 @@ import { IsType } from "../../../../utils/validators/is-type" * .then(({ inventory_item }) => { * console.log(inventory_item.location_levels); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminInventoryItemLocationLevels, + * } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const { + * inventory_item, + * isLoading, + * } = useAdminInventoryItemLocationLevels(inventoryItemId) + * + * return ( + *
+ * {isLoading && Loading...} + * {inventory_item && ( + *
    + * {inventory_item.location_levels.map((level) => ( + * {level.stocked_quantity} + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default InventoryItem * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/inventory-items/update-inventory-item.ts b/packages/medusa/src/api/routes/admin/inventory-items/update-inventory-item.ts index 6beff0463648a..7013ff2e95b02 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/update-inventory-item.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/update-inventory-item.ts @@ -36,6 +36,36 @@ import { IInventoryService } from "@medusajs/types" * .then(({ inventory_item }) => { * console.log(inventory_item.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateInventoryItem } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const updateInventoryItem = useAdminUpdateInventoryItem( + * inventoryItemId + * ) + * // ... + * + * const handleUpdate = (origin_country: string) => { + * updateInventoryItem.mutate({ + * origin_country, + * }, { + * onSuccess: ({ inventory_item }) => { + * console.log(inventory_item.origin_country) + * } + * }) + * } + * + * // ... + * } + * + * export default InventoryItem * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/inventory-items/update-location-level.ts b/packages/medusa/src/api/routes/admin/inventory-items/update-location-level.ts index c150c6d6996e8..50f196ca258ec 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/update-location-level.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/update-location-level.ts @@ -36,6 +36,40 @@ import { FindParams } from "../../../../types/common" * .then(({ inventory_item }) => { * console.log(inventory_item.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateLocationLevel } from "medusa-react" + * + * type Props = { + * inventoryItemId: string + * } + * + * const InventoryItem = ({ inventoryItemId }: Props) => { + * const updateLocationLevel = useAdminUpdateLocationLevel( + * inventoryItemId + * ) + * // ... + * + * const handleUpdate = ( + * stockLocationId: string, + * stocked_quantity: number + * ) => { + * updateLocationLevel.mutate({ + * stockLocationId, + * stocked_quantity, + * }, { + * onSuccess: ({ inventory_item }) => { + * console.log(inventory_item.id) + * } + * }) + * } + * + * // ... + * } + * + * export default InventoryItem * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/invites/accept-invite.ts b/packages/medusa/src/api/routes/admin/invites/accept-invite.ts index 7651b8af49d28..93d738ba6dd7f 100644 --- a/packages/medusa/src/api/routes/admin/invites/accept-invite.ts +++ b/packages/medusa/src/api/routes/admin/invites/accept-invite.ts @@ -44,6 +44,40 @@ import { EntityManager } from "typeorm" * .catch(() => { * // an error occurred * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminAcceptInvite } from "medusa-react" + * + * const AcceptInvite = () => { + * const acceptInvite = useAdminAcceptInvite() + * // ... + * + * const handleAccept = ( + * token: string, + * firstName: string, + * lastName: string, + * password: string + * ) => { + * acceptInvite.mutate({ + * token, + * user: { + * first_name: firstName, + * last_name: lastName, + * password, + * }, + * }, { + * onSuccess: () => { + * // invite accepted successfully. + * } + * }) + * } + * + * // ... + * } + * + * export default AcceptInvite * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/invites/delete-invite.ts b/packages/medusa/src/api/routes/admin/invites/delete-invite.ts index ea37448f0e009..f78fa15d5db91 100644 --- a/packages/medusa/src/api/routes/admin/invites/delete-invite.ts +++ b/packages/medusa/src/api/routes/admin/invites/delete-invite.ts @@ -22,6 +22,32 @@ import InviteService from "../../../../services/invite" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteInvite } from "medusa-react" + * + * type Props = { + * inviteId: string + * } + * + * const DeleteInvite = ({ inviteId }: Props) => { + * const deleteInvite = useAdminDeleteInvite(inviteId) + * // ... + * + * const handleDelete = () => { + * deleteInvite.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Invite * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/invites/resend-invite.ts b/packages/medusa/src/api/routes/admin/invites/resend-invite.ts index 4a9d53130f722..9ec67117960cd 100644 --- a/packages/medusa/src/api/routes/admin/invites/resend-invite.ts +++ b/packages/medusa/src/api/routes/admin/invites/resend-invite.ts @@ -26,6 +26,32 @@ import { EntityManager } from "typeorm" * .catch(() => { * // an error occurred * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminResendInvite } from "medusa-react" + * + * type Props = { + * inviteId: string + * } + * + * const ResendInvite = ({ inviteId }: Props) => { + * const resendInvite = useAdminResendInvite(inviteId) + * // ... + * + * const handleResend = () => { + * resendInvite.mutate(void 0, { + * onSuccess: () => { + * // invite resent successfully + * } + * }) + * } + * + * // ... + * } + * + * export default ResendInvite * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/notes/create-note.ts b/packages/medusa/src/api/routes/admin/notes/create-note.ts index 3ee5e01c61df3..fbc454ff06537 100644 --- a/packages/medusa/src/api/routes/admin/notes/create-note.ts +++ b/packages/medusa/src/api/routes/admin/notes/create-note.ts @@ -32,6 +32,32 @@ import { EntityManager } from "typeorm" * .then(({ note }) => { * console.log(note.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateNote } from "medusa-react" + * + * const CreateNote = () => { + * const createNote = useAdminCreateNote() + * // ... + * + * const handleCreate = () => { + * createNote.mutate({ + * resource_id: "order_123", + * resource_type: "order", + * value: "We delivered this order" + * }, { + * onSuccess: ({ note }) => { + * console.log(note.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateNote * - lang: Shell * label: cURL * source: | @@ -93,6 +119,7 @@ export default async (req, res) => { /** * @schema AdminPostNotesReq * type: object + * description: "The details of the note to be created." * required: * - resource_id * - resource_type diff --git a/packages/medusa/src/api/routes/admin/notes/delete-note.ts b/packages/medusa/src/api/routes/admin/notes/delete-note.ts index dc72e14a74c0d..41d19dee5f74d 100644 --- a/packages/medusa/src/api/routes/admin/notes/delete-note.ts +++ b/packages/medusa/src/api/routes/admin/notes/delete-note.ts @@ -22,6 +22,28 @@ import NoteService from "../../../../services/note" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteNote } from "medusa-react" + * + * type Props = { + * noteId: string + * } + * + * const Note = ({ noteId }: Props) => { + * const deleteNote = useAdminDeleteNote(noteId) + * // ... + * + * const handleDelete = () => { + * deleteNote.mutate() + * } + * + * // ... + * } + * + * export default Note * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/notes/get-note.ts b/packages/medusa/src/api/routes/admin/notes/get-note.ts index e2e37b061ac30..26a95e4ed9139 100644 --- a/packages/medusa/src/api/routes/admin/notes/get-note.ts +++ b/packages/medusa/src/api/routes/admin/notes/get-note.ts @@ -21,6 +21,28 @@ import NoteService from "../../../../services/note" * .then(({ note }) => { * console.log(note.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminNote } from "medusa-react" + * + * type Props = { + * noteId: string + * } + * + * const Note = ({ noteId }: Props) => { + * const { note, isLoading } = useAdminNote(noteId) + * + * return ( + *
+ * {isLoading && Loading...} + * {note && {note.resource_type}} + *
+ * ) + * } + * + * export default Note * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/notes/list-notes.ts b/packages/medusa/src/api/routes/admin/notes/list-notes.ts index 99588bac99a0c..c5441682c8364 100644 --- a/packages/medusa/src/api/routes/admin/notes/list-notes.ts +++ b/packages/medusa/src/api/routes/admin/notes/list-notes.ts @@ -29,6 +29,31 @@ import { validator } from "../../../../utils/validator" * .then(({ notes, limit, offset, count }) => { * console.log(notes.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminNotes } from "medusa-react" + * + * const Notes = () => { + * const { notes, isLoading } = useAdminNotes() + * + * return ( + *
+ * {isLoading && Loading...} + * {notes && !notes.length && No Notes} + * {notes && notes.length > 0 && ( + *
    + * {notes.map((note) => ( + *
  • {note.resource_type}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Notes * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/notes/update-note.ts b/packages/medusa/src/api/routes/admin/notes/update-note.ts index c02c8adc64028..9e510cb161412 100644 --- a/packages/medusa/src/api/routes/admin/notes/update-note.ts +++ b/packages/medusa/src/api/routes/admin/notes/update-note.ts @@ -31,6 +31,36 @@ import { EntityManager } from "typeorm" * .then(({ note }) => { * console.log(note.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateNote } from "medusa-react" + * + * type Props = { + * noteId: string + * } + * + * const Note = ({ noteId }: Props) => { + * const updateNote = useAdminUpdateNote(noteId) + * // ... + * + * const handleUpdate = ( + * value: string + * ) => { + * updateNote.mutate({ + * value + * }, { + * onSuccess: ({ note }) => { + * console.log(note.value) + * } + * }) + * } + * + * // ... + * } + * + * export default Note * - lang: Shell * label: cURL * source: | @@ -85,6 +115,7 @@ export default async (req, res) => { /** * @schema AdminPostNotesNoteReq * type: object + * description: "The details to update of the note." * required: * - value * properties: diff --git a/packages/medusa/src/api/routes/admin/notifications/list-notifications.ts b/packages/medusa/src/api/routes/admin/notifications/list-notifications.ts index 3d58548af8f0b..992cb4417494b 100644 --- a/packages/medusa/src/api/routes/admin/notifications/list-notifications.ts +++ b/packages/medusa/src/api/routes/admin/notifications/list-notifications.ts @@ -41,6 +41,33 @@ import { validator } from "../../../../utils/validator" * .then(({ notifications }) => { * console.log(notifications.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminNotifications } from "medusa-react" + * + * const Notifications = () => { + * const { notifications, isLoading } = useAdminNotifications() + * + * return ( + *
+ * {isLoading && Loading...} + * {notifications && !notifications.length && ( + * No Notifications + * )} + * {notifications && notifications.length > 0 && ( + *
    + * {notifications.map((notification) => ( + *
  • {notification.to}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Notifications * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/notifications/resend-notification.ts b/packages/medusa/src/api/routes/admin/notifications/resend-notification.ts index 341317bd4fba8..d7f0ccd2d9801 100644 --- a/packages/medusa/src/api/routes/admin/notifications/resend-notification.ts +++ b/packages/medusa/src/api/routes/admin/notifications/resend-notification.ts @@ -35,6 +35,34 @@ import { validator } from "../../../../utils/validator" * .then(({ notification }) => { * console.log(notification.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminResendNotification } from "medusa-react" + * + * type Props = { + * notificationId: string + * } + * + * const Notification = ({ notificationId }: Props) => { + * const resendNotification = useAdminResendNotification( + * notificationId + * ) + * // ... + * + * const handleResend = () => { + * resendNotification.mutate({}, { + * onSuccess: ({ notification }) => { + * console.log(notification.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Notification * - lang: Shell * label: cURL * source: | @@ -102,6 +130,7 @@ export default async (req, res) => { /** * @schema AdminPostNotificationsNotificationResendReq * type: object + * description: "The resend details." * properties: * to: * description: >- diff --git a/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts b/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts index af4bc96ad175a..6118255489410 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts @@ -38,6 +38,37 @@ import { * .then(({ order_edit }) => { * console.log(order_edit.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminOrderEditAddLineItem } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const addLineItem = useAdminOrderEditAddLineItem( + * orderEditId + * ) + * + * const handleAddLineItem = + * (quantity: number, variantId: string) => { + * addLineItem.mutate({ + * quantity, + * variant_id: variantId, + * }, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.changes) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit * - lang: Shell * label: cURL * source: | @@ -103,6 +134,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostOrderEditsEditLineItemsReq * type: object + * description: "The details of the line item change to create." * required: * - variant_id * - quantity diff --git a/packages/medusa/src/api/routes/admin/order-edits/cancel-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/cancel-order-edit.ts index c7174754ac814..8ba987ae5d420 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/cancel-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/cancel-order-edit.ts @@ -27,6 +27,38 @@ import { * .then(({ order_edit }) => { * console.log(order_edit.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminCancelOrderEdit + * } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const cancelOrderEdit = + * useAdminCancelOrderEdit( + * orderEditId + * ) + * + * const handleCancel = () => { + * cancelOrderEdit.mutate(void 0, { + * onSuccess: ({ order_edit }) => { + * console.log( + * order_edit.id + * ) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/order-edits/confirm-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/confirm-order-edit.ts index fd9c959ed244d..cfd4c070b741a 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/confirm-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/confirm-order-edit.ts @@ -27,6 +27,36 @@ import { * .then(({ order_edit }) => { * console.log(order_edit.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminConfirmOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const confirmOrderEdit = useAdminConfirmOrderEdit( + * orderEditId + * ) + * + * const handleConfirmOrderEdit = () => { + * confirmOrderEdit.mutate(void 0, { + * onSuccess: ({ order_edit }) => { + * console.log( + * order_edit.confirmed_at, + * order_edit.confirmed_by + * ) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/order-edits/create-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/create-order-edit.ts index 3b83180c6e803..2ff425f514caa 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/create-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/create-order-edit.ts @@ -31,6 +31,29 @@ import { * .then(({ order_edit }) => { * console.log(order_edit.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateOrderEdit } from "medusa-react" + * + * const CreateOrderEdit = () => { + * const createOrderEdit = useAdminCreateOrderEdit() + * + * const handleCreateOrderEdit = (orderId: string) => { + * createOrderEdit.mutate({ + * order_id: orderId, + * }, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateOrderEdit * - lang: Shell * label: cURL * source: | @@ -93,6 +116,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostOrderEditsReq * type: object + * description: "The details of the order edit to create." * required: * - order_id * properties: diff --git a/packages/medusa/src/api/routes/admin/order-edits/delete-line-item.ts b/packages/medusa/src/api/routes/admin/order-edits/delete-line-item.ts index 365bc74fca0dc..2737dbd1613c2 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/delete-line-item.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/delete-line-item.ts @@ -29,6 +29,38 @@ import { * .then(({ order_edit }) => { * console.log(order_edit.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminOrderEditDeleteLineItem } from "medusa-react" + * + * type Props = { + * orderEditId: string + * itemId: string + * } + * + * const OrderEditLineItem = ({ + * orderEditId, + * itemId + * }: Props) => { + * const removeLineItem = useAdminOrderEditDeleteLineItem( + * orderEditId, + * itemId + * ) + * + * const handleRemoveLineItem = () => { + * removeLineItem.mutate(void 0, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.changes) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEditLineItem * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit-item-change.ts b/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit-item-change.ts index 182cd0f349dd5..a5d1dfb4feb9d 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit-item-change.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit-item-change.ts @@ -23,6 +23,38 @@ import { OrderEditService } from "../../../../services" * .then(({ id, object, deleted }) => { * console.log(id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteOrderEditItemChange } from "medusa-react" + * + * type Props = { + * orderEditId: string + * itemChangeId: string + * } + * + * const OrderEditItemChange = ({ + * orderEditId, + * itemChangeId + * }: Props) => { + * const deleteItemChange = useAdminDeleteOrderEditItemChange( + * orderEditId, + * itemChangeId + * ) + * + * const handleDeleteItemChange = () => { + * deleteItemChange.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEditItemChange * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit.ts index 60801ab7795f2..af3b99b3577c5 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit.ts @@ -22,6 +22,33 @@ import { OrderEditService } from "../../../../services" * .then(({ id, object, deleted }) => { * console.log(id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const deleteOrderEdit = useAdminDeleteOrderEdit( + * orderEditId + * ) + * + * const handleDelete = () => { + * deleteOrderEdit.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/order-edits/get-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/get-order-edit.ts index c5a3149b599a1..a153dc536ac63 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/get-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/get-order-edit.ts @@ -26,6 +26,31 @@ import { FindParams } from "../../../../types/common" * .then(({ order_edit }) => { * console.log(order_edit.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const { + * order_edit, + * isLoading, + * } = useAdminOrderEdit(orderEditId) + * + * return ( + *
+ * {isLoading && Loading...} + * {order_edit && {order_edit.status}} + *
+ * ) + * } + * + * export default OrderEdit * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/order-edits/list-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/list-order-edit.ts index 5b77995742194..6486ea5990157 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/list-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/list-order-edit.ts @@ -30,6 +30,35 @@ import { IsOptional, IsString } from "class-validator" * .then(({ order_edits, count, limit, offset }) => { * console.log(order_edits.length) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminOrderEdits } from "medusa-react" + * + * const OrderEdits = () => { + * const { order_edits, isLoading } = useAdminOrderEdits() + * + * return ( + *
+ * {isLoading && Loading...} + * {order_edits && !order_edits.length && ( + * No Order Edits + * )} + * {order_edits && order_edits.length > 0 && ( + *
    + * {order_edits.map((orderEdit) => ( + *
  • + * {orderEdit.status} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default OrderEdits * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/order-edits/request-confirmation.ts b/packages/medusa/src/api/routes/admin/order-edits/request-confirmation.ts index 04a0bec0db9d8..a5ba7dc102dde 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/request-confirmation.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/request-confirmation.ts @@ -33,6 +33,39 @@ import { * .then({ order_edit }) => { * console.log(order_edit.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminRequestOrderEditConfirmation, + * } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const requestOrderConfirmation = + * useAdminRequestOrderEditConfirmation( + * orderEditId + * ) + * + * const handleRequestConfirmation = () => { + * requestOrderConfirmation.mutate(void 0, { + * onSuccess: ({ order_edit }) => { + * console.log( + * order_edit.requested_at, + * order_edit.requested_by + * ) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/order-edits/update-order-edit-line-item.ts b/packages/medusa/src/api/routes/admin/order-edits/update-order-edit-line-item.ts index 5b2388bb52906..7467cc535c29b 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/update-order-edit-line-item.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/update-order-edit-line-item.ts @@ -37,6 +37,40 @@ import { * .then(({ order_edit }) => { * console.log(order_edit.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminOrderEditUpdateLineItem } from "medusa-react" + * + * type Props = { + * orderEditId: string + * itemId: string + * } + * + * const OrderEditItemChange = ({ + * orderEditId, + * itemId + * }: Props) => { + * const updateLineItem = useAdminOrderEditUpdateLineItem( + * orderEditId, + * itemId + * ) + * + * const handleUpdateLineItem = (quantity: number) => { + * updateLineItem.mutate({ + * quantity, + * }, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.items) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEditItemChange * - lang: Shell * label: cURL * source: | @@ -106,6 +140,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostOrderEditsEditLineItemsLineItemReq * type: object + * description: "The details to create or update of the line item change." * required: * - quantity * properties: diff --git a/packages/medusa/src/api/routes/admin/order-edits/update-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/update-order-edit.ts index 257a21cf518e9..50cabc6ab8ad5 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/update-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/update-order-edit.ts @@ -36,6 +36,37 @@ import { * .then(({ order_edit }) => { * console.log(order_edit.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const updateOrderEdit = useAdminUpdateOrderEdit( + * orderEditId, + * ) + * + * const handleUpdate = ( + * internalNote: string + * ) => { + * updateOrderEdit.mutate({ + * internal_note: internalNote + * }, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.internal_note) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit * - lang: Shell * label: cURL * source: | @@ -102,6 +133,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostOrderEditsOrderEditReq * type: object + * description: "The details to update of the order edit." * properties: * internal_note: * description: An optional note to create or update in the order edit. diff --git a/packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts b/packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts index 8d61f46332148..046dc0a316c11 100644 --- a/packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts +++ b/packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts @@ -43,6 +43,40 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminAddShippingMethod } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const addShippingMethod = useAdminAddShippingMethod( + * orderId + * ) + * // ... + * + * const handleAddShippingMethod = ( + * optionId: string, + * price: number + * ) => { + * addShippingMethod.mutate({ + * option_id: optionId, + * price + * }, { + * onSuccess: ({ order }) => { + * console.log(order.shipping_methods) + * } + * }) + * } + * + * // ... + * } + * + * export default Order * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/archive-order.ts b/packages/medusa/src/api/routes/admin/orders/archive-order.ts index dbd2b86ed6247..b608108e47e10 100644 --- a/packages/medusa/src/api/routes/admin/orders/archive-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/archive-order.ts @@ -27,6 +27,34 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminArchiveOrder } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const archiveOrder = useAdminArchiveOrder( + * orderId + * ) + * // ... + * + * const handleArchivingOrder = () => { + * archiveOrder.mutate(void 0, { + * onSuccess: ({ order }) => { + * console.log(order.status) + * } + * }) + * } + * + * // ... + * } + * + * export default Order * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts b/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts index 931d68fd72445..58e63aba5d15e 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts @@ -33,6 +33,29 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCancelClaim } from "medusa-react" + * + * type Props = { + * orderId: string + * claimId: string + * } + * + * const Claim = ({ orderId, claimId }: Props) => { + * const cancelClaim = useAdminCancelClaim(orderId) + * // ... + * + * const handleCancel = () => { + * cancelClaim.mutate(claimId) + * } + * + * // ... + * } + * + * export default Claim * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts index 6615d48c0117d..b00d2b5285068 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts @@ -35,6 +35,38 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCancelClaimFulfillment } from "medusa-react" + * + * type Props = { + * orderId: string + * claimId: string + * } + * + * const Claim = ({ orderId, claimId }: Props) => { + * const cancelFulfillment = useAdminCancelClaimFulfillment( + * orderId + * ) + * // ... + * + * const handleCancel = (fulfillmentId: string) => { + * cancelFulfillment.mutate({ + * claim_id: claimId, + * fulfillment_id: fulfillmentId, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.claims) + * } + * }) + * } + * + * // ... + * } + * + * export default Claim * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts index 3605336255227..c0b6092917e22 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts @@ -35,6 +35,39 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCancelSwapFulfillment } from "medusa-react" + * + * type Props = { + * orderId: string, + * swapId: string + * } + * + * const Swap = ({ + * orderId, + * swapId + * }: Props) => { + * const cancelFulfillment = useAdminCancelSwapFulfillment( + * orderId + * ) + * // ... + * + * const handleCancelFulfillment = ( + * fulfillmentId: string + * ) => { + * cancelFulfillment.mutate({ + * swap_id: swapId, + * fulfillment_id: fulfillmentId, + * }) + * } + * + * // ... + * } + * + * export default Swap * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts index 7b9015f21c62e..0bde669cc64be 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts @@ -37,6 +37,36 @@ import { promiseAll } from "@medusajs/utils" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCancelFulfillment } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const cancelFulfillment = useAdminCancelFulfillment( + * orderId + * ) + * // ... + * + * const handleCancel = ( + * fulfillmentId: string + * ) => { + * cancelFulfillment.mutate(fulfillmentId, { + * onSuccess: ({ order }) => { + * console.log(order.fulfillments) + * } + * }) + * } + * + * // ... + * } + * + * export default Order * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-order.ts b/packages/medusa/src/api/routes/admin/orders/cancel-order.ts index 8d46efa2c635a..fed6709062229 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-order.ts @@ -27,6 +27,34 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCancelOrder } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const cancelOrder = useAdminCancelOrder( + * orderId + * ) + * // ... + * + * const handleCancel = () => { + * cancelOrder.mutate(void 0, { + * onSuccess: ({ order }) => { + * console.log(order.status) + * } + * }) + * } + * + * // ... + * } + * + * export default Order * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts b/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts index 818ef39acddde..112a8a7ff7235 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts @@ -33,6 +33,38 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCancelSwap } from "medusa-react" + * + * type Props = { + * orderId: string, + * swapId: string + * } + * + * const Swap = ({ + * orderId, + * swapId + * }: Props) => { + * const cancelSwap = useAdminCancelSwap( + * orderId + * ) + * // ... + * + * const handleCancel = () => { + * cancelSwap.mutate(swapId, { + * onSuccess: ({ order }) => { + * console.log(order.swaps) + * } + * }) + * } + * + * // ... + * } + * + * export default Swap * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/capture-payment.ts b/packages/medusa/src/api/routes/admin/orders/capture-payment.ts index f2d310376e21c..5db0f6ec38014 100644 --- a/packages/medusa/src/api/routes/admin/orders/capture-payment.ts +++ b/packages/medusa/src/api/routes/admin/orders/capture-payment.ts @@ -27,6 +27,34 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCapturePayment } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const capturePayment = useAdminCapturePayment( + * orderId + * ) + * // ... + * + * const handleCapture = () => { + * capturePayment.mutate(void 0, { + * onSuccess: ({ order }) => { + * console.log(order.status) + * } + * }) + * } + * + * // ... + * } + * + * export default Order * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/complete-order.ts b/packages/medusa/src/api/routes/admin/orders/complete-order.ts index dc9af196bff2e..0461342d25a14 100644 --- a/packages/medusa/src/api/routes/admin/orders/complete-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/complete-order.ts @@ -27,6 +27,34 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCompleteOrder } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const completeOrder = useAdminCompleteOrder( + * orderId + * ) + * // ... + * + * const handleComplete = () => { + * completeOrder.mutate(void 0, { + * onSuccess: ({ order }) => { + * console.log(order.status) + * } + * }) + * } + * + * // ... + * } + * + * export default Order * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts b/packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts index 129e0d445d151..3374f03eaf8d2 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts @@ -40,6 +40,36 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateClaimShipment } from "medusa-react" + * + * type Props = { + * orderId: string + * claimId: string + * } + * + * const Claim = ({ orderId, claimId }: Props) => { + * const createShipment = useAdminCreateClaimShipment(orderId) + * // ... + * + * const handleCreateShipment = (fulfillmentId: string) => { + * createShipment.mutate({ + * claim_id: claimId, + * fulfillment_id: fulfillmentId, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.claims) + * } + * }) + * } + * + * // ... + * } + * + * export default Claim * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/create-claim.ts b/packages/medusa/src/api/routes/admin/orders/create-claim.ts index b87861ca8a87c..ac1c1da625024 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-claim.ts @@ -59,6 +59,42 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateClaim } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const CreateClaim = ({ orderId }: Props) => { + * + * const CreateClaim = (orderId: string) => { + * const createClaim = useAdminCreateClaim(orderId) + * // ... + * + * const handleCreate = (itemId: string) => { + * createClaim.mutate({ + * type: "refund", + * claim_items: [ + * { + * item_id: itemId, + * quantity: 1, + * }, + * ], + * }, { + * onSuccess: ({ order }) => { + * console.log(order.claims) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateClaim * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts b/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts index 73ffa4144a6ec..8b30ea60d7f97 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts @@ -61,6 +61,44 @@ import { promiseAll } from "@medusajs/utils" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateFulfillment } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const createFulfillment = useAdminCreateFulfillment( + * orderId + * ) + * // ... + * + * const handleCreateFulfillment = ( + * itemId: string, + * quantity: number + * ) => { + * createFulfillment.mutate({ + * items: [ + * { + * item_id: itemId, + * quantity, + * }, + * ], + * }, { + * onSuccess: ({ order }) => { + * console.log(order.fulfillments) + * } + * }) + * } + * + * // ... + * } + * + * export default Order * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/create-shipment.ts b/packages/medusa/src/api/routes/admin/orders/create-shipment.ts index e5e06b90afa51..c44fc59e75a77 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-shipment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-shipment.ts @@ -47,6 +47,38 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateShipment } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const createShipment = useAdminCreateShipment( + * orderId + * ) + * // ... + * + * const handleCreate = ( + * fulfillmentId: string + * ) => { + * createShipment.mutate({ + * fulfillment_id: fulfillmentId, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.fulfillment_status) + * } + * }) + * } + * + * // ... + * } + * + * export default Order * - lang: Shell * label: cURL * source: | @@ -116,6 +148,7 @@ export default async (req, res) => { /** * @schema AdminPostOrdersOrderShipmentReq * type: object + * description: "The details of the shipment to create." * required: * - fulfillment_id * properties: diff --git a/packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts b/packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts index 1a21bcc069ce0..c49bd8d6496a6 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts @@ -48,6 +48,43 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateSwapShipment } from "medusa-react" + * + * type Props = { + * orderId: string, + * swapId: string + * } + * + * const Swap = ({ + * orderId, + * swapId + * }: Props) => { + * const createShipment = useAdminCreateSwapShipment( + * orderId + * ) + * // ... + * + * const handleCreateShipment = ( + * fulfillmentId: string + * ) => { + * createShipment.mutate({ + * swap_id: swapId, + * fulfillment_id: fulfillmentId, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.swaps) + * } + * }) + * } + * + * // ... + * } + * + * export default Swap * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/create-swap.ts b/packages/medusa/src/api/routes/admin/orders/create-swap.ts index 142af710f5d4f..76c23332c962c 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-swap.ts @@ -62,6 +62,39 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateSwap } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const CreateSwap = ({ orderId }: Props) => { + * const createSwap = useAdminCreateSwap(orderId) + * // ... + * + * const handleCreate = ( + * returnItems: { + * item_id: string, + * quantity: number + * }[] + * ) => { + * createSwap.mutate({ + * return_items: returnItems + * }, { + * onSuccess: ({ order }) => { + * console.log(order.swaps) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateSwap * - lang: Shell * label: cURL * source: | @@ -268,6 +301,7 @@ export default async (req, res) => { /** * @schema AdminPostOrdersOrderSwapsReq * type: object + * description: "The details of the swap to create." * required: * - return_items * properties: diff --git a/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts b/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts index d6d7e223696e8..0e488553d211a 100644 --- a/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts @@ -45,6 +45,35 @@ import { updateInventoryAndReservations } from "./create-fulfillment" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminFulfillClaim } from "medusa-react" + * + * type Props = { + * orderId: string + * claimId: string + * } + * + * const Claim = ({ orderId, claimId }: Props) => { + * const fulfillClaim = useAdminFulfillClaim(orderId) + * // ... + * + * const handleFulfill = () => { + * fulfillClaim.mutate({ + * claim_id: claimId, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.claims) + * } + * }) + * } + * + * // ... + * } + * + * export default Claim * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts b/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts index bdb5b9d75a6ad..ee5e525a9265d 100644 --- a/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts @@ -47,6 +47,40 @@ import { updateInventoryAndReservations } from "./create-fulfillment" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminFulfillSwap } from "medusa-react" + * + * type Props = { + * orderId: string, + * swapId: string + * } + * + * const Swap = ({ + * orderId, + * swapId + * }: Props) => { + * const fulfillSwap = useAdminFulfillSwap( + * orderId + * ) + * // ... + * + * const handleFulfill = () => { + * fulfillSwap.mutate({ + * swap_id: swapId, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.swaps) + * } + * }) + * } + * + * // ... + * } + * + * export default Swap * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/get-order.ts b/packages/medusa/src/api/routes/admin/orders/get-order.ts index 2faf59ea283c2..0e58a3112f950 100644 --- a/packages/medusa/src/api/routes/admin/orders/get-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/get-order.ts @@ -27,6 +27,32 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminOrder } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const { + * order, + * isLoading, + * } = useAdminOrder(orderId) + * + * return ( + *
+ * {isLoading && Loading...} + * {order && {order.display_id}} + * + *
+ * ) + * } + * + * export default Order * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/list-orders.ts b/packages/medusa/src/api/routes/admin/orders/list-orders.ts index 8adca69618e41..af7cb3860caa6 100644 --- a/packages/medusa/src/api/routes/admin/orders/list-orders.ts +++ b/packages/medusa/src/api/routes/admin/orders/list-orders.ts @@ -166,6 +166,31 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ orders, limit, offset, count }) => { * console.log(orders.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminOrders } from "medusa-react" + * + * const Orders = () => { + * const { orders, isLoading } = useAdminOrders() + * + * return ( + *
+ * {isLoading && Loading...} + * {orders && !orders.length && No Orders} + * {orders && orders.length > 0 && ( + *
    + * {orders.map((order) => ( + *
  • {order.display_id}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Orders * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts b/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts index 39c1eeac7561a..7f28a998ccd6a 100644 --- a/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts +++ b/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts @@ -33,6 +33,38 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminProcessSwapPayment } from "medusa-react" + * + * type Props = { + * orderId: string, + * swapId: string + * } + * + * const Swap = ({ + * orderId, + * swapId + * }: Props) => { + * const processPayment = useAdminProcessSwapPayment( + * orderId + * ) + * // ... + * + * const handleProcessPayment = () => { + * processPayment.mutate(swapId, { + * onSuccess: ({ order }) => { + * console.log(order.swaps) + * } + * }) + * } + * + * // ... + * } + * + * export default Swap * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/refund-payment.ts b/packages/medusa/src/api/routes/admin/orders/refund-payment.ts index ff44959d218e2..16a6d9ecdc4d0 100644 --- a/packages/medusa/src/api/routes/admin/orders/refund-payment.ts +++ b/packages/medusa/src/api/routes/admin/orders/refund-payment.ts @@ -43,6 +43,40 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminRefundPayment } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const refundPayment = useAdminRefundPayment( + * orderId + * ) + * // ... + * + * const handleRefund = ( + * amount: number, + * reason: string + * ) => { + * refundPayment.mutate({ + * amount, + * reason, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.refunds) + * } + * }) + * } + * + * // ... + * } + * + * export default Order * - lang: Shell * label: cURL * source: | @@ -105,6 +139,7 @@ export default async (req, res) => { /** * @schema AdminPostOrdersOrderRefundsReq * type: object + * description: "The details of the order refund." * required: * - amount * - reason diff --git a/packages/medusa/src/api/routes/admin/orders/request-return.ts b/packages/medusa/src/api/routes/admin/orders/request-return.ts index 6b040344901c8..e5bc64e5c61a3 100644 --- a/packages/medusa/src/api/routes/admin/orders/request-return.ts +++ b/packages/medusa/src/api/routes/admin/orders/request-return.ts @@ -59,6 +59,44 @@ import { Logger } from "@medusajs/types" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminRequestReturn } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const requestReturn = useAdminRequestReturn( + * orderId + * ) + * // ... + * + * const handleRequestingReturn = ( + * itemId: string, + * quantity: number + * ) => { + * requestReturn.mutate({ + * items: [ + * { + * item_id: itemId, + * quantity + * } + * ] + * }, { + * onSuccess: ({ order }) => { + * console.log(order.returns) + * } + * }) + * } + * + * // ... + * } + * + * export default Order * - lang: Shell * label: cURL * source: | @@ -304,6 +342,7 @@ type ReturnObj = { /** * @schema AdminPostOrdersOrderReturnsReq * type: object + * description: "The details of the requested return." * required: * - items * properties: diff --git a/packages/medusa/src/api/routes/admin/orders/update-claim.ts b/packages/medusa/src/api/routes/admin/orders/update-claim.ts index 83dbce483f751..db1c7f237552d 100644 --- a/packages/medusa/src/api/routes/admin/orders/update-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/update-claim.ts @@ -48,6 +48,36 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateClaim } from "medusa-react" + * + * type Props = { + * orderId: string + * claimId: string + * } + * + * const Claim = ({ orderId, claimId }: Props) => { + * const updateClaim = useAdminUpdateClaim(orderId) + * // ... + * + * const handleUpdate = () => { + * updateClaim.mutate({ + * claim_id: claimId, + * no_notification: false + * }, { + * onSuccess: ({ order }) => { + * console.log(order.claims) + * } + * }) + * } + * + * // ... + * } + * + * export default Claim * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/orders/update-order.ts b/packages/medusa/src/api/routes/admin/orders/update-order.ts index 4fc44f5823efb..6bb850c5ab48d 100644 --- a/packages/medusa/src/api/routes/admin/orders/update-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/update-order.ts @@ -46,6 +46,37 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateOrder } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const updateOrder = useAdminUpdateOrder( + * orderId + * ) + * + * const handleUpdate = ( + * email: string + * ) => { + * updateOrder.mutate({ + * email, + * }, { + * onSuccess: ({ order }) => { + * console.log(order.email) + * } + * }) + * } + * + * // ... + * } + * + * export default Order * - lang: Shell * label: cURL * source: | @@ -104,6 +135,7 @@ export default async (req, res) => { /** * @schema AdminPostOrdersOrderReq * type: object + * description: "The details to update of the order." * properties: * email: * description: The email associated with the order diff --git a/packages/medusa/src/api/routes/admin/payment-collections/delete-payment-collection.ts b/packages/medusa/src/api/routes/admin/payment-collections/delete-payment-collection.ts index 2941a58e33d86..230e2ebed1f5e 100644 --- a/packages/medusa/src/api/routes/admin/payment-collections/delete-payment-collection.ts +++ b/packages/medusa/src/api/routes/admin/payment-collections/delete-payment-collection.ts @@ -21,6 +21,34 @@ import { PaymentCollectionService } from "../../../../services" * .then(({ id, object, deleted }) => { * console.log(id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeletePaymentCollection } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ paymentCollectionId }: Props) => { + * const deleteCollection = useAdminDeletePaymentCollection( + * paymentCollectionId + * ) + * // ... + * + * const handleDelete = () => { + * deleteCollection.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/payment-collections/get-payment-collection.ts b/packages/medusa/src/api/routes/admin/payment-collections/get-payment-collection.ts index 83fb077c6e22c..71406429b5fc3 100644 --- a/packages/medusa/src/api/routes/admin/payment-collections/get-payment-collection.ts +++ b/packages/medusa/src/api/routes/admin/payment-collections/get-payment-collection.ts @@ -25,6 +25,34 @@ import { FindParams } from "../../../../types/common" * .then(({ payment_collection }) => { * console.log(payment_collection.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminPaymentCollection } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ paymentCollectionId }: Props) => { + * const { + * payment_collection, + * isLoading, + * } = useAdminPaymentCollection(paymentCollectionId) + * + * return ( + *
+ * {isLoading && Loading...} + * {payment_collection && ( + * {payment_collection.status} + * )} + * + *
+ * ) + * } + * + * export default PaymentCollection * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/payment-collections/index.ts b/packages/medusa/src/api/routes/admin/payment-collections/index.ts index c2cb9cd9a95bc..84380a5975a71 100644 --- a/packages/medusa/src/api/routes/admin/payment-collections/index.ts +++ b/packages/medusa/src/api/routes/admin/payment-collections/index.ts @@ -65,6 +65,7 @@ export const defaulPaymentCollectionRelations = [ /** * @schema AdminPaymentCollectionsRes * type: object + * description: "The payment collection's details." * x-expanded-relations: * field: payment_collection * relations: diff --git a/packages/medusa/src/api/routes/admin/payment-collections/mark-authorized-payment-collection.ts b/packages/medusa/src/api/routes/admin/payment-collections/mark-authorized-payment-collection.ts index b0482acaaa281..1573774d01b52 100644 --- a/packages/medusa/src/api/routes/admin/payment-collections/mark-authorized-payment-collection.ts +++ b/packages/medusa/src/api/routes/admin/payment-collections/mark-authorized-payment-collection.ts @@ -22,6 +22,34 @@ import { PaymentCollectionService } from "../../../../services" * .then(({ payment_collection }) => { * console.log(payment_collection.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminMarkPaymentCollectionAsAuthorized } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ paymentCollectionId }: Props) => { + * const markAsAuthorized = useAdminMarkPaymentCollectionAsAuthorized( + * paymentCollectionId + * ) + * // ... + * + * const handleAuthorization = () => { + * markAsAuthorized.mutate(void 0, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.status) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts b/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts index bc3f0e1850b69..064d5a6d0468a 100644 --- a/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts +++ b/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts @@ -31,6 +31,38 @@ import { PaymentCollectionService } from "../../../../services" * .then(({ payment_collection }) => { * console.log(payment_collection.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdatePaymentCollection } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ paymentCollectionId }: Props) => { + * const updateCollection = useAdminUpdatePaymentCollection( + * paymentCollectionId + * ) + * // ... + * + * const handleUpdate = ( + * description: string + * ) => { + * updateCollection.mutate({ + * description + * }, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.description) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection * - lang: Shell * label: cURL * source: | @@ -89,6 +121,7 @@ export default async (req, res) => { /** * @schema AdminUpdatePaymentCollectionsReq * type: object + * description: "The details to update of the payment collection." * properties: * description: * description: A description to create or update the payment collection. diff --git a/packages/medusa/src/api/routes/admin/payments/capture-payment.ts b/packages/medusa/src/api/routes/admin/payments/capture-payment.ts index 658bff679f9fb..1af6f95b3db33 100644 --- a/packages/medusa/src/api/routes/admin/payments/capture-payment.ts +++ b/packages/medusa/src/api/routes/admin/payments/capture-payment.ts @@ -21,6 +21,34 @@ import { PaymentService } from "../../../../services" * .then(({ payment }) => { * console.log(payment.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminPaymentsCapturePayment } from "medusa-react" + * + * type Props = { + * paymentId: string + * } + * + * const Payment = ({ paymentId }: Props) => { + * const capture = useAdminPaymentsCapturePayment( + * paymentId + * ) + * // ... + * + * const handleCapture = () => { + * capture.mutate(void 0, { + * onSuccess: ({ payment }) => { + * console.log(payment.amount) + * } + * }) + * } + * + * // ... + * } + * + * export default Payment * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/payments/get-payment.ts b/packages/medusa/src/api/routes/admin/payments/get-payment.ts index 90e383b4f66f3..e5418db8383b2 100644 --- a/packages/medusa/src/api/routes/admin/payments/get-payment.ts +++ b/packages/medusa/src/api/routes/admin/payments/get-payment.ts @@ -23,6 +23,32 @@ import { FindParams } from "../../../../types/common" * .then(({ payment }) => { * console.log(payment.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminPayment } from "medusa-react" + * + * type Props = { + * paymentId: string + * } + * + * const Payment = ({ paymentId }: Props) => { + * const { + * payment, + * isLoading, + * } = useAdminPayment(paymentId) + * + * return ( + *
+ * {isLoading && Loading...} + * {payment && {payment.amount}} + * + *
+ * ) + * } + * + * export default Payment * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/payments/refund-payment.ts b/packages/medusa/src/api/routes/admin/payments/refund-payment.ts index 4a85689bd5ac7..d8c451021d6fe 100644 --- a/packages/medusa/src/api/routes/admin/payments/refund-payment.ts +++ b/packages/medusa/src/api/routes/admin/payments/refund-payment.ts @@ -39,6 +39,43 @@ import { PaymentService } from "../../../../services" * .then(({ payment }) => { * console.log(payment.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { RefundReason } from "@medusajs/medusa" + * import { useAdminPaymentsRefundPayment } from "medusa-react" + * + * type Props = { + * paymentId: string + * } + * + * const Payment = ({ paymentId }: Props) => { + * const refund = useAdminPaymentsRefundPayment( + * paymentId + * ) + * // ... + * + * const handleRefund = ( + * amount: number, + * reason: RefundReason, + * note: string + * ) => { + * refund.mutate({ + * amount, + * reason, + * note + * }, { + * onSuccess: ({ refund }) => { + * console.log(refund.amount) + * } + * }) + * } + * + * // ... + * } + * + * export default Payment * - lang: Shell * label: cURL * source: | @@ -96,6 +133,7 @@ export default async (req, res) => { /** * @schema AdminPostPaymentRefundsReq * type: object + * description: "The details of the refund to create." * required: * - amount * - reason diff --git a/packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts b/packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts index 2469bdfdae762..4d1d1cb423a4a 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts @@ -45,6 +45,42 @@ import { getPriceListPricingModule } from "./modules-queries" * .then(({ price_list }) => { * console.log(price_list.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreatePriceListPrices } from "medusa-react" + * + * type PriceData = { + * amount: number + * variant_id: string + * currency_code: string + * } + * + * type Props = { + * priceListId: string + * } + * + * const PriceList = ({ + * priceListId + * }: Props) => { + * const addPrices = useAdminCreatePriceListPrices(priceListId) + * // ... + * + * const handleAddPrices = (prices: PriceData[]) => { + * addPrices.mutate({ + * prices + * }, { + * onSuccess: ({ price_list }) => { + * console.log(price_list.prices) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceList * - lang: Shell * label: cURL * source: | @@ -137,6 +173,7 @@ export default async (req, res) => { /** * @schema AdminPostPriceListPricesPricesReq * type: object + * description: "The details of the prices to add." * properties: * prices: * description: The prices to update or add. diff --git a/packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts b/packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts index 6eaa97830755b..b2ed0a3e4ce42 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts @@ -65,6 +65,47 @@ import { transformOptionalDate } from "../../../../utils/validators/date-transfo * .then(({ price_list }) => { * console.log(price_list.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * PriceListStatus, + * PriceListType, + * } from "@medusajs/medusa" + * import { useAdminCreatePriceList } from "medusa-react" + * + * type CreateData = { + * name: string + * description: string + * type: PriceListType + * status: PriceListStatus + * prices: { + * amount: number + * variant_id: string + * currency_code: string + * max_quantity: number + * }[] + * } + * + * const CreatePriceList = () => { + * const createPriceList = useAdminCreatePriceList() + * // ... + * + * const handleCreate = ( + * data: CreateData + * ) => { + * createPriceList.mutate(data, { + * onSuccess: ({ price_list }) => { + * console.log(price_list.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreatePriceList * - lang: Shell * label: cURL * source: | @@ -177,6 +218,7 @@ class CustomerGroup { /** * @schema AdminPostPriceListsPriceListReq * type: object + * description: "The details of the price list to create." * required: * - name * - description diff --git a/packages/medusa/src/api/routes/admin/price-lists/delete-price-list.ts b/packages/medusa/src/api/routes/admin/price-lists/delete-price-list.ts index 3a18ef28da7d0..49493e0608a0d 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/delete-price-list.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/delete-price-list.ts @@ -25,6 +25,34 @@ import PriceListService from "../../../../services/price-list" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeletePriceList } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceList = ({ + * priceListId + * }: Props) => { + * const deletePriceList = useAdminDeletePriceList(priceListId) + * // ... + * + * const handleDelete = () => { + * deletePriceList.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceList * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts b/packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts index 7895c21027ff6..da07615e5fb60 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts @@ -36,6 +36,32 @@ import { removePriceListPrices } from "@medusajs/core-flows" * .then(({ ids, object, deleted }) => { * console.log(ids.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeletePriceListPrices } from "medusa-react" + * + * const PriceList = ( + * priceListId: string + * ) => { + * const deletePrices = useAdminDeletePriceListPrices(priceListId) + * // ... + * + * const handleDeletePrices = (priceIds: string[]) => { + * deletePrices.mutate({ + * price_ids: priceIds + * }, { + * onSuccess: ({ ids, deleted, object }) => { + * console.log(ids) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceList * - lang: Shell * label: cURL * source: | @@ -119,9 +145,10 @@ export default async (req, res) => { /** * @schema AdminDeletePriceListPricesPricesReq * type: object + * description: "The details of the prices to delete." * properties: * price_ids: - * description: The price IDs of the Money Amounts to delete. + * description: The IDs of the prices to delete. * type: array * items: * type: string diff --git a/packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts b/packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts index 52d657c1cda3a..878c43234ecfb 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts @@ -26,6 +26,41 @@ import PriceListService from "../../../../services/price-list" * .then(({ ids, object, deleted }) => { * console.log(ids.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminDeletePriceListProductPrices + * } from "medusa-react" + * + * type Props = { + * priceListId: string + * productId: string + * } + * + * const PriceListProduct = ({ + * priceListId, + * productId + * }: Props) => { + * const deleteProductPrices = useAdminDeletePriceListProductPrices( + * priceListId, + * productId + * ) + * // ... + * + * const handleDeleteProductPrices = () => { + * deleteProductPrices.mutate(void 0, { + * onSuccess: ({ ids, deleted, object }) => { + * console.log(ids) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceListProduct * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/price-lists/delete-products-prices-batch.ts b/packages/medusa/src/api/routes/admin/price-lists/delete-products-prices-batch.ts index ce0dcaa9e3074..a4d482ecd50fd 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/delete-products-prices-batch.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/delete-products-prices-batch.ts @@ -33,6 +33,38 @@ import { WorkflowTypes } from "@medusajs/types" * .then(({ ids, object, deleted }) => { * console.log(ids.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeletePriceListProductsPrices } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceList = ({ + * priceListId + * }: Props) => { + * const deleteProductsPrices = useAdminDeletePriceListProductsPrices( + * priceListId + * ) + * // ... + * + * const handleDeleteProductsPrices = (productIds: string[]) => { + * deleteProductsPrices.mutate({ + * product_ids: productIds + * }, { + * onSuccess: ({ ids, deleted, object }) => { + * console.log(ids) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceList * - lang: Shell * label: cURL * source: | @@ -130,6 +162,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminDeletePriceListsPriceListProductsPricesBatchReq * type: object + * description: "The details of the products' prices to delete." * properties: * product_ids: * description: The IDs of the products to delete their associated prices. diff --git a/packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts b/packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts index debcf269f33e0..a7a7155120fbb 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts @@ -26,6 +26,41 @@ import { WorkflowTypes } from "@medusajs/types" * .then(({ ids, object, deleted }) => { * console.log(ids); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminDeletePriceListVariantPrices + * } from "medusa-react" + * + * type Props = { + * priceListId: string + * variantId: string + * } + * + * const PriceListVariant = ({ + * priceListId, + * variantId + * }: Props) => { + * const deleteVariantPrices = useAdminDeletePriceListVariantPrices( + * priceListId, + * variantId + * ) + * // ... + * + * const handleDeleteVariantPrices = () => { + * deleteVariantPrices.mutate(void 0, { + * onSuccess: ({ ids, deleted, object }) => { + * console.log(ids) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceListVariant * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts b/packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts index 9faa088f55b58..374e0d0a9979c 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts @@ -26,6 +26,33 @@ import { getPriceListPricingModule } from "./modules-queries" * .then(({ price_list }) => { * console.log(price_list.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminPriceList } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceList = ({ + * priceListId + * }: Props) => { + * const { + * price_list, + * isLoading, + * } = useAdminPriceList(priceListId) + * + * return ( + *
+ * {isLoading && Loading...} + * {price_list && {price_list.name}} + *
+ * ) + * } + * + * export default PriceList * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts b/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts index aaebd5817b2a4..70547c9fcb77c 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts @@ -149,6 +149,41 @@ import { listProducts } from "../../../../utils" * .then(({ products, limit, offset, count }) => { * console.log(products.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminPriceListProducts } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceListProducts = ({ + * priceListId + * }: Props) => { + * const { products, isLoading } = useAdminPriceListProducts( + * priceListId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {products && !products.length && ( + * No Price Lists + * )} + * {products && products.length > 0 && ( + *
    + * {products.map((product) => ( + *
  • {product.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default PriceListProducts * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/price-lists/list-price-lists.ts b/packages/medusa/src/api/routes/admin/price-lists/list-price-lists.ts index b1d3013cc3a12..2abca6686f291 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/list-price-lists.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/list-price-lists.ts @@ -131,6 +131,33 @@ import { listAndCountPriceListPricingModule } from "./modules-queries" * .then(({ price_lists, limit, offset, count }) => { * console.log(price_lists.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminPriceLists } from "medusa-react" + * + * const PriceLists = () => { + * const { price_lists, isLoading } = useAdminPriceLists() + * + * return ( + *
+ * {isLoading && Loading...} + * {price_lists && !price_lists.length && ( + * No Price Lists + * )} + * {price_lists && price_lists.length > 0 && ( + *
    + * {price_lists.map((price_list) => ( + *
  • {price_list.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default PriceLists * - lang: Shell * label: cURL * source: | @@ -170,7 +197,7 @@ export default async (req: Request, res) => { let count if (featureFlagRouter.isFeatureEnabled(MedusaV2Flag.key)) { - ;[priceLists, count] = await listAndCountPriceListPricingModule({ + [priceLists, count] = await listAndCountPriceListPricingModule({ filters: req.filterableFields, listConfig: req.listConfig, container: req.scope as MedusaContainer, diff --git a/packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts b/packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts index f6164d6611f82..a6cb94a7f127f 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts @@ -50,6 +50,38 @@ import { transformOptionalDate } from "../../../../utils/validators/date-transfo * .then(({ price_list }) => { * console.log(price_list.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdatePriceList } from "medusa-react" + * + * type Props = { + * priceListId: string + * } + * + * const PriceList = ({ + * priceListId + * }: Props) => { + * const updatePriceList = useAdminUpdatePriceList(priceListId) + * // ... + * + * const handleUpdate = ( + * endsAt: Date + * ) => { + * updatePriceList.mutate({ + * ends_at: endsAt, + * }, { + * onSuccess: ({ price_list }) => { + * console.log(price_list.ends_at) + * } + * }) + * } + * + * // ... + * } + * + * export default PriceList * - lang: Shell * label: cURL * source: | @@ -152,6 +184,7 @@ class CustomerGroup { /** * @schema AdminPostPriceListsPriceListPriceListReq * type: object + * description: "The details to update of the payment collection." * properties: * name: * description: "The name of the Price List" diff --git a/packages/medusa/src/api/routes/admin/product-categories/add-products-batch.ts b/packages/medusa/src/api/routes/admin/product-categories/add-products-batch.ts index 06b1f42998d52..bf39f94533ba3 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/add-products-batch.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/add-products-batch.ts @@ -43,6 +43,44 @@ import { FindParams } from "../../../../types/common" * .then(({ product_category }) => { * console.log(product_category.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminAddProductsToCategory } from "medusa-react" + * + * type ProductsData = { + * id: string + * } + * + * type Props = { + * productCategoryId: string + * } + * + * const Category = ({ + * productCategoryId + * }: Props) => { + * const addProducts = useAdminAddProductsToCategory( + * productCategoryId + * ) + * // ... + * + * const handleAddProducts = ( + * productIds: ProductsData[] + * ) => { + * addProducts.mutate({ + * product_ids: productIds + * }, { + * onSuccess: ({ product_category }) => { + * console.log(product_category.products) + * } + * }) + * } + * + * // ... + * } + * + * export default Category * - lang: Shell * label: cURL * source: | @@ -113,11 +151,12 @@ export default async (req: Request, res: Response): Promise => { /** * @schema AdminPostProductCategoriesCategoryProductsBatchReq * type: object + * description: "The details of the products to add to the product category." * required: * - product_ids * properties: * product_ids: - * description: The IDs of the products to add to the Product Category + * description: The IDs of the products to add to the product category * type: array * items: * type: object diff --git a/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts index 5ba81953188f5..d5b9dccfdbe9a 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts @@ -37,6 +37,32 @@ import { FindParams } from "../../../../types/common" * .then(({ product_category }) => { * console.log(product_category.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateProductCategory } from "medusa-react" + * + * const CreateCategory = () => { + * const createCategory = useAdminCreateProductCategory() + * // ... + * + * const handleCreate = ( + * name: string + * ) => { + * createCategory.mutate({ + * name, + * }, { + * onSuccess: ({ product_category }) => { + * console.log(product_category.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateCategory * - lang: Shell * label: cURL * source: | @@ -99,6 +125,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostProductCategoriesReq * type: object + * description: "The details of the product category to create." * required: * - name * properties: diff --git a/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts index d9879025b414d..a39e9cdfffe14 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts @@ -25,6 +25,36 @@ import { ProductCategoryService } from "../../../../services" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteProductCategory } from "medusa-react" + * + * type Props = { + * productCategoryId: string + * } + * + * const Category = ({ + * productCategoryId + * }: Props) => { + * const deleteCategory = useAdminDeleteProductCategory( + * productCategoryId + * ) + * // ... + * + * const handleDelete = () => { + * deleteCategory.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Category * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/product-categories/delete-products-batch.ts b/packages/medusa/src/api/routes/admin/product-categories/delete-products-batch.ts index be1c519d32a74..58246248bc15a 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/delete-products-batch.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/delete-products-batch.ts @@ -43,6 +43,44 @@ import { FindParams } from "../../../../types/common" * .then(({ product_category }) => { * console.log(product_category.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteProductsFromCategory } from "medusa-react" + * + * type ProductsData = { + * id: string + * } + * + * type Props = { + * productCategoryId: string + * } + * + * const Category = ({ + * productCategoryId + * }: Props) => { + * const deleteProducts = useAdminDeleteProductsFromCategory( + * productCategoryId + * ) + * // ... + * + * const handleDeleteProducts = ( + * productIds: ProductsData[] + * ) => { + * deleteProducts.mutate({ + * product_ids: productIds + * }, { + * onSuccess: ({ product_category }) => { + * console.log(product_category.products) + * } + * }) + * } + * + * // ... + * } + * + * export default Category * - lang: Shell * label: cURL * source: | @@ -111,11 +149,12 @@ export default async (req: Request, res: Response) => { /** * @schema AdminDeleteProductCategoriesCategoryProductsBatchReq * type: object + * description: "The details of the products to delete from the product category." * required: * - product_ids * properties: * product_ids: - * description: The IDs of the products to delete from the Product Category. + * description: The IDs of the products to delete from the product category. * type: array * items: * type: object diff --git a/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts index 553a949405f47..929aaa2b0c17e 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts @@ -29,6 +29,36 @@ import { defaultAdminProductCategoryRelations } from "." * .then(({ product_category }) => { * console.log(product_category.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminProductCategory } from "medusa-react" + * + * type Props = { + * productCategoryId: string + * } + * + * const Category = ({ + * productCategoryId + * }: Props) => { + * const { + * product_category, + * isLoading, + * } = useAdminProductCategory(productCategoryId) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_category && ( + * {product_category.name} + * )} + * + *
+ * ) + * } + * + * export default Category * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts b/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts index 4074c5dd70deb..95fc1c14ffce6 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts @@ -38,6 +38,38 @@ import { optionalBooleanMapper } from "../../../../utils/validators/is-boolean" * .then(({ product_categories, limit, offset, count }) => { * console.log(product_categories.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminProductCategories } from "medusa-react" + * + * function Categories() { + * const { + * product_categories, + * isLoading + * } = useAdminProductCategories() + * + * return ( + *
+ * {isLoading && Loading...} + * {product_categories && !product_categories.length && ( + * No Categories + * )} + * {product_categories && product_categories.length > 0 && ( + *
    + * {product_categories.map( + * (category) => ( + *
  • {category.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Categories * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts index f8e5e0da08d7d..fcd8efce0ca38 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts @@ -45,6 +45,40 @@ import { FindParams } from "../../../../types/common" * .then(({ product_category }) => { * console.log(product_category.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateProductCategory } from "medusa-react" + * + * type Props = { + * productCategoryId: string + * } + * + * const Category = ({ + * productCategoryId + * }: Props) => { + * const updateCategory = useAdminUpdateProductCategory( + * productCategoryId + * ) + * // ... + * + * const handleUpdate = ( + * name: string + * ) => { + * updateCategory.mutate({ + * name, + * }, { + * onSuccess: ({ product_category }) => { + * console.log(product_category.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Category * - lang: Shell * label: cURL * source: | @@ -108,6 +142,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostProductCategoriesCategoryReq * type: object + * description: "The details to update of the product category." * properties: * name: * type: string diff --git a/packages/medusa/src/api/routes/admin/product-tags/list-product-tags.ts b/packages/medusa/src/api/routes/admin/product-tags/list-product-tags.ts index f4114b1594e49..77327afb7b379 100644 --- a/packages/medusa/src/api/routes/admin/product-tags/list-product-tags.ts +++ b/packages/medusa/src/api/routes/admin/product-tags/list-product-tags.ts @@ -97,6 +97,38 @@ import { Request, Response } from "express" * .then(({ product_tags }) => { * console.log(product_tags.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminProductTags } from "medusa-react" + * + * function ProductTags() { + * const { + * product_tags, + * isLoading + * } = useAdminProductTags() + * + * return ( + *
+ * {isLoading && Loading...} + * {product_tags && !product_tags.length && ( + * No Product Tags + * )} + * {product_tags && product_tags.length > 0 && ( + *
    + * {product_tags.map( + * (tag) => ( + *
  • {tag.value}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default ProductTags * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/product-types/list-product-types.ts b/packages/medusa/src/api/routes/admin/product-types/list-product-types.ts index 827e10f382ac2..dc18f3c8ec313 100644 --- a/packages/medusa/src/api/routes/admin/product-types/list-product-types.ts +++ b/packages/medusa/src/api/routes/admin/product-types/list-product-types.ts @@ -96,6 +96,38 @@ import ProductTypeService from "../../../../services/product-type" * .then(({ product_types }) => { * console.log(product_types.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminProductTypes } from "medusa-react" + * + * function ProductTypes() { + * const { + * product_types, + * isLoading + * } = useAdminProductTypes() + * + * return ( + *
+ * {isLoading && Loading...} + * {product_types && !product_types.length && ( + * No Product Tags + * )} + * {product_types && product_types.length > 0 && ( + *
    + * {product_types.map( + * (type) => ( + *
  • {type.value}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default ProductTypes * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/products/add-option.ts b/packages/medusa/src/api/routes/admin/products/add-option.ts index 2f531f628cc8a..674ddbeaef374 100644 --- a/packages/medusa/src/api/routes/admin/products/add-option.ts +++ b/packages/medusa/src/api/routes/admin/products/add-option.ts @@ -33,6 +33,38 @@ import { validator } from "../../../../utils/validator" * .then(({ product }) => { * console.log(product.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateProductOption } from "medusa-react" + * + * type Props = { + * productId: string + * } + * + * const CreateProductOption = ({ productId }: Props) => { + * const createOption = useAdminCreateProductOption( + * productId + * ) + * // ... + * + * const handleCreate = ( + * title: string + * ) => { + * createOption.mutate({ + * title + * }, { + * onSuccess: ({ product }) => { + * console.log(product.options) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateProductOption * - lang: Shell * label: cURL * source: | @@ -99,6 +131,7 @@ export default async (req, res) => { /** * @schema AdminPostProductsProductOptionsReq * type: object + * description: "The details of the product option to create." * required: * - title * properties: diff --git a/packages/medusa/src/api/routes/admin/products/create-product.ts b/packages/medusa/src/api/routes/admin/products/create-product.ts index c39cc21482c7b..9a9e602002411 100644 --- a/packages/medusa/src/api/routes/admin/products/create-product.ts +++ b/packages/medusa/src/api/routes/admin/products/create-product.ts @@ -76,6 +76,57 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators * .then(({ product }) => { * console.log(product.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateProduct } from "medusa-react" + * + * type CreateProductData = { + * title: string + * is_giftcard: boolean + * discountable: boolean + * options: { + * title: string + * }[] + * variants: { + * title: string + * prices: { + * amount: number + * currency_code :string + * }[] + * options: { + * value: string + * }[] + * }[], + * collection_id: string + * categories: { + * id: string + * }[] + * type: { + * value: string + * } + * tags: { + * value: string + * }[] + * } + * + * const CreateProduct = () => { + * const createProduct = useAdminCreateProduct() + * // ... + * + * const handleCreate = (productData: CreateProductData) => { + * createProduct.mutate(productData, { + * onSuccess: ({ product }) => { + * console.log(product.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateProduct * - lang: Shell * label: cURL * source: | @@ -369,6 +420,7 @@ class ProductVariantReq { /** * @schema AdminPostProductsReq * type: object + * description: "The details of the product to create." * required: * - title * properties: diff --git a/packages/medusa/src/api/routes/admin/products/create-variant.ts b/packages/medusa/src/api/routes/admin/products/create-variant.ts index 50ea1e32e2561..2caa26d68dbe8 100644 --- a/packages/medusa/src/api/routes/admin/products/create-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/create-variant.ts @@ -71,6 +71,48 @@ import { createVariantsTransaction } from "./transaction/create-product-variant" * .then(({ product }) => { * console.log(product.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateVariant } from "medusa-react" + * + * type CreateVariantData = { + * title: string + * prices: { + * amount: number + * currency_code: string + * }[] + * options: { + * option_id: string + * value: string + * }[] + * } + * + * type Props = { + * productId: string + * } + * + * const CreateProductVariant = ({ productId }: Props) => { + * const createVariant = useAdminCreateVariant( + * productId + * ) + * // ... + * + * const handleCreate = ( + * variantData: CreateVariantData + * ) => { + * createVariant.mutate(variantData, { + * onSuccess: ({ product }) => { + * console.log(product.variants) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateProductVariant * - lang: Shell * label: cURL * source: | @@ -203,6 +245,7 @@ class ProductVariantOptionReq { /** * @schema AdminPostProductsProductVariantsReq * type: object + * description: "The details of the product variant to create." * required: * - title * - prices diff --git a/packages/medusa/src/api/routes/admin/products/delete-option.ts b/packages/medusa/src/api/routes/admin/products/delete-option.ts index d112baab03c09..aab25889f88ca 100644 --- a/packages/medusa/src/api/routes/admin/products/delete-option.ts +++ b/packages/medusa/src/api/routes/admin/products/delete-option.ts @@ -25,6 +25,38 @@ import { ProductService } from "../../../../services" * .then(({ option_id, object, deleted, product }) => { * console.log(product.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteProductOption } from "medusa-react" + * + * type Props = { + * productId: string + * optionId: string + * } + * + * const ProductOption = ({ + * productId, + * optionId + * }: Props) => { + * const deleteOption = useAdminDeleteProductOption( + * productId + * ) + * // ... + * + * const handleDelete = () => { + * deleteOption.mutate(optionId, { + * onSuccess: ({ option_id, object, deleted, product }) => { + * console.log(product.options) + * } + * }) + * } + * + * // ... + * } + * + * export default ProductOption * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/products/delete-product.ts b/packages/medusa/src/api/routes/admin/products/delete-product.ts index 5c7cf6cbe32e6..091757e6efbce 100644 --- a/packages/medusa/src/api/routes/admin/products/delete-product.ts +++ b/packages/medusa/src/api/routes/admin/products/delete-product.ts @@ -22,6 +22,34 @@ import { ProductService } from "../../../../services" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteProduct } from "medusa-react" + * + * type Props = { + * productId: string + * } + * + * const Product = ({ productId }: Props) => { + * const deleteProduct = useAdminDeleteProduct( + * productId + * ) + * // ... + * + * const handleDelete = () => { + * deleteProduct.mutate(void 0, { + * onSuccess: ({ id, object, deleted}) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Product * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/products/delete-variant.ts b/packages/medusa/src/api/routes/admin/products/delete-variant.ts index 472aaa016a6cb..32209c14f5dfd 100644 --- a/packages/medusa/src/api/routes/admin/products/delete-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/delete-variant.ts @@ -29,6 +29,38 @@ import { EntityManager } from "typeorm" * .then(({ variant_id, object, deleted, product }) => { * console.log(product.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteVariant } from "medusa-react" + * + * type Props = { + * productId: string + * variantId: string + * } + * + * const ProductVariant = ({ + * productId, + * variantId + * }: Props) => { + * const deleteVariant = useAdminDeleteVariant( + * productId + * ) + * // ... + * + * const handleDelete = () => { + * deleteVariant.mutate(variantId, { + * onSuccess: ({ variant_id, object, deleted, product }) => { + * console.log(product.variants) + * } + * }) + * } + * + * // ... + * } + * + * export default ProductVariant * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/products/get-product.ts b/packages/medusa/src/api/routes/admin/products/get-product.ts index 135505d8a4e2d..c987b1dae22a4 100644 --- a/packages/medusa/src/api/routes/admin/products/get-product.ts +++ b/packages/medusa/src/api/routes/admin/products/get-product.ts @@ -31,6 +31,32 @@ import { defaultAdminProductRemoteQueryObject } from "./index" * .then(({ product }) => { * console.log(product.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminProduct } from "medusa-react" + * + * type Props = { + * productId: string + * } + * + * const Product = ({ productId }: Props) => { + * const { + * product, + * isLoading, + * } = useAdminProduct(productId) + * + * return ( + *
+ * {isLoading && Loading...} + * {product && {product.title}} + * + *
+ * ) + * } + * + * export default Product * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/products/list-products.ts b/packages/medusa/src/api/routes/admin/products/list-products.ts index 3854e6faab4cc..f1d9200090565 100644 --- a/packages/medusa/src/api/routes/admin/products/list-products.ts +++ b/packages/medusa/src/api/routes/admin/products/list-products.ts @@ -199,6 +199,31 @@ import { FilterableProductProps } from "../../../../types/product" * .then(({ products, limit, offset, count }) => { * console.log(products.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminProducts } from "medusa-react" + * + * const Products = () => { + * const { products, isLoading } = useAdminProducts() + * + * return ( + *
+ * {isLoading && Loading...} + * {products && !products.length && No Products} + * {products && products.length > 0 && ( + *
    + * {products.map((product) => ( + *
  • {product.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Products * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts b/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts index 0145f15b0bb3c..6ab9c084999e2 100644 --- a/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts +++ b/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts @@ -19,6 +19,31 @@ import { ProductService } from "../../../../services" * .then(({ tags }) => { * console.log(tags.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminProductTagUsage } from "medusa-react" + * + * const ProductTags = (productId: string) => { + * const { tags, isLoading } = useAdminProductTagUsage() + * + * return ( + *
+ * {isLoading && Loading...} + * {tags && !tags.length && No Product Tags} + * {tags && tags.length > 0 && ( + *
    + * {tags.map((tag) => ( + *
  • {tag.value} - {tag.usage_count}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ProductTags * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/products/update-option.ts b/packages/medusa/src/api/routes/admin/products/update-option.ts index 1d11c49679109..f419282d99c1b 100644 --- a/packages/medusa/src/api/routes/admin/products/update-option.ts +++ b/packages/medusa/src/api/routes/admin/products/update-option.ts @@ -34,6 +34,43 @@ import { validator } from "../../../../utils/validator" * .then(({ product }) => { * console.log(product.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateProductOption } from "medusa-react" + * + * type Props = { + * productId: string + * optionId: string + * } + * + * const ProductOption = ({ + * productId, + * optionId + * }: Props) => { + * const updateOption = useAdminUpdateProductOption( + * productId + * ) + * // ... + * + * const handleUpdate = ( + * title: string + * ) => { + * updateOption.mutate({ + * option_id: optionId, + * title, + * }, { + * onSuccess: ({ product }) => { + * console.log(product.options) + * } + * }) + * } + * + * // ... + * } + * + * export default ProductOption * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/products/update-product.ts b/packages/medusa/src/api/routes/admin/products/update-product.ts index d7d0804e7487f..df9751885c045 100644 --- a/packages/medusa/src/api/routes/admin/products/update-product.ts +++ b/packages/medusa/src/api/routes/admin/products/update-product.ts @@ -87,6 +87,38 @@ import { validator } from "../../../../utils/validator" * .then(({ product }) => { * console.log(product.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateProduct } from "medusa-react" + * + * type Props = { + * productId: string + * } + * + * const Product = ({ productId }: Props) => { + * const updateProduct = useAdminUpdateProduct( + * productId + * ) + * // ... + * + * const handleUpdate = ( + * title: string + * ) => { + * updateProduct.mutate({ + * title, + * }, { + * onSuccess: ({ product }) => { + * console.log(product.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Product * - lang: Shell * label: cURL * source: | @@ -407,6 +439,7 @@ class ProductVariantReq { /** * @schema AdminPostProductsProductReq * type: object + * description: "The details to update of the product." * properties: * title: * description: "The title of the Product" diff --git a/packages/medusa/src/api/routes/admin/products/update-variant.ts b/packages/medusa/src/api/routes/admin/products/update-variant.ts index 967e60eff3a78..83f7630fdb752 100644 --- a/packages/medusa/src/api/routes/admin/products/update-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/update-variant.ts @@ -64,6 +64,41 @@ import { validator } from "../../../../utils/validator" * .then(({ product }) => { * console.log(product.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateVariant } from "medusa-react" + * + * type Props = { + * productId: string + * variantId: string + * } + * + * const ProductVariant = ({ + * productId, + * variantId + * }: Props) => { + * const updateVariant = useAdminUpdateVariant( + * productId + * ) + * // ... + * + * const handleUpdate = (title: string) => { + * updateVariant.mutate({ + * variant_id: variantId, + * title, + * }, { + * onSuccess: ({ product }) => { + * console.log(product.variants) + * } + * }) + * } + * + * // ... + * } + * + * export default ProductVariant * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts index 250615b7654e7..998f235259cdd 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts @@ -38,6 +38,45 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * .then(({ publishable_api_key }) => { * console.log(publishable_api_key.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminAddPublishableKeySalesChannelsBatch, + * } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const PublishableApiKey = ({ + * publishableApiKeyId + * }: Props) => { + * const addSalesChannels = + * useAdminAddPublishableKeySalesChannelsBatch( + * publishableApiKeyId + * ) + * // ... + * + * const handleAdd = (salesChannelId: string) => { + * addSalesChannels.mutate({ + * sales_channel_ids: [ + * { + * id: salesChannelId, + * }, + * ], + * }, { + * onSuccess: ({ publishable_api_key }) => { + * console.log(publishable_api_key.id) + * } + * }) + * } + * + * // ... + * } + * + * export default PublishableApiKey * - lang: Shell * label: cURL * source: | @@ -107,6 +146,7 @@ export default async (req: Request, res: Response): Promise => { /** * @schema AdminPostPublishableApiKeySalesChannelsBatchReq * type: object + * description: "The details of the sales channels to add to the publishable API key." * required: * - sales_channel_ids * properties: diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts index f1a0ec38fa30d..7e11a76f16a01 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts @@ -30,6 +30,30 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * .then(({ publishable_api_key }) => { * console.log(publishable_api_key.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreatePublishableApiKey } from "medusa-react" + * + * const CreatePublishableApiKey = () => { + * const createKey = useAdminCreatePublishableApiKey() + * // ... + * + * const handleCreate = (title: string) => { + * createKey.mutate({ + * title, + * }, { + * onSuccess: ({ publishable_api_key }) => { + * console.log(publishable_api_key.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreatePublishableApiKey * - lang: Shell * label: cURL * source: | @@ -87,6 +111,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostPublishableApiKeysReq * type: object + * description: "The details of the publishable API key to create." * required: * - title * properties: diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts index 8c0d2013190d2..cf67916134c38 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts @@ -38,6 +38,45 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * .then(({ publishable_api_key }) => { * console.log(publishable_api_key.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminRemovePublishableKeySalesChannelsBatch, + * } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const PublishableApiKey = ({ + * publishableApiKeyId + * }: Props) => { + * const deleteSalesChannels = + * useAdminRemovePublishableKeySalesChannelsBatch( + * publishableApiKeyId + * ) + * // ... + * + * const handleDelete = (salesChannelId: string) => { + * deleteSalesChannels.mutate({ + * sales_channel_ids: [ + * { + * id: salesChannelId, + * }, + * ], + * }, { + * onSuccess: ({ publishable_api_key }) => { + * console.log(publishable_api_key.id) + * } + * }) + * } + * + * // ... + * } + * + * export default PublishableApiKey * - lang: Shell * label: cURL * source: | @@ -107,6 +146,7 @@ export default async (req: Request, res: Response): Promise => { /** * @schema AdminDeletePublishableApiKeySalesChannelsBatchReq * type: object + * description: "The details of the sales channels to remove from the publishable API key." * required: * - sales_channel_ids * properties: diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts index 2c03044c85cc5..16e20bc7f754e 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts @@ -23,6 +23,36 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * .then(({ id, object, deleted }) => { * console.log(id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeletePublishableApiKey } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const PublishableApiKey = ({ + * publishableApiKeyId + * }: Props) => { + * const deleteKey = useAdminDeletePublishableApiKey( + * publishableApiKeyId + * ) + * // ... + * + * const handleDelete = () => { + * deleteKey.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default PublishableApiKey * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts index 30cf77a57099e..7ac3d20251615 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts @@ -23,6 +23,36 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * .then(({ publishable_api_key }) => { * console.log(publishable_api_key.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminPublishableApiKey, + * } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const PublishableApiKey = ({ + * publishableApiKeyId + * }: Props) => { + * const { publishable_api_key, isLoading } = + * useAdminPublishableApiKey( + * publishableApiKeyId + * ) + * + * + * return ( + *
+ * {isLoading && Loading...} + * {publishable_api_key && {publishable_api_key.title}} + *
+ * ) + * } + * + * export default PublishableApiKey * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts index 5b12577378ff8..8ee03953090f6 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts @@ -27,6 +27,44 @@ import { validator } from "../../../../utils/validator" * .then(({ sales_channels }) => { * console.log(sales_channels.length) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminPublishableApiKeySalesChannels, + * } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const SalesChannels = ({ + * publishableApiKeyId + * }: Props) => { + * const { sales_channels, isLoading } = + * useAdminPublishableApiKeySalesChannels( + * publishableApiKeyId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {sales_channels && !sales_channels.length && ( + * No Sales Channels + * )} + * {sales_channels && sales_channels.length > 0 && ( + *
    + * {sales_channels.map((salesChannel) => ( + *
  • {salesChannel.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default SalesChannels * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-keys.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-keys.ts index 37a7a09a28b62..1265ca22be11c 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-keys.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-keys.ts @@ -30,6 +30,40 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * .then(({ publishable_api_keys, count, limit, offset }) => { * console.log(publishable_api_keys) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { PublishableApiKey } from "@medusajs/medusa" + * import { useAdminPublishableApiKeys } from "medusa-react" + * + * const PublishableApiKeys = () => { + * const { publishable_api_keys, isLoading } = + * useAdminPublishableApiKeys() + * + * return ( + *
+ * {isLoading && Loading...} + * {publishable_api_keys && !publishable_api_keys.length && ( + * No Publishable API Keys + * )} + * {publishable_api_keys && + * publishable_api_keys.length > 0 && ( + *
    + * {publishable_api_keys.map( + * (publishableApiKey: PublishableApiKey) => ( + *
  • + * {publishableApiKey.title} + *
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default PublishableApiKeys * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts index ece3524f385f3..66f26336c7bbc 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts @@ -24,6 +24,36 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * .then(({ publishable_api_key }) => { * console.log(publishable_api_key.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminRevokePublishableApiKey } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const PublishableApiKey = ({ + * publishableApiKeyId + * }: Props) => { + * const revokeKey = useAdminRevokePublishableApiKey( + * publishableApiKeyId + * ) + * // ... + * + * const handleRevoke = () => { + * revokeKey.mutate(void 0, { + * onSuccess: ({ publishable_api_key }) => { + * console.log(publishable_api_key.revoked_at) + * } + * }) + * } + * + * // ... + * } + * + * export default PublishableApiKey * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts index 6d8e3692fe86a..ca405db7d9188 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts @@ -32,6 +32,38 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * .then(({ publishable_api_key }) => { * console.log(publishable_api_key.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdatePublishableApiKey } from "medusa-react" + * + * type Props = { + * publishableApiKeyId: string + * } + * + * const PublishableApiKey = ({ + * publishableApiKeyId + * }: Props) => { + * const updateKey = useAdminUpdatePublishableApiKey( + * publishableApiKeyId + * ) + * // ... + * + * const handleUpdate = (title: string) => { + * updateKey.mutate({ + * title, + * }, { + * onSuccess: ({ publishable_api_key }) => { + * console.log(publishable_api_key.id) + * } + * }) + * } + * + * // ... + * } + * + * export default PublishableApiKey * - lang: Shell * label: cURL * source: | @@ -91,6 +123,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostPublishableApiKeysPublishableApiKeyReq * type: object + * description: "The details to update of the publishable API key." * properties: * title: * description: The title of the Publishable API Key. diff --git a/packages/medusa/src/api/routes/admin/regions/add-country.ts b/packages/medusa/src/api/routes/admin/regions/add-country.ts index 3344599f57774..9462eb8a8b009 100644 --- a/packages/medusa/src/api/routes/admin/regions/add-country.ts +++ b/packages/medusa/src/api/routes/admin/regions/add-country.ts @@ -34,6 +34,38 @@ import { validator } from "../../../../utils/validator" * .then(({ region }) => { * console.log(region.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminRegionAddCountry } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const addCountry = useAdminRegionAddCountry(regionId) + * // ... + * + * const handleAddCountry = ( + * countryCode: string + * ) => { + * addCountry.mutate({ + * country_code: countryCode + * }, { + * onSuccess: ({ region }) => { + * console.log(region.countries) + * } + * }) + * } + * + * // ... + * } + * + * export default Region * - lang: Shell * label: cURL * source: | @@ -95,6 +127,7 @@ export default async (req, res) => { /** * @schema AdminPostRegionsRegionCountriesReq * type: object + * description: "The details of the country to add to the region." * required: * - country_code * properties: diff --git a/packages/medusa/src/api/routes/admin/regions/add-fulfillment-provider.ts b/packages/medusa/src/api/routes/admin/regions/add-fulfillment-provider.ts index 33a1e469a2722..4f63d4d4e66f2 100644 --- a/packages/medusa/src/api/routes/admin/regions/add-fulfillment-provider.ts +++ b/packages/medusa/src/api/routes/admin/regions/add-fulfillment-provider.ts @@ -34,6 +34,41 @@ import { validator } from "../../../../utils/validator" * .then(({ region }) => { * console.log(region.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminRegionAddFulfillmentProvider + * } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const addFulfillmentProvider = + * useAdminRegionAddFulfillmentProvider(regionId) + * // ... + * + * const handleAddFulfillmentProvider = ( + * providerId: string + * ) => { + * addFulfillmentProvider.mutate({ + * provider_id: providerId + * }, { + * onSuccess: ({ region }) => { + * console.log(region.fulfillment_providers) + * } + * }) + * } + * + * // ... + * } + * + * export default Region * - lang: Shell * label: cURL * source: | @@ -94,6 +129,7 @@ export default async (req, res) => { /** * @schema AdminPostRegionsRegionFulfillmentProvidersReq * type: object + * description: "The details of the fulfillment provider to add to the region." * required: * - provider_id * properties: diff --git a/packages/medusa/src/api/routes/admin/regions/add-payment-provider.ts b/packages/medusa/src/api/routes/admin/regions/add-payment-provider.ts index 9e8993aa9a33e..8808bd059e8ad 100644 --- a/packages/medusa/src/api/routes/admin/regions/add-payment-provider.ts +++ b/packages/medusa/src/api/routes/admin/regions/add-payment-provider.ts @@ -34,6 +34,41 @@ import { validator } from "../../../../utils/validator" * .then(({ region }) => { * console.log(region.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminRegionAddPaymentProvider + * } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const addPaymentProvider = + * useAdminRegionAddPaymentProvider(regionId) + * // ... + * + * const handleAddPaymentProvider = ( + * providerId: string + * ) => { + * addPaymentProvider.mutate({ + * provider_id: providerId + * }, { + * onSuccess: ({ region }) => { + * console.log(region.payment_providers) + * } + * }) + * } + * + * // ... + * } + * + * export default Region * - lang: Shell * label: cURL * source: | @@ -94,6 +129,7 @@ export default async (req, res) => { /** * @schema AdminPostRegionsRegionPaymentProvidersReq * type: object + * description: "The details of the payment provider to add to the region." * required: * - provider_id * properties: diff --git a/packages/medusa/src/api/routes/admin/regions/create-region.ts b/packages/medusa/src/api/routes/admin/regions/create-region.ts index 95e2013001818..aec64cc919a9b 100644 --- a/packages/medusa/src/api/routes/admin/regions/create-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/create-region.ts @@ -51,6 +51,37 @@ import { validator } from "../../../../utils/validator" * .then(({ region }) => { * console.log(region.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateRegion } from "medusa-react" + * + * type CreateData = { + * name: string + * currency_code: string + * tax_rate: number + * payment_providers: string[] + * fulfillment_providers: string[] + * countries: string[] + * } + * + * const CreateRegion = () => { + * const createRegion = useAdminCreateRegion() + * // ... + * + * const handleCreate = (regionData: CreateData) => { + * createRegion.mutate(regionData, { + * onSuccess: ({ region }) => { + * console.log(region.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateRegion * - lang: Shell * label: cURL * source: | @@ -121,6 +152,7 @@ export default async (req, res) => { /** * @schema AdminPostRegionsReq * type: object + * description: "The details of the region to create." * required: * - name * - currency_code diff --git a/packages/medusa/src/api/routes/admin/regions/delete-region.ts b/packages/medusa/src/api/routes/admin/regions/delete-region.ts index 8b486117c5a91..19dacc199bc93 100644 --- a/packages/medusa/src/api/routes/admin/regions/delete-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/delete-region.ts @@ -22,6 +22,34 @@ import RegionService from "../../../../services/region" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteRegion } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const deleteRegion = useAdminDeleteRegion(regionId) + * // ... + * + * const handleDelete = () => { + * deleteRegion.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Region * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts b/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts index 822e7241a2c8c..9d30d4f8a689d 100644 --- a/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts +++ b/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts @@ -23,6 +23,47 @@ import RegionService from "../../../../services/region" * .then(({ fulfillment_options }) => { * console.log(fulfillment_options.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminRegionFulfillmentOptions } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const { + * fulfillment_options, + * isLoading + * } = useAdminRegionFulfillmentOptions( + * regionId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {fulfillment_options && !fulfillment_options.length && ( + * No Regions + * )} + * {fulfillment_options && + * fulfillment_options.length > 0 && ( + *
    + * {fulfillment_options.map((option) => ( + *
  • + * {option.provider_id} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Region * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/regions/get-region.ts b/packages/medusa/src/api/routes/admin/regions/get-region.ts index c1fad4eff2149..5ff251c29f675 100644 --- a/packages/medusa/src/api/routes/admin/regions/get-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/get-region.ts @@ -22,6 +22,32 @@ import { FindParams } from "../../../../types/common" * .then(({ region }) => { * console.log(region.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminRegion } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const { region, isLoading } = useAdminRegion( + * regionId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {region && {region.name}} + *
+ * ) + * } + * + * export default Region * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/regions/list-regions.ts b/packages/medusa/src/api/routes/admin/regions/list-regions.ts index 031537aa8dfdb..f2a5ccae4f149 100644 --- a/packages/medusa/src/api/routes/admin/regions/list-regions.ts +++ b/packages/medusa/src/api/routes/admin/regions/list-regions.ts @@ -110,6 +110,31 @@ import { * .then(({ regions, limit, offset, count }) => { * console.log(regions.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminRegions } from "medusa-react" + * + * const Regions = () => { + * const { regions, isLoading } = useAdminRegions() + * + * return ( + *
+ * {isLoading && Loading...} + * {regions && !regions.length && No Regions} + * {regions && regions.length > 0 && ( + *
    + * {regions.map((region) => ( + *
  • {region.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Regions * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/regions/remove-country.ts b/packages/medusa/src/api/routes/admin/regions/remove-country.ts index 1175d5d52aaa6..727c3b453d44c 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-country.ts +++ b/packages/medusa/src/api/routes/admin/regions/remove-country.ts @@ -33,6 +33,36 @@ import RegionService from "../../../../services/region" * .then(({ region }) => { * console.log(region.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminRegionRemoveCountry } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const removeCountry = useAdminRegionRemoveCountry(regionId) + * // ... + * + * const handleRemoveCountry = ( + * countryCode: string + * ) => { + * removeCountry.mutate(countryCode, { + * onSuccess: ({ region }) => { + * console.log(region.countries) + * } + * }) + * } + * + * // ... + * } + * + * export default Region * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts b/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts index 36d25cc533f3d..64ad50a5cec65 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts +++ b/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts @@ -25,6 +25,39 @@ import RegionService from "../../../../services/region" * .then(({ region }) => { * console.log(region.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminRegionDeleteFulfillmentProvider + * } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const removeFulfillmentProvider = + * useAdminRegionDeleteFulfillmentProvider(regionId) + * // ... + * + * const handleRemoveFulfillmentProvider = ( + * providerId: string + * ) => { + * removeFulfillmentProvider.mutate(providerId, { + * onSuccess: ({ region }) => { + * console.log(region.fulfillment_providers) + * } + * }) + * } + * + * // ... + * } + * + * export default Region * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts b/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts index 8dd6e28b2639a..c49c47adb9046 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts +++ b/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts @@ -25,6 +25,39 @@ import RegionService from "../../../../services/region" * .then(({ region }) => { * console.log(region.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminRegionDeletePaymentProvider + * } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const removePaymentProvider = + * useAdminRegionDeletePaymentProvider(regionId) + * // ... + * + * const handleRemovePaymentProvider = ( + * providerId: string + * ) => { + * removePaymentProvider.mutate(providerId, { + * onSuccess: ({ region }) => { + * console.log(region.payment_providers) + * } + * }) + * } + * + * // ... + * } + * + * export default Region * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/regions/update-region.ts b/packages/medusa/src/api/routes/admin/regions/update-region.ts index f49531b534e1f..d00f1e891b8e8 100644 --- a/packages/medusa/src/api/routes/admin/regions/update-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/update-region.ts @@ -42,6 +42,38 @@ import { validator } from "../../../../utils/validator" * .then(({ region }) => { * console.log(region.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateRegion } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ + * regionId + * }: Props) => { + * const updateRegion = useAdminUpdateRegion(regionId) + * // ... + * + * const handleUpdate = ( + * countries: string[] + * ) => { + * updateRegion.mutate({ + * countries, + * }, { + * onSuccess: ({ region }) => { + * console.log(region.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Region * - lang: Shell * label: cURL * source: | @@ -100,6 +132,7 @@ export default async (req, res) => { /** * @schema AdminPostRegionsRegionReq * type: object + * description: "The details to update of the regions." * properties: * name: * description: "The name of the Region" diff --git a/packages/medusa/src/api/routes/admin/reservations/create-reservation.ts b/packages/medusa/src/api/routes/admin/reservations/create-reservation.ts index 67e39718386bf..de2a3a07c51b8 100644 --- a/packages/medusa/src/api/routes/admin/reservations/create-reservation.ts +++ b/packages/medusa/src/api/routes/admin/reservations/create-reservation.ts @@ -31,6 +31,36 @@ import { validateUpdateReservationQuantity } from "./utils/validate-reservation- * .then(({ reservation }) => { * console.log(reservation.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateReservation } from "medusa-react" + * + * const CreateReservation = () => { + * const createReservation = useAdminCreateReservation() + * // ... + * + * const handleCreate = ( + * locationId: string, + * inventoryItemId: string, + * quantity: number + * ) => { + * createReservation.mutate({ + * location_id: locationId, + * inventory_item_id: inventoryItemId, + * quantity, + * }, { + * onSuccess: ({ reservation }) => { + * console.log(reservation.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateReservation * - lang: Shell * label: cURL * source: | @@ -99,6 +129,7 @@ export default async (req, res) => { /** * @schema AdminPostReservationsReq * type: object + * description: "The details of the reservation to create." * required: * - location_id * - inventory_item_id diff --git a/packages/medusa/src/api/routes/admin/reservations/delete-reservation.ts b/packages/medusa/src/api/routes/admin/reservations/delete-reservation.ts index 6d919ce561cbf..49c06db629a8e 100644 --- a/packages/medusa/src/api/routes/admin/reservations/delete-reservation.ts +++ b/packages/medusa/src/api/routes/admin/reservations/delete-reservation.ts @@ -22,6 +22,34 @@ import { EntityManager } from "typeorm" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteReservation } from "medusa-react" + * + * type Props = { + * reservationId: string + * } + * + * const Reservation = ({ reservationId }: Props) => { + * const deleteReservation = useAdminDeleteReservation( + * reservationId + * ) + * // ... + * + * const handleDelete = () => { + * deleteReservation.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Reservation * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/reservations/get-reservation.ts b/packages/medusa/src/api/routes/admin/reservations/get-reservation.ts index 68738ee05fd0e..e7c02ea1b129c 100644 --- a/packages/medusa/src/api/routes/admin/reservations/get-reservation.ts +++ b/packages/medusa/src/api/routes/admin/reservations/get-reservation.ts @@ -20,6 +20,30 @@ import { MedusaError } from "@medusajs/utils" * .then(({ reservation }) => { * console.log(reservation.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminReservation } from "medusa-react" + * + * type Props = { + * reservationId: string + * } + * + * const Reservation = ({ reservationId }: Props) => { + * const { reservation, isLoading } = useAdminReservation( + * reservationId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {reservation && {reservation.inventory_item_id}} + *
+ * ) + * } + * + * export default Reservation * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/reservations/list-reservations.ts b/packages/medusa/src/api/routes/admin/reservations/list-reservations.ts index 3facc9a92c0de..fcc17481fa80f 100644 --- a/packages/medusa/src/api/routes/admin/reservations/list-reservations.ts +++ b/packages/medusa/src/api/routes/admin/reservations/list-reservations.ts @@ -126,6 +126,33 @@ import { promiseAll } from "@medusajs/utils" * .then(({ reservations, count, limit, offset }) => { * console.log(reservations.length) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminReservations } from "medusa-react" + * + * const Reservations = () => { + * const { reservations, isLoading } = useAdminReservations() + * + * return ( + *
+ * {isLoading && Loading...} + * {reservations && !reservations.length && ( + * No Reservations + * )} + * {reservations && reservations.length > 0 && ( + *
    + * {reservations.map((reservation) => ( + *
  • {reservation.quantity}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Reservations * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/reservations/update-reservation.ts b/packages/medusa/src/api/routes/admin/reservations/update-reservation.ts index 5d624c19a6b88..9901e440d473d 100644 --- a/packages/medusa/src/api/routes/admin/reservations/update-reservation.ts +++ b/packages/medusa/src/api/routes/admin/reservations/update-reservation.ts @@ -32,6 +32,34 @@ import { validateUpdateReservationQuantity } from "./utils/validate-reservation- * .then(({ reservation }) => { * console.log(reservation.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateReservation } from "medusa-react" + * + * type Props = { + * reservationId: string + * } + * + * const Reservation = ({ reservationId }: Props) => { + * const updateReservation = useAdminUpdateReservation( + * reservationId + * ) + * // ... + * + * const handleUpdate = ( + * quantity: number + * ) => { + * updateReservation.mutate({ + * quantity, + * }) + * } + * + * // ... + * } + * + * export default Reservation * - lang: Shell * label: cURL * source: | @@ -102,6 +130,7 @@ export default async (req, res) => { /** * @schema AdminPostReservationsReservationReq * type: object + * description: "The details to update of the reservation." * properties: * location_id: * description: "The ID of the location associated with the reservation." diff --git a/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts index b5a35ad4b0ac0..d3f414d684643 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts @@ -35,6 +35,34 @@ import { EntityManager } from "typeorm" * .then(({ return_reason }) => { * console.log(return_reason.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateReturnReason } from "medusa-react" + * + * const CreateReturnReason = () => { + * const createReturnReason = useAdminCreateReturnReason() + * // ... + * + * const handleCreate = ( + * label: string, + * value: string + * ) => { + * createReturnReason.mutate({ + * label, + * value, + * }, { + * onSuccess: ({ return_reason }) => { + * console.log(return_reason.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateReturnReason * - lang: Shell * label: cURL * source: | @@ -95,6 +123,7 @@ export default async (req, res) => { /** * @schema AdminPostReturnReasonsReq * type: object + * description: "The details of the return reason to create." * required: * - label * - value diff --git a/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts index 0998abdad9f05..3305b9e5b6d2e 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts @@ -22,6 +22,34 @@ import { ReturnReasonService } from "../../../../services" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteReturnReason } from "medusa-react" + * + * type Props = { + * returnReasonId: string + * } + * + * const ReturnReason = ({ returnReasonId }: Props) => { + * const deleteReturnReason = useAdminDeleteReturnReason( + * returnReasonId + * ) + * // ... + * + * const handleDelete = () => { + * deleteReturnReason.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default ReturnReason * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts index e16509fd69486..728ff1d6fe132 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts @@ -26,6 +26,30 @@ import { ReturnReasonService } from "../../../../services" * .then(({ return_reason }) => { * console.log(return_reason.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminReturnReason } from "medusa-react" + * + * type Props = { + * returnReasonId: string + * } + * + * const ReturnReason = ({ returnReasonId }: Props) => { + * const { return_reason, isLoading } = useAdminReturnReason( + * returnReasonId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {return_reason && {return_reason.label}} + *
+ * ) + * } + * + * export default ReturnReason * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/return-reasons/list-reasons.ts b/packages/medusa/src/api/routes/admin/return-reasons/list-reasons.ts index b8b3cad429f7c..80b68ff8bc1b0 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/list-reasons.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/list-reasons.ts @@ -25,6 +25,35 @@ import { Selector } from "../../../../types/common" * .then(({ return_reasons }) => { * console.log(return_reasons.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminReturnReasons } from "medusa-react" + * + * const ReturnReasons = () => { + * const { return_reasons, isLoading } = useAdminReturnReasons() + * + * return ( + *
+ * {isLoading && Loading...} + * {return_reasons && !return_reasons.length && ( + * No Return Reasons + * )} + * {return_reasons && return_reasons.length > 0 && ( + *
    + * {return_reasons.map((reason) => ( + *
  • + * {reason.label}: {reason.value} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ReturnReasons * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts index 526b9e12a9480..333eaaba0510e 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts @@ -36,6 +36,38 @@ import { EntityManager } from "typeorm" * .then(({ return_reason }) => { * console.log(return_reason.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateReturnReason } from "medusa-react" + * + * type Props = { + * returnReasonId: string + * } + * + * const ReturnReason = ({ returnReasonId }: Props) => { + * const updateReturnReason = useAdminUpdateReturnReason( + * returnReasonId + * ) + * // ... + * + * const handleUpdate = ( + * label: string + * ) => { + * updateReturnReason.mutate({ + * label, + * }, { + * onSuccess: ({ return_reason }) => { + * console.log(return_reason.label) + * } + * }) + * } + * + * // ... + * } + * + * export default ReturnReason * - lang: Shell * label: cURL * source: | @@ -98,6 +130,7 @@ export default async (req, res) => { /** * @schema AdminPostReturnReasonsReasonReq * type: object + * description: "The details to update of the return reason." * properties: * label: * description: "The label to display to the Customer." diff --git a/packages/medusa/src/api/routes/admin/returns/cancel-return.ts b/packages/medusa/src/api/routes/admin/returns/cancel-return.ts index 24f3231968215..9f2e26d25d403 100644 --- a/packages/medusa/src/api/routes/admin/returns/cancel-return.ts +++ b/packages/medusa/src/api/routes/admin/returns/cancel-return.ts @@ -22,6 +22,34 @@ import { defaultReturnCancelFields, defaultReturnCancelRelations } from "." * .then(({ order }) => { * console.log(order.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCancelReturn } from "medusa-react" + * + * type Props = { + * returnId: string + * } + * + * const Return = ({ returnId }: Props) => { + * const cancelReturn = useAdminCancelReturn( + * returnId + * ) + * // ... + * + * const handleCancel = () => { + * cancelReturn.mutate(void 0, { + * onSuccess: ({ order }) => { + * console.log(order.returns) + * } + * }) + * } + * + * // ... + * } + * + * export default Return * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/returns/list-returns.ts b/packages/medusa/src/api/routes/admin/returns/list-returns.ts index 2e7dc6aa73575..db5b3d07ca77b 100644 --- a/packages/medusa/src/api/routes/admin/returns/list-returns.ts +++ b/packages/medusa/src/api/routes/admin/returns/list-returns.ts @@ -29,6 +29,35 @@ import { validator } from "../../../../utils/validator" * .then(({ returns, limit, offset, count }) => { * console.log(returns.length) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminReturns } from "medusa-react" + * + * const Returns = () => { + * const { returns, isLoading } = useAdminReturns() + * + * return ( + *
+ * {isLoading && Loading...} + * {returns && !returns.length && ( + * No Returns + * )} + * {returns && returns.length > 0 && ( + *
    + * {returns.map((returnData) => ( + *
  • + * {returnData.status} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Returns * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/returns/receive-return.ts b/packages/medusa/src/api/routes/admin/returns/receive-return.ts index 9fb0bc6ed273b..9bca1c6af06f6 100644 --- a/packages/medusa/src/api/routes/admin/returns/receive-return.ts +++ b/packages/medusa/src/api/routes/admin/returns/receive-return.ts @@ -45,6 +45,41 @@ import { defaultRelations } from "." * .then((data) => { * console.log(data.return.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminReceiveReturn } from "medusa-react" + * + * type ReceiveReturnData = { + * items: { + * item_id: string + * quantity: number + * }[] + * } + * + * type Props = { + * returnId: string + * } + * + * const Return = ({ returnId }: Props) => { + * const receiveReturn = useAdminReceiveReturn( + * returnId + * ) + * // ... + * + * const handleReceive = (data: ReceiveReturnData) => { + * receiveReturn.mutate(data, { + * onSuccess: ({ return: dataReturn }) => { + * console.log(dataReturn.status) + * } + * }) + * } + * + * // ... + * } + * + * export default Return * - lang: Shell * label: cURL * source: | @@ -144,6 +179,7 @@ class Item { /** * @schema AdminPostReturnsReturnReceiveReq * type: object + * description: "The details of the received return." * required: * - items * properties: diff --git a/packages/medusa/src/api/routes/admin/sales-channels/add-product-batch.ts b/packages/medusa/src/api/routes/admin/sales-channels/add-product-batch.ts index 72f5266495205..27c81bdb153ee 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/add-product-batch.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/add-product-batch.ts @@ -38,6 +38,40 @@ import { Type } from "class-transformer" * .then(({ sales_channel }) => { * console.log(sales_channel.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminAddProductsToSalesChannel } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const addProducts = useAdminAddProductsToSalesChannel( + * salesChannelId + * ) + * // ... + * + * const handleAddProducts = (productId: string) => { + * addProducts.mutate({ + * product_ids: [ + * { + * id: productId, + * }, + * ], + * }, { + * onSuccess: ({ sales_channel }) => { + * console.log(sales_channel.id) + * } + * }) + * } + * + * // ... + * } + * + * export default SalesChannel * - lang: Shell * label: cURL * source: | @@ -103,11 +137,12 @@ export default async (req: Request, res: Response): Promise => { /** * @schema AdminPostSalesChannelsChannelProductsBatchReq * type: object + * description: "The details of the products to add to the sales channel." * required: * - product_ids * properties: * product_ids: - * description: The IDs of the products to add to the Sales Channel + * description: The IDs of the products to add to the sales channel * type: array * items: * type: object diff --git a/packages/medusa/src/api/routes/admin/sales-channels/associate-stock-location.ts b/packages/medusa/src/api/routes/admin/sales-channels/associate-stock-location.ts index 23568f496b196..62ef5d3afd730 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/associate-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/associate-stock-location.ts @@ -35,6 +35,37 @@ import { * .then(({ sales_channel }) => { * console.log(sales_channel.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminAddLocationToSalesChannel + * } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const addLocation = useAdminAddLocationToSalesChannel() + * // ... + * + * const handleAddLocation = (locationId: string) => { + * addLocation.mutate({ + * sales_channel_id: salesChannelId, + * location_id: locationId + * }, { + * onSuccess: ({ sales_channel }) => { + * console.log(sales_channel.locations) + * } + * }) + * } + * + * // ... + * } + * + * export default SalesChannel * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/sales-channels/create-sales-channel.ts b/packages/medusa/src/api/routes/admin/sales-channels/create-sales-channel.ts index 7206822fd8cf6..c3771682649d8 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/create-sales-channel.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/create-sales-channel.ts @@ -32,6 +32,31 @@ import SalesChannelService from "../../../../services/sales-channel" * .then(({ sales_channel }) => { * console.log(sales_channel.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateSalesChannel } from "medusa-react" + * + * const CreateSalesChannel = () => { + * const createSalesChannel = useAdminCreateSalesChannel() + * // ... + * + * const handleCreate = (name: string, description: string) => { + * createSalesChannel.mutate({ + * name, + * description, + * }, { + * onSuccess: ({ sales_channel }) => { + * console.log(sales_channel.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateSalesChannel * - lang: Shell * label: cURL * source: | @@ -87,6 +112,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostSalesChannelsReq * type: object + * description: "The details of the sales channel to create." * required: * - name * properties: diff --git a/packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts b/packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts index f261d45e9fe8e..3b05abfc55741 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts @@ -38,6 +38,42 @@ import { Type } from "class-transformer" * .then(({ sales_channel }) => { * console.log(sales_channel.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminDeleteProductsFromSalesChannel, + * } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const deleteProducts = useAdminDeleteProductsFromSalesChannel( + * salesChannelId + * ) + * // ... + * + * const handleDeleteProducts = (productId: string) => { + * deleteProducts.mutate({ + * product_ids: [ + * { + * id: productId, + * }, + * ], + * }, { + * onSuccess: ({ sales_channel }) => { + * console.log(sales_channel.id) + * } + * }) + * } + * + * // ... + * } + * + * export default SalesChannel * - lang: Shell * label: cURL * source: | @@ -103,11 +139,12 @@ export default async (req: Request, res: Response) => { /** * @schema AdminDeleteSalesChannelsChannelProductsBatchReq * type: object + * description: "The details of the products to delete from the sales channel." * required: * - product_ids * properties: * product_ids: - * description: The IDs of the products to remove from the Sales Channel. + * description: The IDs of the products to remove from the sales channel. * type: array * items: * type: object diff --git a/packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts b/packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts index fdad2a8c89fe2..cd84349105a70 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts @@ -24,6 +24,34 @@ import { SalesChannelService } from "../../../../services/" * .then(({ id, object, deleted }) => { * console.log(id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteSalesChannel } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const deleteSalesChannel = useAdminDeleteSalesChannel( + * salesChannelId + * ) + * // ... + * + * const handleDelete = () => { + * deleteSalesChannel.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default SalesChannel * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts b/packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts index 13fcedeaaef3b..8d7e38f0ec9e3 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts @@ -23,6 +23,31 @@ import { SalesChannelService } from "../../../../services" * .then(({ sales_channel }) => { * console.log(sales_channel.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminSalesChannel } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const { + * sales_channel, + * isLoading, + * } = useAdminSalesChannel(salesChannelId) + * + * return ( + *
+ * {isLoading && Loading...} + * {sales_channel && {sales_channel.name}} + *
+ * ) + * } + * + * export default SalesChannel * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/sales-channels/list-sales-channels.ts b/packages/medusa/src/api/routes/admin/sales-channels/list-sales-channels.ts index e392175a5adcc..afa3b61d6f69d 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/list-sales-channels.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/list-sales-channels.ts @@ -104,6 +104,33 @@ import { Type } from "class-transformer" * .then(({ sales_channels, limit, offset, count }) => { * console.log(sales_channels.length) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminSalesChannels } from "medusa-react" + * + * const SalesChannels = () => { + * const { sales_channels, isLoading } = useAdminSalesChannels() + * + * return ( + *
+ * {isLoading && Loading...} + * {sales_channels && !sales_channels.length && ( + * No Sales Channels + * )} + * {sales_channels && sales_channels.length > 0 && ( + *
    + * {sales_channels.map((salesChannel) => ( + *
  • {salesChannel.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default SalesChannels * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/sales-channels/remove-stock-location.ts b/packages/medusa/src/api/routes/admin/sales-channels/remove-stock-location.ts index a8182cb9fcade..f869b1dbe478e 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/remove-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/remove-stock-location.ts @@ -32,6 +32,37 @@ import { SalesChannelLocationService } from "../../../../services" * .then(({ sales_channel }) => { * console.log(sales_channel.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminRemoveLocationFromSalesChannel + * } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const removeLocation = useAdminRemoveLocationFromSalesChannel() + * // ... + * + * const handleRemoveLocation = (locationId: string) => { + * removeLocation.mutate({ + * sales_channel_id: salesChannelId, + * location_id: locationId + * }, { + * onSuccess: ({ sales_channel }) => { + * console.log(sales_channel.locations) + * } + * }) + * } + * + * // ... + * } + * + * export default SalesChannel * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/sales-channels/update-sales-channel.ts b/packages/medusa/src/api/routes/admin/sales-channels/update-sales-channel.ts index 237b6704795c8..0f2bedbbf76d8 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/update-sales-channel.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/update-sales-channel.ts @@ -32,6 +32,38 @@ import { EntityManager } from "typeorm" * .then(({ sales_channel }) => { * console.log(sales_channel.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateSalesChannel } from "medusa-react" + * + * type Props = { + * salesChannelId: string + * } + * + * const SalesChannel = ({ salesChannelId }: Props) => { + * const updateSalesChannel = useAdminUpdateSalesChannel( + * salesChannelId + * ) + * // ... + * + * const handleUpdate = ( + * is_disabled: boolean + * ) => { + * updateSalesChannel.mutate({ + * is_disabled, + * }, { + * onSuccess: ({ sales_channel }) => { + * console.log(sales_channel.is_disabled) + * } + * }) + * } + * + * // ... + * } + * + * export default SalesChannel * - lang: Shell * label: cURL * source: | @@ -91,6 +123,7 @@ export default async (req: Request, res: Response) => { /** * @schema AdminPostSalesChannelsSalesChannelReq * type: object + * description: "The details to update of the sales channel." * properties: * name: * type: string diff --git a/packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts b/packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts index 4ed788f0bf7f3..d4343bea27395 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts +++ b/packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts @@ -50,6 +50,45 @@ import { CreateShippingOptionInput } from "../../../../types/shipping-options" * .then(({ shipping_option }) => { * console.log(shipping_option.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateShippingOption } from "medusa-react" + * + * type CreateShippingOption = { + * name: string + * provider_id: string + * data: Record + * price_type: string + * amount: number + * } + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ regionId }: Props) => { + * const createShippingOption = useAdminCreateShippingOption() + * // ... + * + * const handleCreate = ( + * data: CreateShippingOption + * ) => { + * createShippingOption.mutate({ + * ...data, + * region_id: regionId + * }, { + * onSuccess: ({ shipping_option }) => { + * console.log(shipping_option.id) + * } + * }) + * } + * + * // ... + * } + * + * export default Region * - lang: Shell * label: cURL * source: | @@ -131,6 +170,7 @@ class OptionRequirement { /** * @schema AdminPostShippingOptionsReq * type: object + * description: "The details of the shipping option to create." * required: * - name * - region_id diff --git a/packages/medusa/src/api/routes/admin/shipping-options/delete-shipping-option.ts b/packages/medusa/src/api/routes/admin/shipping-options/delete-shipping-option.ts index 442b5f68e4f23..c88f900743b92 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/delete-shipping-option.ts +++ b/packages/medusa/src/api/routes/admin/shipping-options/delete-shipping-option.ts @@ -21,6 +21,34 @@ import { EntityManager } from "typeorm" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteShippingOption } from "medusa-react" + * + * type Props = { + * shippingOptionId: string + * } + * + * const ShippingOption = ({ shippingOptionId }: Props) => { + * const deleteShippingOption = useAdminDeleteShippingOption( + * shippingOptionId + * ) + * // ... + * + * const handleDelete = () => { + * deleteShippingOption.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default ShippingOption * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/shipping-options/get-shipping-option.ts b/packages/medusa/src/api/routes/admin/shipping-options/get-shipping-option.ts index 9764fbc475f86..bf6f280be516c 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/get-shipping-option.ts +++ b/packages/medusa/src/api/routes/admin/shipping-options/get-shipping-option.ts @@ -21,6 +21,33 @@ import { defaultFields, defaultRelations } from "." * .then(({ shipping_option }) => { * console.log(shipping_option.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminShippingOption } from "medusa-react" + * + * type Props = { + * shippingOptionId: string + * } + * + * const ShippingOption = ({ shippingOptionId }: Props) => { + * const { + * shipping_option, + * isLoading + * } = useAdminShippingOption( + * shippingOptionId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {shipping_option && {shipping_option.name}} + *
+ * ) + * } + * + * export default ShippingOption * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/shipping-options/list-shipping-options.ts b/packages/medusa/src/api/routes/admin/shipping-options/list-shipping-options.ts index 4d18935efbbad..ba3df365de77d 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/list-shipping-options.ts +++ b/packages/medusa/src/api/routes/admin/shipping-options/list-shipping-options.ts @@ -42,6 +42,36 @@ import { validator } from "../../../../utils/validator" * .then(({ shipping_options, count }) => { * console.log(shipping_options.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminShippingOptions } from "medusa-react" + * + * const ShippingOptions = () => { + * const { + * shipping_options, + * isLoading + * } = useAdminShippingOptions() + * + * return ( + *
+ * {isLoading && Loading...} + * {shipping_options && !shipping_options.length && ( + * No Shipping Options + * )} + * {shipping_options && shipping_options.length > 0 && ( + *
    + * {shipping_options.map((option) => ( + *
  • {option.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ShippingOptions * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts b/packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts index 9d354b835b252..75c93dfdb3a27 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts +++ b/packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts @@ -54,6 +54,44 @@ import { validator } from "../../../../utils/validator" * .then(({ shipping_option }) => { * console.log(shipping_option.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateShippingOption } from "medusa-react" + * + * type Props = { + * shippingOptionId: string + * } + * + * const ShippingOption = ({ shippingOptionId }: Props) => { + * const updateShippingOption = useAdminUpdateShippingOption( + * shippingOptionId + * ) + * // ... + * + * const handleUpdate = ( + * name: string, + * requirements: { + * id: string, + * type: string, + * amount: number + * }[] + * ) => { + * updateShippingOption.mutate({ + * name, + * requirements + * }, { + * onSuccess: ({ shipping_option }) => { + * console.log(shipping_option.requirements) + * } + * }) + * } + * + * // ... + * } + * + * export default ShippingOption * - lang: Shell * label: cURL * source: | @@ -136,6 +174,7 @@ class OptionRequirement { /** * @schema AdminPostShippingOptionsOptionReq * type: object + * description: "The details to update of the shipping option." * required: * - requirements * properties: diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/create-shipping-profile.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/create-shipping-profile.ts index 9a102ae3dbe6b..640f7dcc34321 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/create-shipping-profile.ts +++ b/packages/medusa/src/api/routes/admin/shipping-profiles/create-shipping-profile.ts @@ -30,6 +30,35 @@ import { validator } from "../../../../utils/validator" * .then(({ shipping_profile }) => { * console.log(shipping_profile.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { ShippingProfileType } from "@medusajs/medusa" + * import { useAdminCreateShippingProfile } from "medusa-react" + * + * const CreateShippingProfile = () => { + * const createShippingProfile = useAdminCreateShippingProfile() + * // ... + * + * const handleCreate = ( + * name: string, + * type: ShippingProfileType + * ) => { + * createShippingProfile.mutate({ + * name, + * type + * }, { + * onSuccess: ({ shipping_profile }) => { + * console.log(shipping_profile.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateShippingProfile * - lang: Shell * label: cURL * source: | @@ -84,6 +113,7 @@ export default async (req, res) => { /** * @schema AdminPostShippingProfilesReq * type: object + * description: "The details of the shipping profile to create." * required: * - name * - type diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/delete-shipping-profile.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/delete-shipping-profile.ts index d665c0f624a1a..f23fdf0db0962 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/delete-shipping-profile.ts +++ b/packages/medusa/src/api/routes/admin/shipping-profiles/delete-shipping-profile.ts @@ -22,6 +22,34 @@ import { ShippingProfileService } from "../../../../services" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteShippingProfile } from "medusa-react" + * + * type Props = { + * shippingProfileId: string + * } + * + * const ShippingProfile = ({ shippingProfileId }: Props) => { + * const deleteShippingProfile = useAdminDeleteShippingProfile( + * shippingProfileId + * ) + * // ... + * + * const handleDelete = () => { + * deleteShippingProfile.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default ShippingProfile * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/get-shipping-profile.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/get-shipping-profile.ts index db286f44c41da..b2a7f087884f4 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/get-shipping-profile.ts +++ b/packages/medusa/src/api/routes/admin/shipping-profiles/get-shipping-profile.ts @@ -26,6 +26,35 @@ import { ShippingProfileService } from "../../../../services" * .then(({ shipping_profile }) => { * console.log(shipping_profile.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminShippingProfile } from "medusa-react" + * + * type Props = { + * shippingProfileId: string + * } + * + * const ShippingProfile = ({ shippingProfileId }: Props) => { + * const { + * shipping_profile, + * isLoading + * } = useAdminShippingProfile( + * shippingProfileId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {shipping_profile && ( + * {shipping_profile.name} + * )} + *
+ * ) + * } + * + * export default ShippingProfile * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/list-shipping-profiles.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/list-shipping-profiles.ts index 7df3653a4cec8..ca6229b0352ce 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/list-shipping-profiles.ts +++ b/packages/medusa/src/api/routes/admin/shipping-profiles/list-shipping-profiles.ts @@ -19,6 +19,36 @@ import { ShippingProfileService } from "../../../../services" * .then(({ shipping_profiles }) => { * console.log(shipping_profiles.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminShippingProfiles } from "medusa-react" + * + * const ShippingProfiles = () => { + * const { + * shipping_profiles, + * isLoading + * } = useAdminShippingProfiles() + * + * return ( + *
+ * {isLoading && Loading...} + * {shipping_profiles && !shipping_profiles.length && ( + * No Shipping Profiles + * )} + * {shipping_profiles && shipping_profiles.length > 0 && ( + *
    + * {shipping_profiles.map((profile) => ( + *
  • {profile.name}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ShippingProfiles * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts index f7c1edcb71968..7fa58fccd4945 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts +++ b/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts @@ -42,6 +42,41 @@ import { * .then(({ shipping_profile }) => { * console.log(shipping_profile.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { ShippingProfileType } from "@medusajs/medusa" + * import { useAdminUpdateShippingProfile } from "medusa-react" + * + * type Props = { + * shippingProfileId: string + * } + * + * const ShippingProfile = ({ shippingProfileId }: Props) => { + * const updateShippingProfile = useAdminUpdateShippingProfile( + * shippingProfileId + * ) + * // ... + * + * const handleUpdate = ( + * name: string, + * type: ShippingProfileType + * ) => { + * updateShippingProfile.mutate({ + * name, + * type + * }, { + * onSuccess: ({ shipping_profile }) => { + * console.log(shipping_profile.name) + * } + * }) + * } + * + * // ... + * } + * + * export default ShippingProfile * - lang: Shell * label: cURL * source: | @@ -107,6 +142,7 @@ export default async (req, res) => { /** * @schema AdminPostShippingProfilesProfileReq * type: object + * description: "The detail to update of the shipping profile." * properties: * name: * description: The name of the Shipping Profile diff --git a/packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts b/packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts index 898006a899dde..948db35bb395d 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts @@ -40,6 +40,30 @@ import { IStockLocationService } from "@medusajs/types" * .then(({ stock_location }) => { * console.log(stock_location.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateStockLocation } from "medusa-react" + * + * const CreateStockLocation = () => { + * const createStockLocation = useAdminCreateStockLocation() + * // ... + * + * const handleCreate = (name: string) => { + * createStockLocation.mutate({ + * name, + * }, { + * onSuccess: ({ stock_location }) => { + * console.log(stock_location.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateStockLocation * - lang: Shell * label: cURL * source: | @@ -168,6 +192,7 @@ class StockLocationAddress { /** * @schema AdminPostStockLocationsReq * type: object + * description: "The details of the stock location to create." * required: * - name * properties: diff --git a/packages/medusa/src/api/routes/admin/stock-locations/delete-stock-location.ts b/packages/medusa/src/api/routes/admin/stock-locations/delete-stock-location.ts index e6f7f04cfa383..20078c5701881 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/delete-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/delete-stock-location.ts @@ -22,6 +22,32 @@ import { SalesChannelLocationService } from "../../../../services" * .then(({ id, object, deleted }) => { * console.log(id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteStockLocation } from "medusa-react" + * + * type Props = { + * stockLocationId: string + * } + * + * const StockLocation = ({ stockLocationId }: Props) => { + * const deleteLocation = useAdminDeleteStockLocation( + * stockLocationId + * ) + * // ... + * + * const handleDelete = () => { + * deleteLocation.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * } + * + * export default StockLocation * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/stock-locations/get-stock-location.ts b/packages/medusa/src/api/routes/admin/stock-locations/get-stock-location.ts index c4a456ed8124b..032a3d975c789 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/get-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/get-stock-location.ts @@ -31,6 +31,33 @@ import { joinSalesChannels } from "./utils/join-sales-channels" * .then(({ stock_location }) => { * console.log(stock_location.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminStockLocation } from "medusa-react" + * + * type Props = { + * stockLocationId: string + * } + * + * const StockLocation = ({ stockLocationId }: Props) => { + * const { + * stock_location, + * isLoading + * } = useAdminStockLocation(stockLocationId) + * + * return ( + *
+ * {isLoading && Loading...} + * {stock_location && ( + * {stock_location.name} + * )} + *
+ * ) + * } + * + * export default StockLocation * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/stock-locations/index.ts b/packages/medusa/src/api/routes/admin/stock-locations/index.ts index 7a55b359b31da..c31c8028118ef 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/index.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/index.ts @@ -136,6 +136,7 @@ export type AdminStockLocationsRes = { * properties: * stock_locations: * type: array + * description: "The list of stock locations." * items: * $ref: "#/components/schemas/StockLocationExpandedDTO" * count: diff --git a/packages/medusa/src/api/routes/admin/stock-locations/list-stock-locations.ts b/packages/medusa/src/api/routes/admin/stock-locations/list-stock-locations.ts index cdb9e64d170a3..fef2f5fa22343 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/list-stock-locations.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/list-stock-locations.ts @@ -103,6 +103,38 @@ import { joinSalesChannels } from "./utils/join-sales-channels" * .then(({ stock_locations, limit, offset, count }) => { * console.log(stock_locations.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminStockLocations } from "medusa-react" + * + * function StockLocations() { + * const { + * stock_locations, + * isLoading + * } = useAdminStockLocations() + * + * return ( + *
+ * {isLoading && Loading...} + * {stock_locations && !stock_locations.length && ( + * No Locations + * )} + * {stock_locations && stock_locations.length > 0 && ( + *
    + * {stock_locations.map( + * (location) => ( + *
  • {location.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default StockLocations * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts b/packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts index 1ae42ee43849a..efad1a6a6503e 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts @@ -34,6 +34,36 @@ import { FindParams } from "../../../../types/common" * .then(({ stock_location }) => { * console.log(stock_location.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateStockLocation } from "medusa-react" + * + * type Props = { + * stockLocationId: string + * } + * + * const StockLocation = ({ stockLocationId }: Props) => { + * const updateLocation = useAdminUpdateStockLocation( + * stockLocationId + * ) + * // ... + * + * const handleUpdate = ( + * name: string + * ) => { + * updateLocation.mutate({ + * name + * }, { + * onSuccess: ({ stock_location }) => { + * console.log(stock_location.name) + * } + * }) + * } + * } + * + * export default StockLocation * - lang: Shell * label: cURL * source: | @@ -148,6 +178,7 @@ class StockLocationAddress { /** * @schema AdminPostStockLocationsLocationReq * type: object + * description: "The details to update of the stock location." * properties: * name: * description: the name of the stock location diff --git a/packages/medusa/src/api/routes/admin/store/add-currency.ts b/packages/medusa/src/api/routes/admin/store/add-currency.ts index a6a3f863de9d5..f900fde79434c 100644 --- a/packages/medusa/src/api/routes/admin/store/add-currency.ts +++ b/packages/medusa/src/api/routes/admin/store/add-currency.ts @@ -31,6 +31,28 @@ import { EntityManager } from "typeorm" * .then(({ store }) => { * console.log(store.currencies); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminAddStoreCurrency } from "medusa-react" + * + * const Store = () => { + * const addCurrency = useAdminAddStoreCurrency() + * // ... + * + * const handleAdd = (code: string) => { + * addCurrency.mutate(code, { + * onSuccess: ({ store }) => { + * console.log(store.currencies) + * } + * }) + * } + * + * // ... + * } + * + * export default Store * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/store/get-store.ts b/packages/medusa/src/api/routes/admin/store/get-store.ts index f8cd768c9189b..98b48cd04e87c 100644 --- a/packages/medusa/src/api/routes/admin/store/get-store.ts +++ b/packages/medusa/src/api/routes/admin/store/get-store.ts @@ -27,6 +27,27 @@ import { MedusaModule } from "@medusajs/modules-sdk" * .then(({ store }) => { * console.log(store.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminStore } from "medusa-react" + * + * const Store = () => { + * const { + * store, + * isLoading + * } = useAdminStore() + * + * return ( + *
+ * {isLoading && Loading...} + * {store && {store.name}} + *
+ * ) + * } + * + * export default Store * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/store/list-payment-providers.ts b/packages/medusa/src/api/routes/admin/store/list-payment-providers.ts index 92e1128382005..2d49e8ebc33e6 100644 --- a/packages/medusa/src/api/routes/admin/store/list-payment-providers.ts +++ b/packages/medusa/src/api/routes/admin/store/list-payment-providers.ts @@ -19,6 +19,37 @@ import { PaymentProviderService } from "../../../../services" * .then(({ payment_providers }) => { * console.log(payment_providers.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminStorePaymentProviders } from "medusa-react" + * + * const PaymentProviders = () => { + * const { + * payment_providers, + * isLoading + * } = useAdminStorePaymentProviders() + * + * return ( + *
+ * {isLoading && Loading...} + * {payment_providers && !payment_providers.length && ( + * No Payment Providers + * )} + * {payment_providers && + * payment_providers.length > 0 &&( + *
    + * {payment_providers.map((provider) => ( + *
  • {provider.id}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default PaymentProviders * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/store/list-tax-providers.ts b/packages/medusa/src/api/routes/admin/store/list-tax-providers.ts index fac54b82d8677..230c1ec14cf59 100644 --- a/packages/medusa/src/api/routes/admin/store/list-tax-providers.ts +++ b/packages/medusa/src/api/routes/admin/store/list-tax-providers.ts @@ -19,6 +19,37 @@ import { TaxProviderService } from "../../../../services" * .then(({ tax_providers }) => { * console.log(tax_providers.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminStoreTaxProviders } from "medusa-react" + * + * const TaxProviders = () => { + * const { + * tax_providers, + * isLoading + * } = useAdminStoreTaxProviders() + * + * return ( + *
+ * {isLoading && Loading...} + * {tax_providers && !tax_providers.length && ( + * No Tax Providers + * )} + * {tax_providers && + * tax_providers.length > 0 &&( + *
    + * {tax_providers.map((provider) => ( + *
  • {provider.id}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default TaxProviders * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/store/remove-currency.ts b/packages/medusa/src/api/routes/admin/store/remove-currency.ts index 79a017351e284..2e7e5a653716b 100644 --- a/packages/medusa/src/api/routes/admin/store/remove-currency.ts +++ b/packages/medusa/src/api/routes/admin/store/remove-currency.ts @@ -30,6 +30,28 @@ import { EntityManager } from "typeorm" * .then(({ store }) => { * console.log(store.currencies); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteStoreCurrency } from "medusa-react" + * + * const Store = () => { + * const deleteCurrency = useAdminDeleteStoreCurrency() + * // ... + * + * const handleAdd = (code: string) => { + * deleteCurrency.mutate(code, { + * onSuccess: ({ store }) => { + * console.log(store.currencies) + * } + * }) + * } + * + * // ... + * } + * + * export default Store * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/store/update-store.ts b/packages/medusa/src/api/routes/admin/store/update-store.ts index 28f52bc25c548..ea39d76dca568 100644 --- a/packages/medusa/src/api/routes/admin/store/update-store.ts +++ b/packages/medusa/src/api/routes/admin/store/update-store.ts @@ -30,6 +30,30 @@ import { EntityManager } from "typeorm" * .then(({ store }) => { * console.log(store.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateStore } from "medusa-react" + * + * function Store() { + * const updateStore = useAdminUpdateStore() + * // ... + * + * const handleUpdate = ( + * name: string + * ) => { + * updateStore.mutate({ + * name + * }, { + * onSuccess: ({ store }) => { + * console.log(store.name) + * } + * }) + * } + * } + * + * export default Store * - lang: Shell * label: cURL * source: | @@ -83,6 +107,7 @@ export default async (req, res) => { /** * @schema AdminPostStoreReq * type: object + * description: "The details to update of the store." * properties: * name: * description: "The name of the Store" diff --git a/packages/medusa/src/api/routes/admin/swaps/get-swap.ts b/packages/medusa/src/api/routes/admin/swaps/get-swap.ts index 6d86d0d891717..b0aaf920cfa0c 100644 --- a/packages/medusa/src/api/routes/admin/swaps/get-swap.ts +++ b/packages/medusa/src/api/routes/admin/swaps/get-swap.ts @@ -23,6 +23,28 @@ import { SwapService } from "../../../../services" * .then(({ swap }) => { * console.log(swap.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminSwap } from "medusa-react" + * + * type Props = { + * swapId: string + * } + * + * const Swap = ({ swapId }: Props) => { + * const { swap, isLoading } = useAdminSwap(swapId) + * + * return ( + *
+ * {isLoading && Loading...} + * {swap && {swap.id}} + *
+ * ) + * } + * + * export default Swap * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/swaps/list-swaps.ts b/packages/medusa/src/api/routes/admin/swaps/list-swaps.ts index cc4e7198fd221..280108e0dd558 100644 --- a/packages/medusa/src/api/routes/admin/swaps/list-swaps.ts +++ b/packages/medusa/src/api/routes/admin/swaps/list-swaps.ts @@ -29,6 +29,31 @@ import { validator } from "../../../../utils/validator" * .then(({ swaps }) => { * console.log(swaps.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminSwaps } from "medusa-react" + * + * const Swaps = () => { + * const { swaps, isLoading } = useAdminSwaps() + * + * return ( + *
+ * {isLoading && Loading...} + * {swaps && !swaps.length && No Swaps} + * {swaps && swaps.length > 0 && ( + *
    + * {swaps.map((swap) => ( + *
  • {swap.payment_status}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Swaps * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts b/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts index 410a104663dfd..b8a2b1105d138 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts @@ -55,6 +55,38 @@ import { validator } from "../../../../utils/validator" * .then(({ tax_rate }) => { * console.log(tax_rate.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminCreateProductTypeTaxRates, + * } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const addProductTypes = useAdminCreateProductTypeTaxRates( + * taxRateId + * ) + * // ... + * + * const handleAddProductTypes = (productTypeIds: string[]) => { + * addProductTypes.mutate({ + * product_types: productTypeIds, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.product_types) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts b/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts index d160aed6fd99e..4dac769cf6985 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts @@ -55,6 +55,34 @@ import { validator } from "../../../../utils/validator" * .then(({ tax_rate }) => { * console.log(tax_rate.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateProductTaxRates } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const addProduct = useAdminCreateProductTaxRates(taxRateId) + * // ... + * + * const handleAddProduct = (productIds: string[]) => { + * addProduct.mutate({ + * products: productIds, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.products) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate * - lang: Shell * label: cURL * source: | @@ -122,6 +150,7 @@ export default async (req, res) => { /** * @schema AdminPostTaxRatesTaxRateProductsReq * type: object + * description: "The details of the products to associat with the tax rate." * required: * - products * properties: diff --git a/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts b/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts index aae68ba491ad0..0d37229842b2c 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts @@ -55,6 +55,38 @@ import { validator } from "../../../../utils/validator" * .then(({ tax_rate }) => { * console.log(tax_rate.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateShippingTaxRates } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const addShippingOption = useAdminCreateShippingTaxRates( + * taxRateId + * ) + * // ... + * + * const handleAddShippingOptions = ( + * shippingOptionIds: string[] + * ) => { + * addShippingOption.mutate({ + * shipping_options: shippingOptionIds, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.shipping_options) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate * - lang: Shell * label: cURL * source: | @@ -124,6 +156,7 @@ export default async (req, res) => { /** * @schema AdminPostTaxRatesTaxRateShippingOptionsReq * type: object + * description: "The details of the shipping options to associate with the tax rate." * required: * - shipping_options * properties: diff --git a/packages/medusa/src/api/routes/admin/tax-rates/create-tax-rate.ts b/packages/medusa/src/api/routes/admin/tax-rates/create-tax-rate.ts index c2a65efcd409e..3d510a46e6605 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/create-tax-rate.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/create-tax-rate.ts @@ -56,6 +56,41 @@ import { validator } from "../../../../utils/validator" * .then(({ tax_rate }) => { * console.log(tax_rate.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateTaxRate } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const CreateTaxRate = ({ regionId }: Props) => { + * const createTaxRate = useAdminCreateTaxRate() + * // ... + * + * const handleCreate = ( + * code: string, + * name: string, + * rate: number + * ) => { + * createTaxRate.mutate({ + * code, + * name, + * region_id: regionId, + * rate, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateTaxRate * - lang: Shell * label: cURL * source: | @@ -143,6 +178,7 @@ export default async (req, res) => { /** * @schema AdminPostTaxRatesReq * type: object + * description: "The details of the tax rate to create." * required: * - code * - name diff --git a/packages/medusa/src/api/routes/admin/tax-rates/delete-tax-rate.ts b/packages/medusa/src/api/routes/admin/tax-rates/delete-tax-rate.ts index af311d7eaf1f0..96c97c60a749e 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/delete-tax-rate.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/delete-tax-rate.ts @@ -22,6 +22,32 @@ import { TaxRateService } from "../../../../services" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteTaxRate } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const deleteTaxRate = useAdminDeleteTaxRate(taxRateId) + * // ... + * + * const handleDelete = () => { + * deleteTaxRate.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts b/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts index 967602f826d8c..3766b48e8d435 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts @@ -45,6 +45,28 @@ import { validator } from "../../../../utils/validator" * .then(({ tax_rate }) => { * console.log(tax_rate.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminTaxRate } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const { tax_rate, isLoading } = useAdminTaxRate(taxRateId) + * + * return ( + *
+ * {isLoading && Loading...} + * {tax_rate && {tax_rate.code}} + *
+ * ) + * } + * + * export default TaxRate * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/tax-rates/list-tax-rates.ts b/packages/medusa/src/api/routes/admin/tax-rates/list-tax-rates.ts index f360432c43165..7d82867a63b23 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/list-tax-rates.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/list-tax-rates.ts @@ -85,6 +85,36 @@ import { validator } from "../../../../utils/validator" * .then(({ tax_rates, limit, offset, count }) => { * console.log(tax_rates.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminTaxRates } from "medusa-react" + * + * const TaxRates = () => { + * const { + * tax_rates, + * isLoading + * } = useAdminTaxRates() + * + * return ( + *
+ * {isLoading && Loading...} + * {tax_rates && !tax_rates.length && ( + * No Tax Rates + * )} + * {tax_rates && tax_rates.length > 0 && ( + *
    + * {tax_rates.map((tax_rate) => ( + *
  • {tax_rate.code}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default TaxRates * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts index 04ac012f123f4..1c609d529858e 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts @@ -55,6 +55,40 @@ import { validator } from "../../../../utils/validator" * .then(({ tax_rate }) => { * console.log(tax_rate.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { + * useAdminDeleteProductTypeTaxRates, + * } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const removeProductTypes = useAdminDeleteProductTypeTaxRates( + * taxRateId + * ) + * // ... + * + * const handleRemoveProductTypes = ( + * productTypeIds: string[] + * ) => { + * removeProductTypes.mutate({ + * product_types: productTypeIds, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.product_types) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts index 190fb661f82f5..9d71c033e05c2 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts @@ -55,6 +55,34 @@ import { validator } from "../../../../utils/validator" * .then(({ tax_rate }) => { * console.log(tax_rate.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteProductTaxRates } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const removeProduct = useAdminDeleteProductTaxRates(taxRateId) + * // ... + * + * const handleRemoveProduct = (productIds: string[]) => { + * removeProduct.mutate({ + * products: productIds, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.products) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate * - lang: Shell * label: cURL * source: | @@ -122,6 +150,7 @@ export default async (req, res) => { /** * @schema AdminDeleteTaxRatesTaxRateProductsReq * type: object + * description: "The details of the products to remove their associated with the tax rate." * required: * - products * properties: diff --git a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts index 89ce47e0b489c..463e81cdb819d 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts @@ -55,6 +55,38 @@ import { validator } from "../../../../utils/validator" * .then(({ tax_rate }) => { * console.log(tax_rate.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteShippingTaxRates } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const removeShippingOptions = useAdminDeleteShippingTaxRates( + * taxRateId + * ) + * // ... + * + * const handleRemoveShippingOptions = ( + * shippingOptionIds: string[] + * ) => { + * removeShippingOptions.mutate({ + * shipping_options: shippingOptionIds, + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.shipping_options) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate * - lang: Shell * label: cURL * source: | @@ -125,6 +157,7 @@ export default async (req, res) => { /** * @schema AdminDeleteTaxRatesTaxRateShippingOptionsReq * type: object + * description: "The details of the shipping options to remove their associate with the tax rate." * required: * - shipping_options * properties: diff --git a/packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts b/packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts index ee0c1120aa8fc..d204eb70efaab 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts @@ -55,6 +55,36 @@ import { validator } from "../../../../utils/validator" * .then(({ tax_rate }) => { * console.log(tax_rate.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateTaxRate } from "medusa-react" + * + * type Props = { + * taxRateId: string + * } + * + * const TaxRate = ({ taxRateId }: Props) => { + * const updateTaxRate = useAdminUpdateTaxRate(taxRateId) + * // ... + * + * const handleUpdate = ( + * name: string + * ) => { + * updateTaxRate.mutate({ + * name + * }, { + * onSuccess: ({ tax_rate }) => { + * console.log(tax_rate.name) + * } + * }) + * } + * + * // ... + * } + * + * export default TaxRate * - lang: Shell * label: cURL * source: | @@ -140,6 +170,7 @@ export default async (req, res) => { /** * @schema AdminPostTaxRatesTaxRateReq * type: object + * description: "The details to update of the tax rate." * properties: * code: * type: string diff --git a/packages/medusa/src/api/routes/admin/uploads/create-protected-upload.ts b/packages/medusa/src/api/routes/admin/uploads/create-protected-upload.ts index 02a6bbcaa58fd..2e286f0afab00 100644 --- a/packages/medusa/src/api/routes/admin/uploads/create-protected-upload.ts +++ b/packages/medusa/src/api/routes/admin/uploads/create-protected-upload.ts @@ -28,6 +28,28 @@ import { IFileService } from "../../../../interfaces" * .then(({ uploads }) => { * console.log(uploads.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUploadProtectedFile } from "medusa-react" + * + * const UploadFile = () => { + * const uploadFile = useAdminUploadProtectedFile() + * // ... + * + * const handleFileUpload = (file: File) => { + * uploadFile.mutate(file, { + * onSuccess: ({ uploads }) => { + * console.log(uploads[0].key) + * } + * }) + * } + * + * // ... + * } + * + * export default UploadFile * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/uploads/create-upload.ts b/packages/medusa/src/api/routes/admin/uploads/create-upload.ts index 7d40260c888da..cdc7755f02af5 100644 --- a/packages/medusa/src/api/routes/admin/uploads/create-upload.ts +++ b/packages/medusa/src/api/routes/admin/uploads/create-upload.ts @@ -27,6 +27,28 @@ import fs from "fs" * .then(({ uploads }) => { * console.log(uploads.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUploadFile } from "medusa-react" + * + * const UploadFile = () => { + * const uploadFile = useAdminUploadFile() + * // ... + * + * const handleFileUpload = (file: File) => { + * uploadFile.mutate(file, { + * onSuccess: ({ uploads }) => { + * console.log(uploads[0].key) + * } + * }) + * } + * + * // ... + * } + * + * export default UploadFile * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/uploads/delete-upload.ts b/packages/medusa/src/api/routes/admin/uploads/delete-upload.ts index e016f1e6765da..f8571cd9307a6 100644 --- a/packages/medusa/src/api/routes/admin/uploads/delete-upload.ts +++ b/packages/medusa/src/api/routes/admin/uploads/delete-upload.ts @@ -24,6 +24,30 @@ import { IsString } from "class-validator" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteFile } from "medusa-react" + * + * const Image = () => { + * const deleteFile = useAdminDeleteFile() + * // ... + * + * const handleDeleteFile = (fileKey: string) => { + * deleteFile.mutate({ + * file_key: fileKey + * }, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default Image * - lang: Shell * label: cURL * source: | @@ -74,6 +98,7 @@ export default async (req, res) => { /** * @schema AdminDeleteUploadsReq * type: object + * description: "The details of the file to delete." * required: * - file_key * properties: diff --git a/packages/medusa/src/api/routes/admin/uploads/get-download-url.ts b/packages/medusa/src/api/routes/admin/uploads/get-download-url.ts index 1d518b8f0b071..3b5c5af5bfc1d 100644 --- a/packages/medusa/src/api/routes/admin/uploads/get-download-url.ts +++ b/packages/medusa/src/api/routes/admin/uploads/get-download-url.ts @@ -25,6 +25,30 @@ import { IsString } from "class-validator" * .then(({ download_url }) => { * console.log(download_url); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreatePresignedDownloadUrl } from "medusa-react" + * + * const Image = () => { + * const createPresignedUrl = useAdminCreatePresignedDownloadUrl() + * // ... + * + * const handlePresignedUrl = (fileKey: string) => { + * createPresignedUrl.mutate({ + * file_key: fileKey + * }, { + * onSuccess: ({ download_url }) => { + * console.log(download_url) + * } + * }) + * } + * + * // ... + * } + * + * export default Image * - lang: Shell * label: cURL * source: | @@ -73,6 +97,7 @@ export default async (req, res) => { /** * @schema AdminPostUploadsDownloadUrlReq * type: object + * description: "The details of the file to retrieve its download URL." * required: * - file_key * properties: diff --git a/packages/medusa/src/api/routes/admin/users/create-user.ts b/packages/medusa/src/api/routes/admin/users/create-user.ts index fd4677308add4..b9d55a92852f7 100644 --- a/packages/medusa/src/api/routes/admin/users/create-user.ts +++ b/packages/medusa/src/api/routes/admin/users/create-user.ts @@ -33,6 +33,31 @@ import { EntityManager } from "typeorm" * .then(({ user }) => { * console.log(user.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminCreateUser } from "medusa-react" + * + * const CreateUser = () => { + * const createUser = useAdminCreateUser() + * // ... + * + * const handleCreateUser = () => { + * createUser.mutate({ + * email: "user@example.com", + * password: "supersecret", + * }, { + * onSuccess: ({ user }) => { + * console.log(user.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateUser * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/users/delete-user.ts b/packages/medusa/src/api/routes/admin/users/delete-user.ts index fd2e5f2a2995d..586ec426db594 100644 --- a/packages/medusa/src/api/routes/admin/users/delete-user.ts +++ b/packages/medusa/src/api/routes/admin/users/delete-user.ts @@ -22,6 +22,32 @@ import UserService from "../../../../services/user" * .then(({ id, object, deleted }) => { * console.log(id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminDeleteUser } from "medusa-react" + * + * type Props = { + * userId: string + * } + * + * const User = ({ userId }: Props) => { + * const deleteUser = useAdminDeleteUser(userId) + * // ... + * + * const handleDeleteUser = () => { + * deleteUser.mutate(void 0, { + * onSuccess: ({ id, object, deleted }) => { + * console.log(id) + * } + * }) + * } + * + * // ... + * } + * + * export default User * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/users/get-user.ts b/packages/medusa/src/api/routes/admin/users/get-user.ts index bbf2c2d77dd14..2c2781d137526 100644 --- a/packages/medusa/src/api/routes/admin/users/get-user.ts +++ b/packages/medusa/src/api/routes/admin/users/get-user.ts @@ -21,6 +21,30 @@ import UserService from "../../../../services/user" * .then(({ user }) => { * console.log(user.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUser } from "medusa-react" + * + * type Props = { + * userId: string + * } + * + * const User = ({ userId }: Props) => { + * const { user, isLoading } = useAdminUser( + * userId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {user && {user.first_name} {user.last_name}} + *
+ * ) + * } + * + * export default User * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/users/list-users.ts b/packages/medusa/src/api/routes/admin/users/list-users.ts index 1b909e9fd516a..b25a4ba3f4888 100644 --- a/packages/medusa/src/api/routes/admin/users/list-users.ts +++ b/packages/medusa/src/api/routes/admin/users/list-users.ts @@ -19,6 +19,31 @@ import UserService from "../../../../services/user" * .then(({ users }) => { * console.log(users.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUsers } from "medusa-react" + * + * const Users = () => { + * const { users, isLoading } = useAdminUsers() + * + * return ( + *
+ * {isLoading && Loading...} + * {users && !users.length && No Users} + * {users && users.length > 0 && ( + *
    + * {users.map((user) => ( + *
  • {user.email}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Users * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/users/reset-password-token.ts b/packages/medusa/src/api/routes/admin/users/reset-password-token.ts index 77bdd9b1826c0..071622c654fd1 100644 --- a/packages/medusa/src/api/routes/admin/users/reset-password-token.ts +++ b/packages/medusa/src/api/routes/admin/users/reset-password-token.ts @@ -36,6 +36,32 @@ import { EntityManager } from "typeorm" * .catch(() => { * // error occurred * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminSendResetPasswordToken } from "medusa-react" + * + * const Login = () => { + * const requestPasswordReset = useAdminSendResetPasswordToken() + * // ... + * + * const handleResetPassword = ( + * email: string + * ) => { + * requestPasswordReset.mutate({ + * email + * }, { + * onSuccess: () => { + * // successful + * } + * }) + * } + * + * // ... + * } + * + * export default Login * - lang: Shell * label: cURL * source: | @@ -91,6 +117,7 @@ export default async (req, res) => { /** * @schema AdminResetPasswordTokenRequest * type: object + * description: "The details of the password reset token request." * required: * - email * properties: diff --git a/packages/medusa/src/api/routes/admin/users/reset-password.ts b/packages/medusa/src/api/routes/admin/users/reset-password.ts index 906944c92efc0..cb4938c32517b 100644 --- a/packages/medusa/src/api/routes/admin/users/reset-password.ts +++ b/packages/medusa/src/api/routes/admin/users/reset-password.ts @@ -38,6 +38,34 @@ import { EntityManager } from "typeorm" * .then(({ user }) => { * console.log(user.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminResetPassword } from "medusa-react" + * + * const ResetPassword = () => { + * const resetPassword = useAdminResetPassword() + * // ... + * + * const handleResetPassword = ( + * token: string, + * password: string + * ) => { + * resetPassword.mutate({ + * token, + * password, + * }, { + * onSuccess: ({ user }) => { + * console.log(user.id) + * } + * }) + * } + * + * // ... + * } + * + * export default ResetPassword * - lang: Shell * label: cURL * source: | @@ -128,6 +156,7 @@ export type payload = { /** * @schema AdminResetPasswordRequest * type: object + * description: "The details of the password reset request." * required: * - token * - password diff --git a/packages/medusa/src/api/routes/admin/users/update-user.ts b/packages/medusa/src/api/routes/admin/users/update-user.ts index f2e6762ee01d9..c374f351f5bf1 100644 --- a/packages/medusa/src/api/routes/admin/users/update-user.ts +++ b/packages/medusa/src/api/routes/admin/users/update-user.ts @@ -33,6 +33,36 @@ import { EntityManager } from "typeorm" * .then(({ user }) => { * console.log(user.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminUpdateUser } from "medusa-react" + * + * type Props = { + * userId: string + * } + * + * const User = ({ userId }: Props) => { + * const updateUser = useAdminUpdateUser(userId) + * // ... + * + * const handleUpdateUser = ( + * firstName: string + * ) => { + * updateUser.mutate({ + * first_name: firstName, + * }, { + * onSuccess: ({ user }) => { + * console.log(user.first_name) + * } + * }) + * } + * + * // ... + * } + * + * export default User * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/variants/get-inventory.ts b/packages/medusa/src/api/routes/admin/variants/get-inventory.ts index 99c2ac453cda2..d5b2f348daa5d 100644 --- a/packages/medusa/src/api/routes/admin/variants/get-inventory.ts +++ b/packages/medusa/src/api/routes/admin/variants/get-inventory.ts @@ -34,6 +34,39 @@ import { promiseAll } from "@medusajs/utils" * .then(({ variant }) => { * console.log(variant.inventory, variant.sales_channel_availability) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminVariantsInventory } from "medusa-react" + * + * type Props = { + * variantId: string + * } + * + * const VariantInventory = ({ variantId }: Props) => { + * const { variant, isLoading } = useAdminVariantsInventory( + * variantId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {variant && variant.inventory.length === 0 && ( + * Variant doesn't have inventory details + * )} + * {variant && variant.inventory.length > 0 && ( + *
    + * {variant.inventory.map((inventory) => ( + *
  • {inventory.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default VariantInventory * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/variants/get-variant.ts b/packages/medusa/src/api/routes/admin/variants/get-variant.ts index 6768cae916c3f..226c7e1bc72d0 100644 --- a/packages/medusa/src/api/routes/admin/variants/get-variant.ts +++ b/packages/medusa/src/api/routes/admin/variants/get-variant.ts @@ -26,6 +26,30 @@ import { FindParams } from "../../../../types/common" * .then(({ variant }) => { * console.log(variant.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminVariant } from "medusa-react" + * + * type Props = { + * variantId: string + * } + * + * const Variant = ({ variantId }: Props) => { + * const { variant, isLoading } = useAdminVariant( + * variantId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {variant && {variant.title}} + *
+ * ) + * } + * + * export default Variant * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/admin/variants/list-variants.ts b/packages/medusa/src/api/routes/admin/variants/list-variants.ts index 901e4c41f0cf3..0c320d37feb91 100644 --- a/packages/medusa/src/api/routes/admin/variants/list-variants.ts +++ b/packages/medusa/src/api/routes/admin/variants/list-variants.ts @@ -126,6 +126,33 @@ import { omit } from "lodash" * .then(({ variants, limit, offset, count }) => { * console.log(variants.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAdminVariants } from "medusa-react" + * + * const Variants = () => { + * const { variants, isLoading } = useAdminVariants() + * + * return ( + *
+ * {isLoading && Loading...} + * {variants && !variants.length && ( + * No Variants + * )} + * {variants && variants.length > 0 && ( + *
    + * {variants.map((variant) => ( + *
  • {variant.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Variants * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/carts/add-shipping-method.ts b/packages/medusa/src/api/routes/store/carts/add-shipping-method.ts index 9c3f9130e00e5..3577770a58895 100644 --- a/packages/medusa/src/api/routes/store/carts/add-shipping-method.ts +++ b/packages/medusa/src/api/routes/store/carts/add-shipping-method.ts @@ -34,6 +34,35 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAddShippingMethodToCart } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const addShippingMethod = useAddShippingMethodToCart(cartId) + * + * const handleAddShippingMethod = ( + * optionId: string + * ) => { + * addShippingMethod.mutate({ + * option_id: optionId, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.shipping_methods) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | @@ -107,6 +136,7 @@ export default async (req, res) => { /** * @schema StorePostCartsCartShippingMethodReq * type: object + * description: "The details of the shipping method to add to the cart." * required: * - option_id * properties: diff --git a/packages/medusa/src/api/routes/store/carts/complete-cart.ts b/packages/medusa/src/api/routes/store/carts/complete-cart.ts index c94b4a568ed02..9c4902e7fcbf5 100644 --- a/packages/medusa/src/api/routes/store/carts/complete-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/complete-cart.ts @@ -33,6 +33,31 @@ import { Logger } from "@medusajs/types" * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCompleteCart } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const completeCart = useCompleteCart(cartId) + * + * const handleComplete = () => { + * completeCart.mutate(void 0, { + * onSuccess: ({ data, type }) => { + * console.log(data.id, type) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/carts/create-cart.ts b/packages/medusa/src/api/routes/store/carts/create-cart.ts index 3c6d4b8c29fcf..32e471fbb8ced 100644 --- a/packages/medusa/src/api/routes/store/carts/create-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/create-cart.ts @@ -56,6 +56,34 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCreateCart } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Cart = ({ regionId }: Props) => { + * const createCart = useCreateCart() + * + * const handleCreate = () => { + * createCart.mutate({ + * region_id: regionId + * // creates an empty cart + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.items) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/carts/create-line-item/index.ts b/packages/medusa/src/api/routes/store/carts/create-line-item/index.ts index acf34f7954431..b23ec04533ca8 100644 --- a/packages/medusa/src/api/routes/store/carts/create-line-item/index.ts +++ b/packages/medusa/src/api/routes/store/carts/create-line-item/index.ts @@ -42,6 +42,37 @@ import { CartService } from "../../../../../services" * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCreateLineItem } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const createLineItem = useCreateLineItem(cartId) + * + * const handleAddItem = ( + * variantId: string, + * quantity: number + * ) => { + * createLineItem.mutate({ + * variant_id: variantId, + * quantity, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.items) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | @@ -198,6 +229,7 @@ export default async (req, res) => { /** * @schema StorePostCartsCartLineItemsReq * type: object + * description: "The details of the line item to create." * required: * - variant_id * - quantity diff --git a/packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts b/packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts index 0757e938ad927..0e73e95945030 100644 --- a/packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts +++ b/packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts @@ -28,6 +28,31 @@ import { Cart } from "../../../../models" * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCreatePaymentSession } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const createPaymentSession = useCreatePaymentSession(cartId) + * + * const handleComplete = () => { + * createPaymentSession.mutate(void 0, { + * onSuccess: ({ cart }) => { + * console.log(cart.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/carts/delete-line-item.ts b/packages/medusa/src/api/routes/store/carts/delete-line-item.ts index 7f63f0d93bb7a..6a7b593e78a11 100644 --- a/packages/medusa/src/api/routes/store/carts/delete-line-item.ts +++ b/packages/medusa/src/api/routes/store/carts/delete-line-item.ts @@ -27,6 +27,35 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useDeleteLineItem } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const deleteLineItem = useDeleteLineItem(cartId) + * + * const handleDeleteItem = ( + * lineItemId: string + * ) => { + * deleteLineItem.mutate({ + * lineId: lineItemId, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.items) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/carts/delete-payment-session.ts b/packages/medusa/src/api/routes/store/carts/delete-payment-session.ts index 096e7f9bcb068..b047de3803754 100644 --- a/packages/medusa/src/api/routes/store/carts/delete-payment-session.ts +++ b/packages/medusa/src/api/routes/store/carts/delete-payment-session.ts @@ -27,6 +27,35 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useDeletePaymentSession } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const deletePaymentSession = useDeletePaymentSession(cartId) + * + * const handleDeletePaymentSession = ( + * providerId: string + * ) => { + * deletePaymentSession.mutate({ + * provider_id: providerId, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/carts/get-cart.ts b/packages/medusa/src/api/routes/store/carts/get-cart.ts index 5da2e384b77b5..885612b4c923a 100644 --- a/packages/medusa/src/api/routes/store/carts/get-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/get-cart.ts @@ -26,6 +26,37 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useGetCart } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const { cart, isLoading } = useGetCart(cartId) + * + * return ( + *
+ * {isLoading && Loading...} + * {cart && cart.items.length === 0 && ( + * Cart is empty + * )} + * {cart && cart.items.length > 0 && ( + *
    + * {cart.items.map((item) => ( + *
  • {item.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/carts/refresh-payment-session.ts b/packages/medusa/src/api/routes/store/carts/refresh-payment-session.ts index 667def0f01449..138cc486c1e48 100644 --- a/packages/medusa/src/api/routes/store/carts/refresh-payment-session.ts +++ b/packages/medusa/src/api/routes/store/carts/refresh-payment-session.ts @@ -22,6 +22,35 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useRefreshPaymentSession } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const refreshPaymentSession = useRefreshPaymentSession(cartId) + * + * const handleRefresh = ( + * providerId: string + * ) => { + * refreshPaymentSession.mutate({ + * provider_id: providerId, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/carts/set-payment-session.ts b/packages/medusa/src/api/routes/store/carts/set-payment-session.ts index 98d54a9f14364..c63059f9b5c7d 100644 --- a/packages/medusa/src/api/routes/store/carts/set-payment-session.ts +++ b/packages/medusa/src/api/routes/store/carts/set-payment-session.ts @@ -35,6 +35,35 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useSetPaymentSession } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const setPaymentSession = useSetPaymentSession(cartId) + * + * const handleSetPaymentSession = ( + * providerId: string + * ) => { + * setPaymentSession.mutate({ + * provider_id: providerId, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.payment_session) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | @@ -96,6 +125,7 @@ export default async (req, res) => { /** * @schema StorePostCartsCartPaymentSessionReq * type: object + * description: "The details of the payment session to set." * required: * - provider_id * properties: diff --git a/packages/medusa/src/api/routes/store/carts/update-cart.ts b/packages/medusa/src/api/routes/store/carts/update-cart.ts index 06ddfa672b690..cda94322f0098 100644 --- a/packages/medusa/src/api/routes/store/carts/update-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/update-cart.ts @@ -46,6 +46,35 @@ import { IsType } from "../../../../utils/validators/is-type" * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useUpdateCart } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const updateCart = useUpdateCart(cartId) + * + * const handleUpdate = ( + * email: string + * ) => { + * updateCart.mutate({ + * email + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.email) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | @@ -188,6 +217,7 @@ class Discount { /** * @schema StorePostCartsCartReq * type: object + * description: "The details to update of the cart." * properties: * region_id: * type: string diff --git a/packages/medusa/src/api/routes/store/carts/update-line-item.ts b/packages/medusa/src/api/routes/store/carts/update-line-item.ts index e700a4cbbbafe..c492c48b29307 100644 --- a/packages/medusa/src/api/routes/store/carts/update-line-item.ts +++ b/packages/medusa/src/api/routes/store/carts/update-line-item.ts @@ -36,6 +36,37 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useUpdateLineItem } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const updateLineItem = useUpdateLineItem(cartId) + * + * const handleUpdateItem = ( + * lineItemId: string, + * quantity: number + * ) => { + * updateLineItem.mutate({ + * lineId: lineItemId, + * quantity, + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.items) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | @@ -131,6 +162,7 @@ export default async (req, res) => { /** * @schema StorePostCartsCartLineItemsItemReq * type: object + * description: "The details to update of the line item." * required: * - quantity * properties: diff --git a/packages/medusa/src/api/routes/store/carts/update-payment-session.ts b/packages/medusa/src/api/routes/store/carts/update-payment-session.ts index 07c569e30782a..645277b74a383 100644 --- a/packages/medusa/src/api/routes/store/carts/update-payment-session.ts +++ b/packages/medusa/src/api/routes/store/carts/update-payment-session.ts @@ -38,6 +38,37 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ cart }) => { * console.log(cart.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useUpdatePaymentSession } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Cart = ({ cartId }: Props) => { + * const updatePaymentSession = useUpdatePaymentSession(cartId) + * + * const handleUpdate = ( + * providerId: string, + * data: Record + * ) => { + * updatePaymentSession.mutate({ + * provider_id: providerId, + * data + * }, { + * onSuccess: ({ cart }) => { + * console.log(cart.payment_session) + * } + * }) + * } + * + * // ... + * } + * + * export default Cart * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/collections/get-collection.ts b/packages/medusa/src/api/routes/store/collections/get-collection.ts index 5ea9712a9c149..1f14851422a65 100644 --- a/packages/medusa/src/api/routes/store/collections/get-collection.ts +++ b/packages/medusa/src/api/routes/store/collections/get-collection.ts @@ -19,6 +19,28 @@ import ProductCollectionService from "../../../../services/product-collection" * .then(({ collection }) => { * console.log(collection.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCollection } from "medusa-react" + * + * type Props = { + * collectionId: string + * } + * + * const ProductCollection = ({ collectionId }: Props) => { + * const { collection, isLoading } = useCollection(collectionId) + * + * return ( + *
+ * {isLoading && Loading...} + * {collection && {collection.title}} + *
+ * ) + * } + * + * export default ProductCollection * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/collections/list-collections.ts b/packages/medusa/src/api/routes/store/collections/list-collections.ts index 1262175aa7c86..53b85727685ad 100644 --- a/packages/medusa/src/api/routes/store/collections/list-collections.ts +++ b/packages/medusa/src/api/routes/store/collections/list-collections.ts @@ -78,6 +78,33 @@ import { Type } from "class-transformer" * .then(({ collections, limit, offset, count }) => { * console.log(collections.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCollections } from "medusa-react" + * + * const ProductCollections = () => { + * const { collections, isLoading } = useCollections() + * + * return ( + *
+ * {isLoading && Loading...} + * {collections && collections.length === 0 && ( + * No Product Collections + * )} + * {collections && collections.length > 0 && ( + *
    + * {collections.map((collection) => ( + *
  • {collection.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ProductCollections * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/customers/create-customer.ts b/packages/medusa/src/api/routes/store/customers/create-customer.ts index 15b896aa2d659..3b1d98aeb112b 100644 --- a/packages/medusa/src/api/routes/store/customers/create-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/create-customer.ts @@ -36,6 +36,36 @@ import { validator } from "../../../../utils/validator" * .then(({ customer }) => { * console.log(customer.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCreateCustomer } from "medusa-react" + * + * const RegisterCustomer = () => { + * const createCustomer = useCreateCustomer() + * // ... + * + * const handleCreate = ( + * customerData: { + * first_name: string + * last_name: string + * email: string + * password: string + * } + * ) => { + * // ... + * createCustomer.mutate(customerData, { + * onSuccess: ({ customer }) => { + * console.log(customer.id) + * } + * }) + * } + * + * // ... + * } + * + * export default RegisterCustomer * - lang: Shell * label: cURL * source: | @@ -111,6 +141,7 @@ export default async (req, res) => { /** * @schema StorePostCustomersReq * type: object + * description: "The details of the customer to create." * required: * - first_name * - last_name diff --git a/packages/medusa/src/api/routes/store/customers/get-customer.ts b/packages/medusa/src/api/routes/store/customers/get-customer.ts index 51cc9dbe01a31..eb24b11265b06 100644 --- a/packages/medusa/src/api/routes/store/customers/get-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/get-customer.ts @@ -20,6 +20,26 @@ import CustomerService from "../../../../services/customer" * .then(({ customer }) => { * console.log(customer.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useMeCustomer } from "medusa-react" + * + * const Customer = () => { + * const { customer, isLoading } = useMeCustomer() + * + * return ( + *
+ * {isLoading && Loading...} + * {customer && ( + * {customer.first_name} {customer.last_name} + * )} + *
+ * ) + * } + * + * export default Customer * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/customers/list-orders.ts b/packages/medusa/src/api/routes/store/customers/list-orders.ts index a52fe765679c1..dbb85fcfcfb7a 100644 --- a/packages/medusa/src/api/routes/store/customers/list-orders.ts +++ b/packages/medusa/src/api/routes/store/customers/list-orders.ts @@ -154,6 +154,32 @@ import { DateComparisonOperator } from "../../../../types/common" * .then(({ orders, limit, offset, count }) => { * console.log(orders); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCustomerOrders } from "medusa-react" + * + * const Orders = () => { + * // refetch a function that can be used to + * // re-retrieve orders after the customer logs in + * const { orders, isLoading } = useCustomerOrders() + * + * return ( + *
+ * {isLoading && Loading orders...} + * {orders?.length && ( + *
    + * {orders.map((order) => ( + *
  • {order.display_id}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Orders * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/customers/update-customer.ts b/packages/medusa/src/api/routes/store/customers/update-customer.ts index 309256b868220..1754b924001dd 100644 --- a/packages/medusa/src/api/routes/store/customers/update-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/update-customer.ts @@ -33,6 +33,38 @@ import { IsType } from "../../../../utils/validators/is-type" * .then(({ customer }) => { * console.log(customer.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useUpdateMe } from "medusa-react" + * + * type Props = { + * customerId: string + * } + * + * const Customer = ({ customerId }: Props) => { + * const updateCustomer = useUpdateMe() + * // ... + * + * const handleUpdate = ( + * firstName: string + * ) => { + * // ... + * updateCustomer.mutate({ + * id: customerId, + * first_name: firstName, + * }, { + * onSuccess: ({ customer }) => { + * console.log(customer.first_name) + * } + * }) + * } + * + * // ... + * } + * + * export default Customer * - lang: Shell * label: cURL * source: | @@ -91,6 +123,7 @@ export default async (req, res) => { /** * @schema StorePostCustomersCustomerReq * type: object + * description: "The details to update of the customer." * properties: * first_name: * description: "The customer's first name." diff --git a/packages/medusa/src/api/routes/store/gift-cards/get-gift-card.ts b/packages/medusa/src/api/routes/store/gift-cards/get-gift-card.ts index 14bd377a731ec..70d5aba5baf7e 100644 --- a/packages/medusa/src/api/routes/store/gift-cards/get-gift-card.ts +++ b/packages/medusa/src/api/routes/store/gift-cards/get-gift-card.ts @@ -22,6 +22,31 @@ import { Logger } from "@medusajs/types" * .then(({ gift_card }) => { * console.log(gift_card.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useGiftCard } from "medusa-react" + * + * type Props = { + * giftCardCode: string + * } + * + * const GiftCard = ({ giftCardCode }: Props) => { + * const { gift_card, isLoading, isError } = useGiftCard( + * giftCardCode + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {gift_card && {gift_card.value}} + * {isError && Gift Card does not exist} + *
+ * ) + * } + * + * export default GiftCard * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/order-edits/complete-order-edit.ts b/packages/medusa/src/api/routes/store/order-edits/complete-order-edit.ts index 59763d572ba17..b58452417402e 100644 --- a/packages/medusa/src/api/routes/store/order-edits/complete-order-edit.ts +++ b/packages/medusa/src/api/routes/store/order-edits/complete-order-edit.ts @@ -30,6 +30,34 @@ import { * .then(({ order_edit }) => { * console.log(order_edit.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCompleteOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const completeOrderEdit = useCompleteOrderEdit( + * orderEditId + * ) + * // ... + * + * const handleCompleteOrderEdit = () => { + * completeOrderEdit.mutate(void 0, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.confirmed_at) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/order-edits/decline-order-edit.ts b/packages/medusa/src/api/routes/store/order-edits/decline-order-edit.ts index 44e1457be4a09..d3b92f6bb963c 100644 --- a/packages/medusa/src/api/routes/store/order-edits/decline-order-edit.ts +++ b/packages/medusa/src/api/routes/store/order-edits/decline-order-edit.ts @@ -31,6 +31,36 @@ import { * .then(({ order_edit }) => { * console.log(order_edit.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useDeclineOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const declineOrderEdit = useDeclineOrderEdit(orderEditId) + * // ... + * + * const handleDeclineOrderEdit = ( + * declinedReason: string + * ) => { + * declineOrderEdit.mutate({ + * declined_reason: declinedReason, + * }, { + * onSuccess: ({ order_edit }) => { + * console.log(order_edit.declined_at) + * } + * }) + * } + * + * // ... + * } + * + * export default OrderEdit * - lang: Shell * label: cURL * source: | @@ -85,6 +115,7 @@ export default async (req: Request, res: Response) => { /** * @schema StorePostOrderEditsOrderEditDecline * type: object + * description: "The details of the order edit's decline." * properties: * declined_reason: * type: string diff --git a/packages/medusa/src/api/routes/store/order-edits/get-order-edit.ts b/packages/medusa/src/api/routes/store/order-edits/get-order-edit.ts index bdf322b0742b5..8ed86f0b232a8 100644 --- a/packages/medusa/src/api/routes/store/order-edits/get-order-edit.ts +++ b/packages/medusa/src/api/routes/store/order-edits/get-order-edit.ts @@ -20,6 +20,34 @@ import { OrderEditService } from "../../../../services" * .then(({ order_edit }) => { * console.log(order_edit.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useOrderEdit } from "medusa-react" + * + * type Props = { + * orderEditId: string + * } + * + * const OrderEdit = ({ orderEditId }: Props) => { + * const { order_edit, isLoading } = useOrderEdit(orderEditId) + * + * return ( + *
+ * {isLoading && Loading...} + * {order_edit && ( + *
    + * {order_edit.changes.map((change) => ( + *
  • {change.type}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default OrderEdit * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/orders/confirm-order-request.ts b/packages/medusa/src/api/routes/store/orders/confirm-order-request.ts index da603408360d5..68626fa55c718 100644 --- a/packages/medusa/src/api/routes/store/orders/confirm-order-request.ts +++ b/packages/medusa/src/api/routes/store/orders/confirm-order-request.ts @@ -38,6 +38,34 @@ import { promiseAll } from "@medusajs/utils" * .catch(() => { * // an error occurred * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useGrantOrderAccess } from "medusa-react" + * + * const ClaimOrder = () => { + * const confirmOrderRequest = useGrantOrderAccess() + * + * const handleOrderRequestConfirmation = ( + * token: string + * ) => { + * confirmOrderRequest.mutate({ + * token + * }, { + * onSuccess: () => { + * // successful + * }, + * onError: () => { + * // an error occurred. + * } + * }) + * } + * + * // ... + * } + * + * export default ClaimOrder * - lang: Shell * label: cURL * source: | @@ -115,6 +143,7 @@ export default async (req, res) => { /** * @schema StorePostCustomersCustomerAcceptClaimReq * type: object + * description: "The details necessary to grant order access." * required: * - token * properties: diff --git a/packages/medusa/src/api/routes/store/orders/get-order-by-cart.ts b/packages/medusa/src/api/routes/store/orders/get-order-by-cart.ts index b51eaab656b62..77e76c09e5c1e 100644 --- a/packages/medusa/src/api/routes/store/orders/get-order-by-cart.ts +++ b/packages/medusa/src/api/routes/store/orders/get-order-by-cart.ts @@ -20,6 +20,32 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCartOrder } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const Order = ({ cartId }: Props) => { + * const { + * order, + * isLoading, + * } = useCartOrder(cartId) + * + * return ( + *
+ * {isLoading && Loading...} + * {order && {order.display_id}} + * + *
+ * ) + * } + * + * export default Order * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/orders/get-order.ts b/packages/medusa/src/api/routes/store/orders/get-order.ts index 5518957f7fa59..a62e5cda564f6 100644 --- a/packages/medusa/src/api/routes/store/orders/get-order.ts +++ b/packages/medusa/src/api/routes/store/orders/get-order.ts @@ -23,6 +23,32 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useOrder } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * const Order = ({ orderId }: Props) => { + * const { + * order, + * isLoading, + * } = useOrder(orderId) + * + * return ( + *
+ * {isLoading && Loading...} + * {order && {order.display_id}} + * + *
+ * ) + * } + * + * export default Order * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/orders/lookup-order.ts b/packages/medusa/src/api/routes/store/orders/lookup-order.ts index d6062de497b18..977a7470ec0d2 100644 --- a/packages/medusa/src/api/routes/store/orders/lookup-order.ts +++ b/packages/medusa/src/api/routes/store/orders/lookup-order.ts @@ -56,6 +56,39 @@ import { FindParams } from "../../../../types/common" * .then(({ order }) => { * console.log(order.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useOrders } from "medusa-react" + * + * type Props = { + * displayId: number + * email: string + * } + * + * const Order = ({ + * displayId, + * email + * }: Props) => { + * const { + * order, + * isLoading, + * } = useOrders({ + * display_id: displayId, + * email, + * }) + * + * return ( + *
+ * {isLoading && Loading...} + * {order && {order.display_id}} + * + *
+ * ) + * } + * + * export default Order * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/orders/request-order.ts b/packages/medusa/src/api/routes/store/orders/request-order.ts index c5fd6fd780a4b..0acd2f454f8f7 100644 --- a/packages/medusa/src/api/routes/store/orders/request-order.ts +++ b/packages/medusa/src/api/routes/store/orders/request-order.ts @@ -40,6 +40,34 @@ import { TokenEvents } from "../../../../types/token" * .catch(() => { * // an error occurred * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useRequestOrderAccess } from "medusa-react" + * + * const ClaimOrder = () => { + * const claimOrder = useRequestOrderAccess() + * + * const handleClaimOrder = ( + * orderIds: string[] + * ) => { + * claimOrder.mutate({ + * order_ids: orderIds + * }, { + * onSuccess: () => { + * // successful + * }, + * onError: () => { + * // an error occurred. + * } + * }) + * } + * + * // ... + * } + * + * export default ClaimOrder * - lang: Shell * label: cURL * source: | @@ -128,6 +156,7 @@ export default async (req, res) => { /** * @schema StorePostCustomersCustomerOrderClaimReq * type: object + * description: "The details of the orders to claim." * required: * - order_ids * properties: diff --git a/packages/medusa/src/api/routes/store/payment-collections/authorize-batch-payment-sessions.ts b/packages/medusa/src/api/routes/store/payment-collections/authorize-batch-payment-sessions.ts index 22d885a8e9967..aabb592f899d9 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/authorize-batch-payment-sessions.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/authorize-batch-payment-sessions.ts @@ -27,6 +27,38 @@ import { PaymentCollectionService } from "../../../../services" * .then(({ payment_collection }) => { * console.log(payment_collection.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAuthorizePaymentSessionsBatch } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const authorizePaymentSessions = useAuthorizePaymentSessionsBatch( + * paymentCollectionId + * ) + * // ... + * + * const handleAuthorizePayments = (paymentSessionIds: string[]) => { + * authorizePaymentSessions.mutate({ + * session_ids: paymentSessionIds + * }, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection * - lang: Shell * label: cURL * source: | @@ -78,6 +110,7 @@ export default async (req, res) => { /** * @schema StorePostPaymentCollectionsBatchSessionsAuthorizeReq * type: object + * description: "The details of the payment sessions to authorize." * required: * - session_ids * properties: diff --git a/packages/medusa/src/api/routes/store/payment-collections/authorize-payment-session.ts b/packages/medusa/src/api/routes/store/payment-collections/authorize-payment-session.ts index e4fb4d6fcfa57..4d73d51de6a9e 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/authorize-payment-session.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/authorize-payment-session.ts @@ -24,6 +24,36 @@ import { PaymentCollectionService } from "../../../../services" * .then(({ payment_collection }) => { * console.log(payment_collection.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useAuthorizePaymentSession } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const authorizePaymentSession = useAuthorizePaymentSession( + * paymentCollectionId + * ) + * // ... + * + * const handleAuthorizePayment = (paymentSessionId: string) => { + * authorizePaymentSession.mutate(paymentSessionId, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/payment-collections/get-payment-collection.ts b/packages/medusa/src/api/routes/store/payment-collections/get-payment-collection.ts index 3e25611097db6..0c938b6d3fa27 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/get-payment-collection.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/get-payment-collection.ts @@ -25,6 +25,37 @@ import { FindParams } from "../../../../types/common" * .then(({ payment_collection }) => { * console.log(payment_collection.id) * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { usePaymentCollection } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const { + * payment_collection, + * isLoading + * } = usePaymentCollection( + * paymentCollectionId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {payment_collection && ( + * {payment_collection.status} + * )} + *
+ * ) + * } + * + * export default PaymentCollection * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/payment-collections/index.ts b/packages/medusa/src/api/routes/store/payment-collections/index.ts index 3d0349e3f0489..c4f91371581ac 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/index.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/index.ts @@ -97,6 +97,7 @@ export type StorePaymentCollectionsRes = { /** * @schema StorePaymentCollectionsSessionRes * type: object + * description: "The details of the payment session." * required: * - payment_session * properties: diff --git a/packages/medusa/src/api/routes/store/payment-collections/manage-batch-payment-sessions.ts b/packages/medusa/src/api/routes/store/payment-collections/manage-batch-payment-sessions.ts index 646bb0a362580..909e5f0613efa 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/manage-batch-payment-sessions.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/manage-batch-payment-sessions.ts @@ -59,6 +59,64 @@ import { PaymentCollectionService } from "../../../../services" * .then(({ payment_collection }) => { * console.log(payment_collection.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useManageMultiplePaymentSessions } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const managePaymentSessions = useManageMultiplePaymentSessions( + * paymentCollectionId + * ) + * + * const handleManagePaymentSessions = () => { + * // Total amount = 10000 + * + * // Example 1: Adding two new sessions + * managePaymentSessions.mutate({ + * sessions: [ + * { + * provider_id: "stripe", + * amount: 5000, + * }, + * { + * provider_id: "manual", + * amount: 5000, + * }, + * ] + * }, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.payment_sessions) + * } + * }) + * + * // Example 2: Updating one session and removing the other + * managePaymentSessions.mutate({ + * sessions: [ + * { + * provider_id: "stripe", + * amount: 10000, + * session_id: "ps_123456" + * }, + * ] + * }, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection * - lang: Shell * label: cURL * source: | @@ -139,6 +197,7 @@ export class StorePostPaymentCollectionsSessionsReq { /** * @schema StorePostPaymentCollectionsBatchSessionsReq * type: object + * description: "The details of the payment sessions to manage." * required: * - sessions * properties: diff --git a/packages/medusa/src/api/routes/store/payment-collections/manage-payment-session.ts b/packages/medusa/src/api/routes/store/payment-collections/manage-payment-session.ts index bb01a1ef3f67c..4ffa24ebbed35 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/manage-payment-session.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/manage-payment-session.ts @@ -29,6 +29,39 @@ import { PaymentCollectionService } from "../../../../services" * .then(({ payment_collection }) => { * console.log(payment_collection.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useManagePaymentSession } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const managePaymentSession = useManagePaymentSession( + * paymentCollectionId + * ) + * + * const handleManagePaymentSession = ( + * providerId: string + * ) => { + * managePaymentSession.mutate({ + * provider_id: providerId + * }, { + * onSuccess: ({ payment_collection }) => { + * console.log(payment_collection.payment_sessions) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection * - lang: Shell * label: cURL * source: | @@ -88,6 +121,7 @@ export default async (req, res) => { /** * @schema StorePaymentCollectionSessionsReq * type: object + * description: "The details of the payment session to manage." * required: * - provider_id * properties: diff --git a/packages/medusa/src/api/routes/store/payment-collections/refresh-payment-session.ts b/packages/medusa/src/api/routes/store/payment-collections/refresh-payment-session.ts index 5800b4fe2d34e..0c34dac704079 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/refresh-payment-session.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/refresh-payment-session.ts @@ -22,6 +22,36 @@ import { PaymentCollectionService } from "../../../../services" * .then(({ payment_session }) => { * console.log(payment_session.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { usePaymentCollectionRefreshPaymentSession } from "medusa-react" + * + * type Props = { + * paymentCollectionId: string + * } + * + * const PaymentCollection = ({ + * paymentCollectionId + * }: Props) => { + * const refreshPaymentSession = usePaymentCollectionRefreshPaymentSession( + * paymentCollectionId + * ) + * // ... + * + * const handleRefreshPaymentSession = (paymentSessionId: string) => { + * refreshPaymentSession.mutate(paymentSessionId, { + * onSuccess: ({ payment_session }) => { + * console.log(payment_session.status) + * } + * }) + * } + * + * // ... + * } + * + * export default PaymentCollection * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/product-categories/get-product-category.ts b/packages/medusa/src/api/routes/store/product-categories/get-product-category.ts index ea29d8381a028..f3c6801ee89ca 100644 --- a/packages/medusa/src/api/routes/store/product-categories/get-product-category.ts +++ b/packages/medusa/src/api/routes/store/product-categories/get-product-category.ts @@ -29,6 +29,30 @@ import { defaultStoreCategoryScope } from "." * .then(({ product_category }) => { * console.log(product_category.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useProductCategory } from "medusa-react" + * + * type Props = { + * categoryId: string + * } + * + * const Category = ({ categoryId }: Props) => { + * const { product_category, isLoading } = useProductCategory( + * categoryId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {product_category && {product_category.name}} + *
+ * ) + * } + * + * export default Category * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/product-categories/list-product-categories.ts b/packages/medusa/src/api/routes/store/product-categories/list-product-categories.ts index 41892d7aa84e4..fcee7dcdc8751 100644 --- a/packages/medusa/src/api/routes/store/product-categories/list-product-categories.ts +++ b/packages/medusa/src/api/routes/store/product-categories/list-product-categories.ts @@ -39,6 +39,38 @@ import { defaultStoreCategoryScope } from "." * .then(({ product_categories, limit, offset, count }) => { * console.log(product_categories.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useProductCategories } from "medusa-react" + * + * function Categories() { + * const { + * product_categories, + * isLoading, + * } = useProductCategories() + * + * return ( + *
+ * {isLoading && Loading...} + * {product_categories && !product_categories.length && ( + * No Categories + * )} + * {product_categories && product_categories.length > 0 && ( + *
    + * {product_categories.map( + * (category) => ( + *
  • {category.name}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Categories * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/product-tags/list-product-tags.ts b/packages/medusa/src/api/routes/store/product-tags/list-product-tags.ts index 7ffd40e4c800d..243cca5e52fc5 100644 --- a/packages/medusa/src/api/routes/store/product-tags/list-product-tags.ts +++ b/packages/medusa/src/api/routes/store/product-tags/list-product-tags.ts @@ -96,6 +96,38 @@ import { IsType } from "../../../../utils/validators/is-type" * .then(({ product_tags }) => { * console.log(product_tags.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useProductTags } from "medusa-react" + * + * function Tags() { + * const { + * product_tags, + * isLoading, + * } = useProductTags() + * + * return ( + *
+ * {isLoading && Loading...} + * {product_tags && !product_tags.length && ( + * No Product Tags + * )} + * {product_tags && product_tags.length > 0 && ( + *
    + * {product_tags.map( + * (tag) => ( + *
  • {tag.value}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Tags * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/product-types/list-product-types.ts b/packages/medusa/src/api/routes/store/product-types/list-product-types.ts index 8c1c6e3c3c04e..8b3ae69614cbe 100644 --- a/packages/medusa/src/api/routes/store/product-types/list-product-types.ts +++ b/packages/medusa/src/api/routes/store/product-types/list-product-types.ts @@ -96,6 +96,38 @@ import ProductTypeService from "../../../../services/product-type" * .then(({ product_types }) => { * console.log(product_types.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useProductTypes } from "medusa-react" + * + * function Types() { + * const { + * product_types, + * isLoading, + * } = useProductTypes() + * + * return ( + *
+ * {isLoading && Loading...} + * {product_types && !product_types.length && ( + * No Product Types + * )} + * {product_types && product_types.length > 0 && ( + *
    + * {product_types.map( + * (type) => ( + *
  • {type.value}
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default Types * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/products/get-product.ts b/packages/medusa/src/api/routes/store/products/get-product.ts index 22bd7ca0a4e52..3f384352ddd1e 100644 --- a/packages/medusa/src/api/routes/store/products/get-product.ts +++ b/packages/medusa/src/api/routes/store/products/get-product.ts @@ -55,6 +55,28 @@ import { defaultStoreProductRemoteQueryObject } from "./index" * .then(({ product }) => { * console.log(product.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useProduct } from "medusa-react" + * + * type Props = { + * productId: string + * } + * + * const Product = ({ productId }: Props) => { + * const { product, isLoading } = useProduct(productId) + * + * return ( + *
+ * {isLoading && Loading...} + * {product && {product.title}} + *
+ * ) + * } + * + * export default Product * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/products/list-products.ts b/packages/medusa/src/api/routes/store/products/list-products.ts index ed33a2cf57e76..bcbfcc81d9799 100644 --- a/packages/medusa/src/api/routes/store/products/list-products.ts +++ b/packages/medusa/src/api/routes/store/products/list-products.ts @@ -188,6 +188,31 @@ import { defaultStoreProductRemoteQueryObject } from "./index" * .then(({ products, limit, offset, count }) => { * console.log(products.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useProducts } from "medusa-react" + * + * const Products = () => { + * const { products, isLoading } = useProducts() + * + * return ( + *
+ * {isLoading && Loading...} + * {products && !products.length && No Products} + * {products && products.length > 0 && ( + *
    + * {products.map((product) => ( + *
  • {product.title}
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Products * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/regions/get-region.ts b/packages/medusa/src/api/routes/store/regions/get-region.ts index e4a195cc87b36..fd32d2cd9bd41 100644 --- a/packages/medusa/src/api/routes/store/regions/get-region.ts +++ b/packages/medusa/src/api/routes/store/regions/get-region.ts @@ -20,6 +20,30 @@ import { FindParams } from "../../../../types/common" * .then(({ region }) => { * console.log(region.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useRegion } from "medusa-react" + * + * type Props = { + * regionId: string + * } + * + * const Region = ({ regionId }: Props) => { + * const { region, isLoading } = useRegion( + * regionId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {region && {region.name}} + *
+ * ) + * } + * + * export default Region * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/regions/list-regions.ts b/packages/medusa/src/api/routes/store/regions/list-regions.ts index ce08ad221d38e..6c3303fded83d 100644 --- a/packages/medusa/src/api/routes/store/regions/list-regions.ts +++ b/packages/medusa/src/api/routes/store/regions/list-regions.ts @@ -76,6 +76,32 @@ import { * .then(({ regions, count, limit, offset }) => { * console.log(regions.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useRegions } from "medusa-react" + * + * const Regions = () => { + * const { regions, isLoading } = useRegions() + * + * return ( + *
+ * {isLoading && Loading...} + * {regions?.length && ( + *
    + * {regions.map((region) => ( + *
  • + * {region.name} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default Regions * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/return-reasons/get-reason.ts b/packages/medusa/src/api/routes/store/return-reasons/get-reason.ts index 3eec6a43424de..57c99de3ce37f 100644 --- a/packages/medusa/src/api/routes/store/return-reasons/get-reason.ts +++ b/packages/medusa/src/api/routes/store/return-reasons/get-reason.ts @@ -23,6 +23,33 @@ import ReturnReasonService from "../../../../services/return-reason" * .then(({ return_reason }) => { * console.log(return_reason.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useReturnReason } from "medusa-react" + * + * type Props = { + * returnReasonId: string + * } + * + * const ReturnReason = ({ returnReasonId }: Props) => { + * const { + * return_reason, + * isLoading + * } = useReturnReason( + * returnReasonId + * ) + * + * return ( + *
+ * {isLoading && Loading...} + * {return_reason && {return_reason.label}} + *
+ * ) + * } + * + * export default ReturnReason * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/return-reasons/list-reasons.ts b/packages/medusa/src/api/routes/store/return-reasons/list-reasons.ts index a8a7ec945c5b1..0f2a12bf825e9 100644 --- a/packages/medusa/src/api/routes/store/return-reasons/list-reasons.ts +++ b/packages/medusa/src/api/routes/store/return-reasons/list-reasons.ts @@ -21,6 +21,35 @@ import ReturnReasonService from "../../../../services/return-reason" * .then(({ return_reasons }) => { * console.log(return_reasons.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useReturnReasons } from "medusa-react" + * + * const ReturnReasons = () => { + * const { + * return_reasons, + * isLoading + * } = useReturnReasons() + * + * return ( + *
+ * {isLoading && Loading...} + * {return_reasons?.length && ( + *
    + * {return_reasons.map((returnReason) => ( + *
  • + * {returnReason.label} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ReturnReasons * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/returns/create-return.ts b/packages/medusa/src/api/routes/store/returns/create-return.ts index 2e36a844edbda..1e59b76870206 100644 --- a/packages/medusa/src/api/routes/store/returns/create-return.ts +++ b/packages/medusa/src/api/routes/store/returns/create-return.ts @@ -51,6 +51,45 @@ import { Logger } from "@medusajs/types" * .then((data) => { * console.log(data.return.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCreateReturn } from "medusa-react" + * + * type CreateReturnData = { + * items: { + * item_id: string, + * quantity: number + * }[] + * return_shipping: { + * option_id: string + * } + * } + * + * type Props = { + * orderId: string + * } + * + * const CreateReturn = ({ orderId }: Props) => { + * const createReturn = useCreateReturn() + * // ... + * + * const handleCreate = (data: CreateReturnData) => { + * createReturn.mutate({ + * ...data, + * order_id: orderId + * }, { + * onSuccess: ({ return: returnData }) => { + * console.log(returnData.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateReturn * - lang: Shell * label: cURL * source: | @@ -259,6 +298,7 @@ class Item { /** * @schema StorePostReturnsReq * type: object + * description: "The details of the return to create." * required: * - order_id * - items diff --git a/packages/medusa/src/api/routes/store/shipping-options/list-options.ts b/packages/medusa/src/api/routes/store/shipping-options/list-options.ts index 5cb6bdb5f92f5..bbb2655f0092c 100644 --- a/packages/medusa/src/api/routes/store/shipping-options/list-options.ts +++ b/packages/medusa/src/api/routes/store/shipping-options/list-options.ts @@ -31,6 +31,36 @@ import { validator } from "../../../../utils/validator" * .then(({ shipping_options }) => { * console.log(shipping_options.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useShippingOptions } from "medusa-react" + * + * const ShippingOptions = () => { + * const { + * shipping_options, + * isLoading, + * } = useShippingOptions() + * + * return ( + *
+ * {isLoading && Loading...} + * {shipping_options?.length && + * shipping_options?.length > 0 && ( + *
    + * {shipping_options?.map((shipping_option) => ( + *
  • + * {shipping_option.id} + *
    • + * ))} + *
+ * )} + *
+ * ) + * } + * + * export default ShippingOptions * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/shipping-options/list-shipping-options.ts b/packages/medusa/src/api/routes/store/shipping-options/list-shipping-options.ts index c7219e8a1f30f..62b6167ae9027 100644 --- a/packages/medusa/src/api/routes/store/shipping-options/list-shipping-options.ts +++ b/packages/medusa/src/api/routes/store/shipping-options/list-shipping-options.ts @@ -23,6 +23,42 @@ import ShippingProfileService from "../../../../services/shipping-profile" * .then(({ shipping_options }) => { * console.log(shipping_options.length); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCartShippingOptions } from "medusa-react" + * + * type Props = { + * cartId: string + * } + * + * const ShippingOptions = ({ cartId }: Props) => { + * const { shipping_options, isLoading } = + * useCartShippingOptions(cartId) + * + * return ( + *
+ * {isLoading && Loading...} + * {shipping_options && !shipping_options.length && ( + * No shipping options + * )} + * {shipping_options && ( + *
    + * {shipping_options.map( + * (shipping_option) => ( + *
  • + * {shipping_option.name} + *
    • + * ) + * )} + *
+ * )} + *
+ * ) + * } + * + * export default ShippingOptions * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/api/routes/store/swaps/create-swap.ts b/packages/medusa/src/api/routes/store/swaps/create-swap.ts index dd2260bdc6885..f71c0e40f9bc9 100644 --- a/packages/medusa/src/api/routes/store/swaps/create-swap.ts +++ b/packages/medusa/src/api/routes/store/swaps/create-swap.ts @@ -63,6 +63,51 @@ import { validator } from "../../../../utils/validator" * .then(({ swap }) => { * console.log(swap.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCreateSwap } from "medusa-react" + * + * type Props = { + * orderId: string + * } + * + * type CreateData = { + * return_items: { + * item_id: string + * quantity: number + * }[] + * additional_items: { + * variant_id: string + * quantity: number + * }[] + * return_shipping_option: string + * } + * + * const CreateSwap = ({ + * orderId + * }: Props) => { + * const createSwap = useCreateSwap() + * // ... + * + * const handleCreate = ( + * data: CreateData + * ) => { + * createSwap.mutate({ + * ...data, + * order_id: orderId + * }, { + * onSuccess: ({ swap }) => { + * console.log(swap.id) + * } + * }) + * } + * + * // ... + * } + * + * export default CreateSwap * - lang: Shell * label: cURL * source: | @@ -292,6 +337,7 @@ class AdditionalItem { /** * @schema StorePostSwapsReq * type: object + * description: "The details of the swap to create." * required: * - order_id * - return_items diff --git a/packages/medusa/src/api/routes/store/swaps/get-swap-by-cart.ts b/packages/medusa/src/api/routes/store/swaps/get-swap-by-cart.ts index 26a42254309a4..5e1e321e64e53 100644 --- a/packages/medusa/src/api/routes/store/swaps/get-swap-by-cart.ts +++ b/packages/medusa/src/api/routes/store/swaps/get-swap-by-cart.ts @@ -20,6 +20,31 @@ import { defaultStoreSwapRelations } from "." * .then(({ swap }) => { * console.log(swap.id); * }) + * - lang: tsx + * label: Medusa React + * source: | + * import React from "react" + * import { useCartSwap } from "medusa-react" + * type Props = { + * cartId: string + * } + * + * const Swap = ({ cartId }: Props) => { + * const { + * swap, + * isLoading, + * } = useCartSwap(cartId) + * + * return ( + *
+ * {isLoading && Loading...} + * {swap && {swap.id}} + * + *
+ * ) + * } + * + * export default Swap * - lang: Shell * label: cURL * source: | diff --git a/packages/medusa/src/types/common.ts b/packages/medusa/src/types/common.ts index 381214cfbe922..47a1263b61b22 100644 --- a/packages/medusa/src/types/common.ts +++ b/packages/medusa/src/types/common.ts @@ -163,7 +163,7 @@ export type PaginatedResponse = { /** * @interface * - * The response returned for a DELETE request. + * The response returned for a `DELETE` request. */ export type DeleteResponse = { /** diff --git a/www/apps/api-reference/package.json b/www/apps/api-reference/package.json index fd32b5391884e..1fb6dc027f445 100644 --- a/www/apps/api-reference/package.json +++ b/www/apps/api-reference/package.json @@ -35,7 +35,7 @@ "openapi-sampler": "^1.3.1", "openapi-types": "^12.1.3", "postcss": "8.4.27", - "prism-react-renderer": "^2.3.0", + "prism-react-renderer": "2.3.1", "react": "latest", "react-dom": "latest", "react-instantsearch": "^7.0.1", diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_auth/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_auth/deleteundefined new file mode 100644 index 0000000000000..f7e0c99715dca --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_auth/deleteundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useAdminDeleteSession } from "medusa-react" + +const Logout = () => { + const adminLogout = useAdminDeleteSession() + // ... + + const handleLogout = () => { + adminLogout.mutate(undefined, { + onSuccess: () => { + // user logged out. + } + }) + } + + // ... +} + +export default Logout diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_auth/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_auth/getundefined new file mode 100644 index 0000000000000..31843ba03f2ac --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_auth/getundefined @@ -0,0 +1,15 @@ +import React from "react" +import { useAdminGetSession } from "medusa-react" + +const Profile = () => { + const { user, isLoading } = useAdminGetSession() + + return ( +
+ {isLoading && Loading...} + {user && {user.email}} +
+ ) +} + +export default Profile diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_auth/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_auth/postundefined new file mode 100644 index 0000000000000..d12e8e0da6e7b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_auth/postundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useAdminLogin } from "medusa-react" + +const Login = () => { + const adminLogin = useAdminLogin() + // ... + + const handleLogin = () => { + adminLogin.mutate({ + email: "user@example.com", + password: "supersecret", + }, { + onSuccess: ({ user }) => { + console.log(user) + } + }) + } + + // ... +} + +export default Login diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs/getundefined new file mode 100644 index 0000000000000..649608f7aa534 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs/getundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminBatchJobs } from "medusa-react" + +const BatchJobs = () => { + const { + batch_jobs, + limit, + offset, + count, + isLoading + } = useAdminBatchJobs() + + return ( +
+ {isLoading && Loading...} + {batch_jobs?.length && ( +
    + {batch_jobs.map((batchJob) => ( +
  • + {batchJob.id} +
    • + ))} +
+ )} +
+ ) +} + +export default BatchJobs diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs/postundefined new file mode 100644 index 0000000000000..feaf488e08b76 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs/postundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminCreateBatchJob } from "medusa-react" + +const CreateBatchJob = () => { + const createBatchJob = useAdminCreateBatchJob() + // ... + + const handleCreateBatchJob = () => { + createBatchJob.mutate({ + type: "publish-products", + context: {}, + dry_run: true + }, { + onSuccess: ({ batch_job }) => { + console.log(batch_job) + } + }) + } + + // ... +} + +export default CreateBatchJob diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs_{id}/getundefined new file mode 100644 index 0000000000000..8f46818fcbe30 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs_{id}/getundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useAdminBatchJob } from "medusa-react" + +type Props = { + batchJobId: string +} + +const BatchJob = ({ batchJobId }: Props) => { + const { batch_job, isLoading } = useAdminBatchJob(batchJobId) + + return ( +
+ {isLoading && Loading...} + {batch_job && {batch_job.created_by}} +
+ ) +} + +export default BatchJob diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs_{id}_cancel/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs_{id}_cancel/postundefined new file mode 100644 index 0000000000000..d64dd6a396653 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs_{id}_cancel/postundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminCancelBatchJob } from "medusa-react" + +type Props = { + batchJobId: string +} + +const BatchJob = ({ batchJobId }: Props) => { + const cancelBatchJob = useAdminCancelBatchJob(batchJobId) + // ... + + const handleCancel = () => { + cancelBatchJob.mutate(undefined, { + onSuccess: ({ batch_job }) => { + console.log(batch_job) + } + }) + } + + // ... +} + +export default BatchJob diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs_{id}_confirm/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs_{id}_confirm/postundefined new file mode 100644 index 0000000000000..10cccca092f6a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_batch-jobs_{id}_confirm/postundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminConfirmBatchJob } from "medusa-react" + +type Props = { + batchJobId: string +} + +const BatchJob = ({ batchJobId }: Props) => { + const confirmBatchJob = useAdminConfirmBatchJob(batchJobId) + // ... + + const handleConfirm = () => { + confirmBatchJob.mutate(undefined, { + onSuccess: ({ batch_job }) => { + console.log(batch_job) + } + }) + } + + // ... +} + +export default BatchJob diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections/getundefined new file mode 100644 index 0000000000000..6a75994666b09 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminCollections } from "medusa-react" + +const Collections = () => { + const { collections, isLoading } = useAdminCollections() + + return ( +
+ {isLoading && Loading...} + {collections && !collections.length && + No Product Collections + } + {collections && collections.length > 0 && ( +
    + {collections.map((collection) => ( +
  • {collection.title}
    • + ))} +
+ )} +
+ ) +} + +export default Collections diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections/postundefined new file mode 100644 index 0000000000000..5a7968c237aed --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections/postundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminCreateCollection } from "medusa-react" + +const CreateCollection = () => { + const createCollection = useAdminCreateCollection() + // ... + + const handleCreate = (title: string) => { + createCollection.mutate({ + title + }, { + onSuccess: ({ collection }) => { + console.log(collection.id) + } + }) + } + + // ... +} + +export default CreateCollection diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}/deleteundefined new file mode 100644 index 0000000000000..13b16dd02b038 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}/deleteundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminDeleteCollection } from "medusa-react" + +type Props = { + collectionId: string +} + +const Collection = ({ collectionId }: Props) => { + const deleteCollection = useAdminDeleteCollection(collectionId) + // ... + + const handleDelete = (title: string) => { + deleteCollection.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default Collection diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}/getundefined new file mode 100644 index 0000000000000..97baebadfe0af --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}/getundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useAdminCollection } from "medusa-react" + +type Props = { + collectionId: string +} + +const Collection = ({ collectionId }: Props) => { + const { collection, isLoading } = useAdminCollection(collectionId) + + return ( +
+ {isLoading && Loading...} + {collection && {collection.title}} +
+ ) +} + +export default Collection diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}/postundefined new file mode 100644 index 0000000000000..ece82e028f12b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminUpdateCollection } from "medusa-react" + +type Props = { + collectionId: string +} + +const Collection = ({ collectionId }: Props) => { + const updateCollection = useAdminUpdateCollection(collectionId) + // ... + + const handleUpdate = (title: string) => { + updateCollection.mutate({ + title + }, { + onSuccess: ({ collection }) => { + console.log(collection.id) + } + }) + } + + // ... +} + +export default Collection diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}_products_batch/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}_products_batch/deleteundefined new file mode 100644 index 0000000000000..96816c17931ab --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}_products_batch/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminRemoveProductsFromCollection } from "medusa-react" + +type Props = { + collectionId: string +} + +const Collection = ({ collectionId }: Props) => { + const removeProducts = useAdminRemoveProductsFromCollection(collectionId) + // ... + + const handleRemoveProducts = (productIds: string[]) => { + removeProducts.mutate({ + product_ids: productIds + }, { + onSuccess: ({ id, object, removed_products }) => { + console.log(removed_products) + } + }) + } + + // ... +} + +export default Collection diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}_products_batch/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}_products_batch/postundefined new file mode 100644 index 0000000000000..4d05b2ef9f218 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_collections_{id}_products_batch/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminAddProductsToCollection } from "medusa-react" + +type Props = { + collectionId: string +} + +const Collection = ({ collectionId }: Props) => { + const addProducts = useAdminAddProductsToCollection(collectionId) + // ... + + const handleAddProducts = (productIds: string[]) => { + addProducts.mutate({ + product_ids: productIds + }, { + onSuccess: ({ collection }) => { + console.log(collection.products) + } + }) + } + + // ... +} + +export default Collection diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_currencies/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_currencies/getundefined new file mode 100644 index 0000000000000..3baf56da8735a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_currencies/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminCurrencies } from "medusa-react" + +const Currencies = () => { + const { currencies, isLoading } = useAdminCurrencies() + + return ( +
+ {isLoading && Loading...} + {currencies && !currencies.length && ( + No Currencies + )} + {currencies && currencies.length > 0 && ( +
    + {currencies.map((currency) => ( +
  • {currency.name}
    • + ))} +
+ )} +
+ ) +} + +export default Currencies diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_currencies_{code}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_currencies_{code}/postundefined new file mode 100644 index 0000000000000..e15e86c718c0d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_currencies_{code}/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminUpdateCurrency } from "medusa-react" + +type Props = { + currencyCode: string +} + +const Currency = ({ currencyCode }: Props) => { + const updateCurrency = useAdminUpdateCurrency(currencyCode) + // ... + + const handleUpdate = (includes_tax: boolean) => { + updateCurrency.mutate({ + includes_tax, + }, { + onSuccess: ({ currency }) => { + console.log(currency) + } + }) + } + + // ... +} + +export default Currency diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups/getundefined new file mode 100644 index 0000000000000..2fed5941ebf78 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups/getundefined @@ -0,0 +1,31 @@ +import React from "react" +import { useAdminCustomerGroups } from "medusa-react" + +const CustomerGroups = () => { + const { + customer_groups, + isLoading, + } = useAdminCustomerGroups() + + return ( +
+ {isLoading && Loading...} + {customer_groups && !customer_groups.length && ( + No Customer Groups + )} + {customer_groups && customer_groups.length > 0 && ( +
    + {customer_groups.map( + (customerGroup) => ( +
  • + {customerGroup.name} +
    • + ) + )} +
+ )} +
+ ) +} + +export default CustomerGroups diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups/postundefined new file mode 100644 index 0000000000000..caed96f9cd08b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups/postundefined @@ -0,0 +1,17 @@ +import React from "react" +import { useAdminCreateCustomerGroup } from "medusa-react" + +const CreateCustomerGroup = () => { + const createCustomerGroup = useAdminCreateCustomerGroup() + // ... + + const handleCreate = (name: string) => { + createCustomerGroup.mutate({ + name, + }) + } + + // ... +} + +export default CreateCustomerGroup diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}/deleteundefined new file mode 100644 index 0000000000000..2ebd8bd7382ae --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}/deleteundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminDeleteCustomerGroup } from "medusa-react" + +type Props = { + customerGroupId: string +} + +const CustomerGroup = ({ customerGroupId }: Props) => { + const deleteCustomerGroup = useAdminDeleteCustomerGroup( + customerGroupId + ) + // ... + + const handleDeleteCustomerGroup = () => { + deleteCustomerGroup.mutate() + } + + // ... +} + +export default CustomerGroup diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}/getundefined new file mode 100644 index 0000000000000..fcec5e8cc8741 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}/getundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminCustomerGroup } from "medusa-react" + +type Props = { + customerGroupId: string +} + +const CustomerGroup = ({ customerGroupId }: Props) => { + const { customer_group, isLoading } = useAdminCustomerGroup( + customerGroupId + ) + + return ( +
+ {isLoading && Loading...} + {customer_group && {customer_group.name}} +
+ ) +} + +export default CustomerGroup diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}/postundefined new file mode 100644 index 0000000000000..a9a402f054c15 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}/postundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminUpdateCustomerGroup } from "medusa-react" + +type Props = { + customerGroupId: string +} + +const CustomerGroup = ({ customerGroupId }: Props) => { + const updateCustomerGroup = useAdminUpdateCustomerGroup( + customerGroupId + ) + // .. + + const handleUpdate = (name: string) => { + updateCustomerGroup.mutate({ + name, + }) + } + + // ... +} + +export default CustomerGroup diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}_customers/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}_customers/getundefined new file mode 100644 index 0000000000000..8182bd7596316 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}_customers/getundefined @@ -0,0 +1,33 @@ +import React from "react" +import { useAdminCustomerGroupCustomers } from "medusa-react" + +type Props = { + customerGroupId: string +} + +const CustomerGroup = ({ customerGroupId }: Props) => { + const { + customers, + isLoading, + } = useAdminCustomerGroupCustomers( + customerGroupId + ) + + return ( +
+ {isLoading && Loading...} + {customers && !customers.length && ( + No customers + )} + {customers && customers.length > 0 && ( +
    + {customers.map((customer) => ( +
  • {customer.first_name}
    • + ))} +
+ )} +
+ ) +} + +export default CustomerGroup diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}_customers_batch/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}_customers_batch/deleteundefined new file mode 100644 index 0000000000000..5363f252081ef --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}_customers_batch/deleteundefined @@ -0,0 +1,30 @@ +import React from "react" +import { + useAdminRemoveCustomersFromCustomerGroup, +} from "medusa-react" + +type Props = { + customerGroupId: string +} + +const CustomerGroup = ({ customerGroupId }: Props) => { + const removeCustomers = + useAdminRemoveCustomersFromCustomerGroup( + customerGroupId + ) + // ... + + const handleRemoveCustomer = (customerId: string) => { + removeCustomers.mutate({ + customer_ids: [ + { + id: customerId, + }, + ], + }) + } + + // ... +} + +export default CustomerGroup diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}_customers_batch/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}_customers_batch/postundefined new file mode 100644 index 0000000000000..133cdb0f16da9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customer-groups_{id}_customers_batch/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { + useAdminAddCustomersToCustomerGroup, +} from "medusa-react" + +type Props = { + customerGroupId: string +} + +const CustomerGroup = ({ customerGroupId }: Props) => { + const addCustomers = useAdminAddCustomersToCustomerGroup( + customerGroupId + ) + // ... + + const handleAddCustomers= (customerId: string) => { + addCustomers.mutate({ + customer_ids: [ + { + id: customerId, + }, + ], + }) + } + + // ... +} + +export default CustomerGroup diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers/getundefined new file mode 100644 index 0000000000000..ccd29cf36eb2f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminCustomers } from "medusa-react" + +const Customers = () => { + const { customers, isLoading } = useAdminCustomers() + + return ( +
+ {isLoading && Loading...} + {customers && !customers.length && ( + No customers + )} + {customers && customers.length > 0 && ( +
    + {customers.map((customer) => ( +
  • {customer.first_name}
    • + ))} +
+ )} +
+ ) +} + +export default Customers diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers/postundefined new file mode 100644 index 0000000000000..f211730064853 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers/postundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useAdminCreateCustomer } from "medusa-react" + +type CustomerData = { + first_name: string + last_name: string + email: string + password: string +} + +const CreateCustomer = () => { + const createCustomer = useAdminCreateCustomer() + // ... + + const handleCreate = (customerData: CustomerData) => { + createCustomer.mutate(customerData, { + onSuccess: ({ customer }) => { + console.log(customer.id) + } + }) + } + + // ... +} + +export default CreateCustomer diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers_{id}/getundefined new file mode 100644 index 0000000000000..bae0acc37ccdb --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers_{id}/getundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminCustomer } from "medusa-react" + +type Props = { + customerId: string +} + +const Customer = ({ customerId }: Props) => { + const { customer, isLoading } = useAdminCustomer( + customerId + ) + + return ( +
+ {isLoading && Loading...} + {customer && {customer.first_name}} +
+ ) +} + +export default Customer diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers_{id}/postundefined new file mode 100644 index 0000000000000..65783fd138c24 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_customers_{id}/postundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useAdminUpdateCustomer } from "medusa-react" + +type CustomerData = { + first_name: string + last_name: string + email: string + password: string +} + +type Props = { + customerId: string +} + +const Customer = ({ customerId }: Props) => { + const updateCustomer = useAdminUpdateCustomer(customerId) + // ... + + const handleUpdate = (customerData: CustomerData) => { + updateCustomer.mutate(customerData) + } + + // ... +} + +export default Customer diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts/getundefined new file mode 100644 index 0000000000000..3f765829b5225 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminDiscounts } from "medusa-react" + +const Discounts = () => { + const { discounts, isLoading } = useAdminDiscounts() + + return ( +
+ {isLoading && Loading...} + {discounts && !discounts.length && ( + No customers + )} + {discounts && discounts.length > 0 && ( +
    + {discounts.map((discount) => ( +
  • {discount.code}
    • + ))} +
+ )} +
+ ) +} + +export default Discounts diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts/postundefined new file mode 100644 index 0000000000000..9396d9365bfe1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts/postundefined @@ -0,0 +1,37 @@ +import React from "react" +import { + useAdminCreateDiscount, +} from "medusa-react" +import { + AllocationType, + DiscountRuleType, +} from "@medusajs/medusa" + +const CreateDiscount = () => { + const createDiscount = useAdminCreateDiscount() + // ... + + const handleCreate = ( + currencyCode: string, + regionId: string + ) => { + // ... + createDiscount.mutate({ + code: currencyCode, + rule: { + type: DiscountRuleType.FIXED, + value: 10, + allocation: AllocationType.ITEM, + }, + regions: [ + regionId, + ], + is_dynamic: false, + is_disabled: false, + }) + } + + // ... +} + +export default CreateDiscount diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_code_{code}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_code_{code}/getundefined new file mode 100644 index 0000000000000..8fc922386c137 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_code_{code}/getundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminGetDiscountByCode } from "medusa-react" + +type Props = { + discountCode: string +} + +const Discount = ({ discountCode }: Props) => { + const { discount, isLoading } = useAdminGetDiscountByCode( + discountCode + ) + + return ( +
+ {isLoading && Loading...} + {discount && {discount.code}} +
+ ) +} + +export default Discount diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions/postundefined new file mode 100644 index 0000000000000..302dd8800fbc0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions/postundefined @@ -0,0 +1,30 @@ +import React from "react" +import { DiscountConditionOperator } from "@medusajs/medusa" +import { useAdminDiscountCreateCondition } from "medusa-react" + +type Props = { + discountId: string +} + +const Discount = ({ discountId }: Props) => { + const createCondition = useAdminDiscountCreateCondition(discountId) + // ... + + const handleCreateCondition = ( + operator: DiscountConditionOperator, + products: string[] + ) => { + createCondition.mutate({ + operator, + products + }, { + onSuccess: ({ discount }) => { + console.log(discount.id) + } + }) + } + + // ... +} + +export default Discount diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/deleteundefined new file mode 100644 index 0000000000000..92649d199e2b0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/deleteundefined @@ -0,0 +1,29 @@ +import React from "react" +import { + useAdminDiscountRemoveCondition +} from "medusa-react" + +type Props = { + discountId: string +} + +const Discount = ({ discountId }: Props) => { + const deleteCondition = useAdminDiscountRemoveCondition( + discountId + ) + // ... + + const handleDelete = ( + conditionId: string + ) => { + deleteCondition.mutate(conditionId, { + onSuccess: ({ id, object, deleted }) => { + console.log(deleted) + } + }) + } + + // ... +} + +export default Discount diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/getundefined new file mode 100644 index 0000000000000..fcc1761abb3d4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/getundefined @@ -0,0 +1,31 @@ +import React from "react" +import { useAdminGetDiscountCondition } from "medusa-react" + +type Props = { + discountId: string + discountConditionId: string +} + +const DiscountCondition = ({ + discountId, + discountConditionId +}: Props) => { + const { + discount_condition, + isLoading + } = useAdminGetDiscountCondition( + discountId, + discountConditionId + ) + + return ( +
+ {isLoading && Loading...} + {discount_condition && ( + {discount_condition.type} + )} +
+ ) +} + +export default DiscountCondition diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/postundefined new file mode 100644 index 0000000000000..5a37d9c29692c --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/postundefined @@ -0,0 +1,34 @@ +import React from "react" +import { useAdminDiscountUpdateCondition } from "medusa-react" + +type Props = { + discountId: string + conditionId: string +} + +const DiscountCondition = ({ + discountId, + conditionId +}: Props) => { + const update = useAdminDiscountUpdateCondition( + discountId, + conditionId + ) + // ... + + const handleUpdate = ( + products: string[] + ) => { + update.mutate({ + products + }, { + onSuccess: ({ discount }) => { + console.log(discount.id) + } + }) + } + + // ... +} + +export default DiscountCondition diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}_batch/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}_batch/deleteundefined new file mode 100644 index 0000000000000..8a7ccea0253b7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}_batch/deleteundefined @@ -0,0 +1,38 @@ +import React from "react" +import { + useAdminDeleteDiscountConditionResourceBatch +} from "medusa-react" + +type Props = { + discountId: string + conditionId: string +} + +const DiscountCondition = ({ + discountId, + conditionId +}: Props) => { + const deleteConditionResource = useAdminDeleteDiscountConditionResourceBatch( + discountId, + conditionId, + ) + // ... + + const handleDelete = (itemId: string) => { + deleteConditionResource.mutate({ + resources: [ + { + id: itemId + } + ] + }, { + onSuccess: ({ discount }) => { + console.log(discount.id) + } + }) + } + + // ... +} + +export default DiscountCondition diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}_batch/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}_batch/postundefined new file mode 100644 index 0000000000000..4683656cd0f5d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}_batch/postundefined @@ -0,0 +1,38 @@ +import React from "react" +import { + useAdminAddDiscountConditionResourceBatch +} from "medusa-react" + +type Props = { + discountId: string + conditionId: string +} + +const DiscountCondition = ({ + discountId, + conditionId +}: Props) => { + const addConditionResources = useAdminAddDiscountConditionResourceBatch( + discountId, + conditionId + ) + // ... + + const handleAdd = (itemId: string) => { + addConditionResources.mutate({ + resources: [ + { + id: itemId + } + ] + }, { + onSuccess: ({ discount }) => { + console.log(discount.id) + } + }) + } + + // ... +} + +export default DiscountCondition diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}/deleteundefined new file mode 100644 index 0000000000000..2793d68b654d0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}/deleteundefined @@ -0,0 +1,15 @@ +import React from "react" +import { useAdminDeleteDiscount } from "medusa-react" + +const Discount = () => { + const deleteDiscount = useAdminDeleteDiscount(discount_id) + // ... + + const handleDelete = () => { + deleteDiscount.mutate() + } + + // ... +} + +export default Discount diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}/getundefined new file mode 100644 index 0000000000000..ecc8cb26e4875 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}/getundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminDiscount } from "medusa-react" + +type Props = { + discountId: string +} + +const Discount = ({ discountId }: Props) => { + const { discount, isLoading } = useAdminDiscount( + discountId + ) + + return ( +
+ {isLoading && Loading...} + {discount && {discount.code}} +
+ ) +} + +export default Discount diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}/postundefined new file mode 100644 index 0000000000000..26a0b502c240d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}/postundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminUpdateDiscount } from "medusa-react" + +type Props = { + discountId: string +} + +const Discount = ({ discountId }: Props) => { + const updateDiscount = useAdminUpdateDiscount(discountId) + // ... + + const handleUpdate = (isDisabled: boolean) => { + updateDiscount.mutate({ + is_disabled: isDisabled, + }) + } + + // ... +} + +export default Discount diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_dynamic-codes/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_dynamic-codes/postundefined new file mode 100644 index 0000000000000..2b6770b8ca05b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_dynamic-codes/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminCreateDynamicDiscountCode } from "medusa-react" + +type Props = { + discountId: string +} + +const Discount = ({ discountId }: Props) => { + const createDynamicDiscount = useAdminCreateDynamicDiscountCode(discountId) + // ... + + const handleCreate = ( + code: string, + usageLimit: number + ) => { + createDynamicDiscount.mutate({ + code, + usage_limit: usageLimit + }, { + onSuccess: ({ discount }) => { + console.log(discount.is_dynamic) + } + }) + } + + // ... +} + +export default Discount diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_dynamic-codes_{code}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_dynamic-codes_{code}/deleteundefined new file mode 100644 index 0000000000000..ee8a6e59d257e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_dynamic-codes_{code}/deleteundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminDeleteDynamicDiscountCode } from "medusa-react" + +type Props = { + discountId: string +} + +const Discount = ({ discountId }: Props) => { + const deleteDynamicDiscount = useAdminDeleteDynamicDiscountCode(discountId) + // ... + + const handleDelete = (code: string) => { + deleteDynamicDiscount.mutate(code, { + onSuccess: ({ discount }) => { + console.log(discount.is_dynamic) + } + }) + } + + // ... +} + +export default Discount diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_regions_{region_id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_regions_{region_id}/deleteundefined new file mode 100644 index 0000000000000..417384ee942d2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_regions_{region_id}/deleteundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminDiscountRemoveRegion } from "medusa-react" + +type Props = { + discountId: string +} + +const Discount = ({ discountId }: Props) => { + const deleteRegion = useAdminDiscountRemoveRegion(discountId) + // ... + + const handleDelete = (regionId: string) => { + deleteRegion.mutate(regionId, { + onSuccess: ({ discount }) => { + console.log(discount.regions) + } + }) + } + + // ... +} + +export default Discount diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_regions_{region_id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_regions_{region_id}/postundefined new file mode 100644 index 0000000000000..d146c8b91a12b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_discounts_{id}_regions_{region_id}/postundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminDiscountAddRegion } from "medusa-react" + +type Props = { + discountId: string +} + +const Discount = ({ discountId }: Props) => { + const addRegion = useAdminDiscountAddRegion(discountId) + // ... + + const handleAdd = (regionId: string) => { + addRegion.mutate(regionId, { + onSuccess: ({ discount }) => { + console.log(discount.regions) + } + }) + } + + // ... +} + +export default Discount diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders/getundefined new file mode 100644 index 0000000000000..9427212b0b860 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminDraftOrders } from "medusa-react" + +const DraftOrders = () => { + const { draft_orders, isLoading } = useAdminDraftOrders() + + return ( +
+ {isLoading && Loading...} + {draft_orders && !draft_orders.length && ( + No Draft Orders + )} + {draft_orders && draft_orders.length > 0 && ( +
    + {draft_orders.map((order) => ( +
  • {order.display_id}
    • + ))} +
+ )} +
+ ) +} + +export default DraftOrders diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders/postundefined new file mode 100644 index 0000000000000..74b97ed2123a7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders/postundefined @@ -0,0 +1,32 @@ +import React from "react" +import { useAdminCreateDraftOrder } from "medusa-react" + +type DraftOrderData = { + email: string + region_id: string + items: { + quantity: number, + variant_id: string + }[] + shipping_methods: { + option_id: string + price: number + }[] +} + +const CreateDraftOrder = () => { + const createDraftOrder = useAdminCreateDraftOrder() + // ... + + const handleCreate = (data: DraftOrderData) => { + createDraftOrder.mutate(data, { + onSuccess: ({ draft_order }) => { + console.log(draft_order.id) + } + }) + } + + // ... +} + +export default CreateDraftOrder diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}/deleteundefined new file mode 100644 index 0000000000000..36ef1a96bdde8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDeleteDraftOrder } from "medusa-react" + +type Props = { + draftOrderId: string +} + +const DraftOrder = ({ draftOrderId }: Props) => { + const deleteDraftOrder = useAdminDeleteDraftOrder( + draftOrderId + ) + // ... + + const handleDelete = () => { + deleteDraftOrder.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default DraftOrder diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}/getundefined new file mode 100644 index 0000000000000..fc770501ae8fc --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}/getundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminDraftOrder } from "medusa-react" + +type Props = { + draftOrderId: string +} + +const DraftOrder = ({ draftOrderId }: Props) => { + const { + draft_order, + isLoading, + } = useAdminDraftOrder(draftOrderId) + + return ( +
+ {isLoading && Loading...} + {draft_order && {draft_order.display_id}} + +
+ ) +} + +export default DraftOrder diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}/postundefined new file mode 100644 index 0000000000000..878c466f010b1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminUpdateDraftOrder } from "medusa-react" + +type Props = { + draftOrderId: string +} + +const DraftOrder = ({ draftOrderId }: Props) => { + const updateDraftOrder = useAdminUpdateDraftOrder( + draftOrderId + ) + // ... + + const handleUpdate = (email: string) => { + updateDraftOrder.mutate({ + email, + }, { + onSuccess: ({ draft_order }) => { + console.log(draft_order.id) + } + }) + } + + // ... +} + +export default DraftOrder diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_line-items/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_line-items/postundefined new file mode 100644 index 0000000000000..149e78fea2bd3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_line-items/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminDraftOrderAddLineItem } from "medusa-react" + +type Props = { + draftOrderId: string +} + +const DraftOrder = ({ draftOrderId }: Props) => { + const addLineItem = useAdminDraftOrderAddLineItem( + draftOrderId + ) + // ... + + const handleAdd = (quantity: number) => { + addLineItem.mutate({ + quantity, + }, { + onSuccess: ({ draft_order }) => { + console.log(draft_order.cart) + } + }) + } + + // ... +} + +export default DraftOrder diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_line-items_{line_id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_line-items_{line_id}/deleteundefined new file mode 100644 index 0000000000000..6e4a51fdd5488 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_line-items_{line_id}/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDraftOrderRemoveLineItem } from "medusa-react" + +type Props = { + draftOrderId: string +} + +const DraftOrder = ({ draftOrderId }: Props) => { + const deleteLineItem = useAdminDraftOrderRemoveLineItem( + draftOrderId + ) + // ... + + const handleDelete = (itemId: string) => { + deleteLineItem.mutate(itemId, { + onSuccess: ({ draft_order }) => { + console.log(draft_order.cart) + } + }) + } + + // ... +} + +export default DraftOrder diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_line-items_{line_id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_line-items_{line_id}/postundefined new file mode 100644 index 0000000000000..1f11cb96827c6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_line-items_{line_id}/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminDraftOrderUpdateLineItem } from "medusa-react" + +type Props = { + draftOrderId: string +} + +const DraftOrder = ({ draftOrderId }: Props) => { + const updateLineItem = useAdminDraftOrderUpdateLineItem( + draftOrderId + ) + // ... + + const handleUpdate = ( + itemId: string, + quantity: number + ) => { + updateLineItem.mutate({ + item_id: itemId, + quantity, + }) + } + + // ... +} + +export default DraftOrder diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_pay/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_pay/postundefined new file mode 100644 index 0000000000000..fab40520d1100 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_draft-orders_{id}_pay/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDraftOrderRegisterPayment } from "medusa-react" + +type Props = { + draftOrderId: string +} + +const DraftOrder = ({ draftOrderId }: Props) => { + const registerPayment = useAdminDraftOrderRegisterPayment( + draftOrderId + ) + // ... + + const handlePayment = () => { + registerPayment.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.id) + } + }) + } + + // ... +} + +export default DraftOrder diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards/getundefined new file mode 100644 index 0000000000000..851b342b8138e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards/getundefined @@ -0,0 +1,25 @@ +import React from "react" +import { GiftCard } from "@medusajs/medusa" +import { useAdminGiftCards } from "medusa-react" + +const CustomGiftCards = () => { + const { gift_cards, isLoading } = useAdminGiftCards() + + return ( +
+ {isLoading && Loading...} + {gift_cards && !gift_cards.length && ( + No custom gift cards... + )} + {gift_cards && gift_cards.length > 0 && ( +
    + {gift_cards.map((giftCard: GiftCard) => ( +
  • {giftCard.code}
    • + ))} +
+ )} +
+ ) +} + +export default CustomGiftCards diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards/postundefined new file mode 100644 index 0000000000000..7f2d78dbdff71 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminCreateGiftCard } from "medusa-react" + +const CreateCustomGiftCards = () => { + const createGiftCard = useAdminCreateGiftCard() + // ... + + const handleCreate = ( + regionId: string, + value: number + ) => { + createGiftCard.mutate({ + region_id: regionId, + value, + }, { + onSuccess: ({ gift_card }) => { + console.log(gift_card.id) + } + }) + } + + // ... +} + +export default CreateCustomGiftCards diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards_{id}/deleteundefined new file mode 100644 index 0000000000000..66f70ded0816f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards_{id}/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDeleteGiftCard } from "medusa-react" + +type Props = { + customGiftCardId: string +} + +const CustomGiftCard = ({ customGiftCardId }: Props) => { + const deleteGiftCard = useAdminDeleteGiftCard( + customGiftCardId + ) + // ... + + const handleDelete = () => { + deleteGiftCard.mutate(void 0, { + onSuccess: ({ id, object, deleted}) => { + console.log(id) + } + }) + } + + // ... +} + +export default CustomGiftCard diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards_{id}/getundefined new file mode 100644 index 0000000000000..2dede57fba1ca --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards_{id}/getundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useAdminGiftCard } from "medusa-react" + +type Props = { + giftCardId: string +} + +const CustomGiftCard = ({ giftCardId }: Props) => { + const { gift_card, isLoading } = useAdminGiftCard(giftCardId) + + return ( +
+ {isLoading && Loading...} + {gift_card && {gift_card.code}} +
+ ) +} + +export default CustomGiftCard diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards_{id}/postundefined new file mode 100644 index 0000000000000..e5c22ac6beae4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_gift-cards_{id}/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminUpdateGiftCard } from "medusa-react" + +type Props = { + customGiftCardId: string +} + +const CustomGiftCard = ({ customGiftCardId }: Props) => { + const updateGiftCard = useAdminUpdateGiftCard( + customGiftCardId + ) + // ... + + const handleUpdate = (regionId: string) => { + updateGiftCard.mutate({ + region_id: regionId, + }, { + onSuccess: ({ gift_card }) => { + console.log(gift_card.id) + } + }) + } + + // ... +} + +export default CustomGiftCard diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items/getundefined new file mode 100644 index 0000000000000..4d61d3cbdce8d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items/getundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminInventoryItems } from "medusa-react" + +function InventoryItems() { + const { + inventory_items, + isLoading + } = useAdminInventoryItems() + + return ( +
+ {isLoading && Loading...} + {inventory_items && !inventory_items.length && ( + No Items + )} + {inventory_items && inventory_items.length > 0 && ( +
    + {inventory_items.map( + (item) => ( +
  • {item.id}
    • + ) + )} +
+ )} +
+ ) +} + +export default InventoryItems diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items/postundefined new file mode 100644 index 0000000000000..67781a7453a55 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items/postundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminCreateInventoryItem } from "medusa-react" + +const CreateInventoryItem = () => { + const createInventoryItem = useAdminCreateInventoryItem() + // ... + + const handleCreate = (variantId: string) => { + createInventoryItem.mutate({ + variant_id: variantId, + }, { + onSuccess: ({ inventory_item }) => { + console.log(inventory_item.id) + } + }) + } + + // ... +} + +export default CreateInventoryItem diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}/deleteundefined new file mode 100644 index 0000000000000..68377e3d80171 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}/deleteundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminDeleteInventoryItem } from "medusa-react" + +type Props = { + inventoryItemId: string +} + +const InventoryItem = ({ inventoryItemId }: Props) => { + const deleteInventoryItem = useAdminDeleteInventoryItem( + inventoryItemId + ) + // ... + + const handleDelete = () => { + deleteInventoryItem.mutate() + } + + // ... +} + +export default InventoryItem diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}/getundefined new file mode 100644 index 0000000000000..16edab6c5abe0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminInventoryItem } from "medusa-react" + +type Props = { + inventoryItemId: string +} + +const InventoryItem = ({ inventoryItemId }: Props) => { + const { + inventory_item, + isLoading + } = useAdminInventoryItem(inventoryItemId) + + return ( +
+ {isLoading && Loading...} + {inventory_item && ( + {inventory_item.sku} + )} +
+ ) +} + +export default InventoryItem diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}/postundefined new file mode 100644 index 0000000000000..bf66bca6f04a7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminUpdateInventoryItem } from "medusa-react" + +type Props = { + inventoryItemId: string +} + +const InventoryItem = ({ inventoryItemId }: Props) => { + const updateInventoryItem = useAdminUpdateInventoryItem( + inventoryItemId + ) + // ... + + const handleUpdate = (origin_country: string) => { + updateInventoryItem.mutate({ + origin_country, + }, { + onSuccess: ({ inventory_item }) => { + console.log(inventory_item.origin_country) + } + }) + } + + // ... +} + +export default InventoryItem diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels/getundefined new file mode 100644 index 0000000000000..c1b037353e20b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels/getundefined @@ -0,0 +1,30 @@ +import React from "react" +import { + useAdminInventoryItemLocationLevels, +} from "medusa-react" + +type Props = { + inventoryItemId: string +} + +const InventoryItem = ({ inventoryItemId }: Props) => { + const { + inventory_item, + isLoading, + } = useAdminInventoryItemLocationLevels(inventoryItemId) + + return ( +
+ {isLoading && Loading...} + {inventory_item && ( +
    + {inventory_item.location_levels.map((level) => ( + {level.stocked_quantity} + ))} +
+ )} +
+ ) +} + +export default InventoryItem diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels/postundefined new file mode 100644 index 0000000000000..0eccc8b3d1407 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels/postundefined @@ -0,0 +1,31 @@ +import React from "react" +import { useAdminCreateLocationLevel } from "medusa-react" + +type Props = { + inventoryItemId: string +} + +const InventoryItem = ({ inventoryItemId }: Props) => { + const createLocationLevel = useAdminCreateLocationLevel( + inventoryItemId + ) + // ... + + const handleCreateLocationLevel = ( + locationId: string, + stockedQuantity: number + ) => { + createLocationLevel.mutate({ + location_id: locationId, + stocked_quantity: stockedQuantity, + }, { + onSuccess: ({ inventory_item }) => { + console.log(inventory_item.id) + } + }) + } + + // ... +} + +export default InventoryItem diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels_{location_id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels_{location_id}/deleteundefined new file mode 100644 index 0000000000000..d7a7fa4d14221 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels_{location_id}/deleteundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminDeleteLocationLevel } from "medusa-react" + +type Props = { + inventoryItemId: string +} + +const InventoryItem = ({ inventoryItemId }: Props) => { + const deleteLocationLevel = useAdminDeleteLocationLevel( + inventoryItemId + ) + // ... + + const handleDelete = ( + locationId: string + ) => { + deleteLocationLevel.mutate(locationId) + } + + // ... +} + +export default InventoryItem diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels_{location_id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels_{location_id}/postundefined new file mode 100644 index 0000000000000..b5fb876374354 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_inventory-items_{id}_location-levels_{location_id}/postundefined @@ -0,0 +1,31 @@ +import React from "react" +import { useAdminUpdateLocationLevel } from "medusa-react" + +type Props = { + inventoryItemId: string +} + +const InventoryItem = ({ inventoryItemId }: Props) => { + const updateLocationLevel = useAdminUpdateLocationLevel( + inventoryItemId + ) + // ... + + const handleUpdate = ( + stockLocationId: string, + stocked_quantity: number + ) => { + updateLocationLevel.mutate({ + stockLocationId, + stocked_quantity, + }, { + onSuccess: ({ inventory_item }) => { + console.log(inventory_item.id) + } + }) + } + + // ... +} + +export default InventoryItem diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_invites_accept/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_invites_accept/postundefined new file mode 100644 index 0000000000000..500035e16eb76 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_invites_accept/postundefined @@ -0,0 +1,31 @@ +import React from "react" +import { useAdminAcceptInvite } from "medusa-react" + +const AcceptInvite = () => { + const acceptInvite = useAdminAcceptInvite() + // ... + + const handleAccept = ( + token: string, + firstName: string, + lastName: string, + password: string + ) => { + acceptInvite.mutate({ + token, + user: { + first_name: firstName, + last_name: lastName, + password, + }, + }, { + onSuccess: () => { + // invite accepted successfully. + } + }) + } + + // ... +} + +export default AcceptInvite diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_invites_{invite_id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_invites_{invite_id}/deleteundefined new file mode 100644 index 0000000000000..14ee4edb9a1ee --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_invites_{invite_id}/deleteundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminDeleteInvite } from "medusa-react" + +type Props = { + inviteId: string +} + +const DeleteInvite = ({ inviteId }: Props) => { + const deleteInvite = useAdminDeleteInvite(inviteId) + // ... + + const handleDelete = () => { + deleteInvite.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default Invite diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_invites_{invite_id}_resend/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_invites_{invite_id}_resend/postundefined new file mode 100644 index 0000000000000..174af6336ff76 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_invites_{invite_id}_resend/postundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminResendInvite } from "medusa-react" + +type Props = { + inviteId: string +} + +const ResendInvite = ({ inviteId }: Props) => { + const resendInvite = useAdminResendInvite(inviteId) + // ... + + const handleResend = () => { + resendInvite.mutate(void 0, { + onSuccess: () => { + // invite resent successfully + } + }) + } + + // ... +} + +export default ResendInvite diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes/getundefined new file mode 100644 index 0000000000000..5f03be318b8aa --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes/getundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useAdminNotes } from "medusa-react" + +const Notes = () => { + const { notes, isLoading } = useAdminNotes() + + return ( +
+ {isLoading && Loading...} + {notes && !notes.length && No Notes} + {notes && notes.length > 0 && ( +
    + {notes.map((note) => ( +
  • {note.resource_type}
    • + ))} +
+ )} +
+ ) +} + +export default Notes diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes/postundefined new file mode 100644 index 0000000000000..373f407bd6ce0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes/postundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminCreateNote } from "medusa-react" + +const CreateNote = () => { + const createNote = useAdminCreateNote() + // ... + + const handleCreate = () => { + createNote.mutate({ + resource_id: "order_123", + resource_type: "order", + value: "We delivered this order" + }, { + onSuccess: ({ note }) => { + console.log(note.id) + } + }) + } + + // ... +} + +export default CreateNote diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes_{id}/deleteundefined new file mode 100644 index 0000000000000..67e9e6059ba80 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes_{id}/deleteundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useAdminDeleteNote } from "medusa-react" + +type Props = { + noteId: string +} + +const Note = ({ noteId }: Props) => { + const deleteNote = useAdminDeleteNote(noteId) + // ... + + const handleDelete = () => { + deleteNote.mutate() + } + + // ... +} + +export default Note diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes_{id}/getundefined new file mode 100644 index 0000000000000..c988865da1383 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes_{id}/getundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useAdminNote } from "medusa-react" + +type Props = { + noteId: string +} + +const Note = ({ noteId }: Props) => { + const { note, isLoading } = useAdminNote(noteId) + + return ( +
+ {isLoading && Loading...} + {note && {note.resource_type}} +
+ ) +} + +export default Note diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes_{id}/postundefined new file mode 100644 index 0000000000000..55e4b1c3f7d8f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notes_{id}/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminUpdateNote } from "medusa-react" + +type Props = { + noteId: string +} + +const Note = ({ noteId }: Props) => { + const updateNote = useAdminUpdateNote(noteId) + // ... + + const handleUpdate = ( + value: string + ) => { + updateNote.mutate({ + value + }, { + onSuccess: ({ note }) => { + console.log(note.value) + } + }) + } + + // ... +} + +export default Note diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notifications/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notifications/getundefined new file mode 100644 index 0000000000000..e988c5843f1e7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notifications/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminNotifications } from "medusa-react" + +const Notifications = () => { + const { notifications, isLoading } = useAdminNotifications() + + return ( +
+ {isLoading && Loading...} + {notifications && !notifications.length && ( + No Notifications + )} + {notifications && notifications.length > 0 && ( +
    + {notifications.map((notification) => ( +
  • {notification.to}
    • + ))} +
+ )} +
+ ) +} + +export default Notifications diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notifications_{id}_resend/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notifications_{id}_resend/postundefined new file mode 100644 index 0000000000000..d01ccd65f4f0d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_notifications_{id}_resend/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminResendNotification } from "medusa-react" + +type Props = { + notificationId: string +} + +const Notification = ({ notificationId }: Props) => { + const resendNotification = useAdminResendNotification( + notificationId + ) + // ... + + const handleResend = () => { + resendNotification.mutate({}, { + onSuccess: ({ notification }) => { + console.log(notification.id) + } + }) + } + + // ... +} + +export default Notification diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits/getundefined new file mode 100644 index 0000000000000..c6c72826922ca --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits/getundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useAdminOrderEdits } from "medusa-react" + +const OrderEdits = () => { + const { order_edits, isLoading } = useAdminOrderEdits() + + return ( +
+ {isLoading && Loading...} + {order_edits && !order_edits.length && ( + No Order Edits + )} + {order_edits && order_edits.length > 0 && ( +
    + {order_edits.map((orderEdit) => ( +
  • + {orderEdit.status} +
    • + ))} +
+ )} +
+ ) +} + +export default OrderEdits diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits/postundefined new file mode 100644 index 0000000000000..1d464dabb0a39 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits/postundefined @@ -0,0 +1,20 @@ +import React from "react" +import { useAdminCreateOrderEdit } from "medusa-react" + +const CreateOrderEdit = () => { + const createOrderEdit = useAdminCreateOrderEdit() + + const handleCreateOrderEdit = (orderId: string) => { + createOrderEdit.mutate({ + order_id: orderId, + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.id) + } + }) + } + + // ... +} + +export default CreateOrderEdit diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}/deleteundefined new file mode 100644 index 0000000000000..1f42bc4867bb8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}/deleteundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminDeleteOrderEdit } from "medusa-react" + +type Props = { + orderEditId: string +} + +const OrderEdit = ({ orderEditId }: Props) => { + const deleteOrderEdit = useAdminDeleteOrderEdit( + orderEditId + ) + + const handleDelete = () => { + deleteOrderEdit.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default OrderEdit diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}/getundefined new file mode 100644 index 0000000000000..3c8030a9e096e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}/getundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useAdminOrderEdit } from "medusa-react" + +type Props = { + orderEditId: string +} + +const OrderEdit = ({ orderEditId }: Props) => { + const { + order_edit, + isLoading, + } = useAdminOrderEdit(orderEditId) + + return ( +
+ {isLoading && Loading...} + {order_edit && {order_edit.status}} +
+ ) +} + +export default OrderEdit diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}/postundefined new file mode 100644 index 0000000000000..9b73c3346e201 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}/postundefined @@ -0,0 +1,28 @@ +import React from "react" +import { useAdminUpdateOrderEdit } from "medusa-react" + +type Props = { + orderEditId: string +} + +const OrderEdit = ({ orderEditId }: Props) => { + const updateOrderEdit = useAdminUpdateOrderEdit( + orderEditId, + ) + + const handleUpdate = ( + internalNote: string + ) => { + updateOrderEdit.mutate({ + internal_note: internalNote + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.internal_note) + } + }) + } + + // ... +} + +export default OrderEdit diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_cancel/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_cancel/postundefined new file mode 100644 index 0000000000000..c612aa770a7ae --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_cancel/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { + useAdminCancelOrderEdit +} from "medusa-react" + +type Props = { + orderEditId: string +} + +const OrderEdit = ({ orderEditId }: Props) => { + const cancelOrderEdit = + useAdminCancelOrderEdit( + orderEditId + ) + + const handleCancel = () => { + cancelOrderEdit.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log( + order_edit.id + ) + } + }) + } + + // ... +} + +export default OrderEdit diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_changes_{change_id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_changes_{change_id}/deleteundefined new file mode 100644 index 0000000000000..a67c5892158ec --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_changes_{change_id}/deleteundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminDeleteOrderEditItemChange } from "medusa-react" + +type Props = { + orderEditId: string + itemChangeId: string +} + +const OrderEditItemChange = ({ + orderEditId, + itemChangeId +}: Props) => { + const deleteItemChange = useAdminDeleteOrderEditItemChange( + orderEditId, + itemChangeId + ) + + const handleDeleteItemChange = () => { + deleteItemChange.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default OrderEditItemChange diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_confirm/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_confirm/postundefined new file mode 100644 index 0000000000000..46b0a300860da --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_confirm/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminConfirmOrderEdit } from "medusa-react" + +type Props = { + orderEditId: string +} + +const OrderEdit = ({ orderEditId }: Props) => { + const confirmOrderEdit = useAdminConfirmOrderEdit( + orderEditId + ) + + const handleConfirmOrderEdit = () => { + confirmOrderEdit.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log( + order_edit.confirmed_at, + order_edit.confirmed_by + ) + } + }) + } + + // ... +} + +export default OrderEdit diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_items/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_items/postundefined new file mode 100644 index 0000000000000..3e8f31ff279eb --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_items/postundefined @@ -0,0 +1,28 @@ +import React from "react" +import { useAdminOrderEditAddLineItem } from "medusa-react" + +type Props = { + orderEditId: string +} + +const OrderEdit = ({ orderEditId }: Props) => { + const addLineItem = useAdminOrderEditAddLineItem( + orderEditId + ) + + const handleAddLineItem = + (quantity: number, variantId: string) => { + addLineItem.mutate({ + quantity, + variant_id: variantId, + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.changes) + } + }) + } + + // ... +} + +export default OrderEdit diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_items_{item_id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_items_{item_id}/deleteundefined new file mode 100644 index 0000000000000..0f30e30af791a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_items_{item_id}/deleteundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminOrderEditDeleteLineItem } from "medusa-react" + +type Props = { + orderEditId: string + itemId: string +} + +const OrderEditLineItem = ({ + orderEditId, + itemId +}: Props) => { + const removeLineItem = useAdminOrderEditDeleteLineItem( + orderEditId, + itemId + ) + + const handleRemoveLineItem = () => { + removeLineItem.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.changes) + } + }) + } + + // ... +} + +export default OrderEditLineItem diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_items_{item_id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_items_{item_id}/postundefined new file mode 100644 index 0000000000000..f1421ca69981a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_items_{item_id}/postundefined @@ -0,0 +1,31 @@ +import React from "react" +import { useAdminOrderEditUpdateLineItem } from "medusa-react" + +type Props = { + orderEditId: string + itemId: string +} + +const OrderEditItemChange = ({ + orderEditId, + itemId +}: Props) => { + const updateLineItem = useAdminOrderEditUpdateLineItem( + orderEditId, + itemId + ) + + const handleUpdateLineItem = (quantity: number) => { + updateLineItem.mutate({ + quantity, + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.items) + } + }) + } + + // ... +} + +export default OrderEditItemChange diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_request/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_request/postundefined new file mode 100644 index 0000000000000..23199c686ff61 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_order-edits_{id}_request/postundefined @@ -0,0 +1,30 @@ +import React from "react" +import { + useAdminRequestOrderEditConfirmation, +} from "medusa-react" + +type Props = { + orderEditId: string +} + +const OrderEdit = ({ orderEditId }: Props) => { + const requestOrderConfirmation = + useAdminRequestOrderEditConfirmation( + orderEditId + ) + + const handleRequestConfirmation = () => { + requestOrderConfirmation.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log( + order_edit.requested_at, + order_edit.requested_by + ) + } + }) + } + + // ... +} + +export default OrderEdit diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders/getundefined new file mode 100644 index 0000000000000..8ed27a3d43c52 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders/getundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useAdminOrders } from "medusa-react" + +const Orders = () => { + const { orders, isLoading } = useAdminOrders() + + return ( +
+ {isLoading && Loading...} + {orders && !orders.length && No Orders} + {orders && orders.length > 0 && ( +
    + {orders.map((order) => ( +
  • {order.display_id}
    • + ))} +
+ )} +
+ ) +} + +export default Orders diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}/getundefined new file mode 100644 index 0000000000000..2e3fc6d4eea7a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}/getundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminOrder } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const { + order, + isLoading, + } = useAdminOrder(orderId) + + return ( +
+ {isLoading && Loading...} + {order && {order.display_id}} + +
+ ) +} + +export default Order diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}/postundefined new file mode 100644 index 0000000000000..72c69116d74d5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}/postundefined @@ -0,0 +1,28 @@ +import React from "react" +import { useAdminUpdateOrder } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const updateOrder = useAdminUpdateOrder( + orderId + ) + + const handleUpdate = ( + email: string + ) => { + updateOrder.mutate({ + email, + }, { + onSuccess: ({ order }) => { + console.log(order.email) + } + }) + } + + // ... +} + +export default Order diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_archive/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_archive/postundefined new file mode 100644 index 0000000000000..3c5c67bb08240 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_archive/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminArchiveOrder } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const archiveOrder = useAdminArchiveOrder( + orderId + ) + // ... + + const handleArchivingOrder = () => { + archiveOrder.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.status) + } + }) + } + + // ... +} + +export default Order diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_cancel/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_cancel/postundefined new file mode 100644 index 0000000000000..ca595e362ba5d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_cancel/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminCancelOrder } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const cancelOrder = useAdminCancelOrder( + orderId + ) + // ... + + const handleCancel = () => { + cancelOrder.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.status) + } + }) + } + + // ... +} + +export default Order diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_capture/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_capture/postundefined new file mode 100644 index 0000000000000..876cc12edcf7e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_capture/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminCapturePayment } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const capturePayment = useAdminCapturePayment( + orderId + ) + // ... + + const handleCapture = () => { + capturePayment.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.status) + } + }) + } + + // ... +} + +export default Order diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims/postundefined new file mode 100644 index 0000000000000..9ade683618c4e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims/postundefined @@ -0,0 +1,33 @@ +import React from "react" +import { useAdminCreateClaim } from "medusa-react" + +type Props = { + orderId: string +} + +const CreateClaim = ({ orderId }: Props) => { + +const CreateClaim = (orderId: string) => { + const createClaim = useAdminCreateClaim(orderId) + // ... + + const handleCreate = (itemId: string) => { + createClaim.mutate({ + type: "refund", + claim_items: [ + { + item_id: itemId, + quantity: 1, + }, + ], + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } + }) + } + + // ... +} + +export default CreateClaim diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}/postundefined new file mode 100644 index 0000000000000..729861e78d520 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminUpdateClaim } from "medusa-react" + +type Props = { + orderId: string + claimId: string +} + +const Claim = ({ orderId, claimId }: Props) => { + const updateClaim = useAdminUpdateClaim(orderId) + // ... + + const handleUpdate = () => { + updateClaim.mutate({ + claim_id: claimId, + no_notification: false + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } + }) + } + + // ... +} + +export default Claim diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_cancel/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_cancel/postundefined new file mode 100644 index 0000000000000..1a558f8558f43 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_cancel/postundefined @@ -0,0 +1,20 @@ +import React from "react" +import { useAdminCancelClaim } from "medusa-react" + +type Props = { + orderId: string + claimId: string +} + +const Claim = ({ orderId, claimId }: Props) => { + const cancelClaim = useAdminCancelClaim(orderId) + // ... + + const handleCancel = () => { + cancelClaim.mutate(claimId) + } + + // ... +} + +export default Claim diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_fulfillments/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_fulfillments/postundefined new file mode 100644 index 0000000000000..4aa47b153a989 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_fulfillments/postundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useAdminFulfillClaim } from "medusa-react" + +type Props = { + orderId: string + claimId: string +} + +const Claim = ({ orderId, claimId }: Props) => { + const fulfillClaim = useAdminFulfillClaim(orderId) + // ... + + const handleFulfill = () => { + fulfillClaim.mutate({ + claim_id: claimId, + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } + }) + } + + // ... +} + +export default Claim diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/postundefined new file mode 100644 index 0000000000000..c1798beab1c21 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminCancelClaimFulfillment } from "medusa-react" + +type Props = { + orderId: string + claimId: string +} + +const Claim = ({ orderId, claimId }: Props) => { + const cancelFulfillment = useAdminCancelClaimFulfillment( + orderId + ) + // ... + + const handleCancel = (fulfillmentId: string) => { + cancelFulfillment.mutate({ + claim_id: claimId, + fulfillment_id: fulfillmentId, + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } + }) + } + + // ... +} + +export default Claim diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_shipments/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_shipments/postundefined new file mode 100644 index 0000000000000..2c87380d0e239 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_claims_{claim_id}_shipments/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminCreateClaimShipment } from "medusa-react" + +type Props = { + orderId: string + claimId: string +} + +const Claim = ({ orderId, claimId }: Props) => { + const createShipment = useAdminCreateClaimShipment(orderId) + // ... + + const handleCreateShipment = (fulfillmentId: string) => { + createShipment.mutate({ + claim_id: claimId, + fulfillment_id: fulfillmentId, + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } + }) + } + + // ... +} + +export default Claim diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_complete/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_complete/postundefined new file mode 100644 index 0000000000000..c2d55a22b6a9b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_complete/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminCompleteOrder } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const completeOrder = useAdminCompleteOrder( + orderId + ) + // ... + + const handleComplete = () => { + completeOrder.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.status) + } + }) + } + + // ... +} + +export default Order diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_fulfillment/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_fulfillment/postundefined new file mode 100644 index 0000000000000..86079002fea3b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_fulfillment/postundefined @@ -0,0 +1,35 @@ +import React from "react" +import { useAdminCreateFulfillment } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const createFulfillment = useAdminCreateFulfillment( + orderId + ) + // ... + + const handleCreateFulfillment = ( + itemId: string, + quantity: number + ) => { + createFulfillment.mutate({ + items: [ + { + item_id: itemId, + quantity, + }, + ], + }, { + onSuccess: ({ order }) => { + console.log(order.fulfillments) + } + }) + } + + // ... +} + +export default Order diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/postundefined new file mode 100644 index 0000000000000..d0b5e6ca506a9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminCancelFulfillment } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const cancelFulfillment = useAdminCancelFulfillment( + orderId + ) + // ... + + const handleCancel = ( + fulfillmentId: string + ) => { + cancelFulfillment.mutate(fulfillmentId, { + onSuccess: ({ order }) => { + console.log(order.fulfillments) + } + }) + } + + // ... +} + +export default Order diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_refund/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_refund/postundefined new file mode 100644 index 0000000000000..aaf937c4d7168 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_refund/postundefined @@ -0,0 +1,31 @@ +import React from "react" +import { useAdminRefundPayment } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const refundPayment = useAdminRefundPayment( + orderId + ) + // ... + + const handleRefund = ( + amount: number, + reason: string + ) => { + refundPayment.mutate({ + amount, + reason, + }, { + onSuccess: ({ order }) => { + console.log(order.refunds) + } + }) + } + + // ... +} + +export default Order diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_return/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_return/postundefined new file mode 100644 index 0000000000000..f6d2b40bfc5fd --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_return/postundefined @@ -0,0 +1,35 @@ +import React from "react" +import { useAdminRequestReturn } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const requestReturn = useAdminRequestReturn( + orderId + ) + // ... + + const handleRequestingReturn = ( + itemId: string, + quantity: number + ) => { + requestReturn.mutate({ + items: [ + { + item_id: itemId, + quantity + } + ] + }, { + onSuccess: ({ order }) => { + console.log(order.returns) + } + }) + } + + // ... +} + +export default Order diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_shipment/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_shipment/postundefined new file mode 100644 index 0000000000000..6d12137790c3a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_shipment/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminCreateShipment } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const createShipment = useAdminCreateShipment( + orderId + ) + // ... + + const handleCreate = ( + fulfillmentId: string + ) => { + createShipment.mutate({ + fulfillment_id: fulfillmentId, + }, { + onSuccess: ({ order }) => { + console.log(order.fulfillment_status) + } + }) + } + + // ... +} + +export default Order diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_shipping-methods/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_shipping-methods/postundefined new file mode 100644 index 0000000000000..eec3471a8f894 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_shipping-methods/postundefined @@ -0,0 +1,31 @@ +import React from "react" +import { useAdminAddShippingMethod } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const addShippingMethod = useAdminAddShippingMethod( + orderId + ) + // ... + + const handleAddShippingMethod = ( + optionId: string, + price: number + ) => { + addShippingMethod.mutate({ + option_id: optionId, + price + }, { + onSuccess: ({ order }) => { + console.log(order.shipping_methods) + } + }) + } + + // ... +} + +export default Order diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps/postundefined new file mode 100644 index 0000000000000..b215d366c3948 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps/postundefined @@ -0,0 +1,30 @@ +import React from "react" +import { useAdminCreateSwap } from "medusa-react" + +type Props = { + orderId: string +} + +const CreateSwap = ({ orderId }: Props) => { + const createSwap = useAdminCreateSwap(orderId) + // ... + + const handleCreate = ( + returnItems: { + item_id: string, + quantity: number + }[] + ) => { + createSwap.mutate({ + return_items: returnItems + }, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } + }) + } + + // ... +} + +export default CreateSwap diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_cancel/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_cancel/postundefined new file mode 100644 index 0000000000000..bab3da81a6643 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_cancel/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminCancelSwap } from "medusa-react" + +type Props = { + orderId: string, + swapId: string +} + +const Swap = ({ + orderId, + swapId +}: Props) => { + const cancelSwap = useAdminCancelSwap( + orderId + ) + // ... + + const handleCancel = () => { + cancelSwap.mutate(swapId, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } + }) + } + + // ... +} + +export default Swap diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_fulfillments/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_fulfillments/postundefined new file mode 100644 index 0000000000000..1824122ed7d14 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_fulfillments/postundefined @@ -0,0 +1,31 @@ +import React from "react" +import { useAdminFulfillSwap } from "medusa-react" + +type Props = { + orderId: string, + swapId: string +} + +const Swap = ({ + orderId, + swapId +}: Props) => { + const fulfillSwap = useAdminFulfillSwap( + orderId + ) + // ... + + const handleFulfill = () => { + fulfillSwap.mutate({ + swap_id: swapId, + }, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } + }) + } + + // ... +} + +export default Swap diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/postundefined new file mode 100644 index 0000000000000..a4c88c19c1555 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/postundefined @@ -0,0 +1,30 @@ +import React from "react" +import { useAdminCancelSwapFulfillment } from "medusa-react" + +type Props = { + orderId: string, + swapId: string +} + +const Swap = ({ + orderId, + swapId +}: Props) => { + const cancelFulfillment = useAdminCancelSwapFulfillment( + orderId + ) + // ... + + const handleCancelFulfillment = ( + fulfillmentId: string + ) => { + cancelFulfillment.mutate({ + swap_id: swapId, + fulfillment_id: fulfillmentId, + }) + } + + // ... +} + +export default Swap diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_process-payment/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_process-payment/postundefined new file mode 100644 index 0000000000000..5883be9ed0d0f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_process-payment/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminProcessSwapPayment } from "medusa-react" + +type Props = { + orderId: string, + swapId: string +} + +const Swap = ({ + orderId, + swapId +}: Props) => { + const processPayment = useAdminProcessSwapPayment( + orderId + ) + // ... + + const handleProcessPayment = () => { + processPayment.mutate(swapId, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } + }) + } + + // ... +} + +export default Swap diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_shipments/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_shipments/postundefined new file mode 100644 index 0000000000000..8a04c442d5ad9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_shipments/postundefined @@ -0,0 +1,34 @@ +import React from "react" +import { useAdminCreateSwapShipment } from "medusa-react" + +type Props = { + orderId: string, + swapId: string +} + +const Swap = ({ + orderId, + swapId +}: Props) => { + const createShipment = useAdminCreateSwapShipment( + orderId + ) + // ... + + const handleCreateShipment = ( + fulfillmentId: string + ) => { + createShipment.mutate({ + swap_id: swapId, + fulfillment_id: fulfillmentId, + }, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } + }) + } + + // ... +} + +export default Swap diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}/deleteundefined new file mode 100644 index 0000000000000..d5254a3980d86 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDeletePaymentCollection } from "medusa-react" + +type Props = { + paymentCollectionId: string +} + +const PaymentCollection = ({ paymentCollectionId }: Props) => { + const deleteCollection = useAdminDeletePaymentCollection( + paymentCollectionId + ) + // ... + + const handleDelete = () => { + deleteCollection.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default PaymentCollection diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}/getundefined new file mode 100644 index 0000000000000..7da4ee3c30a58 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}/getundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminPaymentCollection } from "medusa-react" + +type Props = { + paymentCollectionId: string +} + +const PaymentCollection = ({ paymentCollectionId }: Props) => { + const { + payment_collection, + isLoading, + } = useAdminPaymentCollection(paymentCollectionId) + + return ( +
+ {isLoading && Loading...} + {payment_collection && ( + {payment_collection.status} + )} + +
+ ) +} + +export default PaymentCollection diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}/postundefined new file mode 100644 index 0000000000000..b85fd9de1662f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminUpdatePaymentCollection } from "medusa-react" + +type Props = { + paymentCollectionId: string +} + +const PaymentCollection = ({ paymentCollectionId }: Props) => { + const updateCollection = useAdminUpdatePaymentCollection( + paymentCollectionId + ) + // ... + + const handleUpdate = ( + description: string + ) => { + updateCollection.mutate({ + description + }, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.description) + } + }) + } + + // ... +} + +export default PaymentCollection diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}_authorize/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}_authorize/postundefined new file mode 100644 index 0000000000000..7603ac8445ee8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payment-collections_{id}_authorize/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminMarkPaymentCollectionAsAuthorized } from "medusa-react" + +type Props = { + paymentCollectionId: string +} + +const PaymentCollection = ({ paymentCollectionId }: Props) => { + const markAsAuthorized = useAdminMarkPaymentCollectionAsAuthorized( + paymentCollectionId + ) + // ... + + const handleAuthorization = () => { + markAsAuthorized.mutate(void 0, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.status) + } + }) + } + + // ... +} + +export default PaymentCollection diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payments_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payments_{id}/getundefined new file mode 100644 index 0000000000000..3c569f2544e18 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payments_{id}/getundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminPayment } from "medusa-react" + +type Props = { + paymentId: string +} + +const Payment = ({ paymentId }: Props) => { + const { + payment, + isLoading, + } = useAdminPayment(paymentId) + + return ( +
+ {isLoading && Loading...} + {payment && {payment.amount}} + +
+ ) +} + +export default Payment diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payments_{id}_capture/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payments_{id}_capture/postundefined new file mode 100644 index 0000000000000..cff62106d34df --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payments_{id}_capture/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminPaymentsCapturePayment } from "medusa-react" + +type Props = { + paymentId: string +} + +const Payment = ({ paymentId }: Props) => { + const capture = useAdminPaymentsCapturePayment( + paymentId + ) + // ... + + const handleCapture = () => { + capture.mutate(void 0, { + onSuccess: ({ payment }) => { + console.log(payment.amount) + } + }) + } + + // ... +} + +export default Payment diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payments_{id}_refund/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payments_{id}_refund/postundefined new file mode 100644 index 0000000000000..7edfbdd3ad85a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_payments_{id}_refund/postundefined @@ -0,0 +1,34 @@ +import React from "react" +import { RefundReason } from "@medusajs/medusa" +import { useAdminPaymentsRefundPayment } from "medusa-react" + +type Props = { + paymentId: string +} + +const Payment = ({ paymentId }: Props) => { + const refund = useAdminPaymentsRefundPayment( + paymentId + ) + // ... + + const handleRefund = ( + amount: number, + reason: RefundReason, + note: string + ) => { + refund.mutate({ + amount, + reason, + note + }, { + onSuccess: ({ refund }) => { + console.log(refund.amount) + } + }) + } + + // ... +} + +export default Payment diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists/getundefined new file mode 100644 index 0000000000000..08df21321346f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminPriceLists } from "medusa-react" + +const PriceLists = () => { + const { price_lists, isLoading } = useAdminPriceLists() + + return ( +
+ {isLoading && Loading...} + {price_lists && !price_lists.length && ( + No Price Lists + )} + {price_lists && price_lists.length > 0 && ( +
    + {price_lists.map((price_list) => ( +
  • {price_list.name}
    • + ))} +
+ )} +
+ ) +} + +export default PriceLists diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists/postundefined new file mode 100644 index 0000000000000..8cedddf1b0576 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists/postundefined @@ -0,0 +1,38 @@ +import React from "react" +import { + PriceListStatus, + PriceListType, +} from "@medusajs/medusa" +import { useAdminCreatePriceList } from "medusa-react" + +type CreateData = { + name: string + description: string + type: PriceListType + status: PriceListStatus + prices: { + amount: number + variant_id: string + currency_code: string + max_quantity: number + }[] +} + +const CreatePriceList = () => { + const createPriceList = useAdminCreatePriceList() + // ... + + const handleCreate = ( + data: CreateData + ) => { + createPriceList.mutate(data, { + onSuccess: ({ price_list }) => { + console.log(price_list.id) + } + }) + } + + // ... +} + +export default CreatePriceList diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}/deleteundefined new file mode 100644 index 0000000000000..686f0d903f80f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDeletePriceList } from "medusa-react" + +type Props = { + priceListId: string +} + +const PriceList = ({ + priceListId +}: Props) => { + const deletePriceList = useAdminDeletePriceList(priceListId) + // ... + + const handleDelete = () => { + deletePriceList.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default PriceList diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}/getundefined new file mode 100644 index 0000000000000..974d570134e2b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminPriceList } from "medusa-react" + +type Props = { + priceListId: string +} + +const PriceList = ({ + priceListId +}: Props) => { + const { + price_list, + isLoading, + } = useAdminPriceList(priceListId) + + return ( +
+ {isLoading && Loading...} + {price_list && {price_list.name}} +
+ ) +} + +export default PriceList diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}/postundefined new file mode 100644 index 0000000000000..8785d4ba01f7a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminUpdatePriceList } from "medusa-react" + +type Props = { + priceListId: string +} + +const PriceList = ({ + priceListId +}: Props) => { + const updatePriceList = useAdminUpdatePriceList(priceListId) + // ... + + const handleUpdate = ( + endsAt: Date + ) => { + updatePriceList.mutate({ + ends_at: endsAt, + }, { + onSuccess: ({ price_list }) => { + console.log(price_list.ends_at) + } + }) + } + + // ... +} + +export default PriceList diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_prices_batch/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_prices_batch/deleteundefined new file mode 100644 index 0000000000000..62a5f91992069 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_prices_batch/deleteundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminDeletePriceListPrices } from "medusa-react" + +const PriceList = ( + priceListId: string +) => { + const deletePrices = useAdminDeletePriceListPrices(priceListId) + // ... + + const handleDeletePrices = (priceIds: string[]) => { + deletePrices.mutate({ + price_ids: priceIds + }, { + onSuccess: ({ ids, deleted, object }) => { + console.log(ids) + } + }) + } + + // ... +} + +export default PriceList diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_prices_batch/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_prices_batch/postundefined new file mode 100644 index 0000000000000..c2dfe55128b07 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_prices_batch/postundefined @@ -0,0 +1,33 @@ +import React from "react" +import { useAdminCreatePriceListPrices } from "medusa-react" + +type PriceData = { + amount: number + variant_id: string + currency_code: string +} + +type Props = { + priceListId: string +} + +const PriceList = ({ + priceListId +}: Props) => { + const addPrices = useAdminCreatePriceListPrices(priceListId) + // ... + + const handleAddPrices = (prices: PriceData[]) => { + addPrices.mutate({ + prices + }, { + onSuccess: ({ price_list }) => { + console.log(price_list.prices) + } + }) + } + + // ... +} + +export default PriceList diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_products/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_products/getundefined new file mode 100644 index 0000000000000..0fc5109dd0ed8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_products/getundefined @@ -0,0 +1,32 @@ +import React from "react" +import { useAdminPriceListProducts } from "medusa-react" + +type Props = { + priceListId: string +} + +const PriceListProducts = ({ + priceListId +}: Props) => { + const { products, isLoading } = useAdminPriceListProducts( + priceListId + ) + + return ( +
+ {isLoading && Loading...} + {products && !products.length && ( + No Price Lists + )} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
+ ) +} + +export default PriceListProducts diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_products_prices_batch/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_products_prices_batch/deleteundefined new file mode 100644 index 0000000000000..70690b7a43be0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_products_prices_batch/deleteundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminDeletePriceListProductsPrices } from "medusa-react" + +type Props = { + priceListId: string +} + +const PriceList = ({ + priceListId +}: Props) => { + const deleteProductsPrices = useAdminDeletePriceListProductsPrices( + priceListId + ) + // ... + + const handleDeleteProductsPrices = (productIds: string[]) => { + deleteProductsPrices.mutate({ + product_ids: productIds + }, { + onSuccess: ({ ids, deleted, object }) => { + console.log(ids) + } + }) + } + + // ... +} + +export default PriceList diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_products_{product_id}_prices/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_products_{product_id}_prices/deleteundefined new file mode 100644 index 0000000000000..1192bf1113c69 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_products_{product_id}_prices/deleteundefined @@ -0,0 +1,32 @@ +import React from "react" +import { + useAdminDeletePriceListProductPrices +} from "medusa-react" + +type Props = { + priceListId: string + productId: string +} + +const PriceListProduct = ({ + priceListId, + productId +}: Props) => { + const deleteProductPrices = useAdminDeletePriceListProductPrices( + priceListId, + productId + ) + // ... + + const handleDeleteProductPrices = () => { + deleteProductPrices.mutate(void 0, { + onSuccess: ({ ids, deleted, object }) => { + console.log(ids) + } + }) + } + + // ... +} + +export default PriceListProduct diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_variants_{variant_id}_prices/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_variants_{variant_id}_prices/deleteundefined new file mode 100644 index 0000000000000..cfff01f2472c2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_price-lists_{id}_variants_{variant_id}_prices/deleteundefined @@ -0,0 +1,32 @@ +import React from "react" +import { + useAdminDeletePriceListVariantPrices +} from "medusa-react" + +type Props = { + priceListId: string + variantId: string +} + +const PriceListVariant = ({ + priceListId, + variantId +}: Props) => { + const deleteVariantPrices = useAdminDeletePriceListVariantPrices( + priceListId, + variantId + ) + // ... + + const handleDeleteVariantPrices = () => { + deleteVariantPrices.mutate(void 0, { + onSuccess: ({ ids, deleted, object }) => { + console.log(ids) + } + }) + } + + // ... +} + +export default PriceListVariant diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories/getundefined new file mode 100644 index 0000000000000..81310dbcd275a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories/getundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminProductCategories } from "medusa-react" + +function Categories() { + const { + product_categories, + isLoading + } = useAdminProductCategories() + + return ( +
+ {isLoading && Loading...} + {product_categories && !product_categories.length && ( + No Categories + )} + {product_categories && product_categories.length > 0 && ( +
    + {product_categories.map( + (category) => ( +
  • {category.name}
    • + ) + )} +
+ )} +
+ ) +} + +export default Categories diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories/postundefined new file mode 100644 index 0000000000000..e1e122de25e42 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories/postundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminCreateProductCategory } from "medusa-react" + +const CreateCategory = () => { + const createCategory = useAdminCreateProductCategory() + // ... + + const handleCreate = ( + name: string + ) => { + createCategory.mutate({ + name, + }, { + onSuccess: ({ product_category }) => { + console.log(product_category.id) + } + }) + } + + // ... +} + +export default CreateCategory diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}/deleteundefined new file mode 100644 index 0000000000000..077e93d851a70 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}/deleteundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminDeleteProductCategory } from "medusa-react" + +type Props = { + productCategoryId: string +} + +const Category = ({ + productCategoryId +}: Props) => { + const deleteCategory = useAdminDeleteProductCategory( + productCategoryId + ) + // ... + + const handleDelete = () => { + deleteCategory.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default Category diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}/getundefined new file mode 100644 index 0000000000000..3365cd513cea7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}/getundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminProductCategory } from "medusa-react" + +type Props = { + productCategoryId: string +} + +const Category = ({ + productCategoryId +}: Props) => { + const { + product_category, + isLoading, + } = useAdminProductCategory(productCategoryId) + + return ( +
+ {isLoading && Loading...} + {product_category && ( + {product_category.name} + )} + +
+ ) +} + +export default Category diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}/postundefined new file mode 100644 index 0000000000000..f2ea381b876f1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}/postundefined @@ -0,0 +1,31 @@ +import React from "react" +import { useAdminUpdateProductCategory } from "medusa-react" + +type Props = { + productCategoryId: string +} + +const Category = ({ + productCategoryId +}: Props) => { + const updateCategory = useAdminUpdateProductCategory( + productCategoryId + ) + // ... + + const handleUpdate = ( + name: string + ) => { + updateCategory.mutate({ + name, + }, { + onSuccess: ({ product_category }) => { + console.log(product_category.id) + } + }) + } + + // ... +} + +export default Category diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}_products_batch/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}_products_batch/deleteundefined new file mode 100644 index 0000000000000..485e1e0cf100e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}_products_batch/deleteundefined @@ -0,0 +1,35 @@ +import React from "react" +import { useAdminDeleteProductsFromCategory } from "medusa-react" + +type ProductsData = { + id: string +} + +type Props = { + productCategoryId: string +} + +const Category = ({ + productCategoryId +}: Props) => { + const deleteProducts = useAdminDeleteProductsFromCategory( + productCategoryId + ) + // ... + + const handleDeleteProducts = ( + productIds: ProductsData[] + ) => { + deleteProducts.mutate({ + product_ids: productIds + }, { + onSuccess: ({ product_category }) => { + console.log(product_category.products) + } + }) + } + + // ... +} + +export default Category diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}_products_batch/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}_products_batch/postundefined new file mode 100644 index 0000000000000..7d2c482a78d04 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-categories_{id}_products_batch/postundefined @@ -0,0 +1,35 @@ +import React from "react" +import { useAdminAddProductsToCategory } from "medusa-react" + +type ProductsData = { + id: string +} + +type Props = { + productCategoryId: string +} + +const Category = ({ + productCategoryId +}: Props) => { + const addProducts = useAdminAddProductsToCategory( + productCategoryId + ) + // ... + + const handleAddProducts = ( + productIds: ProductsData[] + ) => { + addProducts.mutate({ + product_ids: productIds + }, { + onSuccess: ({ product_category }) => { + console.log(product_category.products) + } + }) + } + + // ... +} + +export default Category diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-tags/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-tags/getundefined new file mode 100644 index 0000000000000..7d8ed91514ccf --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-tags/getundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminProductTags } from "medusa-react" + +function ProductTags() { + const { + product_tags, + isLoading + } = useAdminProductTags() + + return ( +
+ {isLoading && Loading...} + {product_tags && !product_tags.length && ( + No Product Tags + )} + {product_tags && product_tags.length > 0 && ( +
    + {product_tags.map( + (tag) => ( +
  • {tag.value}
    • + ) + )} +
+ )} +
+ ) +} + +export default ProductTags diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-types/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-types/getundefined new file mode 100644 index 0000000000000..a79f1f5f4bc9d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_product-types/getundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminProductTypes } from "medusa-react" + +function ProductTypes() { + const { + product_types, + isLoading + } = useAdminProductTypes() + + return ( +
+ {isLoading && Loading...} + {product_types && !product_types.length && ( + No Product Tags + )} + {product_types && product_types.length > 0 && ( +
    + {product_types.map( + (type) => ( +
  • {type.value}
    • + ) + )} +
+ )} +
+ ) +} + +export default ProductTypes diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products/getundefined new file mode 100644 index 0000000000000..abbb3931e59bf --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products/getundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useAdminProducts } from "medusa-react" + +const Products = () => { + const { products, isLoading } = useAdminProducts() + + return ( +
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
+ ) +} + +export default Products diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products/postundefined new file mode 100644 index 0000000000000..34face10ca603 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products/postundefined @@ -0,0 +1,48 @@ +import React from "react" +import { useAdminCreateProduct } from "medusa-react" + +type CreateProductData = { + title: string + is_giftcard: boolean + discountable: boolean + options: { + title: string + }[] + variants: { + title: string + prices: { + amount: number + currency_code :string + }[] + options: { + value: string + }[] + }[], + collection_id: string + categories: { + id: string + }[] + type: { + value: string + } + tags: { + value: string + }[] +} + +const CreateProduct = () => { + const createProduct = useAdminCreateProduct() + // ... + + const handleCreate = (productData: CreateProductData) => { + createProduct.mutate(productData, { + onSuccess: ({ product }) => { + console.log(product.id) + } + }) + } + + // ... +} + +export default CreateProduct diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_tag-usage/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_tag-usage/getundefined new file mode 100644 index 0000000000000..6e78d16038fe0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_tag-usage/getundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useAdminProductTagUsage } from "medusa-react" + +const ProductTags = (productId: string) => { + const { tags, isLoading } = useAdminProductTagUsage() + + return ( +
+ {isLoading && Loading...} + {tags && !tags.length && No Product Tags} + {tags && tags.length > 0 && ( +
    + {tags.map((tag) => ( +
  • {tag.value} - {tag.usage_count}
    • + ))} +
+ )} +
+ ) +} + +export default ProductTags diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}/deleteundefined new file mode 100644 index 0000000000000..9c0e33c183ce1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDeleteProduct } from "medusa-react" + +type Props = { + productId: string +} + +const Product = ({ productId }: Props) => { + const deleteProduct = useAdminDeleteProduct( + productId + ) + // ... + + const handleDelete = () => { + deleteProduct.mutate(void 0, { + onSuccess: ({ id, object, deleted}) => { + console.log(id) + } + }) + } + + // ... +} + +export default Product diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}/getundefined new file mode 100644 index 0000000000000..bc2a0dde7fb5e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}/getundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminProduct } from "medusa-react" + +type Props = { + productId: string +} + +const Product = ({ productId }: Props) => { + const { + product, + isLoading, + } = useAdminProduct(productId) + + return ( +
+ {isLoading && Loading...} + {product && {product.title}} + +
+ ) +} + +export default Product diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}/postundefined new file mode 100644 index 0000000000000..46d9c6df851b2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminUpdateProduct } from "medusa-react" + +type Props = { + productId: string +} + +const Product = ({ productId }: Props) => { + const updateProduct = useAdminUpdateProduct( + productId + ) + // ... + + const handleUpdate = ( + title: string + ) => { + updateProduct.mutate({ + title, + }, { + onSuccess: ({ product }) => { + console.log(product.id) + } + }) + } + + // ... +} + +export default Product diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_options/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_options/postundefined new file mode 100644 index 0000000000000..2d8dd027d5b0e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_options/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminCreateProductOption } from "medusa-react" + +type Props = { + productId: string +} + +const CreateProductOption = ({ productId }: Props) => { + const createOption = useAdminCreateProductOption( + productId + ) + // ... + + const handleCreate = ( + title: string + ) => { + createOption.mutate({ + title + }, { + onSuccess: ({ product }) => { + console.log(product.options) + } + }) + } + + // ... +} + +export default CreateProductOption diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_options_{option_id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_options_{option_id}/deleteundefined new file mode 100644 index 0000000000000..e2179206317c8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_options_{option_id}/deleteundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminDeleteProductOption } from "medusa-react" + +type Props = { + productId: string + optionId: string +} + +const ProductOption = ({ + productId, + optionId +}: Props) => { + const deleteOption = useAdminDeleteProductOption( + productId + ) + // ... + + const handleDelete = () => { + deleteOption.mutate(optionId, { + onSuccess: ({ option_id, object, deleted, product }) => { + console.log(product.options) + } + }) + } + + // ... +} + +export default ProductOption diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_options_{option_id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_options_{option_id}/postundefined new file mode 100644 index 0000000000000..0b0cdc0ba60ea --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_options_{option_id}/postundefined @@ -0,0 +1,34 @@ +import React from "react" +import { useAdminUpdateProductOption } from "medusa-react" + +type Props = { + productId: string + optionId: string +} + +const ProductOption = ({ + productId, + optionId +}: Props) => { + const updateOption = useAdminUpdateProductOption( + productId + ) + // ... + + const handleUpdate = ( + title: string + ) => { + updateOption.mutate({ + option_id: optionId, + title, + }, { + onSuccess: ({ product }) => { + console.log(product.options) + } + }) + } + + // ... +} + +export default ProductOption diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_variants/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_variants/postundefined new file mode 100644 index 0000000000000..621e790976790 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_variants/postundefined @@ -0,0 +1,39 @@ +import React from "react" +import { useAdminCreateVariant } from "medusa-react" + +type CreateVariantData = { + title: string + prices: { + amount: number + currency_code: string + }[] + options: { + option_id: string + value: string + }[] +} + +type Props = { + productId: string +} + +const CreateProductVariant = ({ productId }: Props) => { + const createVariant = useAdminCreateVariant( + productId + ) + // ... + + const handleCreate = ( + variantData: CreateVariantData + ) => { + createVariant.mutate(variantData, { + onSuccess: ({ product }) => { + console.log(product.variants) + } + }) + } + + // ... +} + +export default CreateProductVariant diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_variants_{variant_id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_variants_{variant_id}/deleteundefined new file mode 100644 index 0000000000000..612709ea748e4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_variants_{variant_id}/deleteundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminDeleteVariant } from "medusa-react" + +type Props = { + productId: string + variantId: string +} + +const ProductVariant = ({ + productId, + variantId +}: Props) => { + const deleteVariant = useAdminDeleteVariant( + productId + ) + // ... + + const handleDelete = () => { + deleteVariant.mutate(variantId, { + onSuccess: ({ variant_id, object, deleted, product }) => { + console.log(product.variants) + } + }) + } + + // ... +} + +export default ProductVariant diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_variants_{variant_id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_variants_{variant_id}/postundefined new file mode 100644 index 0000000000000..7b5836c76e535 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_products_{id}_variants_{variant_id}/postundefined @@ -0,0 +1,32 @@ +import React from "react" +import { useAdminUpdateVariant } from "medusa-react" + +type Props = { + productId: string + variantId: string +} + +const ProductVariant = ({ + productId, + variantId +}: Props) => { + const updateVariant = useAdminUpdateVariant( + productId + ) + // ... + + const handleUpdate = (title: string) => { + updateVariant.mutate({ + variant_id: variantId, + title, + }, { + onSuccess: ({ product }) => { + console.log(product.variants) + } + }) + } + + // ... +} + +export default ProductVariant diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys/getundefined new file mode 100644 index 0000000000000..5f4fe624e6b90 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys/getundefined @@ -0,0 +1,31 @@ +import React from "react" +import { PublishableApiKey } from "@medusajs/medusa" +import { useAdminPublishableApiKeys } from "medusa-react" + +const PublishableApiKeys = () => { + const { publishable_api_keys, isLoading } = + useAdminPublishableApiKeys() + + return ( +
+ {isLoading && Loading...} + {publishable_api_keys && !publishable_api_keys.length && ( + No Publishable API Keys + )} + {publishable_api_keys && + publishable_api_keys.length > 0 && ( +
    + {publishable_api_keys.map( + (publishableApiKey: PublishableApiKey) => ( +
  • + {publishableApiKey.title} +
    • + ) + )} +
+ )} +
+ ) +} + +export default PublishableApiKeys diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys/postundefined new file mode 100644 index 0000000000000..3733c4d15b6c0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys/postundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminCreatePublishableApiKey } from "medusa-react" + +const CreatePublishableApiKey = () => { + const createKey = useAdminCreatePublishableApiKey() + // ... + + const handleCreate = (title: string) => { + createKey.mutate({ + title, + }, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.id) + } + }) + } + + // ... +} + +export default CreatePublishableApiKey diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}/deleteundefined new file mode 100644 index 0000000000000..e97ecae6e3386 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}/deleteundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminDeletePublishableApiKey } from "medusa-react" + +type Props = { + publishableApiKeyId: string +} + +const PublishableApiKey = ({ + publishableApiKeyId +}: Props) => { + const deleteKey = useAdminDeletePublishableApiKey( + publishableApiKeyId + ) + // ... + + const handleDelete = () => { + deleteKey.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default PublishableApiKey diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}/getundefined new file mode 100644 index 0000000000000..28a349f11a47d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}/getundefined @@ -0,0 +1,27 @@ +import React from "react" +import { + useAdminPublishableApiKey, +} from "medusa-react" + +type Props = { + publishableApiKeyId: string +} + +const PublishableApiKey = ({ + publishableApiKeyId +}: Props) => { + const { publishable_api_key, isLoading } = + useAdminPublishableApiKey( + publishableApiKeyId + ) + + + return ( +
+ {isLoading && Loading...} + {publishable_api_key && {publishable_api_key.title}} +
+ ) +} + +export default PublishableApiKey diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}/postundefined new file mode 100644 index 0000000000000..960ab908cde3a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminUpdatePublishableApiKey } from "medusa-react" + +type Props = { + publishableApiKeyId: string +} + +const PublishableApiKey = ({ + publishableApiKeyId +}: Props) => { + const updateKey = useAdminUpdatePublishableApiKey( + publishableApiKeyId + ) + // ... + + const handleUpdate = (title: string) => { + updateKey.mutate({ + title, + }, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.id) + } + }) + } + + // ... +} + +export default PublishableApiKey diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_revoke/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_revoke/postundefined new file mode 100644 index 0000000000000..50badc614d6c5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_revoke/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminRevokePublishableApiKey } from "medusa-react" + +type Props = { + publishableApiKeyId: string +} + +const PublishableApiKey = ({ + publishableApiKeyId +}: Props) => { + const revokeKey = useAdminRevokePublishableApiKey( + publishableApiKeyId + ) + // ... + + const handleRevoke = () => { + revokeKey.mutate(void 0, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.revoked_at) + } + }) + } + + // ... +} + +export default PublishableApiKey diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels/getundefined new file mode 100644 index 0000000000000..09bf34ac3b5bb --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels/getundefined @@ -0,0 +1,35 @@ +import React from "react" +import { + useAdminPublishableApiKeySalesChannels, +} from "medusa-react" + +type Props = { + publishableApiKeyId: string +} + +const SalesChannels = ({ + publishableApiKeyId +}: Props) => { + const { sales_channels, isLoading } = + useAdminPublishableApiKeySalesChannels( + publishableApiKeyId + ) + + return ( +
+ {isLoading && Loading...} + {sales_channels && !sales_channels.length && ( + No Sales Channels + )} + {sales_channels && sales_channels.length > 0 && ( +
    + {sales_channels.map((salesChannel) => ( +
  • {salesChannel.name}
    • + ))} +
+ )} +
+ ) +} + +export default SalesChannels diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels_batch/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels_batch/deleteundefined new file mode 100644 index 0000000000000..80fbd5bd51b32 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels_batch/deleteundefined @@ -0,0 +1,36 @@ +import React from "react" +import { + useAdminRemovePublishableKeySalesChannelsBatch, +} from "medusa-react" + +type Props = { + publishableApiKeyId: string +} + +const PublishableApiKey = ({ + publishableApiKeyId +}: Props) => { + const deleteSalesChannels = + useAdminRemovePublishableKeySalesChannelsBatch( + publishableApiKeyId + ) + // ... + + const handleDelete = (salesChannelId: string) => { + deleteSalesChannels.mutate({ + sales_channel_ids: [ + { + id: salesChannelId, + }, + ], + }, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.id) + } + }) + } + + // ... +} + +export default PublishableApiKey diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels_batch/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels_batch/postundefined new file mode 100644 index 0000000000000..30f70c3221be3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels_batch/postundefined @@ -0,0 +1,36 @@ +import React from "react" +import { + useAdminAddPublishableKeySalesChannelsBatch, +} from "medusa-react" + +type Props = { + publishableApiKeyId: string +} + +const PublishableApiKey = ({ + publishableApiKeyId +}: Props) => { + const addSalesChannels = + useAdminAddPublishableKeySalesChannelsBatch( + publishableApiKeyId + ) + // ... + + const handleAdd = (salesChannelId: string) => { + addSalesChannels.mutate({ + sales_channel_ids: [ + { + id: salesChannelId, + }, + ], + }, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.id) + } + }) + } + + // ... +} + +export default PublishableApiKey diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions/getundefined new file mode 100644 index 0000000000000..d3047a14e0003 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions/getundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useAdminRegions } from "medusa-react" + +const Regions = () => { + const { regions, isLoading } = useAdminRegions() + + return ( +
+ {isLoading && Loading...} + {regions && !regions.length && No Regions} + {regions && regions.length > 0 && ( +
    + {regions.map((region) => ( +
  • {region.name}
    • + ))} +
+ )} +
+ ) +} + +export default Regions diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions/postundefined new file mode 100644 index 0000000000000..0065cce82e294 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions/postundefined @@ -0,0 +1,28 @@ +import React from "react" +import { useAdminCreateRegion } from "medusa-react" + +type CreateData = { + name: string + currency_code: string + tax_rate: number + payment_providers: string[] + fulfillment_providers: string[] + countries: string[] +} + +const CreateRegion = () => { + const createRegion = useAdminCreateRegion() + // ... + + const handleCreate = (regionData: CreateData) => { + createRegion.mutate(regionData, { + onSuccess: ({ region }) => { + console.log(region.id) + } + }) + } + + // ... +} + +export default CreateRegion diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}/deleteundefined new file mode 100644 index 0000000000000..e8ae2847bf2d7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDeleteRegion } from "medusa-react" + +type Props = { + regionId: string +} + +const Region = ({ + regionId +}: Props) => { + const deleteRegion = useAdminDeleteRegion(regionId) + // ... + + const handleDelete = () => { + deleteRegion.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default Region diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}/getundefined new file mode 100644 index 0000000000000..8bdd82b38121d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}/getundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminRegion } from "medusa-react" + +type Props = { + regionId: string +} + +const Region = ({ + regionId +}: Props) => { + const { region, isLoading } = useAdminRegion( + regionId + ) + + return ( +
+ {isLoading && Loading...} + {region && {region.name}} +
+ ) +} + +export default Region diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}/postundefined new file mode 100644 index 0000000000000..5c38751f89e9e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminUpdateRegion } from "medusa-react" + +type Props = { + regionId: string +} + +const Region = ({ + regionId +}: Props) => { + const updateRegion = useAdminUpdateRegion(regionId) + // ... + + const handleUpdate = ( + countries: string[] + ) => { + updateRegion.mutate({ + countries, + }, { + onSuccess: ({ region }) => { + console.log(region.id) + } + }) + } + + // ... +} + +export default Region diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_countries/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_countries/postundefined new file mode 100644 index 0000000000000..8028fe26da82b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_countries/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminRegionAddCountry } from "medusa-react" + +type Props = { + regionId: string +} + +const Region = ({ + regionId +}: Props) => { + const addCountry = useAdminRegionAddCountry(regionId) + // ... + + const handleAddCountry = ( + countryCode: string + ) => { + addCountry.mutate({ + country_code: countryCode + }, { + onSuccess: ({ region }) => { + console.log(region.countries) + } + }) + } + + // ... +} + +export default Region diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_countries_{country_code}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_countries_{country_code}/deleteundefined new file mode 100644 index 0000000000000..00fb39175963f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_countries_{country_code}/deleteundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminRegionRemoveCountry } from "medusa-react" + +type Props = { + regionId: string +} + +const Region = ({ + regionId +}: Props) => { + const removeCountry = useAdminRegionRemoveCountry(regionId) + // ... + + const handleRemoveCountry = ( + countryCode: string + ) => { + removeCountry.mutate(countryCode, { + onSuccess: ({ region }) => { + console.log(region.countries) + } + }) + } + + // ... +} + +export default Region diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_fulfillment-options/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_fulfillment-options/getundefined new file mode 100644 index 0000000000000..fd365e0a1d7d3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_fulfillment-options/getundefined @@ -0,0 +1,38 @@ +import React from "react" +import { useAdminRegionFulfillmentOptions } from "medusa-react" + +type Props = { + regionId: string +} + +const Region = ({ + regionId +}: Props) => { + const { + fulfillment_options, + isLoading + } = useAdminRegionFulfillmentOptions( + regionId + ) + + return ( +
+ {isLoading && Loading...} + {fulfillment_options && !fulfillment_options.length && ( + No Regions + )} + {fulfillment_options && + fulfillment_options.length > 0 && ( +
    + {fulfillment_options.map((option) => ( +
  • + {option.provider_id} +
    • + ))} +
+ )} +
+ ) +} + +export default Region diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_fulfillment-providers/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_fulfillment-providers/postundefined new file mode 100644 index 0000000000000..5d7b0e8048165 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_fulfillment-providers/postundefined @@ -0,0 +1,32 @@ +import React from "react" +import { + useAdminRegionAddFulfillmentProvider +} from "medusa-react" + +type Props = { + regionId: string +} + +const Region = ({ + regionId +}: Props) => { + const addFulfillmentProvider = + useAdminRegionAddFulfillmentProvider(regionId) + // ... + + const handleAddFulfillmentProvider = ( + providerId: string + ) => { + addFulfillmentProvider.mutate({ + provider_id: providerId + }, { + onSuccess: ({ region }) => { + console.log(region.fulfillment_providers) + } + }) + } + + // ... +} + +export default Region diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_fulfillment-providers_{provider_id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_fulfillment-providers_{provider_id}/deleteundefined new file mode 100644 index 0000000000000..cd91f16ce1b60 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_fulfillment-providers_{provider_id}/deleteundefined @@ -0,0 +1,30 @@ +import React from "react" +import { + useAdminRegionDeleteFulfillmentProvider +} from "medusa-react" + +type Props = { + regionId: string +} + +const Region = ({ + regionId +}: Props) => { + const removeFulfillmentProvider = + useAdminRegionDeleteFulfillmentProvider(regionId) + // ... + + const handleRemoveFulfillmentProvider = ( + providerId: string + ) => { + removeFulfillmentProvider.mutate(providerId, { + onSuccess: ({ region }) => { + console.log(region.fulfillment_providers) + } + }) + } + + // ... +} + +export default Region diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_payment-providers/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_payment-providers/postundefined new file mode 100644 index 0000000000000..aeff48d3cb578 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_payment-providers/postundefined @@ -0,0 +1,32 @@ +import React from "react" +import { + useAdminRegionAddPaymentProvider +} from "medusa-react" + +type Props = { + regionId: string +} + +const Region = ({ + regionId +}: Props) => { + const addPaymentProvider = + useAdminRegionAddPaymentProvider(regionId) + // ... + + const handleAddPaymentProvider = ( + providerId: string + ) => { + addPaymentProvider.mutate({ + provider_id: providerId + }, { + onSuccess: ({ region }) => { + console.log(region.payment_providers) + } + }) + } + + // ... +} + +export default Region diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_payment-providers_{provider_id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_payment-providers_{provider_id}/deleteundefined new file mode 100644 index 0000000000000..82cb654e6f4f9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_regions_{id}_payment-providers_{provider_id}/deleteundefined @@ -0,0 +1,30 @@ +import React from "react" +import { + useAdminRegionDeletePaymentProvider +} from "medusa-react" + +type Props = { + regionId: string +} + +const Region = ({ + regionId +}: Props) => { + const removePaymentProvider = + useAdminRegionDeletePaymentProvider(regionId) + // ... + + const handleRemovePaymentProvider = ( + providerId: string + ) => { + removePaymentProvider.mutate(providerId, { + onSuccess: ({ region }) => { + console.log(region.payment_providers) + } + }) + } + + // ... +} + +export default Region diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations/getundefined new file mode 100644 index 0000000000000..7448c95be97cc --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminReservations } from "medusa-react" + +const Reservations = () => { + const { reservations, isLoading } = useAdminReservations() + + return ( +
+ {isLoading && Loading...} + {reservations && !reservations.length && ( + No Reservations + )} + {reservations && reservations.length > 0 && ( +
    + {reservations.map((reservation) => ( +
  • {reservation.quantity}
    • + ))} +
+ )} +
+ ) +} + +export default Reservations diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations/postundefined new file mode 100644 index 0000000000000..89ea01a6f79fb --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminCreateReservation } from "medusa-react" + +const CreateReservation = () => { + const createReservation = useAdminCreateReservation() + // ... + + const handleCreate = ( + locationId: string, + inventoryItemId: string, + quantity: number + ) => { + createReservation.mutate({ + location_id: locationId, + inventory_item_id: inventoryItemId, + quantity, + }, { + onSuccess: ({ reservation }) => { + console.log(reservation.id) + } + }) + } + + // ... +} + +export default CreateReservation diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations_{id}/deleteundefined new file mode 100644 index 0000000000000..e4d2d7c875ffb --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations_{id}/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDeleteReservation } from "medusa-react" + +type Props = { + reservationId: string +} + +const Reservation = ({ reservationId }: Props) => { + const deleteReservation = useAdminDeleteReservation( + reservationId + ) + // ... + + const handleDelete = () => { + deleteReservation.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default Reservation diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations_{id}/getundefined new file mode 100644 index 0000000000000..147be76c2c322 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations_{id}/getundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminReservation } from "medusa-react" + +type Props = { + reservationId: string +} + +const Reservation = ({ reservationId }: Props) => { + const { reservation, isLoading } = useAdminReservation( + reservationId + ) + + return ( +
+ {isLoading && Loading...} + {reservation && {reservation.inventory_item_id}} +
+ ) +} + +export default Reservation diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations_{id}/postundefined new file mode 100644 index 0000000000000..ab1c6fe4b935b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_reservations_{id}/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminUpdateReservation } from "medusa-react" + +type Props = { + reservationId: string +} + +const Reservation = ({ reservationId }: Props) => { + const updateReservation = useAdminUpdateReservation( + reservationId + ) + // ... + + const handleUpdate = ( + quantity: number + ) => { + updateReservation.mutate({ + quantity, + }) + } + + // ... +} + +export default Reservation diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons/getundefined new file mode 100644 index 0000000000000..3088c65f2e2d5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons/getundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useAdminReturnReasons } from "medusa-react" + +const ReturnReasons = () => { + const { return_reasons, isLoading } = useAdminReturnReasons() + + return ( +
+ {isLoading && Loading...} + {return_reasons && !return_reasons.length && ( + No Return Reasons + )} + {return_reasons && return_reasons.length > 0 && ( +
    + {return_reasons.map((reason) => ( +
  • + {reason.label}: {reason.value} +
    • + ))} +
+ )} +
+ ) +} + +export default ReturnReasons diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons/postundefined new file mode 100644 index 0000000000000..af1bfcf79b734 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminCreateReturnReason } from "medusa-react" + +const CreateReturnReason = () => { + const createReturnReason = useAdminCreateReturnReason() + // ... + + const handleCreate = ( + label: string, + value: string + ) => { + createReturnReason.mutate({ + label, + value, + }, { + onSuccess: ({ return_reason }) => { + console.log(return_reason.id) + } + }) + } + + // ... +} + +export default CreateReturnReason diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons_{id}/deleteundefined new file mode 100644 index 0000000000000..1ed77fb20f5f4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons_{id}/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDeleteReturnReason } from "medusa-react" + +type Props = { + returnReasonId: string +} + +const ReturnReason = ({ returnReasonId }: Props) => { + const deleteReturnReason = useAdminDeleteReturnReason( + returnReasonId + ) + // ... + + const handleDelete = () => { + deleteReturnReason.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default ReturnReason diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons_{id}/getundefined new file mode 100644 index 0000000000000..71cdc32ddb9e8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons_{id}/getundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminReturnReason } from "medusa-react" + +type Props = { + returnReasonId: string +} + +const ReturnReason = ({ returnReasonId }: Props) => { + const { return_reason, isLoading } = useAdminReturnReason( + returnReasonId + ) + + return ( +
+ {isLoading && Loading...} + {return_reason && {return_reason.label}} +
+ ) +} + +export default ReturnReason diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons_{id}/postundefined new file mode 100644 index 0000000000000..a5ab7d0b37f5d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_return-reasons_{id}/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminUpdateReturnReason } from "medusa-react" + +type Props = { + returnReasonId: string +} + +const ReturnReason = ({ returnReasonId }: Props) => { + const updateReturnReason = useAdminUpdateReturnReason( + returnReasonId + ) + // ... + + const handleUpdate = ( + label: string + ) => { + updateReturnReason.mutate({ + label, + }, { + onSuccess: ({ return_reason }) => { + console.log(return_reason.label) + } + }) + } + + // ... +} + +export default ReturnReason diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_returns/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_returns/getundefined new file mode 100644 index 0000000000000..41bb4764c1b68 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_returns/getundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useAdminReturns } from "medusa-react" + +const Returns = () => { + const { returns, isLoading } = useAdminReturns() + + return ( +
+ {isLoading && Loading...} + {returns && !returns.length && ( + No Returns + )} + {returns && returns.length > 0 && ( +
    + {returns.map((returnData) => ( +
  • + {returnData.status} +
    • + ))} +
+ )} +
+ ) +} + +export default Returns diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_returns_{id}_cancel/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_returns_{id}_cancel/postundefined new file mode 100644 index 0000000000000..bf03bebab31b0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_returns_{id}_cancel/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminCancelReturn } from "medusa-react" + +type Props = { + returnId: string +} + +const Return = ({ returnId }: Props) => { + const cancelReturn = useAdminCancelReturn( + returnId + ) + // ... + + const handleCancel = () => { + cancelReturn.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.returns) + } + }) + } + + // ... +} + +export default Return diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_returns_{id}_receive/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_returns_{id}_receive/postundefined new file mode 100644 index 0000000000000..b05170456d1a3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_returns_{id}_receive/postundefined @@ -0,0 +1,32 @@ +import React from "react" +import { useAdminReceiveReturn } from "medusa-react" + +type ReceiveReturnData = { + items: { + item_id: string + quantity: number + }[] +} + +type Props = { + returnId: string +} + +const Return = ({ returnId }: Props) => { + const receiveReturn = useAdminReceiveReturn( + returnId + ) + // ... + + const handleReceive = (data: ReceiveReturnData) => { + receiveReturn.mutate(data, { + onSuccess: ({ return: dataReturn }) => { + console.log(dataReturn.status) + } + }) + } + + // ... +} + +export default Return diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels/getundefined new file mode 100644 index 0000000000000..0a5cffdeb9a12 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminSalesChannels } from "medusa-react" + +const SalesChannels = () => { + const { sales_channels, isLoading } = useAdminSalesChannels() + + return ( +
+ {isLoading && Loading...} + {sales_channels && !sales_channels.length && ( + No Sales Channels + )} + {sales_channels && sales_channels.length > 0 && ( +
    + {sales_channels.map((salesChannel) => ( +
  • {salesChannel.name}
    • + ))} +
+ )} +
+ ) +} + +export default SalesChannels diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels/postundefined new file mode 100644 index 0000000000000..0106d99fccd36 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels/postundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useAdminCreateSalesChannel } from "medusa-react" + +const CreateSalesChannel = () => { + const createSalesChannel = useAdminCreateSalesChannel() + // ... + + const handleCreate = (name: string, description: string) => { + createSalesChannel.mutate({ + name, + description, + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.id) + } + }) + } + + // ... +} + +export default CreateSalesChannel diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}/deleteundefined new file mode 100644 index 0000000000000..398356218d725 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDeleteSalesChannel } from "medusa-react" + +type Props = { + salesChannelId: string +} + +const SalesChannel = ({ salesChannelId }: Props) => { + const deleteSalesChannel = useAdminDeleteSalesChannel( + salesChannelId + ) + // ... + + const handleDelete = () => { + deleteSalesChannel.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default SalesChannel diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}/getundefined new file mode 100644 index 0000000000000..0542f868df517 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}/getundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useAdminSalesChannel } from "medusa-react" + +type Props = { + salesChannelId: string +} + +const SalesChannel = ({ salesChannelId }: Props) => { + const { + sales_channel, + isLoading, + } = useAdminSalesChannel(salesChannelId) + + return ( +
+ {isLoading && Loading...} + {sales_channel && {sales_channel.name}} +
+ ) +} + +export default SalesChannel diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}/postundefined new file mode 100644 index 0000000000000..7ee5357ffaf26 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminUpdateSalesChannel } from "medusa-react" + +type Props = { + salesChannelId: string +} + +const SalesChannel = ({ salesChannelId }: Props) => { + const updateSalesChannel = useAdminUpdateSalesChannel( + salesChannelId + ) + // ... + + const handleUpdate = ( + is_disabled: boolean + ) => { + updateSalesChannel.mutate({ + is_disabled, + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.is_disabled) + } + }) + } + + // ... +} + +export default SalesChannel diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_products_batch/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_products_batch/deleteundefined new file mode 100644 index 0000000000000..7c852970bada3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_products_batch/deleteundefined @@ -0,0 +1,33 @@ +import React from "react" +import { + useAdminDeleteProductsFromSalesChannel, +} from "medusa-react" + +type Props = { + salesChannelId: string +} + +const SalesChannel = ({ salesChannelId }: Props) => { + const deleteProducts = useAdminDeleteProductsFromSalesChannel( + salesChannelId + ) + // ... + + const handleDeleteProducts = (productId: string) => { + deleteProducts.mutate({ + product_ids: [ + { + id: productId, + }, + ], + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.id) + } + }) + } + + // ... +} + +export default SalesChannel diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_products_batch/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_products_batch/postundefined new file mode 100644 index 0000000000000..6ad37b2b7035d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_products_batch/postundefined @@ -0,0 +1,31 @@ +import React from "react" +import { useAdminAddProductsToSalesChannel } from "medusa-react" + +type Props = { + salesChannelId: string +} + +const SalesChannel = ({ salesChannelId }: Props) => { + const addProducts = useAdminAddProductsToSalesChannel( + salesChannelId + ) + // ... + + const handleAddProducts = (productId: string) => { + addProducts.mutate({ + product_ids: [ + { + id: productId, + }, + ], + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.id) + } + }) + } + + // ... +} + +export default SalesChannel diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_stock-locations/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_stock-locations/deleteundefined new file mode 100644 index 0000000000000..e748372153fd3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_stock-locations/deleteundefined @@ -0,0 +1,28 @@ +import React from "react" +import { + useAdminRemoveLocationFromSalesChannel +} from "medusa-react" + +type Props = { + salesChannelId: string +} + +const SalesChannel = ({ salesChannelId }: Props) => { + const removeLocation = useAdminRemoveLocationFromSalesChannel() + // ... + + const handleRemoveLocation = (locationId: string) => { + removeLocation.mutate({ + sales_channel_id: salesChannelId, + location_id: locationId + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.locations) + } + }) + } + + // ... +} + +export default SalesChannel diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_stock-locations/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_stock-locations/postundefined new file mode 100644 index 0000000000000..51e42aff452c1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_sales-channels_{id}_stock-locations/postundefined @@ -0,0 +1,28 @@ +import React from "react" +import { + useAdminAddLocationToSalesChannel +} from "medusa-react" + +type Props = { + salesChannelId: string +} + +const SalesChannel = ({ salesChannelId }: Props) => { + const addLocation = useAdminAddLocationToSalesChannel() + // ... + + const handleAddLocation = (locationId: string) => { + addLocation.mutate({ + sales_channel_id: salesChannelId, + location_id: locationId + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.locations) + } + }) + } + + // ... +} + +export default SalesChannel diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options/getundefined new file mode 100644 index 0000000000000..585f65b6da9b5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options/getundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminShippingOptions } from "medusa-react" + +const ShippingOptions = () => { + const { + shipping_options, + isLoading + } = useAdminShippingOptions() + + return ( +
+ {isLoading && Loading...} + {shipping_options && !shipping_options.length && ( + No Shipping Options + )} + {shipping_options && shipping_options.length > 0 && ( +
    + {shipping_options.map((option) => ( +
  • {option.name}
    • + ))} +
+ )} +
+ ) +} + +export default ShippingOptions diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options/postundefined new file mode 100644 index 0000000000000..160e1b2c085a9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options/postundefined @@ -0,0 +1,36 @@ +import React from "react" +import { useAdminCreateShippingOption } from "medusa-react" + +type CreateShippingOption = { + name: string + provider_id: string + data: Record + price_type: string + amount: number +} + +type Props = { + regionId: string +} + +const Region = ({ regionId }: Props) => { + const createShippingOption = useAdminCreateShippingOption() + // ... + + const handleCreate = ( + data: CreateShippingOption + ) => { + createShippingOption.mutate({ + ...data, + region_id: regionId + }, { + onSuccess: ({ shipping_option }) => { + console.log(shipping_option.id) + } + }) + } + + // ... +} + +export default Region diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options_{id}/deleteundefined new file mode 100644 index 0000000000000..28dcb6dc241e6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options_{id}/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDeleteShippingOption } from "medusa-react" + +type Props = { + shippingOptionId: string +} + +const ShippingOption = ({ shippingOptionId }: Props) => { + const deleteShippingOption = useAdminDeleteShippingOption( + shippingOptionId + ) + // ... + + const handleDelete = () => { + deleteShippingOption.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default ShippingOption diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options_{id}/getundefined new file mode 100644 index 0000000000000..78698ccd7943b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options_{id}/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminShippingOption } from "medusa-react" + +type Props = { + shippingOptionId: string +} + +const ShippingOption = ({ shippingOptionId }: Props) => { + const { + shipping_option, + isLoading + } = useAdminShippingOption( + shippingOptionId + ) + + return ( +
+ {isLoading && Loading...} + {shipping_option && {shipping_option.name}} +
+ ) +} + +export default ShippingOption diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options_{id}/postundefined new file mode 100644 index 0000000000000..ec6ecbc98134f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-options_{id}/postundefined @@ -0,0 +1,35 @@ +import React from "react" +import { useAdminUpdateShippingOption } from "medusa-react" + +type Props = { + shippingOptionId: string +} + +const ShippingOption = ({ shippingOptionId }: Props) => { + const updateShippingOption = useAdminUpdateShippingOption( + shippingOptionId + ) + // ... + + const handleUpdate = ( + name: string, + requirements: { + id: string, + type: string, + amount: number + }[] + ) => { + updateShippingOption.mutate({ + name, + requirements + }, { + onSuccess: ({ shipping_option }) => { + console.log(shipping_option.requirements) + } + }) + } + + // ... +} + +export default ShippingOption diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles/getundefined new file mode 100644 index 0000000000000..be8e493635577 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles/getundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminShippingProfiles } from "medusa-react" + +const ShippingProfiles = () => { + const { + shipping_profiles, + isLoading + } = useAdminShippingProfiles() + + return ( +
+ {isLoading && Loading...} + {shipping_profiles && !shipping_profiles.length && ( + No Shipping Profiles + )} + {shipping_profiles && shipping_profiles.length > 0 && ( +
    + {shipping_profiles.map((profile) => ( +
  • {profile.name}
    • + ))} +
+ )} +
+ ) +} + +export default ShippingProfiles diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles/postundefined new file mode 100644 index 0000000000000..48364cad28512 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles/postundefined @@ -0,0 +1,26 @@ +import React from "react" +import { ShippingProfileType } from "@medusajs/medusa" +import { useAdminCreateShippingProfile } from "medusa-react" + +const CreateShippingProfile = () => { + const createShippingProfile = useAdminCreateShippingProfile() + // ... + + const handleCreate = ( + name: string, + type: ShippingProfileType + ) => { + createShippingProfile.mutate({ + name, + type + }, { + onSuccess: ({ shipping_profile }) => { + console.log(shipping_profile.id) + } + }) + } + + // ... +} + +export default CreateShippingProfile diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles_{id}/deleteundefined new file mode 100644 index 0000000000000..a71e310ebceab --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles_{id}/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDeleteShippingProfile } from "medusa-react" + +type Props = { + shippingProfileId: string +} + +const ShippingProfile = ({ shippingProfileId }: Props) => { + const deleteShippingProfile = useAdminDeleteShippingProfile( + shippingProfileId + ) + // ... + + const handleDelete = () => { + deleteShippingProfile.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default ShippingProfile diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles_{id}/getundefined new file mode 100644 index 0000000000000..c5ef864b189b1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles_{id}/getundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useAdminShippingProfile } from "medusa-react" + +type Props = { + shippingProfileId: string +} + +const ShippingProfile = ({ shippingProfileId }: Props) => { + const { + shipping_profile, + isLoading + } = useAdminShippingProfile( + shippingProfileId + ) + + return ( +
+ {isLoading && Loading...} + {shipping_profile && ( + {shipping_profile.name} + )} +
+ ) +} + +export default ShippingProfile diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles_{id}/postundefined new file mode 100644 index 0000000000000..7404dac87c809 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_shipping-profiles_{id}/postundefined @@ -0,0 +1,32 @@ +import React from "react" +import { ShippingProfileType } from "@medusajs/medusa" +import { useAdminUpdateShippingProfile } from "medusa-react" + +type Props = { + shippingProfileId: string +} + +const ShippingProfile = ({ shippingProfileId }: Props) => { + const updateShippingProfile = useAdminUpdateShippingProfile( + shippingProfileId + ) + // ... + + const handleUpdate = ( + name: string, + type: ShippingProfileType + ) => { + updateShippingProfile.mutate({ + name, + type + }, { + onSuccess: ({ shipping_profile }) => { + console.log(shipping_profile.name) + } + }) + } + + // ... +} + +export default ShippingProfile diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations/getundefined new file mode 100644 index 0000000000000..95dbf88b30f98 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations/getundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminStockLocations } from "medusa-react" + +function StockLocations() { + const { + stock_locations, + isLoading + } = useAdminStockLocations() + + return ( +
+ {isLoading && Loading...} + {stock_locations && !stock_locations.length && ( + No Locations + )} + {stock_locations && stock_locations.length > 0 && ( +
    + {stock_locations.map( + (location) => ( +
  • {location.name}
    • + ) + )} +
+ )} +
+ ) +} + +export default StockLocations diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations/postundefined new file mode 100644 index 0000000000000..188fd7cc29a0f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations/postundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminCreateStockLocation } from "medusa-react" + +const CreateStockLocation = () => { + const createStockLocation = useAdminCreateStockLocation() + // ... + + const handleCreate = (name: string) => { + createStockLocation.mutate({ + name, + }, { + onSuccess: ({ stock_location }) => { + console.log(stock_location.id) + } + }) + } + + // ... +} + +export default CreateStockLocation diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations_{id}/deleteundefined new file mode 100644 index 0000000000000..71125870815a0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations_{id}/deleteundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminDeleteStockLocation } from "medusa-react" + +type Props = { + stockLocationId: string +} + +const StockLocation = ({ stockLocationId }: Props) => { + const deleteLocation = useAdminDeleteStockLocation( + stockLocationId + ) + // ... + + const handleDelete = () => { + deleteLocation.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } +} + +export default StockLocation diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations_{id}/getundefined new file mode 100644 index 0000000000000..5e225b37ff0cf --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations_{id}/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminStockLocation } from "medusa-react" + +type Props = { + stockLocationId: string +} + +const StockLocation = ({ stockLocationId }: Props) => { + const { + stock_location, + isLoading + } = useAdminStockLocation(stockLocationId) + + return ( +
+ {isLoading && Loading...} + {stock_location && ( + {stock_location.name} + )} +
+ ) +} + +export default StockLocation diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations_{id}/postundefined new file mode 100644 index 0000000000000..e4d62322bbe6d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_stock-locations_{id}/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminUpdateStockLocation } from "medusa-react" + +type Props = { + stockLocationId: string +} + +const StockLocation = ({ stockLocationId }: Props) => { + const updateLocation = useAdminUpdateStockLocation( + stockLocationId + ) + // ... + + const handleUpdate = ( + name: string + ) => { + updateLocation.mutate({ + name + }, { + onSuccess: ({ stock_location }) => { + console.log(stock_location.name) + } + }) + } +} + +export default StockLocation diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store/getundefined new file mode 100644 index 0000000000000..c2004792f30af --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store/getundefined @@ -0,0 +1,18 @@ +import React from "react" +import { useAdminStore } from "medusa-react" + +const Store = () => { + const { + store, + isLoading + } = useAdminStore() + + return ( +
+ {isLoading && Loading...} + {store && {store.name}} +
+ ) +} + +export default Store diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store/postundefined new file mode 100644 index 0000000000000..50f7b3d49a967 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store/postundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminUpdateStore } from "medusa-react" + +function Store() { + const updateStore = useAdminUpdateStore() + // ... + + const handleUpdate = ( + name: string + ) => { + updateStore.mutate({ + name + }, { + onSuccess: ({ store }) => { + console.log(store.name) + } + }) + } +} + +export default Store diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_currencies_{code}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_currencies_{code}/deleteundefined new file mode 100644 index 0000000000000..bfb3914d677b3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_currencies_{code}/deleteundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useAdminDeleteStoreCurrency } from "medusa-react" + +const Store = () => { + const deleteCurrency = useAdminDeleteStoreCurrency() + // ... + + const handleAdd = (code: string) => { + deleteCurrency.mutate(code, { + onSuccess: ({ store }) => { + console.log(store.currencies) + } + }) + } + + // ... +} + +export default Store diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_currencies_{code}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_currencies_{code}/postundefined new file mode 100644 index 0000000000000..c4a586f2c16ec --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_currencies_{code}/postundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useAdminAddStoreCurrency } from "medusa-react" + +const Store = () => { + const addCurrency = useAdminAddStoreCurrency() + // ... + + const handleAdd = (code: string) => { + addCurrency.mutate(code, { + onSuccess: ({ store }) => { + console.log(store.currencies) + } + }) + } + + // ... +} + +export default Store diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_payment-providers/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_payment-providers/getundefined new file mode 100644 index 0000000000000..48c4d20924957 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_payment-providers/getundefined @@ -0,0 +1,28 @@ +import React from "react" +import { useAdminStorePaymentProviders } from "medusa-react" + +const PaymentProviders = () => { + const { + payment_providers, + isLoading + } = useAdminStorePaymentProviders() + + return ( +
+ {isLoading && Loading...} + {payment_providers && !payment_providers.length && ( + No Payment Providers + )} + {payment_providers && + payment_providers.length > 0 &&( +
    + {payment_providers.map((provider) => ( +
  • {provider.id}
    • + ))} +
+ )} +
+ ) +} + +export default PaymentProviders diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_tax-providers/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_tax-providers/getundefined new file mode 100644 index 0000000000000..b0214ad1cdb9a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_store_tax-providers/getundefined @@ -0,0 +1,28 @@ +import React from "react" +import { useAdminStoreTaxProviders } from "medusa-react" + +const TaxProviders = () => { + const { + tax_providers, + isLoading + } = useAdminStoreTaxProviders() + + return ( +
+ {isLoading && Loading...} + {tax_providers && !tax_providers.length && ( + No Tax Providers + )} + {tax_providers && + tax_providers.length > 0 &&( +
    + {tax_providers.map((provider) => ( +
  • {provider.id}
    • + ))} +
+ )} +
+ ) +} + +export default TaxProviders diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_swaps/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_swaps/getundefined new file mode 100644 index 0000000000000..9e297a882350c --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_swaps/getundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useAdminSwaps } from "medusa-react" + +const Swaps = () => { + const { swaps, isLoading } = useAdminSwaps() + + return ( +
+ {isLoading && Loading...} + {swaps && !swaps.length && No Swaps} + {swaps && swaps.length > 0 && ( +
    + {swaps.map((swap) => ( +
  • {swap.payment_status}
    • + ))} +
+ )} +
+ ) +} + +export default Swaps diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_swaps_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_swaps_{id}/getundefined new file mode 100644 index 0000000000000..85f72480f7448 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_swaps_{id}/getundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useAdminSwap } from "medusa-react" + +type Props = { + swapId: string +} + +const Swap = ({ swapId }: Props) => { + const { swap, isLoading } = useAdminSwap(swapId) + + return ( +
+ {isLoading && Loading...} + {swap && {swap.id}} +
+ ) +} + +export default Swap diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates/getundefined new file mode 100644 index 0000000000000..a82ad7feb7149 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates/getundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminTaxRates } from "medusa-react" + +const TaxRates = () => { + const { + tax_rates, + isLoading + } = useAdminTaxRates() + + return ( +
+ {isLoading && Loading...} + {tax_rates && !tax_rates.length && ( + No Tax Rates + )} + {tax_rates && tax_rates.length > 0 && ( +
    + {tax_rates.map((tax_rate) => ( +
  • {tax_rate.code}
    • + ))} +
+ )} +
+ ) +} + +export default TaxRates diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates/postundefined new file mode 100644 index 0000000000000..595cf119b0f8a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates/postundefined @@ -0,0 +1,32 @@ +import React from "react" +import { useAdminCreateTaxRate } from "medusa-react" + +type Props = { + regionId: string +} + +const CreateTaxRate = ({ regionId }: Props) => { + const createTaxRate = useAdminCreateTaxRate() + // ... + + const handleCreate = ( + code: string, + name: string, + rate: number + ) => { + createTaxRate.mutate({ + code, + name, + region_id: regionId, + rate, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.id) + } + }) + } + + // ... +} + +export default CreateTaxRate diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}/deleteundefined new file mode 100644 index 0000000000000..25a4bc4bdf513 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}/deleteundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminDeleteTaxRate } from "medusa-react" + +type Props = { + taxRateId: string +} + +const TaxRate = ({ taxRateId }: Props) => { + const deleteTaxRate = useAdminDeleteTaxRate(taxRateId) + // ... + + const handleDelete = () => { + deleteTaxRate.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default TaxRate diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}/getundefined new file mode 100644 index 0000000000000..eea6f92e61f87 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}/getundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useAdminTaxRate } from "medusa-react" + +type Props = { + taxRateId: string +} + +const TaxRate = ({ taxRateId }: Props) => { + const { tax_rate, isLoading } = useAdminTaxRate(taxRateId) + + return ( +
+ {isLoading && Loading...} + {tax_rate && {tax_rate.code}} +
+ ) +} + +export default TaxRate diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}/postundefined new file mode 100644 index 0000000000000..2265bbd4486ed --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminUpdateTaxRate } from "medusa-react" + +type Props = { + taxRateId: string +} + +const TaxRate = ({ taxRateId }: Props) => { + const updateTaxRate = useAdminUpdateTaxRate(taxRateId) + // ... + + const handleUpdate = ( + name: string + ) => { + updateTaxRate.mutate({ + name + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.name) + } + }) + } + + // ... +} + +export default TaxRate diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_product-types_batch/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_product-types_batch/deleteundefined new file mode 100644 index 0000000000000..bc4cdd19a7bc0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_product-types_batch/deleteundefined @@ -0,0 +1,31 @@ +import React from "react" +import { + useAdminDeleteProductTypeTaxRates, +} from "medusa-react" + +type Props = { + taxRateId: string +} + +const TaxRate = ({ taxRateId }: Props) => { + const removeProductTypes = useAdminDeleteProductTypeTaxRates( + taxRateId + ) + // ... + + const handleRemoveProductTypes = ( + productTypeIds: string[] + ) => { + removeProductTypes.mutate({ + product_types: productTypeIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.product_types) + } + }) + } + + // ... +} + +export default TaxRate diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_product-types_batch/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_product-types_batch/postundefined new file mode 100644 index 0000000000000..b398eb8e9e31c --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_product-types_batch/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { + useAdminCreateProductTypeTaxRates, +} from "medusa-react" + +type Props = { + taxRateId: string +} + +const TaxRate = ({ taxRateId }: Props) => { + const addProductTypes = useAdminCreateProductTypeTaxRates( + taxRateId + ) + // ... + + const handleAddProductTypes = (productTypeIds: string[]) => { + addProductTypes.mutate({ + product_types: productTypeIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.product_types) + } + }) + } + + // ... +} + +export default TaxRate diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_products_batch/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_products_batch/deleteundefined new file mode 100644 index 0000000000000..d55af26d4387e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_products_batch/deleteundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminDeleteProductTaxRates } from "medusa-react" + +type Props = { + taxRateId: string +} + +const TaxRate = ({ taxRateId }: Props) => { + const removeProduct = useAdminDeleteProductTaxRates(taxRateId) + // ... + + const handleRemoveProduct = (productIds: string[]) => { + removeProduct.mutate({ + products: productIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.products) + } + }) + } + + // ... +} + +export default TaxRate diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_products_batch/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_products_batch/postundefined new file mode 100644 index 0000000000000..cb5ad79c49f42 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_products_batch/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminCreateProductTaxRates } from "medusa-react" + +type Props = { + taxRateId: string +} + +const TaxRate = ({ taxRateId }: Props) => { + const addProduct = useAdminCreateProductTaxRates(taxRateId) + // ... + + const handleAddProduct = (productIds: string[]) => { + addProduct.mutate({ + products: productIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.products) + } + }) + } + + // ... +} + +export default TaxRate diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_shipping-options_batch/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_shipping-options_batch/deleteundefined new file mode 100644 index 0000000000000..087c23976a5e7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_shipping-options_batch/deleteundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminDeleteShippingTaxRates } from "medusa-react" + +type Props = { + taxRateId: string +} + +const TaxRate = ({ taxRateId }: Props) => { + const removeShippingOptions = useAdminDeleteShippingTaxRates( + taxRateId + ) + // ... + + const handleRemoveShippingOptions = ( + shippingOptionIds: string[] + ) => { + removeShippingOptions.mutate({ + shipping_options: shippingOptionIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.shipping_options) + } + }) + } + + // ... +} + +export default TaxRate diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_shipping-options_batch/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_shipping-options_batch/postundefined new file mode 100644 index 0000000000000..8951d71328a76 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_tax-rates_{id}_shipping-options_batch/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAdminCreateShippingTaxRates } from "medusa-react" + +type Props = { + taxRateId: string +} + +const TaxRate = ({ taxRateId }: Props) => { + const addShippingOption = useAdminCreateShippingTaxRates( + taxRateId + ) + // ... + + const handleAddShippingOptions = ( + shippingOptionIds: string[] + ) => { + addShippingOption.mutate({ + shipping_options: shippingOptionIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.shipping_options) + } + }) + } + + // ... +} + +export default TaxRate diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads/deleteundefined new file mode 100644 index 0000000000000..ee004df738458 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads/deleteundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminDeleteFile } from "medusa-react" + +const Image = () => { + const deleteFile = useAdminDeleteFile() + // ... + + const handleDeleteFile = (fileKey: string) => { + deleteFile.mutate({ + file_key: fileKey + }, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default Image diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads/postundefined new file mode 100644 index 0000000000000..b35789cbab3a6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads/postundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useAdminUploadFile } from "medusa-react" + +const UploadFile = () => { + const uploadFile = useAdminUploadFile() + // ... + + const handleFileUpload = (file: File) => { + uploadFile.mutate(file, { + onSuccess: ({ uploads }) => { + console.log(uploads[0].key) + } + }) + } + + // ... +} + +export default UploadFile diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads_download-url/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads_download-url/postundefined new file mode 100644 index 0000000000000..97162405d4d0f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads_download-url/postundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminCreatePresignedDownloadUrl } from "medusa-react" + +const Image = () => { + const createPresignedUrl = useAdminCreatePresignedDownloadUrl() + // ... + + const handlePresignedUrl = (fileKey: string) => { + createPresignedUrl.mutate({ + file_key: fileKey + }, { + onSuccess: ({ download_url }) => { + console.log(download_url) + } + }) + } + + // ... +} + +export default Image diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads_protected/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads_protected/postundefined new file mode 100644 index 0000000000000..b2f2016550ba2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_uploads_protected/postundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useAdminUploadProtectedFile } from "medusa-react" + +const UploadFile = () => { + const uploadFile = useAdminUploadProtectedFile() + // ... + + const handleFileUpload = (file: File) => { + uploadFile.mutate(file, { + onSuccess: ({ uploads }) => { + console.log(uploads[0].key) + } + }) + } + + // ... +} + +export default UploadFile diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users/getundefined new file mode 100644 index 0000000000000..9277ace79ed25 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users/getundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useAdminUsers } from "medusa-react" + +const Users = () => { + const { users, isLoading } = useAdminUsers() + + return ( +
+ {isLoading && Loading...} + {users && !users.length && No Users} + {users && users.length > 0 && ( +
    + {users.map((user) => ( +
  • {user.email}
    • + ))} +
+ )} +
+ ) +} + +export default Users diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users/postundefined new file mode 100644 index 0000000000000..b9a2a0009e9a2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users/postundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useAdminCreateUser } from "medusa-react" + +const CreateUser = () => { + const createUser = useAdminCreateUser() + // ... + + const handleCreateUser = () => { + createUser.mutate({ + email: "user@example.com", + password: "supersecret", + }, { + onSuccess: ({ user }) => { + console.log(user.id) + } + }) + } + + // ... +} + +export default CreateUser diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_password-token/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_password-token/postundefined new file mode 100644 index 0000000000000..e38a685370656 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_password-token/postundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminSendResetPasswordToken } from "medusa-react" + +const Login = () => { + const requestPasswordReset = useAdminSendResetPasswordToken() + // ... + + const handleResetPassword = ( + email: string + ) => { + requestPasswordReset.mutate({ + email + }, { + onSuccess: () => { + // successful + } + }) + } + + // ... +} + +export default Login diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_reset-password/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_reset-password/postundefined new file mode 100644 index 0000000000000..dfd742bfae4be --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_reset-password/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useAdminResetPassword } from "medusa-react" + +const ResetPassword = () => { + const resetPassword = useAdminResetPassword() + // ... + + const handleResetPassword = ( + token: string, + password: string + ) => { + resetPassword.mutate({ + token, + password, + }, { + onSuccess: ({ user }) => { + console.log(user.id) + } + }) + } + + // ... +} + +export default ResetPassword diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_{id}/deleteundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_{id}/deleteundefined new file mode 100644 index 0000000000000..14d748a56fc22 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_{id}/deleteundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useAdminDeleteUser } from "medusa-react" + +type Props = { + userId: string +} + +const User = ({ userId }: Props) => { + const deleteUser = useAdminDeleteUser(userId) + // ... + + const handleDeleteUser = () => { + deleteUser.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... +} + +export default User diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_{id}/getundefined new file mode 100644 index 0000000000000..959579302ed38 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_{id}/getundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminUser } from "medusa-react" + +type Props = { + userId: string +} + +const User = ({ userId }: Props) => { + const { user, isLoading } = useAdminUser( + userId + ) + + return ( +
+ {isLoading && Loading...} + {user && {user.first_name} {user.last_name}} +
+ ) +} + +export default User diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_{id}/postundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_{id}/postundefined new file mode 100644 index 0000000000000..85b794db220b9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_users_{id}/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAdminUpdateUser } from "medusa-react" + +type Props = { + userId: string +} + +const User = ({ userId }: Props) => { + const updateUser = useAdminUpdateUser(userId) + // ... + + const handleUpdateUser = ( + firstName: string + ) => { + updateUser.mutate({ + first_name: firstName, + }, { + onSuccess: ({ user }) => { + console.log(user.first_name) + } + }) + } + + // ... +} + +export default User diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_variants/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_variants/getundefined new file mode 100644 index 0000000000000..8f112134c47bc --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_variants/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useAdminVariants } from "medusa-react" + +const Variants = () => { + const { variants, isLoading } = useAdminVariants() + + return ( +
+ {isLoading && Loading...} + {variants && !variants.length && ( + No Variants + )} + {variants && variants.length > 0 && ( +
    + {variants.map((variant) => ( +
  • {variant.title}
    • + ))} +
+ )} +
+ ) +} + +export default Variants diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_variants_{id}/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_variants_{id}/getundefined new file mode 100644 index 0000000000000..d26d992398815 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_variants_{id}/getundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useAdminVariant } from "medusa-react" + +type Props = { + variantId: string +} + +const Variant = ({ variantId }: Props) => { + const { variant, isLoading } = useAdminVariant( + variantId + ) + + return ( +
+ {isLoading && Loading...} + {variant && {variant.title}} +
+ ) +} + +export default Variant diff --git a/www/apps/api-reference/specs/admin/code_samples/tsx/admin_variants_{id}_inventory/getundefined b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_variants_{id}_inventory/getundefined new file mode 100644 index 0000000000000..87b00a2827054 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/tsx/admin_variants_{id}_inventory/getundefined @@ -0,0 +1,30 @@ +import React from "react" +import { useAdminVariantsInventory } from "medusa-react" + +type Props = { + variantId: string +} + +const VariantInventory = ({ variantId }: Props) => { + const { variant, isLoading } = useAdminVariantsInventory( + variantId + ) + + return ( +
+ {isLoading && Loading...} + {variant && variant.inventory.length === 0 && ( + Variant doesn't have inventory details + )} + {variant && variant.inventory.length > 0 && ( +
    + {variant.inventory.map((inventory) => ( +
  • {inventory.title}
    • + ))} +
+ )} +
+ ) +} + +export default VariantInventory diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteCustomerGroupsGroupCustomerBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteCustomerGroupsGroupCustomerBatchReq.yaml index f8faad9a4eed3..ebd0cf5526d2f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteCustomerGroupsGroupCustomerBatchReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteCustomerGroupsGroupCustomerBatchReq.yaml @@ -1,4 +1,5 @@ type: object +description: The customers to remove from the customer group. required: - customer_ids properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListPricesPricesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListPricesPricesReq.yaml index 43b788bdf6ccb..9bc07263fc535 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListPricesPricesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListPricesPricesReq.yaml @@ -1,7 +1,8 @@ type: object +description: The details of the prices to delete. properties: price_ids: - description: The price IDs of the Money Amounts to delete. + description: The IDs of the prices to delete. type: array items: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListsPriceListProductsPricesBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListsPriceListProductsPricesBatchReq.yaml index 4d0d09956547e..b54e2e550f3ee 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListsPriceListProductsPricesBatchReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListsPriceListProductsPricesBatchReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the products' prices to delete. properties: product_ids: description: The IDs of the products to delete their associated prices. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq.yaml index 52d2aaa809ef0..67764d4914d13 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq.yaml @@ -1,9 +1,10 @@ type: object +description: The details of the products to delete from the product category. required: - product_ids properties: product_ids: - description: The IDs of the products to delete from the Product Category. + description: The IDs of the products to delete from the product category. type: array items: type: object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionReq.yaml index 0c9720a3493c8..2c9d19ccb5559 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the products to remove from the collection. required: - product_ids properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePublishableApiKeySalesChannelsBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePublishableApiKeySalesChannelsBatchReq.yaml index 992882d4df83a..3c1afa930c929 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePublishableApiKeySalesChannelsBatchReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePublishableApiKeySalesChannelsBatchReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the sales channels to remove from the publishable API key. required: - sales_channel_ids properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteSalesChannelsChannelProductsBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteSalesChannelsChannelProductsBatchReq.yaml index 3526ff5c591fb..38602e26b411f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteSalesChannelsChannelProductsBatchReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteSalesChannelsChannelProductsBatchReq.yaml @@ -1,9 +1,10 @@ type: object +description: The details of the products to delete from the sales channel. required: - product_ids properties: product_ids: - description: The IDs of the products to remove from the Sales Channel. + description: The IDs of the products to remove from the sales channel. type: array items: type: object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductsReq.yaml index e3036f7e2d0be..3e8e2efb14f03 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the products to remove their associated with the tax rate. required: - products properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateShippingOptionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateShippingOptionsReq.yaml index a870e114eaf28..e383613f0b4c3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateShippingOptionsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateShippingOptionsReq.yaml @@ -1,4 +1,7 @@ type: object +description: >- + The details of the shipping options to remove their associate with the tax + rate. required: - shipping_options properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUploadsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUploadsReq.yaml index 74a8b059c73f2..28df01fe6277d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUploadsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUploadsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the file to delete. required: - file_key properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionsRes.yaml index 3c4502a811112..690f1daeff51b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The payment collection's details. x-expanded-relations: field: payment_collection relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostAuthReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostAuthReq.yaml index a70918cdeda21..49793b6181cc7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostAuthReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostAuthReq.yaml @@ -1,4 +1,5 @@ type: object +description: The admin's credentials used to log in. required: - email - password diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostBatchesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostBatchesReq.yaml index ab6f9a5afc18b..7219868bf11bb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostBatchesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostBatchesReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the batch job to create. required: - type - context diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsCollectionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsCollectionReq.yaml index 481f005f4daae..2fd371ac5f7d8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsCollectionReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsCollectionReq.yaml @@ -1,4 +1,5 @@ type: object +description: The product collection's details to update. properties: title: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsReq.yaml index fb7b5921b74ed..2b759bb8b8a73 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The product collection's details. required: - title properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCurrenciesCurrencyReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCurrenciesCurrencyReq.yaml index 2d7ac5b299abe..a18f97dea6059 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCurrenciesCurrencyReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCurrenciesCurrencyReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update in the currency properties: includes_tax: type: boolean diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml index f9d2ccacbea91..001be4ea41af5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml @@ -1,4 +1,5 @@ type: object +description: The customers to add to the customer group. required: - customer_ids properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupReq.yaml index af9b08076afcf..073078c077e28 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update in the customer group. properties: name: description: Name of the customer group diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsReq.yaml index a806ec59393ea..d28a86c9f609f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the customer group to create. required: - name properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersCustomerReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersCustomerReq.yaml index 7056855fda143..4a5bf522e7ad8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersCustomerReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersCustomerReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the customer to update. properties: email: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersReq.yaml index 00889d8f5b386..724189f931631 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the customer to create. required: - email - first_name diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsConditionBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsConditionBatchReq.yaml index b79fdcaf524bb..592e04144ddcd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsConditionBatchReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsConditionBatchReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the resources to add. required: - resources properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountDynamicCodesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountDynamicCodesReq.yaml index c3d055f336f2b..9b8818aae8299 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountDynamicCodesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountDynamicCodesReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the dynamic discount to create. required: - code properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountReq.yaml index 7b87f318bc606..58fd553d1f1cd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the discount to update. properties: code: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsReq.yaml index e7a5f2568e58d..4aca231f7e1b4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the discount to create. required: - code - rule diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsItemReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsItemReq.yaml index 50739d501d358..9eb17a0a8ad05 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsItemReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsItemReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the line item. properties: unit_price: description: >- diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsReq.yaml index 534a197e29ce1..eb259a08f5394 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the line item to create. required: - quantity properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderReq.yaml index 78ce97bc42a0c..48ac5e452f963 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the draft order to update. properties: region_id: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersReq.yaml index 0677686a7c704..a3e5578924754 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the draft order to create. required: - email - region_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsGiftCardReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsGiftCardReq.yaml index f2eed952d6b61..fe097102c9b5a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsGiftCardReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsGiftCardReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the gift card. properties: balance: type: integer diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsReq.yaml index e969813ef8e6b..1704d9a3e297a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the gift card to create. required: - region_id properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml index a581c1918d548..c7c1dc67ba211 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the location level to create. required: - location_id - stocked_quantity diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml index ca1e586a24939..1516b42d4a1c8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the inventory item to create. required: - variant_id properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesNoteReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesNoteReq.yaml index e5422c1680d9b..c275eb99c25fd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesNoteReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesNoteReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the note. required: - value properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesReq.yaml index 94c6db4726349..2ece35fa61604 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the note to be created. required: - resource_id - resource_type diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotificationsNotificationResendReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotificationsNotificationResendReq.yaml index 15e00764ea959..8f4484779c619 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotificationsNotificationResendReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotificationsNotificationResendReq.yaml @@ -1,4 +1,5 @@ type: object +description: The resend details. properties: to: description: >- diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsLineItemReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsLineItemReq.yaml index cb38c689f2323..988baaa0c3ed4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsLineItemReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsLineItemReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to create or update of the line item change. required: - quantity properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsReq.yaml index 8476606d5ac13..ed5d1236f9f97 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the line item change to create. required: - variant_id - quantity diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsOrderEditReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsOrderEditReq.yaml index 15db5e930f510..76f864ed6d240 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsOrderEditReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsOrderEditReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the order edit. properties: internal_note: description: An optional note to create or update in the order edit. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReq.yaml index f02ce3c01ad4f..5e3b9ce6f1fc1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the order edit to create. required: - order_id properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderRefundsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderRefundsReq.yaml index 004cc962fc7cd..07db31127d4cd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderRefundsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderRefundsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the order refund. required: - amount - reason diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReq.yaml index ce759df2f76cf..fa7a2a7530686 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the order. properties: email: description: The email associated with the order diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReturnsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReturnsReq.yaml index d7b166d0bb7e6..6526c405a801f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReturnsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReturnsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the requested return. required: - items properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShipmentReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShipmentReq.yaml index 760275eb19082..164ef7563857b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShipmentReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShipmentReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the shipment to create. required: - fulfillment_id properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsReq.yaml index 093972e864d86..75ca36674afcb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the swap to create. required: - return_items properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentRefundsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentRefundsReq.yaml index 3ac53d359acb7..25c74f1d4bd8d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentRefundsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentRefundsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the refund to create. required: - amount - reason diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListPricesPricesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListPricesPricesReq.yaml index ba11d243786cd..bed0213a0e24c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListPricesPricesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListPricesPricesReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the prices to add. properties: prices: description: The prices to update or add. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPriceListReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPriceListReq.yaml index bb5acd67fedfd..e053f0dbf5bcc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPriceListReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPriceListReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the payment collection. properties: name: description: The name of the Price List diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml index d7367f1a04a0a..ec65faee0ab23 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the price list to create. required: - name - description diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq.yaml index 5d2772de1b4f9..5d95e9141db05 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq.yaml @@ -1,9 +1,10 @@ type: object +description: The details of the products to add to the product category. required: - product_ids properties: product_ids: - description: The IDs of the products to add to the Product Category + description: The IDs of the products to add to the product category type: array items: type: object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml index 276e25b0e8f64..066991c4c8049 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the product category. properties: name: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesReq.yaml index 444e7e7636198..e68357b5d904c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the product category to create. required: - name properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductOptionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductOptionsReq.yaml index 55b83b86915f4..a8aebb777bdeb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductOptionsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductOptionsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the product option to create. required: - title properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductReq.yaml index f2b81a1546432..d493778ddf3a4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the product. properties: title: description: The title of the Product diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductVariantsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductVariantsReq.yaml index 98424f1ed9aae..4714294c7f99a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductVariantsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductVariantsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the product variant to create. required: - title - prices diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsReq.yaml index bfaa84f7ddaf8..1af53e32cccf9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the product to create. required: - title properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsToCollectionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsToCollectionReq.yaml index 6311a4138bdcd..9dea69c4f5de0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsToCollectionReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsToCollectionReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the products to add to the collection. required: - product_ids properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeySalesChannelsBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeySalesChannelsBatchReq.yaml index 0c36582012ca0..e4488d0be6018 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeySalesChannelsBatchReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeySalesChannelsBatchReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the sales channels to add to the publishable API key. required: - sales_channel_ids properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysPublishableApiKeyReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysPublishableApiKeyReq.yaml index d0a54b266be29..7a546010fd188 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysPublishableApiKeyReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysPublishableApiKeyReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the publishable API key. properties: title: description: The title of the Publishable API Key. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysReq.yaml index 8cd110a6dc5ef..64bce0a179304 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the publishable API key to create. required: - title properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionCountriesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionCountriesReq.yaml index 92f579df49348..67711cf9c0148 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionCountriesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionCountriesReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the country to add to the region. required: - country_code properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionFulfillmentProvidersReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionFulfillmentProvidersReq.yaml index 0a0105962b12a..f952ecb909c5d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionFulfillmentProvidersReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionFulfillmentProvidersReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the fulfillment provider to add to the region. required: - provider_id properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionPaymentProvidersReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionPaymentProvidersReq.yaml index 8afda21c45ef4..eec9ff73b8b3c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionPaymentProvidersReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionPaymentProvidersReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the payment provider to add to the region. required: - provider_id properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionReq.yaml index c38fac3063d8e..f979ec56b973b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the regions. properties: name: description: The name of the Region diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsReq.yaml index 5ab04aa90b7e0..7b81a1cf9d090 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the region to create. required: - name - currency_code diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReq.yaml index 863f0a8ed9c1c..03fe9386f4d8a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the reservation to create. required: - location_id - inventory_item_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReservationReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReservationReq.yaml index e77598239c414..87e6d986cad01 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReservationReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReservationReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the reservation. properties: location_id: description: The ID of the location associated with the reservation. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReasonReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReasonReq.yaml index 29add7bd23f88..210fd0ce29c1d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReasonReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReasonReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the return reason. properties: label: description: The label to display to the Customer. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReq.yaml index 61574e3262486..c279b67d5b0ff 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the return reason to create. required: - label - value diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReceiveReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReceiveReq.yaml index 2147216e85f5e..1df680e51255c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReceiveReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReceiveReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the received return. required: - items properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsChannelProductsBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsChannelProductsBatchReq.yaml index 90b5b227c99c7..1ea7c4dccced0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsChannelProductsBatchReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsChannelProductsBatchReq.yaml @@ -1,9 +1,10 @@ type: object +description: The details of the products to add to the sales channel. required: - product_ids properties: product_ids: - description: The IDs of the products to add to the Sales Channel + description: The IDs of the products to add to the sales channel type: array items: type: object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsReq.yaml index 6f6e01cc4de4a..350e640c6e803 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the sales channel to create. required: - name properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsSalesChannelReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsSalesChannelReq.yaml index 8c45cfa8c144e..b19fe3093ec9c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsSalesChannelReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsSalesChannelReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the sales channel. properties: name: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsOptionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsOptionReq.yaml index da4ee33decfb0..b203c31f1cf82 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsOptionReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsOptionReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the shipping option. required: - requirements properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsReq.yaml index 5ba35c798ebd6..ded76946d4155 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the shipping option to create. required: - name - region_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesProfileReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesProfileReq.yaml index cb096bcfd189f..66706941a7f23 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesProfileReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesProfileReq.yaml @@ -1,4 +1,5 @@ type: object +description: The detail to update of the shipping profile. properties: name: description: The name of the Shipping Profile diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesReq.yaml index cedb4ee33d667..6811257b50892 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the shipping profile to create. required: - name - type diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml index 186ace8985e27..58ba572f6105b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the stock location. properties: name: description: the name of the stock location diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReq.yaml index e9f228e3e57a2..ba6e9ea4d2a1f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the stock location to create. required: - name properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStoreReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStoreReq.yaml index a1c91438413ae..7cedff30fdc45 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStoreReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStoreReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the store. properties: name: description: The name of the Store diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesReq.yaml index e761008909bda..380858f2560de 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the tax rate to create. required: - code - name diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductsReq.yaml index 74c55626a97ae..fe7852a7a0386 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the products to associat with the tax rate. required: - products properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml index b16850d706ad4..2ef465db033fc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the tax rate. properties: code: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateShippingOptionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateShippingOptionsReq.yaml index 1a7110b271e1d..8daa099db8abd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateShippingOptionsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateShippingOptionsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the shipping options to associate with the tax rate. required: - shipping_options properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostUploadsDownloadUrlReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostUploadsDownloadUrlReq.yaml index 1d6bb389028ba..bb45c046557b2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostUploadsDownloadUrlReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostUploadsDownloadUrlReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the file to retrieve its download URL. required: - file_key properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordRequest.yaml index efbec17c4a77d..3fa29d4bb2d41 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordRequest.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordRequest.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the password reset request. required: - token - password diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordTokenRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordTokenRequest.yaml index ed2bacd924cf5..f2e5b0e6d5611 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordTokenRequest.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordTokenRequest.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the password reset token request. required: - email properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsListRes.yaml index a44c47a8ba132..f8fcbd8e39bfd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsListRes.yaml @@ -8,6 +8,7 @@ required: properties: stock_locations: type: array + description: The list of stock locations. items: $ref: ./StockLocationExpandedDTO.yaml count: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePaymentCollectionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePaymentCollectionsReq.yaml index e5a532b151ad5..61b6570e260b1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePaymentCollectionsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePaymentCollectionsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the payment collection. properties: description: description: A description to create or update the payment collection. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index f1a24178eca17..cd92c3d0279cb 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -463,6 +463,24 @@ paths: .then(({ user }) => { console.log(user.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminGetSession } from "medusa-react" + + const Profile = () => { + const { user, isLoading } = useAdminGetSession() + + return ( +
+ {isLoading && Loading...} + {user && {user.email}} +
+ ) + } + + export default Profile - lang: Shell label: cURL source: | @@ -527,6 +545,31 @@ paths: .then(({ user }) => { console.log(user.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminLogin } from "medusa-react" + + const Login = () => { + const adminLogin = useAdminLogin() + // ... + + const handleLogin = () => { + adminLogin.mutate({ + email: "user@example.com", + password: "supersecret", + }, { + onSuccess: ({ user }) => { + console.log(user) + } + }) + } + + // ... + } + + export default Login - lang: Shell label: cURL source: | @@ -580,6 +623,28 @@ paths: // must be previously logged in medusa.admin.auth.deleteSession() + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteSession } from "medusa-react" + + const Logout = () => { + const adminLogout = useAdminDeleteSession() + // ... + + const handleLogout = () => { + adminLogout.mutate(undefined, { + onSuccess: () => { + // user logged out. + } + }) + } + + // ... + } + + export default Logout - lang: Shell label: cURL source: | @@ -918,6 +983,38 @@ paths: .then(({ batch_jobs, limit, offset, count }) => { console.log(batch_jobs.length) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminBatchJobs } from "medusa-react" + + const BatchJobs = () => { + const { + batch_jobs, + limit, + offset, + count, + isLoading + } = useAdminBatchJobs() + + return ( +
+ {isLoading && Loading...} + {batch_jobs?.length && ( +
    + {batch_jobs.map((batchJob) => ( +
  • + {batchJob.id} +
    • + ))} +
+ )} +
+ ) + } + + export default BatchJobs - lang: Shell label: cURL source: | @@ -986,6 +1083,32 @@ paths: }).then((({ batch_job }) => { console.log(batch_job.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateBatchJob } from "medusa-react" + + const CreateBatchJob = () => { + const createBatchJob = useAdminCreateBatchJob() + // ... + + const handleCreateBatchJob = () => { + createBatchJob.mutate({ + type: "publish-products", + context: {}, + dry_run: true + }, { + onSuccess: ({ batch_job }) => { + console.log(batch_job) + } + }) + } + + // ... + } + + export default CreateBatchJob - lang: Shell label: cURL source: | @@ -1052,6 +1175,28 @@ paths: .then(({ batch_job }) => { console.log(batch_job.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminBatchJob } from "medusa-react" + + type Props = { + batchJobId: string + } + + const BatchJob = ({ batchJobId }: Props) => { + const { batch_job, isLoading } = useAdminBatchJob(batchJobId) + + return ( +
+ {isLoading && Loading...} + {batch_job && {batch_job.created_by}} +
+ ) + } + + export default BatchJob - lang: Shell label: cURL source: | @@ -1115,6 +1260,32 @@ paths: .then(({ batch_job }) => { console.log(batch_job.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCancelBatchJob } from "medusa-react" + + type Props = { + batchJobId: string + } + + const BatchJob = ({ batchJobId }: Props) => { + const cancelBatchJob = useAdminCancelBatchJob(batchJobId) + // ... + + const handleCancel = () => { + cancelBatchJob.mutate(undefined, { + onSuccess: ({ batch_job }) => { + console.log(batch_job) + } + }) + } + + // ... + } + + export default BatchJob - lang: Shell label: cURL source: | @@ -1179,6 +1350,32 @@ paths: .then(({ batch_job }) => { console.log(batch_job.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminConfirmBatchJob } from "medusa-react" + + type Props = { + batchJobId: string + } + + const BatchJob = ({ batchJobId }: Props) => { + const confirmBatchJob = useAdminConfirmBatchJob(batchJobId) + // ... + + const handleConfirm = () => { + confirmBatchJob.mutate(undefined, { + onSuccess: ({ batch_job }) => { + console.log(batch_job) + } + }) + } + + // ... + } + + export default BatchJob - lang: Shell label: cURL source: | @@ -1336,6 +1533,33 @@ paths: .then(({ collections, limit, offset, count }) => { console.log(collections.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCollections } from "medusa-react" + + const Collections = () => { + const { collections, isLoading } = useAdminCollections() + + return ( +
+ {isLoading && Loading...} + {collections && !collections.length && + No Product Collections + } + {collections && collections.length > 0 && ( +
    + {collections.map((collection) => ( +
  • {collection.title}
    • + ))} +
+ )} +
+ ) + } + + export default Collections - lang: Shell label: cURL source: | @@ -1396,6 +1620,30 @@ paths: .then(({ collection }) => { console.log(collection.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateCollection } from "medusa-react" + + const CreateCollection = () => { + const createCollection = useAdminCreateCollection() + // ... + + const handleCreate = (title: string) => { + createCollection.mutate({ + title + }, { + onSuccess: ({ collection }) => { + console.log(collection.id) + } + }) + } + + // ... + } + + export default CreateCollection - lang: Shell label: cURL source: | @@ -1463,6 +1711,28 @@ paths: .then(({ collection }) => { console.log(collection.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCollection } from "medusa-react" + + type Props = { + collectionId: string + } + + const Collection = ({ collectionId }: Props) => { + const { collection, isLoading } = useAdminCollection(collectionId) + + return ( +
+ {isLoading && Loading...} + {collection && {collection.title}} +
+ ) + } + + export default Collection - lang: Shell label: cURL source: | @@ -1530,6 +1800,34 @@ paths: .then(({ collection }) => { console.log(collection.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateCollection } from "medusa-react" + + type Props = { + collectionId: string + } + + const Collection = ({ collectionId }: Props) => { + const updateCollection = useAdminUpdateCollection(collectionId) + // ... + + const handleUpdate = (title: string) => { + updateCollection.mutate({ + title + }, { + onSuccess: ({ collection }) => { + console.log(collection.id) + } + }) + } + + // ... + } + + export default Collection - lang: Shell label: cURL source: | @@ -1594,6 +1892,32 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteCollection } from "medusa-react" + + type Props = { + collectionId: string + } + + const Collection = ({ collectionId }: Props) => { + const deleteCollection = useAdminDeleteCollection(collectionId) + // ... + + const handleDelete = (title: string) => { + deleteCollection.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default Collection - lang: Shell label: cURL source: | @@ -1665,6 +1989,34 @@ paths: .then(({ collection }) => { console.log(collection.products) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminAddProductsToCollection } from "medusa-react" + + type Props = { + collectionId: string + } + + const Collection = ({ collectionId }: Props) => { + const addProducts = useAdminAddProductsToCollection(collectionId) + // ... + + const handleAddProducts = (productIds: string[]) => { + addProducts.mutate({ + product_ids: productIds + }, { + onSuccess: ({ collection }) => { + console.log(collection.products) + } + }) + } + + // ... + } + + export default Collection - lang: Shell label: cURL source: | @@ -1743,6 +2095,34 @@ paths: .then(({ id, object, removed_products }) => { console.log(removed_products) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminRemoveProductsFromCollection } from "medusa-react" + + type Props = { + collectionId: string + } + + const Collection = ({ collectionId }: Props) => { + const removeProducts = useAdminRemoveProductsFromCollection(collectionId) + // ... + + const handleRemoveProducts = (productIds: string[]) => { + removeProducts.mutate({ + product_ids: productIds + }, { + onSuccess: ({ id, object, removed_products }) => { + console.log(removed_products) + } + }) + } + + // ... + } + + export default Collection - lang: Shell label: cURL source: > @@ -1839,6 +2219,33 @@ paths: .then(({ currencies, count, offset, limit }) => { console.log(currencies.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCurrencies } from "medusa-react" + + const Currencies = () => { + const { currencies, isLoading } = useAdminCurrencies() + + return ( +
+ {isLoading && Loading...} + {currencies && !currencies.length && ( + No Currencies + )} + {currencies && currencies.length > 0 && ( +
    + {currencies.map((currency) => ( +
  • {currency.name}
    • + ))} +
+ )} +
+ ) + } + + export default Currencies - lang: Shell label: cURL source: | @@ -1907,6 +2314,34 @@ paths: .then(({ currency }) => { console.log(currency.code); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateCurrency } from "medusa-react" + + type Props = { + currencyCode: string + } + + const Currency = ({ currencyCode }: Props) => { + const updateCurrency = useAdminUpdateCurrency(currencyCode) + // ... + + const handleUpdate = (includes_tax: boolean) => { + updateCurrency.mutate({ + includes_tax, + }, { + onSuccess: ({ currency }) => { + console.log(currency) + } + }) + } + + // ... + } + + export default Currency - lang: Shell label: cURL source: | @@ -2088,6 +2523,40 @@ paths: .then(({ customer_groups, limit, offset, count }) => { console.log(customer_groups.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCustomerGroups } from "medusa-react" + + const CustomerGroups = () => { + const { + customer_groups, + isLoading, + } = useAdminCustomerGroups() + + return ( +
+ {isLoading && Loading...} + {customer_groups && !customer_groups.length && ( + No Customer Groups + )} + {customer_groups && customer_groups.length > 0 && ( +
    + {customer_groups.map( + (customerGroup) => ( +
  • + {customerGroup.name} +
    • + ) + )} +
+ )} +
+ ) + } + + export default CustomerGroups - lang: Shell label: cURL source: | @@ -2148,6 +2617,26 @@ paths: .then(({ customer_group }) => { console.log(customer_group.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateCustomerGroup } from "medusa-react" + + const CreateCustomerGroup = () => { + const createCustomerGroup = useAdminCreateCustomerGroup() + // ... + + const handleCreate = (name: string) => { + createCustomerGroup.mutate({ + name, + }) + } + + // ... + } + + export default CreateCustomerGroup - lang: Shell label: cURL source: | @@ -2230,6 +2719,30 @@ paths: .then(({ customer_group }) => { console.log(customer_group.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCustomerGroup } from "medusa-react" + + type Props = { + customerGroupId: string + } + + const CustomerGroup = ({ customerGroupId }: Props) => { + const { customer_group, isLoading } = useAdminCustomerGroup( + customerGroupId + ) + + return ( +
+ {isLoading && Loading...} + {customer_group && {customer_group.name}} +
+ ) + } + + export default CustomerGroup - lang: Shell label: cURL source: | @@ -2297,6 +2810,32 @@ paths: .then(({ customer_group }) => { console.log(customer_group.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateCustomerGroup } from "medusa-react" + + type Props = { + customerGroupId: string + } + + const CustomerGroup = ({ customerGroupId }: Props) => { + const updateCustomerGroup = useAdminUpdateCustomerGroup( + customerGroupId + ) + // .. + + const handleUpdate = (name: string) => { + updateCustomerGroup.mutate({ + name, + }) + } + + // ... + } + + export default CustomerGroup - lang: Shell label: cURL source: | @@ -2363,6 +2902,30 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteCustomerGroup } from "medusa-react" + + type Props = { + customerGroupId: string + } + + const CustomerGroup = ({ customerGroupId }: Props) => { + const deleteCustomerGroup = useAdminDeleteCustomerGroup( + customerGroupId + ) + // ... + + const handleDeleteCustomerGroup = () => { + deleteCustomerGroup.mutate() + } + + // ... + } + + export default CustomerGroup - lang: Shell label: cURL source: | @@ -2451,6 +3014,42 @@ paths: .then(({ customers }) => { console.log(customers.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCustomerGroupCustomers } from "medusa-react" + + type Props = { + customerGroupId: string + } + + const CustomerGroup = ({ customerGroupId }: Props) => { + const { + customers, + isLoading, + } = useAdminCustomerGroupCustomers( + customerGroupId + ) + + return ( +
+ {isLoading && Loading...} + {customers && !customers.length && ( + No customers + )} + {customers && customers.length > 0 && ( +
    + {customers.map((customer) => ( +
  • {customer.first_name}
    • + ))} +
+ )} +
+ ) + } + + export default CustomerGroup - lang: Shell label: cURL source: | @@ -2524,6 +3123,38 @@ paths: .then(({ customer_group }) => { console.log(customer_group.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminAddCustomersToCustomerGroup, + } from "medusa-react" + + type Props = { + customerGroupId: string + } + + const CustomerGroup = ({ customerGroupId }: Props) => { + const addCustomers = useAdminAddCustomersToCustomerGroup( + customerGroupId + ) + // ... + + const handleAddCustomers= (customerId: string) => { + addCustomers.mutate({ + customer_ids: [ + { + id: customerId, + }, + ], + }) + } + + // ... + } + + export default CustomerGroup - lang: Shell label: cURL source: > @@ -2611,6 +3242,39 @@ paths: .then(({ customer_group }) => { console.log(customer_group.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminRemoveCustomersFromCustomerGroup, + } from "medusa-react" + + type Props = { + customerGroupId: string + } + + const CustomerGroup = ({ customerGroupId }: Props) => { + const removeCustomers = + useAdminRemoveCustomersFromCustomerGroup( + customerGroupId + ) + // ... + + const handleRemoveCustomer = (customerId: string) => { + removeCustomers.mutate({ + customer_ids: [ + { + id: customerId, + }, + ], + }) + } + + // ... + } + + export default CustomerGroup - lang: Shell label: cURL source: > @@ -2714,6 +3378,33 @@ paths: .then(({ customers, limit, offset, count }) => { console.log(customers.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCustomers } from "medusa-react" + + const Customers = () => { + const { customers, isLoading } = useAdminCustomers() + + return ( +
+ {isLoading && Loading...} + {customers && !customers.length && ( + No customers + )} + {customers && customers.length > 0 && ( +
    + {customers.map((customer) => ( +
  • {customer.first_name}
    • + ))} +
+ )} +
+ ) + } + + export default Customers - lang: Shell label: cURL source: | @@ -2777,6 +3468,35 @@ paths: .then(({ customer }) => { console.log(customer.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateCustomer } from "medusa-react" + + type CustomerData = { + first_name: string + last_name: string + email: string + password: string + } + + const CreateCustomer = () => { + const createCustomer = useAdminCreateCustomer() + // ... + + const handleCreate = (customerData: CustomerData) => { + createCustomer.mutate(customerData, { + onSuccess: ({ customer }) => { + console.log(customer.id) + } + }) + } + + // ... + } + + export default CreateCustomer - lang: Shell label: cURL source: | @@ -2859,6 +3579,30 @@ paths: .then(({ customer }) => { console.log(customer.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCustomer } from "medusa-react" + + type Props = { + customerId: string + } + + const Customer = ({ customerId }: Props) => { + const { customer, isLoading } = useAdminCustomer( + customerId + ) + + return ( +
+ {isLoading && Loading...} + {customer && {customer.first_name}} +
+ ) + } + + export default Customer - lang: Shell label: cURL source: | @@ -2940,6 +3684,35 @@ paths: .then(({ customer }) => { console.log(customer.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateCustomer } from "medusa-react" + + type CustomerData = { + first_name: string + last_name: string + email: string + password: string + } + + type Props = { + customerId: string + } + + const Customer = ({ customerId }: Props) => { + const updateCustomer = useAdminUpdateCustomer(customerId) + // ... + + const handleUpdate = (customerData: CustomerData) => { + updateCustomer.mutate(customerData) + } + + // ... + } + + export default Customer - lang: Shell label: cURL source: | @@ -3055,6 +3828,33 @@ paths: .then(({ discounts, limit, offset, count }) => { console.log(discounts.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDiscounts } from "medusa-react" + + const Discounts = () => { + const { discounts, isLoading } = useAdminDiscounts() + + return ( +
+ {isLoading && Loading...} + {discounts && !discounts.length && ( + No customers + )} + {discounts && discounts.length > 0 && ( +
    + {discounts.map((discount) => ( +
  • {discount.code}
    • + ))} +
+ )} +
+ ) + } + + export default Discounts - lang: Shell label: cURL source: | @@ -3143,6 +3943,46 @@ paths: .then(({ discount }) => { console.log(discount.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminCreateDiscount, + } from "medusa-react" + import { + AllocationType, + DiscountRuleType, + } from "@medusajs/medusa" + + const CreateDiscount = () => { + const createDiscount = useAdminCreateDiscount() + // ... + + const handleCreate = ( + currencyCode: string, + regionId: string + ) => { + // ... + createDiscount.mutate({ + code: currencyCode, + rule: { + type: DiscountRuleType.FIXED, + value: 10, + allocation: AllocationType.ITEM, + }, + regions: [ + regionId, + ], + is_dynamic: false, + is_disabled: false, + }) + } + + // ... + } + + export default CreateDiscount - lang: Shell label: cURL source: | @@ -3229,6 +4069,30 @@ paths: .then(({ discount }) => { console.log(discount.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminGetDiscountByCode } from "medusa-react" + + type Props = { + discountCode: string + } + + const Discount = ({ discountCode }: Props) => { + const { discount, isLoading } = useAdminGetDiscountByCode( + discountCode + ) + + return ( +
+ {isLoading && Loading...} + {discount && {discount.code}} +
+ ) + } + + export default Discount - lang: Shell label: cURL source: | @@ -3320,6 +4184,39 @@ paths: .then(({ discount }) => { console.log(discount.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { DiscountConditionOperator } from "@medusajs/medusa" + import { useAdminDiscountCreateCondition } from "medusa-react" + + type Props = { + discountId: string + } + + const Discount = ({ discountId }: Props) => { + const createCondition = useAdminDiscountCreateCondition(discountId) + // ... + + const handleCreateCondition = ( + operator: DiscountConditionOperator, + products: string[] + ) => { + createCondition.mutate({ + operator, + products + }, { + onSuccess: ({ discount }) => { + console.log(discount.id) + } + }) + } + + // ... + } + + export default Discount - lang: Shell label: cURL source: | @@ -3406,6 +4303,40 @@ paths: .then(({ discount_condition }) => { console.log(discount_condition.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminGetDiscountCondition } from "medusa-react" + + type Props = { + discountId: string + discountConditionId: string + } + + const DiscountCondition = ({ + discountId, + discountConditionId + }: Props) => { + const { + discount_condition, + isLoading + } = useAdminGetDiscountCondition( + discountId, + discountConditionId + ) + + return ( +
+ {isLoading && Loading...} + {discount_condition && ( + {discount_condition.type} + )} +
+ ) + } + + export default DiscountCondition - lang: Shell label: cURL source: > @@ -3504,6 +4435,43 @@ paths: .then(({ discount }) => { console.log(discount.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDiscountUpdateCondition } from "medusa-react" + + type Props = { + discountId: string + conditionId: string + } + + const DiscountCondition = ({ + discountId, + conditionId + }: Props) => { + const update = useAdminDiscountUpdateCondition( + discountId, + conditionId + ) + // ... + + const handleUpdate = ( + products: string[] + ) => { + update.mutate({ + products + }, { + onSuccess: ({ discount }) => { + console.log(discount.id) + } + }) + } + + // ... + } + + export default DiscountCondition - lang: Shell label: cURL source: > @@ -3597,6 +4565,38 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminDiscountRemoveCondition + } from "medusa-react" + + type Props = { + discountId: string + } + + const Discount = ({ discountId }: Props) => { + const deleteCondition = useAdminDiscountRemoveCondition( + discountId + ) + // ... + + const handleDelete = ( + conditionId: string + ) => { + deleteCondition.mutate(conditionId, { + onSuccess: ({ id, object, deleted }) => { + console.log(deleted) + } + }) + } + + // ... + } + + export default Discount - lang: Shell label: cURL source: > @@ -3694,6 +4694,47 @@ paths: .then(({ discount }) => { console.log(discount.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminAddDiscountConditionResourceBatch + } from "medusa-react" + + type Props = { + discountId: string + conditionId: string + } + + const DiscountCondition = ({ + discountId, + conditionId + }: Props) => { + const addConditionResources = useAdminAddDiscountConditionResourceBatch( + discountId, + conditionId + ) + // ... + + const handleAdd = (itemId: string) => { + addConditionResources.mutate({ + resources: [ + { + id: itemId + } + ] + }, { + onSuccess: ({ discount }) => { + console.log(discount.id) + } + }) + } + + // ... + } + + export default DiscountCondition - lang: Shell label: cURL source: > @@ -3795,6 +4836,47 @@ paths: .then(({ discount }) => { console.log(discount.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminDeleteDiscountConditionResourceBatch + } from "medusa-react" + + type Props = { + discountId: string + conditionId: string + } + + const DiscountCondition = ({ + discountId, + conditionId + }: Props) => { + const deleteConditionResource = useAdminDeleteDiscountConditionResourceBatch( + discountId, + conditionId, + ) + // ... + + const handleDelete = (itemId: string) => { + deleteConditionResource.mutate({ + resources: [ + { + id: itemId + } + ] + }, { + onSuccess: ({ discount }) => { + console.log(discount.id) + } + }) + } + + // ... + } + + export default DiscountCondition - lang: Shell label: cURL source: > @@ -3880,6 +4962,30 @@ paths: .then(({ discount }) => { console.log(discount.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDiscount } from "medusa-react" + + type Props = { + discountId: string + } + + const Discount = ({ discountId }: Props) => { + const { discount, isLoading } = useAdminDiscount( + discountId + ) + + return ( +
+ {isLoading && Loading...} + {discount && {discount.code}} +
+ ) + } + + export default Discount - lang: Shell label: cURL source: | @@ -3964,6 +5070,30 @@ paths: .then(({ discount }) => { console.log(discount.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateDiscount } from "medusa-react" + + type Props = { + discountId: string + } + + const Discount = ({ discountId }: Props) => { + const updateDiscount = useAdminUpdateDiscount(discountId) + // ... + + const handleUpdate = (isDisabled: boolean) => { + updateDiscount.mutate({ + is_disabled: isDisabled, + }) + } + + // ... + } + + export default Discount - lang: Shell label: cURL source: | @@ -4030,6 +5160,24 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteDiscount } from "medusa-react" + + const Discount = () => { + const deleteDiscount = useAdminDeleteDiscount(discount_id) + // ... + + const handleDelete = () => { + deleteDiscount.mutate() + } + + // ... + } + + export default Discount - lang: Shell label: cURL source: | @@ -4102,6 +5250,38 @@ paths: .then(({ discount }) => { console.log(discount.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateDynamicDiscountCode } from "medusa-react" + + type Props = { + discountId: string + } + + const Discount = ({ discountId }: Props) => { + const createDynamicDiscount = useAdminCreateDynamicDiscountCode(discountId) + // ... + + const handleCreate = ( + code: string, + usageLimit: number + ) => { + createDynamicDiscount.mutate({ + code, + usage_limit: usageLimit + }, { + onSuccess: ({ discount }) => { + console.log(discount.is_dynamic) + } + }) + } + + // ... + } + + export default Discount - lang: Shell label: cURL source: | @@ -4173,6 +5353,32 @@ paths: .then(({ discount }) => { console.log(discount.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteDynamicDiscountCode } from "medusa-react" + + type Props = { + discountId: string + } + + const Discount = ({ discountId }: Props) => { + const deleteDynamicDiscount = useAdminDeleteDynamicDiscountCode(discountId) + // ... + + const handleDelete = (code: string) => { + deleteDynamicDiscount.mutate(code, { + onSuccess: ({ discount }) => { + console.log(discount.is_dynamic) + } + }) + } + + // ... + } + + export default Discount - lang: Shell label: cURL source: > @@ -4242,6 +5448,32 @@ paths: .then(({ discount }) => { console.log(discount.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDiscountAddRegion } from "medusa-react" + + type Props = { + discountId: string + } + + const Discount = ({ discountId }: Props) => { + const addRegion = useAdminDiscountAddRegion(discountId) + // ... + + const handleAdd = (regionId: string) => { + addRegion.mutate(regionId, { + onSuccess: ({ discount }) => { + console.log(discount.regions) + } + }) + } + + // ... + } + + export default Discount - lang: Shell label: cURL source: > @@ -4313,6 +5545,32 @@ paths: .then(({ discount }) => { console.log(discount.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDiscountRemoveRegion } from "medusa-react" + + type Props = { + discountId: string + } + + const Discount = ({ discountId }: Props) => { + const deleteRegion = useAdminDiscountRemoveRegion(discountId) + // ... + + const handleDelete = (regionId: string) => { + deleteRegion.mutate(regionId, { + onSuccess: ({ discount }) => { + console.log(discount.regions) + } + }) + } + + // ... + } + + export default Discount - lang: Shell label: cURL source: > @@ -4392,6 +5650,33 @@ paths: .then(({ draft_orders, limit, offset, count }) => { console.log(draft_orders.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDraftOrders } from "medusa-react" + + const DraftOrders = () => { + const { draft_orders, isLoading } = useAdminDraftOrders() + + return ( +
+ {isLoading && Loading...} + {draft_orders && !draft_orders.length && ( + No Draft Orders + )} + {draft_orders && draft_orders.length > 0 && ( +
    + {draft_orders.map((order) => ( +
  • {order.display_id}
    • + ))} +
+ )} +
+ ) + } + + export default DraftOrders - lang: Shell label: cURL source: | @@ -4465,6 +5750,41 @@ paths: .then(({ draft_order }) => { console.log(draft_order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateDraftOrder } from "medusa-react" + + type DraftOrderData = { + email: string + region_id: string + items: { + quantity: number, + variant_id: string + }[] + shipping_methods: { + option_id: string + price: number + }[] + } + + const CreateDraftOrder = () => { + const createDraftOrder = useAdminCreateDraftOrder() + // ... + + const handleCreate = (data: DraftOrderData) => { + createDraftOrder.mutate(data, { + onSuccess: ({ draft_order }) => { + console.log(draft_order.id) + } + }) + } + + // ... + } + + export default CreateDraftOrder - lang: Shell label: cURL source: | @@ -4541,6 +5861,32 @@ paths: .then(({ draft_order }) => { console.log(draft_order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDraftOrder } from "medusa-react" + + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { + const { + draft_order, + isLoading, + } = useAdminDraftOrder(draftOrderId) + + return ( +
+ {isLoading && Loading...} + {draft_order && {draft_order.display_id}} + +
+ ) + } + + export default DraftOrder - lang: Shell label: cURL source: | @@ -4608,6 +5954,36 @@ paths: .then(({ draft_order }) => { console.log(draft_order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateDraftOrder } from "medusa-react" + + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { + const updateDraftOrder = useAdminUpdateDraftOrder( + draftOrderId + ) + // ... + + const handleUpdate = (email: string) => { + updateDraftOrder.mutate({ + email, + }, { + onSuccess: ({ draft_order }) => { + console.log(draft_order.id) + } + }) + } + + // ... + } + + export default DraftOrder - lang: Shell label: cURL source: | @@ -4672,6 +6048,34 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteDraftOrder } from "medusa-react" + + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { + const deleteDraftOrder = useAdminDeleteDraftOrder( + draftOrderId + ) + // ... + + const handleDelete = () => { + deleteDraftOrder.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default DraftOrder - lang: Shell label: cURL source: | @@ -4740,6 +6144,36 @@ paths: .then(({ draft_order }) => { console.log(draft_order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDraftOrderAddLineItem } from "medusa-react" + + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { + const addLineItem = useAdminDraftOrderAddLineItem( + draftOrderId + ) + // ... + + const handleAdd = (quantity: number) => { + addLineItem.mutate({ + quantity, + }, { + onSuccess: ({ draft_order }) => { + console.log(draft_order.cart) + } + }) + } + + // ... + } + + export default DraftOrder - lang: Shell label: cURL source: | @@ -4819,6 +6253,36 @@ paths: .then(({ draft_order }) => { console.log(draft_order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDraftOrderUpdateLineItem } from "medusa-react" + + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { + const updateLineItem = useAdminDraftOrderUpdateLineItem( + draftOrderId + ) + // ... + + const handleUpdate = ( + itemId: string, + quantity: number + ) => { + updateLineItem.mutate({ + item_id: itemId, + quantity, + }) + } + + // ... + } + + export default DraftOrder - lang: Shell label: cURL source: > @@ -4893,6 +6357,34 @@ paths: .then(({ draft_order }) => { console.log(draft_order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDraftOrderRemoveLineItem } from "medusa-react" + + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { + const deleteLineItem = useAdminDraftOrderRemoveLineItem( + draftOrderId + ) + // ... + + const handleDelete = (itemId: string) => { + deleteLineItem.mutate(itemId, { + onSuccess: ({ draft_order }) => { + console.log(draft_order.cart) + } + }) + } + + // ... + } + + export default DraftOrder - lang: Shell label: cURL source: > @@ -4961,6 +6453,34 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDraftOrderRegisterPayment } from "medusa-react" + + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { + const registerPayment = useAdminDraftOrderRegisterPayment( + draftOrderId + ) + // ... + + const handlePayment = () => { + registerPayment.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.id) + } + }) + } + + // ... + } + + export default DraftOrder - lang: Shell label: cURL source: | @@ -5037,6 +6557,34 @@ paths: .then(({ gift_cards, limit, offset, count }) => { console.log(gift_cards.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { GiftCard } from "@medusajs/medusa" + import { useAdminGiftCards } from "medusa-react" + + const CustomGiftCards = () => { + const { gift_cards, isLoading } = useAdminGiftCards() + + return ( +
+ {isLoading && Loading...} + {gift_cards && !gift_cards.length && ( + No custom gift cards... + )} + {gift_cards && gift_cards.length > 0 && ( +
    + {gift_cards.map((giftCard: GiftCard) => ( +
  • {giftCard.code}
    • + ))} +
+ )} +
+ ) + } + + export default CustomGiftCards - lang: Shell label: cURL source: | @@ -5099,6 +6647,34 @@ paths: .then(({ gift_card }) => { console.log(gift_card.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateGiftCard } from "medusa-react" + + const CreateCustomGiftCards = () => { + const createGiftCard = useAdminCreateGiftCard() + // ... + + const handleCreate = ( + regionId: string, + value: number + ) => { + createGiftCard.mutate({ + region_id: regionId, + value, + }, { + onSuccess: ({ gift_card }) => { + console.log(gift_card.id) + } + }) + } + + // ... + } + + export default CreateCustomGiftCards - lang: Shell label: cURL source: | @@ -5164,6 +6740,28 @@ paths: .then(({ gift_card }) => { console.log(gift_card.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminGiftCard } from "medusa-react" + + type Props = { + giftCardId: string + } + + const CustomGiftCard = ({ giftCardId }: Props) => { + const { gift_card, isLoading } = useAdminGiftCard(giftCardId) + + return ( +
+ {isLoading && Loading...} + {gift_card && {gift_card.code}} +
+ ) + } + + export default CustomGiftCard - lang: Shell label: cURL source: | @@ -5231,6 +6829,36 @@ paths: .then(({ gift_card }) => { console.log(gift_card.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateGiftCard } from "medusa-react" + + type Props = { + customGiftCardId: string + } + + const CustomGiftCard = ({ customGiftCardId }: Props) => { + const updateGiftCard = useAdminUpdateGiftCard( + customGiftCardId + ) + // ... + + const handleUpdate = (regionId: string) => { + updateGiftCard.mutate({ + region_id: regionId, + }, { + onSuccess: ({ gift_card }) => { + console.log(gift_card.id) + } + }) + } + + // ... + } + + export default CustomGiftCard - lang: Shell label: cURL source: | @@ -5295,6 +6923,34 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteGiftCard } from "medusa-react" + + type Props = { + customGiftCardId: string + } + + const CustomGiftCard = ({ customGiftCardId }: Props) => { + const deleteGiftCard = useAdminDeleteGiftCard( + customGiftCardId + ) + // ... + + const handleDelete = () => { + deleteGiftCard.mutate(void 0, { + onSuccess: ({ id, object, deleted}) => { + console.log(id) + } + }) + } + + // ... + } + + export default CustomGiftCard - lang: Shell label: cURL source: | @@ -5459,6 +7115,38 @@ paths: .then(({ inventory_items, count, offset, limit }) => { console.log(inventory_items.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminInventoryItems } from "medusa-react" + + function InventoryItems() { + const { + inventory_items, + isLoading + } = useAdminInventoryItems() + + return ( +
+ {isLoading && Loading...} + {inventory_items && !inventory_items.length && ( + No Items + )} + {inventory_items && inventory_items.length > 0 && ( +
    + {inventory_items.map( + (item) => ( +
  • {item.id}
    • + ) + )} +
+ )} +
+ ) + } + + export default InventoryItems - lang: Shell label: cURL source: | @@ -5536,6 +7224,30 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateInventoryItem } from "medusa-react" + + const CreateInventoryItem = () => { + const createInventoryItem = useAdminCreateInventoryItem() + // ... + + const handleCreate = (variantId: string) => { + createInventoryItem.mutate({ + variant_id: variantId, + }, { + onSuccess: ({ inventory_item }) => { + console.log(inventory_item.id) + } + }) + } + + // ... + } + + export default CreateInventoryItem - lang: Shell label: cURL source: | @@ -5616,6 +7328,33 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminInventoryItem } from "medusa-react" + + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { + const { + inventory_item, + isLoading + } = useAdminInventoryItem(inventoryItemId) + + return ( +
+ {isLoading && Loading...} + {inventory_item && ( + {inventory_item.sku} + )} +
+ ) + } + + export default InventoryItem - lang: Shell label: cURL source: | @@ -5698,6 +7437,36 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateInventoryItem } from "medusa-react" + + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { + const updateInventoryItem = useAdminUpdateInventoryItem( + inventoryItemId + ) + // ... + + const handleUpdate = (origin_country: string) => { + updateInventoryItem.mutate({ + origin_country, + }, { + onSuccess: ({ inventory_item }) => { + console.log(inventory_item.origin_country) + } + }) + } + + // ... + } + + export default InventoryItem - lang: Shell label: cURL source: | @@ -5764,6 +7533,30 @@ paths: .then(({ id, object, deleted }) => { console.log(id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteInventoryItem } from "medusa-react" + + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { + const deleteInventoryItem = useAdminDeleteInventoryItem( + inventoryItemId + ) + // ... + + const handleDelete = () => { + deleteInventoryItem.mutate() + } + + // ... + } + + export default InventoryItem - lang: Shell label: cURL source: | @@ -5841,6 +7634,39 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.location_levels); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminInventoryItemLocationLevels, + } from "medusa-react" + + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { + const { + inventory_item, + isLoading, + } = useAdminInventoryItemLocationLevels(inventoryItemId) + + return ( +
+ {isLoading && Loading...} + {inventory_item && ( +
    + {inventory_item.location_levels.map((level) => ( + {level.stocked_quantity} + ))} +
+ )} +
+ ) + } + + export default InventoryItem - lang: Shell label: cURL source: | @@ -5925,6 +7751,40 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateLocationLevel } from "medusa-react" + + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { + const createLocationLevel = useAdminCreateLocationLevel( + inventoryItemId + ) + // ... + + const handleCreateLocationLevel = ( + locationId: string, + stockedQuantity: number + ) => { + createLocationLevel.mutate({ + location_id: locationId, + stocked_quantity: stockedQuantity, + }, { + onSuccess: ({ inventory_item }) => { + console.log(inventory_item.id) + } + }) + } + + // ... + } + + export default InventoryItem - lang: Shell label: cURL source: > @@ -6025,6 +7885,40 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateLocationLevel } from "medusa-react" + + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { + const updateLocationLevel = useAdminUpdateLocationLevel( + inventoryItemId + ) + // ... + + const handleUpdate = ( + stockLocationId: string, + stocked_quantity: number + ) => { + updateLocationLevel.mutate({ + stockLocationId, + stocked_quantity, + }, { + onSuccess: ({ inventory_item }) => { + console.log(inventory_item.id) + } + }) + } + + // ... + } + + export default InventoryItem - lang: Shell label: cURL source: > @@ -6101,6 +7995,32 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteLocationLevel } from "medusa-react" + + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { + const deleteLocationLevel = useAdminDeleteLocationLevel( + inventoryItemId + ) + // ... + + const handleDelete = ( + locationId: string + ) => { + deleteLocationLevel.mutate(locationId) + } + + // ... + } + + export default InventoryItem - lang: Shell label: cURL source: > @@ -6302,6 +8222,40 @@ paths: .catch(() => { // an error occurred }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminAcceptInvite } from "medusa-react" + + const AcceptInvite = () => { + const acceptInvite = useAdminAcceptInvite() + // ... + + const handleAccept = ( + token: string, + firstName: string, + lastName: string, + password: string + ) => { + acceptInvite.mutate({ + token, + user: { + first_name: firstName, + last_name: lastName, + password, + }, + }, { + onSuccess: () => { + // invite accepted successfully. + } + }) + } + + // ... + } + + export default AcceptInvite - lang: Shell label: cURL source: | @@ -6368,6 +8322,32 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteInvite } from "medusa-react" + + type Props = { + inviteId: string + } + + const DeleteInvite = ({ inviteId }: Props) => { + const deleteInvite = useAdminDeleteInvite(inviteId) + // ... + + const handleDelete = () => { + deleteInvite.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default Invite - lang: Shell label: cURL source: | @@ -6438,6 +8418,32 @@ paths: .catch(() => { // an error occurred }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminResendInvite } from "medusa-react" + + type Props = { + inviteId: string + } + + const ResendInvite = ({ inviteId }: Props) => { + const resendInvite = useAdminResendInvite(inviteId) + // ... + + const handleResend = () => { + resendInvite.mutate(void 0, { + onSuccess: () => { + // invite resent successfully + } + }) + } + + // ... + } + + export default ResendInvite - lang: Shell label: cURL source: | @@ -6509,6 +8515,31 @@ paths: .then(({ notes, limit, offset, count }) => { console.log(notes.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminNotes } from "medusa-react" + + const Notes = () => { + const { notes, isLoading } = useAdminNotes() + + return ( +
+ {isLoading && Loading...} + {notes && !notes.length && No Notes} + {notes && notes.length > 0 && ( +
    + {notes.map((note) => ( +
  • {note.resource_type}
    • + ))} +
+ )} +
+ ) + } + + export default Notes - lang: Shell label: cURL source: | @@ -6571,6 +8602,32 @@ paths: .then(({ note }) => { console.log(note.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateNote } from "medusa-react" + + const CreateNote = () => { + const createNote = useAdminCreateNote() + // ... + + const handleCreate = () => { + createNote.mutate({ + resource_id: "order_123", + resource_type: "order", + value: "We delivered this order" + }, { + onSuccess: ({ note }) => { + console.log(note.id) + } + }) + } + + // ... + } + + export default CreateNote - lang: Shell label: cURL source: | @@ -6638,6 +8695,28 @@ paths: .then(({ note }) => { console.log(note.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminNote } from "medusa-react" + + type Props = { + noteId: string + } + + const Note = ({ noteId }: Props) => { + const { note, isLoading } = useAdminNote(noteId) + + return ( +
+ {isLoading && Loading...} + {note && {note.resource_type}} +
+ ) + } + + export default Note - lang: Shell label: cURL source: | @@ -6705,6 +8784,36 @@ paths: .then(({ note }) => { console.log(note.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateNote } from "medusa-react" + + type Props = { + noteId: string + } + + const Note = ({ noteId }: Props) => { + const updateNote = useAdminUpdateNote(noteId) + // ... + + const handleUpdate = ( + value: string + ) => { + updateNote.mutate({ + value + }, { + onSuccess: ({ note }) => { + console.log(note.value) + } + }) + } + + // ... + } + + export default Note - lang: Shell label: cURL source: | @@ -6769,6 +8878,28 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteNote } from "medusa-react" + + type Props = { + noteId: string + } + + const Note = ({ noteId }: Props) => { + const deleteNote = useAdminDeleteNote(noteId) + // ... + + const handleDelete = () => { + deleteNote.mutate() + } + + // ... + } + + export default Note - lang: Shell label: cURL source: | @@ -6888,6 +9019,33 @@ paths: .then(({ notifications }) => { console.log(notifications.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminNotifications } from "medusa-react" + + const Notifications = () => { + const { notifications, isLoading } = useAdminNotifications() + + return ( +
+ {isLoading && Loading...} + {notifications && !notifications.length && ( + No Notifications + )} + {notifications && notifications.length > 0 && ( +
    + {notifications.map((notification) => ( +
  • {notification.to}
    • + ))} +
+ )} +
+ ) + } + + export default Notifications - lang: Shell label: cURL source: | @@ -6956,6 +9114,34 @@ paths: .then(({ notification }) => { console.log(notification.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminResendNotification } from "medusa-react" + + type Props = { + notificationId: string + } + + const Notification = ({ notificationId }: Props) => { + const resendNotification = useAdminResendNotification( + notificationId + ) + // ... + + const handleResend = () => { + resendNotification.mutate({}, { + onSuccess: ({ notification }) => { + console.log(notification.id) + } + }) + } + + // ... + } + + export default Notification - lang: Shell label: cURL source: | @@ -7050,6 +9236,35 @@ paths: .then(({ order_edits, count, limit, offset }) => { console.log(order_edits.length) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminOrderEdits } from "medusa-react" + + const OrderEdits = () => { + const { order_edits, isLoading } = useAdminOrderEdits() + + return ( +
+ {isLoading && Loading...} + {order_edits && !order_edits.length && ( + No Order Edits + )} + {order_edits && order_edits.length > 0 && ( +
    + {order_edits.map((orderEdit) => ( +
  • + {orderEdit.status} +
    • + ))} +
+ )} +
+ ) + } + + export default OrderEdits - lang: Shell label: cURL source: | @@ -7108,6 +9323,29 @@ paths: .then(({ order_edit }) => { console.log(order_edit.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateOrderEdit } from "medusa-react" + + const CreateOrderEdit = () => { + const createOrderEdit = useAdminCreateOrderEdit() + + const handleCreateOrderEdit = (orderId: string) => { + createOrderEdit.mutate({ + order_id: orderId, + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.id) + } + }) + } + + // ... + } + + export default CreateOrderEdit - lang: Shell label: cURL source: > @@ -7190,6 +9428,31 @@ paths: .then(({ order_edit }) => { console.log(order_edit.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminOrderEdit } from "medusa-react" + + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const { + order_edit, + isLoading, + } = useAdminOrderEdit(orderEditId) + + return ( +
+ {isLoading && Loading...} + {order_edit && {order_edit.status}} +
+ ) + } + + export default OrderEdit - lang: Shell label: cURL source: | @@ -7257,6 +9520,37 @@ paths: .then(({ order_edit }) => { console.log(order_edit.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateOrderEdit } from "medusa-react" + + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const updateOrderEdit = useAdminUpdateOrderEdit( + orderEditId, + ) + + const handleUpdate = ( + internalNote: string + ) => { + updateOrderEdit.mutate({ + internal_note: internalNote + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.internal_note) + } + }) + } + + // ... + } + + export default OrderEdit - lang: Shell label: cURL source: | @@ -7323,6 +9617,33 @@ paths: .then(({ id, object, deleted }) => { console.log(id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteOrderEdit } from "medusa-react" + + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const deleteOrderEdit = useAdminDeleteOrderEdit( + orderEditId + ) + + const handleDelete = () => { + deleteOrderEdit.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default OrderEdit - lang: Shell label: cURL source: | @@ -7374,6 +9695,38 @@ paths: .then(({ order_edit }) => { console.log(order_edit.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminCancelOrderEdit + } from "medusa-react" + + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const cancelOrderEdit = + useAdminCancelOrderEdit( + orderEditId + ) + + const handleCancel = () => { + cancelOrderEdit.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log( + order_edit.id + ) + } + }) + } + + // ... + } + + export default OrderEdit - lang: Shell label: cURL source: | @@ -7439,6 +9792,38 @@ paths: .then(({ id, object, deleted }) => { console.log(id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteOrderEditItemChange } from "medusa-react" + + type Props = { + orderEditId: string + itemChangeId: string + } + + const OrderEditItemChange = ({ + orderEditId, + itemChangeId + }: Props) => { + const deleteItemChange = useAdminDeleteOrderEditItemChange( + orderEditId, + itemChangeId + ) + + const handleDeleteItemChange = () => { + deleteItemChange.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default OrderEditItemChange - lang: Shell label: cURL source: > @@ -7494,6 +9879,36 @@ paths: .then(({ order_edit }) => { console.log(order_edit.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminConfirmOrderEdit } from "medusa-react" + + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const confirmOrderEdit = useAdminConfirmOrderEdit( + orderEditId + ) + + const handleConfirmOrderEdit = () => { + confirmOrderEdit.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log( + order_edit.confirmed_at, + order_edit.confirmed_by + ) + } + }) + } + + // ... + } + + export default OrderEdit - lang: Shell label: cURL source: | @@ -7562,6 +9977,37 @@ paths: .then(({ order_edit }) => { console.log(order_edit.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminOrderEditAddLineItem } from "medusa-react" + + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const addLineItem = useAdminOrderEditAddLineItem( + orderEditId + ) + + const handleAddLineItem = + (quantity: number, variantId: string) => { + addLineItem.mutate({ + quantity, + variant_id: variantId, + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.changes) + } + }) + } + + // ... + } + + export default OrderEdit - lang: Shell label: cURL source: > @@ -7646,6 +10092,40 @@ paths: .then(({ order_edit }) => { console.log(order_edit.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminOrderEditUpdateLineItem } from "medusa-react" + + type Props = { + orderEditId: string + itemId: string + } + + const OrderEditItemChange = ({ + orderEditId, + itemId + }: Props) => { + const updateLineItem = useAdminOrderEditUpdateLineItem( + orderEditId, + itemId + ) + + const handleUpdateLineItem = (quantity: number) => { + updateLineItem.mutate({ + quantity, + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.items) + } + }) + } + + // ... + } + + export default OrderEditItemChange - lang: Shell label: cURL source: > @@ -7721,6 +10201,38 @@ paths: .then(({ order_edit }) => { console.log(order_edit.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminOrderEditDeleteLineItem } from "medusa-react" + + type Props = { + orderEditId: string + itemId: string + } + + const OrderEditLineItem = ({ + orderEditId, + itemId + }: Props) => { + const removeLineItem = useAdminOrderEditDeleteLineItem( + orderEditId, + itemId + ) + + const handleRemoveLineItem = () => { + removeLineItem.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.changes) + } + }) + } + + // ... + } + + export default OrderEditLineItem - lang: Shell label: cURL source: > @@ -7787,6 +10299,39 @@ paths: .then({ order_edit }) => { console.log(order_edit.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminRequestOrderEditConfirmation, + } from "medusa-react" + + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const requestOrderConfirmation = + useAdminRequestOrderEditConfirmation( + orderEditId + ) + + const handleRequestConfirmation = () => { + requestOrderConfirmation.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log( + order_edit.requested_at, + order_edit.requested_by + ) + } + }) + } + + // ... + } + + export default OrderEdit - lang: Shell label: cURL source: | @@ -8054,6 +10599,31 @@ paths: .then(({ orders, limit, offset, count }) => { console.log(orders.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminOrders } from "medusa-react" + + const Orders = () => { + const { orders, isLoading } = useAdminOrders() + + return ( +
+ {isLoading && Loading...} + {orders && !orders.length && No Orders} + {orders && orders.length > 0 && ( +
    + {orders.map((order) => ( +
  • {order.display_id}
    • + ))} +
+ )} +
+ ) + } + + export default Orders - lang: Shell label: cURL source: | @@ -8130,6 +10700,32 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminOrder } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const { + order, + isLoading, + } = useAdminOrder(orderId) + + return ( +
+ {isLoading && Loading...} + {order && {order.display_id}} + +
+ ) + } + + export default Order - lang: Shell label: cURL source: | @@ -8212,6 +10808,37 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateOrder } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const updateOrder = useAdminUpdateOrder( + orderId + ) + + const handleUpdate = ( + email: string + ) => { + updateOrder.mutate({ + email, + }, { + onSuccess: ({ order }) => { + console.log(order.email) + } + }) + } + + // ... + } + + export default Order - lang: Shell label: cURL source: | @@ -8292,6 +10919,34 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminArchiveOrder } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const archiveOrder = useAdminArchiveOrder( + orderId + ) + // ... + + const handleArchivingOrder = () => { + archiveOrder.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.status) + } + }) + } + + // ... + } + + export default Order - lang: Shell label: cURL source: | @@ -8371,6 +11026,34 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCancelOrder } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const cancelOrder = useAdminCancelOrder( + orderId + ) + // ... + + const handleCancel = () => { + cancelOrder.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.status) + } + }) + } + + // ... + } + + export default Order - lang: Shell label: cURL source: | @@ -8449,6 +11132,34 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCapturePayment } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const capturePayment = useAdminCapturePayment( + orderId + ) + // ... + + const handleCapture = () => { + capturePayment.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.status) + } + }) + } + + // ... + } + + export default Order - lang: Shell label: cURL source: | @@ -8544,6 +11255,42 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateClaim } from "medusa-react" + + type Props = { + orderId: string + } + + const CreateClaim = ({ orderId }: Props) => { + + const CreateClaim = (orderId: string) => { + const createClaim = useAdminCreateClaim(orderId) + // ... + + const handleCreate = (itemId: string) => { + createClaim.mutate({ + type: "refund", + claim_items: [ + { + item_id: itemId, + quantity: 1, + }, + ], + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } + }) + } + + // ... + } + + export default CreateClaim - lang: Shell label: cURL source: | @@ -8643,6 +11390,36 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateClaim } from "medusa-react" + + type Props = { + orderId: string + claimId: string + } + + const Claim = ({ orderId, claimId }: Props) => { + const updateClaim = useAdminUpdateClaim(orderId) + // ... + + const handleUpdate = () => { + updateClaim.mutate({ + claim_id: claimId, + no_notification: false + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } + }) + } + + // ... + } + + export default Claim - lang: Shell label: cURL source: | @@ -8735,6 +11512,29 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCancelClaim } from "medusa-react" + + type Props = { + orderId: string + claimId: string + } + + const Claim = ({ orderId, claimId }: Props) => { + const cancelClaim = useAdminCancelClaim(orderId) + // ... + + const handleCancel = () => { + cancelClaim.mutate(claimId) + } + + // ... + } + + export default Claim - lang: Shell label: cURL source: > @@ -8834,6 +11634,35 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminFulfillClaim } from "medusa-react" + + type Props = { + orderId: string + claimId: string + } + + const Claim = ({ orderId, claimId }: Props) => { + const fulfillClaim = useAdminFulfillClaim(orderId) + // ... + + const handleFulfill = () => { + fulfillClaim.mutate({ + claim_id: claimId, + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } + }) + } + + // ... + } + + export default Claim - lang: Shell label: cURL source: > @@ -8927,6 +11756,38 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCancelClaimFulfillment } from "medusa-react" + + type Props = { + orderId: string + claimId: string + } + + const Claim = ({ orderId, claimId }: Props) => { + const cancelFulfillment = useAdminCancelClaimFulfillment( + orderId + ) + // ... + + const handleCancel = (fulfillmentId: string) => { + cancelFulfillment.mutate({ + claim_id: claimId, + fulfillment_id: fulfillmentId, + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } + }) + } + + // ... + } + + export default Claim - lang: Shell label: cURL source: > @@ -9026,6 +11887,36 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateClaimShipment } from "medusa-react" + + type Props = { + orderId: string + claimId: string + } + + const Claim = ({ orderId, claimId }: Props) => { + const createShipment = useAdminCreateClaimShipment(orderId) + // ... + + const handleCreateShipment = (fulfillmentId: string) => { + createShipment.mutate({ + claim_id: claimId, + fulfillment_id: fulfillmentId, + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } + }) + } + + // ... + } + + export default Claim - lang: Shell label: cURL source: > @@ -9112,6 +12003,34 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCompleteOrder } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const completeOrder = useAdminCompleteOrder( + orderId + ) + // ... + + const handleComplete = () => { + completeOrder.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.status) + } + }) + } + + // ... + } + + export default Order - lang: Shell label: cURL source: | @@ -9206,6 +12125,44 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateFulfillment } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const createFulfillment = useAdminCreateFulfillment( + orderId + ) + // ... + + const handleCreateFulfillment = ( + itemId: string, + quantity: number + ) => { + createFulfillment.mutate({ + items: [ + { + item_id: itemId, + quantity, + }, + ], + }, { + onSuccess: ({ order }) => { + console.log(order.fulfillments) + } + }) + } + + // ... + } + + export default Order - lang: Shell label: cURL source: | @@ -9299,6 +12256,36 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCancelFulfillment } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const cancelFulfillment = useAdminCancelFulfillment( + orderId + ) + // ... + + const handleCancel = ( + fulfillmentId: string + ) => { + cancelFulfillment.mutate(fulfillmentId, { + onSuccess: ({ order }) => { + console.log(order.fulfillments) + } + }) + } + + // ... + } + + export default Order - lang: Shell label: cURL source: > @@ -9454,6 +12441,40 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminRefundPayment } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const refundPayment = useAdminRefundPayment( + orderId + ) + // ... + + const handleRefund = ( + amount: number, + reason: string + ) => { + refundPayment.mutate({ + amount, + reason, + }, { + onSuccess: ({ order }) => { + console.log(order.refunds) + } + }) + } + + // ... + } + + export default Order - lang: Shell label: cURL source: | @@ -9608,6 +12629,44 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminRequestReturn } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const requestReturn = useAdminRequestReturn( + orderId + ) + // ... + + const handleRequestingReturn = ( + itemId: string, + quantity: number + ) => { + requestReturn.mutate({ + items: [ + { + item_id: itemId, + quantity + } + ] + }, { + onSuccess: ({ order }) => { + console.log(order.returns) + } + }) + } + + // ... + } + + export default Order - lang: Shell label: cURL source: | @@ -9706,6 +12765,38 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateShipment } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const createShipment = useAdminCreateShipment( + orderId + ) + // ... + + const handleCreate = ( + fulfillmentId: string + ) => { + createShipment.mutate({ + fulfillment_id: fulfillmentId, + }, { + onSuccess: ({ order }) => { + console.log(order.fulfillment_status) + } + }) + } + + // ... + } + + export default Order - lang: Shell label: cURL source: | @@ -9797,6 +12888,40 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminAddShippingMethod } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const addShippingMethod = useAdminAddShippingMethod( + orderId + ) + // ... + + const handleAddShippingMethod = ( + optionId: string, + price: number + ) => { + addShippingMethod.mutate({ + option_id: optionId, + price + }, { + onSuccess: ({ order }) => { + console.log(order.shipping_methods) + } + }) + } + + // ... + } + + export default Order - lang: Shell label: cURL source: | @@ -9895,6 +13020,39 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateSwap } from "medusa-react" + + type Props = { + orderId: string + } + + const CreateSwap = ({ orderId }: Props) => { + const createSwap = useAdminCreateSwap(orderId) + // ... + + const handleCreate = ( + returnItems: { + item_id: string, + quantity: number + }[] + ) => { + createSwap.mutate({ + return_items: returnItems + }, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } + }) + } + + // ... + } + + export default CreateSwap - lang: Shell label: cURL source: | @@ -9989,6 +13147,38 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCancelSwap } from "medusa-react" + + type Props = { + orderId: string, + swapId: string + } + + const Swap = ({ + orderId, + swapId + }: Props) => { + const cancelSwap = useAdminCancelSwap( + orderId + ) + // ... + + const handleCancel = () => { + cancelSwap.mutate(swapId, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } + }) + } + + // ... + } + + export default Swap - lang: Shell label: cURL source: > @@ -10089,6 +13279,40 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminFulfillSwap } from "medusa-react" + + type Props = { + orderId: string, + swapId: string + } + + const Swap = ({ + orderId, + swapId + }: Props) => { + const fulfillSwap = useAdminFulfillSwap( + orderId + ) + // ... + + const handleFulfill = () => { + fulfillSwap.mutate({ + swap_id: swapId, + }, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } + }) + } + + // ... + } + + export default Swap - lang: Shell label: cURL source: > @@ -10182,6 +13406,39 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCancelSwapFulfillment } from "medusa-react" + + type Props = { + orderId: string, + swapId: string + } + + const Swap = ({ + orderId, + swapId + }: Props) => { + const cancelFulfillment = useAdminCancelSwapFulfillment( + orderId + ) + // ... + + const handleCancelFulfillment = ( + fulfillmentId: string + ) => { + cancelFulfillment.mutate({ + swap_id: swapId, + fulfillment_id: fulfillmentId, + }) + } + + // ... + } + + export default Swap - lang: Shell label: cURL source: > @@ -10274,6 +13531,38 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminProcessSwapPayment } from "medusa-react" + + type Props = { + orderId: string, + swapId: string + } + + const Swap = ({ + orderId, + swapId + }: Props) => { + const processPayment = useAdminProcessSwapPayment( + orderId + ) + // ... + + const handleProcessPayment = () => { + processPayment.mutate(swapId, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } + }) + } + + // ... + } + + export default Swap - lang: Shell label: cURL source: > @@ -10372,6 +13661,43 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateSwapShipment } from "medusa-react" + + type Props = { + orderId: string, + swapId: string + } + + const Swap = ({ + orderId, + swapId + }: Props) => { + const createShipment = useAdminCreateSwapShipment( + orderId + ) + // ... + + const handleCreateShipment = ( + fulfillmentId: string + ) => { + createShipment.mutate({ + swap_id: swapId, + fulfillment_id: fulfillmentId, + }, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } + }) + } + + // ... + } + + export default Swap - lang: Shell label: cURL source: > @@ -10456,6 +13782,34 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminPaymentCollection } from "medusa-react" + + type Props = { + paymentCollectionId: string + } + + const PaymentCollection = ({ paymentCollectionId }: Props) => { + const { + payment_collection, + isLoading, + } = useAdminPaymentCollection(paymentCollectionId) + + return ( +
+ {isLoading && Loading...} + {payment_collection && ( + {payment_collection.status} + )} + +
+ ) + } + + export default PaymentCollection - lang: Shell label: cURL source: | @@ -10523,6 +13877,38 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdatePaymentCollection } from "medusa-react" + + type Props = { + paymentCollectionId: string + } + + const PaymentCollection = ({ paymentCollectionId }: Props) => { + const updateCollection = useAdminUpdatePaymentCollection( + paymentCollectionId + ) + // ... + + const handleUpdate = ( + description: string + ) => { + updateCollection.mutate({ + description + }, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.description) + } + }) + } + + // ... + } + + export default PaymentCollection - lang: Shell label: cURL source: | @@ -10589,6 +13975,34 @@ paths: .then(({ id, object, deleted }) => { console.log(id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeletePaymentCollection } from "medusa-react" + + type Props = { + paymentCollectionId: string + } + + const PaymentCollection = ({ paymentCollectionId }: Props) => { + const deleteCollection = useAdminDeletePaymentCollection( + paymentCollectionId + ) + // ... + + const handleDelete = () => { + deleteCollection.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default PaymentCollection - lang: Shell label: cURL source: | @@ -10644,6 +14058,39 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id) }) + - lang: tsx + label: Medusa React + source: > + import React from "react" + + import { useAdminMarkPaymentCollectionAsAuthorized } from + "medusa-react" + + + type Props = { + paymentCollectionId: string + } + + + const PaymentCollection = ({ paymentCollectionId }: Props) => { + const markAsAuthorized = useAdminMarkPaymentCollectionAsAuthorized( + paymentCollectionId + ) + // ... + + const handleAuthorization = () => { + markAsAuthorized.mutate(void 0, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.status) + } + }) + } + + // ... + } + + + export default PaymentCollection - lang: Shell label: cURL source: > @@ -10708,6 +14155,32 @@ paths: .then(({ payment }) => { console.log(payment.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminPayment } from "medusa-react" + + type Props = { + paymentId: string + } + + const Payment = ({ paymentId }: Props) => { + const { + payment, + isLoading, + } = useAdminPayment(paymentId) + + return ( +
+ {isLoading && Loading...} + {payment && {payment.amount}} + +
+ ) + } + + export default Payment - lang: Shell label: cURL source: | @@ -10769,6 +14242,34 @@ paths: .then(({ payment }) => { console.log(payment.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminPaymentsCapturePayment } from "medusa-react" + + type Props = { + paymentId: string + } + + const Payment = ({ paymentId }: Props) => { + const capture = useAdminPaymentsCapturePayment( + paymentId + ) + // ... + + const handleCapture = () => { + capture.mutate(void 0, { + onSuccess: ({ payment }) => { + console.log(payment.amount) + } + }) + } + + // ... + } + + export default Payment - lang: Shell label: cURL source: | @@ -10839,6 +14340,43 @@ paths: .then(({ payment }) => { console.log(payment.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { RefundReason } from "@medusajs/medusa" + import { useAdminPaymentsRefundPayment } from "medusa-react" + + type Props = { + paymentId: string + } + + const Payment = ({ paymentId }: Props) => { + const refund = useAdminPaymentsRefundPayment( + paymentId + ) + // ... + + const handleRefund = ( + amount: number, + reason: RefundReason, + note: string + ) => { + refund.mutate({ + amount, + reason, + note + }, { + onSuccess: ({ refund }) => { + console.log(refund.amount) + } + }) + } + + // ... + } + + export default Payment - lang: Shell label: cURL source: | @@ -11051,6 +14589,33 @@ paths: .then(({ price_lists, limit, offset, count }) => { console.log(price_lists.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminPriceLists } from "medusa-react" + + const PriceLists = () => { + const { price_lists, isLoading } = useAdminPriceLists() + + return ( +
+ {isLoading && Loading...} + {price_lists && !price_lists.length && ( + No Price Lists + )} + {price_lists && price_lists.length > 0 && ( +
    + {price_lists.map((price_list) => ( +
  • {price_list.name}
    • + ))} +
+ )} +
+ ) + } + + export default PriceLists - lang: Shell label: cURL source: | @@ -11122,6 +14687,47 @@ paths: .then(({ price_list }) => { console.log(price_list.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + PriceListStatus, + PriceListType, + } from "@medusajs/medusa" + import { useAdminCreatePriceList } from "medusa-react" + + type CreateData = { + name: string + description: string + type: PriceListType + status: PriceListStatus + prices: { + amount: number + variant_id: string + currency_code: string + max_quantity: number + }[] + } + + const CreatePriceList = () => { + const createPriceList = useAdminCreatePriceList() + // ... + + const handleCreate = ( + data: CreateData + ) => { + createPriceList.mutate(data, { + onSuccess: ({ price_list }) => { + console.log(price_list.id) + } + }) + } + + // ... + } + + export default CreatePriceList - lang: Shell label: cURL source: | @@ -11196,6 +14802,33 @@ paths: .then(({ price_list }) => { console.log(price_list.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminPriceList } from "medusa-react" + + type Props = { + priceListId: string + } + + const PriceList = ({ + priceListId + }: Props) => { + const { + price_list, + isLoading, + } = useAdminPriceList(priceListId) + + return ( +
+ {isLoading && Loading...} + {price_list && {price_list.name}} +
+ ) + } + + export default PriceList - lang: Shell label: cURL source: | @@ -11263,6 +14896,38 @@ paths: .then(({ price_list }) => { console.log(price_list.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdatePriceList } from "medusa-react" + + type Props = { + priceListId: string + } + + const PriceList = ({ + priceListId + }: Props) => { + const updatePriceList = useAdminUpdatePriceList(priceListId) + // ... + + const handleUpdate = ( + endsAt: Date + ) => { + updatePriceList.mutate({ + ends_at: endsAt, + }, { + onSuccess: ({ price_list }) => { + console.log(price_list.ends_at) + } + }) + } + + // ... + } + + export default PriceList - lang: Shell label: cURL source: | @@ -11327,6 +14992,34 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeletePriceList } from "medusa-react" + + type Props = { + priceListId: string + } + + const PriceList = ({ + priceListId + }: Props) => { + const deletePriceList = useAdminDeletePriceList(priceListId) + // ... + + const handleDelete = () => { + deletePriceList.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default PriceList - lang: Shell label: cURL source: | @@ -11401,6 +15094,42 @@ paths: .then(({ price_list }) => { console.log(price_list.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreatePriceListPrices } from "medusa-react" + + type PriceData = { + amount: number + variant_id: string + currency_code: string + } + + type Props = { + priceListId: string + } + + const PriceList = ({ + priceListId + }: Props) => { + const addPrices = useAdminCreatePriceListPrices(priceListId) + // ... + + const handleAddPrices = (prices: PriceData[]) => { + addPrices.mutate({ + prices + }, { + onSuccess: ({ price_list }) => { + console.log(price_list.prices) + } + }) + } + + // ... + } + + export default PriceList - lang: Shell label: cURL source: | @@ -11480,6 +15209,32 @@ paths: .then(({ ids, object, deleted }) => { console.log(ids.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeletePriceListPrices } from "medusa-react" + + const PriceList = ( + priceListId: string + ) => { + const deletePrices = useAdminDeletePriceListPrices(priceListId) + // ... + + const handleDeletePrices = (priceIds: string[]) => { + deletePrices.mutate({ + price_ids: priceIds + }, { + onSuccess: ({ ids, deleted, object }) => { + console.log(ids) + } + }) + } + + // ... + } + + export default PriceList - lang: Shell label: cURL source: | @@ -11722,6 +15477,41 @@ paths: .then(({ products, limit, offset, count }) => { console.log(products.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminPriceListProducts } from "medusa-react" + + type Props = { + priceListId: string + } + + const PriceListProducts = ({ + priceListId + }: Props) => { + const { products, isLoading } = useAdminPriceListProducts( + priceListId + ) + + return ( +
+ {isLoading && Loading...} + {products && !products.length && ( + No Price Lists + )} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
+ ) + } + + export default PriceListProducts - lang: Shell label: cURL source: | @@ -11788,6 +15578,38 @@ paths: .then(({ ids, object, deleted }) => { console.log(ids.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeletePriceListProductsPrices } from "medusa-react" + + type Props = { + priceListId: string + } + + const PriceList = ({ + priceListId + }: Props) => { + const deleteProductsPrices = useAdminDeletePriceListProductsPrices( + priceListId + ) + // ... + + const handleDeleteProductsPrices = (productIds: string[]) => { + deleteProductsPrices.mutate({ + product_ids: productIds + }, { + onSuccess: ({ ids, deleted, object }) => { + console.log(ids) + } + }) + } + + // ... + } + + export default PriceList - lang: Shell label: cURL source: > @@ -11866,6 +15688,41 @@ paths: .then(({ ids, object, deleted }) => { console.log(ids.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminDeletePriceListProductPrices + } from "medusa-react" + + type Props = { + priceListId: string + productId: string + } + + const PriceListProduct = ({ + priceListId, + productId + }: Props) => { + const deleteProductPrices = useAdminDeletePriceListProductPrices( + priceListId, + productId + ) + // ... + + const handleDeleteProductPrices = () => { + deleteProductPrices.mutate(void 0, { + onSuccess: ({ ids, deleted, object }) => { + console.log(ids) + } + }) + } + + // ... + } + + export default PriceListProduct - lang: Shell label: cURL source: > @@ -11936,6 +15793,41 @@ paths: .then(({ ids, object, deleted }) => { console.log(ids); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminDeletePriceListVariantPrices + } from "medusa-react" + + type Props = { + priceListId: string + variantId: string + } + + const PriceListVariant = ({ + priceListId, + variantId + }: Props) => { + const deleteVariantPrices = useAdminDeletePriceListVariantPrices( + priceListId, + variantId + ) + // ... + + const handleDeleteVariantPrices = () => { + deleteVariantPrices.mutate(void 0, { + onSuccess: ({ ids, deleted, object }) => { + console.log(ids) + } + }) + } + + // ... + } + + export default PriceListVariant - lang: Shell label: cURL source: > @@ -12059,6 +15951,38 @@ paths: .then(({ product_categories, limit, offset, count }) => { console.log(product_categories.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminProductCategories } from "medusa-react" + + function Categories() { + const { + product_categories, + isLoading + } = useAdminProductCategories() + + return ( +
+ {isLoading && Loading...} + {product_categories && !product_categories.length && ( + No Categories + )} + {product_categories && product_categories.length > 0 && ( +
    + {product_categories.map( + (category) => ( +
  • {category.name}
    • + ) + )} +
+ )} +
+ ) + } + + export default Categories - lang: Shell label: cURL source: | @@ -12136,6 +16060,32 @@ paths: .then(({ product_category }) => { console.log(product_category.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateProductCategory } from "medusa-react" + + const CreateCategory = () => { + const createCategory = useAdminCreateProductCategory() + // ... + + const handleCreate = ( + name: string + ) => { + createCategory.mutate({ + name, + }, { + onSuccess: ({ product_category }) => { + console.log(product_category.id) + } + }) + } + + // ... + } + + export default CreateCategory - lang: Shell label: cURL source: | @@ -12217,6 +16167,36 @@ paths: .then(({ product_category }) => { console.log(product_category.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminProductCategory } from "medusa-react" + + type Props = { + productCategoryId: string + } + + const Category = ({ + productCategoryId + }: Props) => { + const { + product_category, + isLoading, + } = useAdminProductCategory(productCategoryId) + + return ( +
+ {isLoading && Loading...} + {product_category && ( + {product_category.name} + )} + +
+ ) + } + + export default Category - lang: Shell label: cURL source: | @@ -12300,6 +16280,40 @@ paths: .then(({ product_category }) => { console.log(product_category.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateProductCategory } from "medusa-react" + + type Props = { + productCategoryId: string + } + + const Category = ({ + productCategoryId + }: Props) => { + const updateCategory = useAdminUpdateProductCategory( + productCategoryId + ) + // ... + + const handleUpdate = ( + name: string + ) => { + updateCategory.mutate({ + name, + }, { + onSuccess: ({ product_category }) => { + console.log(product_category.id) + } + }) + } + + // ... + } + + export default Category - lang: Shell label: cURL source: | @@ -12365,6 +16379,36 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteProductCategory } from "medusa-react" + + type Props = { + productCategoryId: string + } + + const Category = ({ + productCategoryId + }: Props) => { + const deleteCategory = useAdminDeleteProductCategory( + productCategoryId + ) + // ... + + const handleDelete = () => { + deleteCategory.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default Category - lang: Shell label: cURL source: | @@ -12454,6 +16498,44 @@ paths: .then(({ product_category }) => { console.log(product_category.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminAddProductsToCategory } from "medusa-react" + + type ProductsData = { + id: string + } + + type Props = { + productCategoryId: string + } + + const Category = ({ + productCategoryId + }: Props) => { + const addProducts = useAdminAddProductsToCategory( + productCategoryId + ) + // ... + + const handleAddProducts = ( + productIds: ProductsData[] + ) => { + addProducts.mutate({ + product_ids: productIds + }, { + onSuccess: ({ product_category }) => { + console.log(product_category.products) + } + }) + } + + // ... + } + + export default Category - lang: Shell label: cURL source: > @@ -12554,6 +16636,44 @@ paths: .then(({ product_category }) => { console.log(product_category.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteProductsFromCategory } from "medusa-react" + + type ProductsData = { + id: string + } + + type Props = { + productCategoryId: string + } + + const Category = ({ + productCategoryId + }: Props) => { + const deleteProducts = useAdminDeleteProductsFromCategory( + productCategoryId + ) + // ... + + const handleDeleteProducts = ( + productIds: ProductsData[] + ) => { + deleteProducts.mutate({ + product_ids: productIds + }, { + onSuccess: ({ product_category }) => { + console.log(product_category.products) + } + }) + } + + // ... + } + + export default Category - lang: Shell label: cURL source: > @@ -12716,6 +16836,38 @@ paths: .then(({ product_tags }) => { console.log(product_tags.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminProductTags } from "medusa-react" + + function ProductTags() { + const { + product_tags, + isLoading + } = useAdminProductTags() + + return ( +
+ {isLoading && Loading...} + {product_tags && !product_tags.length && ( + No Product Tags + )} + {product_tags && product_tags.length > 0 && ( +
    + {product_tags.map( + (tag) => ( +
  • {tag.value}
    • + ) + )} +
+ )} +
+ ) + } + + export default ProductTags - lang: Shell label: cURL source: | @@ -12868,6 +17020,38 @@ paths: .then(({ product_types }) => { console.log(product_types.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminProductTypes } from "medusa-react" + + function ProductTypes() { + const { + product_types, + isLoading + } = useAdminProductTypes() + + return ( +
+ {isLoading && Loading...} + {product_types && !product_types.length && ( + No Product Tags + )} + {product_types && product_types.length > 0 && ( +
    + {product_types.map( + (type) => ( +
  • {type.value}
    • + ) + )} +
+ )} +
+ ) + } + + export default ProductTypes - lang: Shell label: cURL source: | @@ -13161,6 +17345,31 @@ paths: .then(({ products, limit, offset, count }) => { console.log(products.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminProducts } from "medusa-react" + + const Products = () => { + const { products, isLoading } = useAdminProducts() + + return ( +
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
+ ) + } + + export default Products - lang: Shell label: cURL source: | @@ -13225,6 +17434,57 @@ paths: .then(({ product }) => { console.log(product.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateProduct } from "medusa-react" + + type CreateProductData = { + title: string + is_giftcard: boolean + discountable: boolean + options: { + title: string + }[] + variants: { + title: string + prices: { + amount: number + currency_code :string + }[] + options: { + value: string + }[] + }[], + collection_id: string + categories: { + id: string + }[] + type: { + value: string + } + tags: { + value: string + }[] + } + + const CreateProduct = () => { + const createProduct = useAdminCreateProduct() + // ... + + const handleCreate = (productData: CreateProductData) => { + createProduct.mutate(productData, { + onSuccess: ({ product }) => { + console.log(product.id) + } + }) + } + + // ... + } + + export default CreateProduct - lang: Shell label: cURL source: | @@ -13285,6 +17545,31 @@ paths: .then(({ tags }) => { console.log(tags.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminProductTagUsage } from "medusa-react" + + const ProductTags = (productId: string) => { + const { tags, isLoading } = useAdminProductTagUsage() + + return ( +
+ {isLoading && Loading...} + {tags && !tags.length && No Product Tags} + {tags && tags.length > 0 && ( +
    + {tags.map((tag) => ( +
  • {tag.value} - {tag.usage_count}
    • + ))} +
+ )} +
+ ) + } + + export default ProductTags - lang: Shell label: cURL source: | @@ -13401,6 +17686,32 @@ paths: .then(({ product }) => { console.log(product.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminProduct } from "medusa-react" + + type Props = { + productId: string + } + + const Product = ({ productId }: Props) => { + const { + product, + isLoading, + } = useAdminProduct(productId) + + return ( +
+ {isLoading && Loading...} + {product && {product.title}} + +
+ ) + } + + export default Product - lang: Shell label: cURL source: | @@ -13468,6 +17779,38 @@ paths: .then(({ product }) => { console.log(product.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateProduct } from "medusa-react" + + type Props = { + productId: string + } + + const Product = ({ productId }: Props) => { + const updateProduct = useAdminUpdateProduct( + productId + ) + // ... + + const handleUpdate = ( + title: string + ) => { + updateProduct.mutate({ + title, + }, { + onSuccess: ({ product }) => { + console.log(product.id) + } + }) + } + + // ... + } + + export default Product - lang: Shell label: cURL source: | @@ -13532,6 +17875,34 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteProduct } from "medusa-react" + + type Props = { + productId: string + } + + const Product = ({ productId }: Props) => { + const deleteProduct = useAdminDeleteProduct( + productId + ) + // ... + + const handleDelete = () => { + deleteProduct.mutate(void 0, { + onSuccess: ({ id, object, deleted}) => { + console.log(id) + } + }) + } + + // ... + } + + export default Product - lang: Shell label: cURL source: | @@ -13680,6 +18051,38 @@ paths: .then(({ product }) => { console.log(product.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateProductOption } from "medusa-react" + + type Props = { + productId: string + } + + const CreateProductOption = ({ productId }: Props) => { + const createOption = useAdminCreateProductOption( + productId + ) + // ... + + const handleCreate = ( + title: string + ) => { + createOption.mutate({ + title + }, { + onSuccess: ({ product }) => { + console.log(product.options) + } + }) + } + + // ... + } + + export default CreateProductOption - lang: Shell label: cURL source: | @@ -13758,6 +18161,43 @@ paths: .then(({ product }) => { console.log(product.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateProductOption } from "medusa-react" + + type Props = { + productId: string + optionId: string + } + + const ProductOption = ({ + productId, + optionId + }: Props) => { + const updateOption = useAdminUpdateProductOption( + productId + ) + // ... + + const handleUpdate = ( + title: string + ) => { + updateOption.mutate({ + option_id: optionId, + title, + }, { + onSuccess: ({ product }) => { + console.log(product.options) + } + }) + } + + // ... + } + + export default ProductOption - lang: Shell label: cURL source: > @@ -13834,6 +18274,38 @@ paths: .then(({ option_id, object, deleted, product }) => { console.log(product.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteProductOption } from "medusa-react" + + type Props = { + productId: string + optionId: string + } + + const ProductOption = ({ + productId, + optionId + }: Props) => { + const deleteOption = useAdminDeleteProductOption( + productId + ) + // ... + + const handleDelete = () => { + deleteOption.mutate(optionId, { + onSuccess: ({ option_id, object, deleted, product }) => { + console.log(product.options) + } + }) + } + + // ... + } + + export default ProductOption - lang: Shell label: cURL source: > @@ -14000,6 +18472,48 @@ paths: .then(({ product }) => { console.log(product.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateVariant } from "medusa-react" + + type CreateVariantData = { + title: string + prices: { + amount: number + currency_code: string + }[] + options: { + option_id: string + value: string + }[] + } + + type Props = { + productId: string + } + + const CreateProductVariant = ({ productId }: Props) => { + const createVariant = useAdminCreateVariant( + productId + ) + // ... + + const handleCreate = ( + variantData: CreateVariantData + ) => { + createVariant.mutate(variantData, { + onSuccess: ({ product }) => { + console.log(product.variants) + } + }) + } + + // ... + } + + export default CreateProductVariant - lang: Shell label: cURL source: | @@ -14103,6 +18617,41 @@ paths: .then(({ product }) => { console.log(product.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateVariant } from "medusa-react" + + type Props = { + productId: string + variantId: string + } + + const ProductVariant = ({ + productId, + variantId + }: Props) => { + const updateVariant = useAdminUpdateVariant( + productId + ) + // ... + + const handleUpdate = (title: string) => { + updateVariant.mutate({ + variant_id: variantId, + title, + }, { + onSuccess: ({ product }) => { + console.log(product.variants) + } + }) + } + + // ... + } + + export default ProductVariant - lang: Shell label: cURL source: > @@ -14183,6 +18732,38 @@ paths: .then(({ variant_id, object, deleted, product }) => { console.log(product.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteVariant } from "medusa-react" + + type Props = { + productId: string + variantId: string + } + + const ProductVariant = ({ + productId, + variantId + }: Props) => { + const deleteVariant = useAdminDeleteVariant( + productId + ) + // ... + + const handleDelete = () => { + deleteVariant.mutate(variantId, { + onSuccess: ({ variant_id, object, deleted, product }) => { + console.log(product.variants) + } + }) + } + + // ... + } + + export default ProductVariant - lang: Shell label: cURL source: > @@ -14277,6 +18858,40 @@ paths: .then(({ publishable_api_keys, count, limit, offset }) => { console.log(publishable_api_keys) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { PublishableApiKey } from "@medusajs/medusa" + import { useAdminPublishableApiKeys } from "medusa-react" + + const PublishableApiKeys = () => { + const { publishable_api_keys, isLoading } = + useAdminPublishableApiKeys() + + return ( +
+ {isLoading && Loading...} + {publishable_api_keys && !publishable_api_keys.length && ( + No Publishable API Keys + )} + {publishable_api_keys && + publishable_api_keys.length > 0 && ( +
    + {publishable_api_keys.map( + (publishableApiKey: PublishableApiKey) => ( +
  • + {publishableApiKey.title} +
    • + ) + )} +
+ )} +
+ ) + } + + export default PublishableApiKeys - lang: Shell label: cURL source: | @@ -14337,6 +18952,30 @@ paths: .then(({ publishable_api_key }) => { console.log(publishable_api_key.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreatePublishableApiKey } from "medusa-react" + + const CreatePublishableApiKey = () => { + const createKey = useAdminCreatePublishableApiKey() + // ... + + const handleCreate = (title: string) => { + createKey.mutate({ + title, + }, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.id) + } + }) + } + + // ... + } + + export default CreatePublishableApiKey - lang: Shell label: cURL source: | @@ -14402,6 +19041,36 @@ paths: .then(({ publishable_api_key }) => { console.log(publishable_api_key.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminPublishableApiKey, + } from "medusa-react" + + type Props = { + publishableApiKeyId: string + } + + const PublishableApiKey = ({ + publishableApiKeyId + }: Props) => { + const { publishable_api_key, isLoading } = + useAdminPublishableApiKey( + publishableApiKeyId + ) + + + return ( +
+ {isLoading && Loading...} + {publishable_api_key && {publishable_api_key.title}} +
+ ) + } + + export default PublishableApiKey - lang: Shell label: cURL source: | @@ -14470,6 +19139,38 @@ paths: .then(({ publishable_api_key }) => { console.log(publishable_api_key.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdatePublishableApiKey } from "medusa-react" + + type Props = { + publishableApiKeyId: string + } + + const PublishableApiKey = ({ + publishableApiKeyId + }: Props) => { + const updateKey = useAdminUpdatePublishableApiKey( + publishableApiKeyId + ) + // ... + + const handleUpdate = (title: string) => { + updateKey.mutate({ + title, + }, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.id) + } + }) + } + + // ... + } + + export default PublishableApiKey - lang: Shell label: cURL source: | @@ -14536,6 +19237,36 @@ paths: .then(({ id, object, deleted }) => { console.log(id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeletePublishableApiKey } from "medusa-react" + + type Props = { + publishableApiKeyId: string + } + + const PublishableApiKey = ({ + publishableApiKeyId + }: Props) => { + const deleteKey = useAdminDeletePublishableApiKey( + publishableApiKeyId + ) + // ... + + const handleDelete = () => { + deleteKey.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default PublishableApiKey - lang: Shell label: cURL source: | @@ -14589,6 +19320,36 @@ paths: .then(({ publishable_api_key }) => { console.log(publishable_api_key.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminRevokePublishableApiKey } from "medusa-react" + + type Props = { + publishableApiKeyId: string + } + + const PublishableApiKey = ({ + publishableApiKeyId + }: Props) => { + const revokeKey = useAdminRevokePublishableApiKey( + publishableApiKeyId + ) + // ... + + const handleRevoke = () => { + revokeKey.mutate(void 0, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.revoked_at) + } + }) + } + + // ... + } + + export default PublishableApiKey - lang: Shell label: cURL source: > @@ -14660,6 +19421,44 @@ paths: .then(({ sales_channels }) => { console.log(sales_channels.length) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminPublishableApiKeySalesChannels, + } from "medusa-react" + + type Props = { + publishableApiKeyId: string + } + + const SalesChannels = ({ + publishableApiKeyId + }: Props) => { + const { sales_channels, isLoading } = + useAdminPublishableApiKeySalesChannels( + publishableApiKeyId + ) + + return ( +
+ {isLoading && Loading...} + {sales_channels && !sales_channels.length && ( + No Sales Channels + )} + {sales_channels && sales_channels.length > 0 && ( +
    + {sales_channels.map((salesChannel) => ( +
  • {salesChannel.name}
    • + ))} +
+ )} +
+ ) + } + + export default SalesChannels - lang: Shell label: cURL source: > @@ -14737,6 +19536,45 @@ paths: .then(({ publishable_api_key }) => { console.log(publishable_api_key.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminAddPublishableKeySalesChannelsBatch, + } from "medusa-react" + + type Props = { + publishableApiKeyId: string + } + + const PublishableApiKey = ({ + publishableApiKeyId + }: Props) => { + const addSalesChannels = + useAdminAddPublishableKeySalesChannelsBatch( + publishableApiKeyId + ) + // ... + + const handleAdd = (salesChannelId: string) => { + addSalesChannels.mutate({ + sales_channel_ids: [ + { + id: salesChannelId, + }, + ], + }, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.id) + } + }) + } + + // ... + } + + export default PublishableApiKey - lang: Shell label: cURL source: > @@ -14825,6 +19663,45 @@ paths: .then(({ publishable_api_key }) => { console.log(publishable_api_key.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminRemovePublishableKeySalesChannelsBatch, + } from "medusa-react" + + type Props = { + publishableApiKeyId: string + } + + const PublishableApiKey = ({ + publishableApiKeyId + }: Props) => { + const deleteSalesChannels = + useAdminRemovePublishableKeySalesChannelsBatch( + publishableApiKeyId + ) + // ... + + const handleDelete = (salesChannelId: string) => { + deleteSalesChannels.mutate({ + sales_channel_ids: [ + { + id: salesChannelId, + }, + ], + }, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.id) + } + }) + } + + // ... + } + + export default PublishableApiKey - lang: Shell label: cURL source: > @@ -14978,6 +19855,31 @@ paths: .then(({ regions, limit, offset, count }) => { console.log(regions.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminRegions } from "medusa-react" + + const Regions = () => { + const { regions, isLoading } = useAdminRegions() + + return ( +
+ {isLoading && Loading...} + {regions && !regions.length && No Regions} + {regions && regions.length > 0 && ( +
    + {regions.map((region) => ( +
  • {region.name}
    • + ))} +
+ )} +
+ ) + } + + export default Regions - lang: Shell label: cURL source: | @@ -15049,6 +19951,37 @@ paths: .then(({ region }) => { console.log(region.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateRegion } from "medusa-react" + + type CreateData = { + name: string + currency_code: string + tax_rate: number + payment_providers: string[] + fulfillment_providers: string[] + countries: string[] + } + + const CreateRegion = () => { + const createRegion = useAdminCreateRegion() + // ... + + const handleCreate = (regionData: CreateData) => { + createRegion.mutate(regionData, { + onSuccess: ({ region }) => { + console.log(region.id) + } + }) + } + + // ... + } + + export default CreateRegion - lang: Shell label: cURL source: | @@ -15125,6 +20058,32 @@ paths: .then(({ region }) => { console.log(region.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminRegion } from "medusa-react" + + type Props = { + regionId: string + } + + const Region = ({ + regionId + }: Props) => { + const { region, isLoading } = useAdminRegion( + regionId + ) + + return ( +
+ {isLoading && Loading...} + {region && {region.name}} +
+ ) + } + + export default Region - lang: Shell label: cURL source: | @@ -15192,6 +20151,38 @@ paths: .then(({ region }) => { console.log(region.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateRegion } from "medusa-react" + + type Props = { + regionId: string + } + + const Region = ({ + regionId + }: Props) => { + const updateRegion = useAdminUpdateRegion(regionId) + // ... + + const handleUpdate = ( + countries: string[] + ) => { + updateRegion.mutate({ + countries, + }, { + onSuccess: ({ region }) => { + console.log(region.id) + } + }) + } + + // ... + } + + export default Region - lang: Shell label: cURL source: | @@ -15258,6 +20249,34 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteRegion } from "medusa-react" + + type Props = { + regionId: string + } + + const Region = ({ + regionId + }: Props) => { + const deleteRegion = useAdminDeleteRegion(regionId) + // ... + + const handleDelete = () => { + deleteRegion.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default Region - lang: Shell label: cURL source: | @@ -15326,6 +20345,38 @@ paths: .then(({ region }) => { console.log(region.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminRegionAddCountry } from "medusa-react" + + type Props = { + regionId: string + } + + const Region = ({ + regionId + }: Props) => { + const addCountry = useAdminRegionAddCountry(regionId) + // ... + + const handleAddCountry = ( + countryCode: string + ) => { + addCountry.mutate({ + country_code: countryCode + }, { + onSuccess: ({ region }) => { + console.log(region.countries) + } + }) + } + + // ... + } + + export default Region - lang: Shell label: cURL source: | @@ -15403,6 +20454,36 @@ paths: .then(({ region }) => { console.log(region.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminRegionRemoveCountry } from "medusa-react" + + type Props = { + regionId: string + } + + const Region = ({ + regionId + }: Props) => { + const removeCountry = useAdminRegionRemoveCountry(regionId) + // ... + + const handleRemoveCountry = ( + countryCode: string + ) => { + removeCountry.mutate(countryCode, { + onSuccess: ({ region }) => { + console.log(region.countries) + } + }) + } + + // ... + } + + export default Region - lang: Shell label: cURL source: > @@ -15466,6 +20547,47 @@ paths: .then(({ fulfillment_options }) => { console.log(fulfillment_options.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminRegionFulfillmentOptions } from "medusa-react" + + type Props = { + regionId: string + } + + const Region = ({ + regionId + }: Props) => { + const { + fulfillment_options, + isLoading + } = useAdminRegionFulfillmentOptions( + regionId + ) + + return ( +
+ {isLoading && Loading...} + {fulfillment_options && !fulfillment_options.length && ( + No Regions + )} + {fulfillment_options && + fulfillment_options.length > 0 && ( +
    + {fulfillment_options.map((option) => ( +
  • + {option.provider_id} +
    • + ))} +
+ )} +
+ ) + } + + export default Region - lang: Shell label: cURL source: | @@ -15538,6 +20660,41 @@ paths: .then(({ region }) => { console.log(region.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminRegionAddFulfillmentProvider + } from "medusa-react" + + type Props = { + regionId: string + } + + const Region = ({ + regionId + }: Props) => { + const addFulfillmentProvider = + useAdminRegionAddFulfillmentProvider(regionId) + // ... + + const handleAddFulfillmentProvider = ( + providerId: string + ) => { + addFulfillmentProvider.mutate({ + provider_id: providerId + }, { + onSuccess: ({ region }) => { + console.log(region.fulfillment_providers) + } + }) + } + + // ... + } + + export default Region - lang: Shell label: cURL source: > @@ -15615,6 +20772,39 @@ paths: .then(({ region }) => { console.log(region.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminRegionDeleteFulfillmentProvider + } from "medusa-react" + + type Props = { + regionId: string + } + + const Region = ({ + regionId + }: Props) => { + const removeFulfillmentProvider = + useAdminRegionDeleteFulfillmentProvider(regionId) + // ... + + const handleRemoveFulfillmentProvider = ( + providerId: string + ) => { + removeFulfillmentProvider.mutate(providerId, { + onSuccess: ({ region }) => { + console.log(region.fulfillment_providers) + } + }) + } + + // ... + } + + export default Region - lang: Shell label: cURL source: > @@ -15686,6 +20876,41 @@ paths: .then(({ region }) => { console.log(region.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminRegionAddPaymentProvider + } from "medusa-react" + + type Props = { + regionId: string + } + + const Region = ({ + regionId + }: Props) => { + const addPaymentProvider = + useAdminRegionAddPaymentProvider(regionId) + // ... + + const handleAddPaymentProvider = ( + providerId: string + ) => { + addPaymentProvider.mutate({ + provider_id: providerId + }, { + onSuccess: ({ region }) => { + console.log(region.payment_providers) + } + }) + } + + // ... + } + + export default Region - lang: Shell label: cURL source: | @@ -15759,6 +20984,39 @@ paths: .then(({ region }) => { console.log(region.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminRegionDeletePaymentProvider + } from "medusa-react" + + type Props = { + regionId: string + } + + const Region = ({ + regionId + }: Props) => { + const removePaymentProvider = + useAdminRegionDeletePaymentProvider(regionId) + // ... + + const handleRemovePaymentProvider = ( + providerId: string + ) => { + removePaymentProvider.mutate(providerId, { + onSuccess: ({ region }) => { + console.log(region.payment_providers) + } + }) + } + + // ... + } + + export default Region - lang: Shell label: cURL source: > @@ -15941,6 +21199,33 @@ paths: .then(({ reservations, count, limit, offset }) => { console.log(reservations.length) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminReservations } from "medusa-react" + + const Reservations = () => { + const { reservations, isLoading } = useAdminReservations() + + return ( +
+ {isLoading && Loading...} + {reservations && !reservations.length && ( + No Reservations + )} + {reservations && reservations.length > 0 && ( +
    + {reservations.map((reservation) => ( +
  • {reservation.quantity}
    • + ))} +
+ )} +
+ ) + } + + export default Reservations - lang: Shell label: cURL source: | @@ -16004,6 +21289,36 @@ paths: .then(({ reservation }) => { console.log(reservation.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateReservation } from "medusa-react" + + const CreateReservation = () => { + const createReservation = useAdminCreateReservation() + // ... + + const handleCreate = ( + locationId: string, + inventoryItemId: string, + quantity: number + ) => { + createReservation.mutate({ + location_id: locationId, + inventory_item_id: inventoryItemId, + quantity, + }, { + onSuccess: ({ reservation }) => { + console.log(reservation.id) + } + }) + } + + // ... + } + + export default CreateReservation - lang: Shell label: cURL source: | @@ -16070,6 +21385,30 @@ paths: .then(({ reservation }) => { console.log(reservation.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminReservation } from "medusa-react" + + type Props = { + reservationId: string + } + + const Reservation = ({ reservationId }: Props) => { + const { reservation, isLoading } = useAdminReservation( + reservationId + ) + + return ( +
+ {isLoading && Loading...} + {reservation && {reservation.inventory_item_id}} +
+ ) + } + + export default Reservation - lang: Shell label: cURL source: | @@ -16135,6 +21474,34 @@ paths: .then(({ reservation }) => { console.log(reservation.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateReservation } from "medusa-react" + + type Props = { + reservationId: string + } + + const Reservation = ({ reservationId }: Props) => { + const updateReservation = useAdminUpdateReservation( + reservationId + ) + // ... + + const handleUpdate = ( + quantity: number + ) => { + updateReservation.mutate({ + quantity, + }) + } + + // ... + } + + export default Reservation - lang: Shell label: cURL source: | @@ -16201,6 +21568,34 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteReservation } from "medusa-react" + + type Props = { + reservationId: string + } + + const Reservation = ({ reservationId }: Props) => { + const deleteReservation = useAdminDeleteReservation( + reservationId + ) + // ... + + const handleDelete = () => { + deleteReservation.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default Reservation - lang: Shell label: cURL source: | @@ -16255,6 +21650,35 @@ paths: .then(({ return_reasons }) => { console.log(return_reasons.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminReturnReasons } from "medusa-react" + + const ReturnReasons = () => { + const { return_reasons, isLoading } = useAdminReturnReasons() + + return ( +
+ {isLoading && Loading...} + {return_reasons && !return_reasons.length && ( + No Return Reasons + )} + {return_reasons && return_reasons.length > 0 && ( +
    + {return_reasons.map((reason) => ( +
  • + {reason.label}: {reason.value} +
    • + ))} +
+ )} +
+ ) + } + + export default ReturnReasons - lang: Shell label: cURL source: | @@ -16316,6 +21740,34 @@ paths: .then(({ return_reason }) => { console.log(return_reason.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateReturnReason } from "medusa-react" + + const CreateReturnReason = () => { + const createReturnReason = useAdminCreateReturnReason() + // ... + + const handleCreate = ( + label: string, + value: string + ) => { + createReturnReason.mutate({ + label, + value, + }, { + onSuccess: ({ return_reason }) => { + console.log(return_reason.id) + } + }) + } + + // ... + } + + export default CreateReturnReason - lang: Shell label: cURL source: | @@ -16382,6 +21834,30 @@ paths: .then(({ return_reason }) => { console.log(return_reason.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminReturnReason } from "medusa-react" + + type Props = { + returnReasonId: string + } + + const ReturnReason = ({ returnReasonId }: Props) => { + const { return_reason, isLoading } = useAdminReturnReason( + returnReasonId + ) + + return ( +
+ {isLoading && Loading...} + {return_reason && {return_reason.label}} +
+ ) + } + + export default ReturnReason - lang: Shell label: cURL source: | @@ -16449,6 +21925,38 @@ paths: .then(({ return_reason }) => { console.log(return_reason.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateReturnReason } from "medusa-react" + + type Props = { + returnReasonId: string + } + + const ReturnReason = ({ returnReasonId }: Props) => { + const updateReturnReason = useAdminUpdateReturnReason( + returnReasonId + ) + // ... + + const handleUpdate = ( + label: string + ) => { + updateReturnReason.mutate({ + label, + }, { + onSuccess: ({ return_reason }) => { + console.log(return_reason.label) + } + }) + } + + // ... + } + + export default ReturnReason - lang: Shell label: cURL source: | @@ -16513,6 +22021,34 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteReturnReason } from "medusa-react" + + type Props = { + returnReasonId: string + } + + const ReturnReason = ({ returnReasonId }: Props) => { + const deleteReturnReason = useAdminDeleteReturnReason( + returnReasonId + ) + // ... + + const handleDelete = () => { + deleteReturnReason.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default ReturnReason - lang: Shell label: cURL source: | @@ -16580,6 +22116,35 @@ paths: .then(({ returns, limit, offset, count }) => { console.log(returns.length) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminReturns } from "medusa-react" + + const Returns = () => { + const { returns, isLoading } = useAdminReturns() + + return ( +
+ {isLoading && Loading...} + {returns && !returns.length && ( + No Returns + )} + {returns && returns.length > 0 && ( +
    + {returns.map((returnData) => ( +
  • + {returnData.status} +
    • + ))} +
+ )} +
+ ) + } + + export default Returns - lang: Shell label: cURL source: | @@ -16642,6 +22207,34 @@ paths: .then(({ order }) => { console.log(order.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCancelReturn } from "medusa-react" + + type Props = { + returnId: string + } + + const Return = ({ returnId }: Props) => { + const cancelReturn = useAdminCancelReturn( + returnId + ) + // ... + + const handleCancel = () => { + cancelReturn.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.returns) + } + }) + } + + // ... + } + + export default Return - lang: Shell label: cURL source: | @@ -16716,6 +22309,41 @@ paths: .then((data) => { console.log(data.return.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminReceiveReturn } from "medusa-react" + + type ReceiveReturnData = { + items: { + item_id: string + quantity: number + }[] + } + + type Props = { + returnId: string + } + + const Return = ({ returnId }: Props) => { + const receiveReturn = useAdminReceiveReturn( + returnId + ) + // ... + + const handleReceive = (data: ReceiveReturnData) => { + receiveReturn.mutate(data, { + onSuccess: ({ return: dataReturn }) => { + console.log(dataReturn.status) + } + }) + } + + // ... + } + + export default Return - lang: Shell label: cURL source: | @@ -16903,6 +22531,33 @@ paths: .then(({ sales_channels, limit, offset, count }) => { console.log(sales_channels.length) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminSalesChannels } from "medusa-react" + + const SalesChannels = () => { + const { sales_channels, isLoading } = useAdminSalesChannels() + + return ( +
+ {isLoading && Loading...} + {sales_channels && !sales_channels.length && ( + No Sales Channels + )} + {sales_channels && sales_channels.length > 0 && ( +
    + {sales_channels.map((salesChannel) => ( +
  • {salesChannel.name}
    • + ))} +
+ )} +
+ ) + } + + export default SalesChannels - lang: Shell label: cURL source: | @@ -16964,6 +22619,31 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateSalesChannel } from "medusa-react" + + const CreateSalesChannel = () => { + const createSalesChannel = useAdminCreateSalesChannel() + // ... + + const handleCreate = (name: string, description: string) => { + createSalesChannel.mutate({ + name, + description, + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.id) + } + }) + } + + // ... + } + + export default CreateSalesChannel - lang: Shell label: cURL source: | @@ -17029,6 +22709,31 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminSalesChannel } from "medusa-react" + + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { + const { + sales_channel, + isLoading, + } = useAdminSalesChannel(salesChannelId) + + return ( +
+ {isLoading && Loading...} + {sales_channel && {sales_channel.name}} +
+ ) + } + + export default SalesChannel - lang: Shell label: cURL source: | @@ -17096,6 +22801,38 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateSalesChannel } from "medusa-react" + + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { + const updateSalesChannel = useAdminUpdateSalesChannel( + salesChannelId + ) + // ... + + const handleUpdate = ( + is_disabled: boolean + ) => { + updateSalesChannel.mutate({ + is_disabled, + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.is_disabled) + } + }) + } + + // ... + } + + export default SalesChannel - lang: Shell label: cURL source: | @@ -17162,6 +22899,34 @@ paths: .then(({ id, object, deleted }) => { console.log(id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteSalesChannel } from "medusa-react" + + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { + const deleteSalesChannel = useAdminDeleteSalesChannel( + salesChannelId + ) + // ... + + const handleDelete = () => { + deleteSalesChannel.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default SalesChannel - lang: Shell label: cURL source: | @@ -17235,6 +23000,40 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminAddProductsToSalesChannel } from "medusa-react" + + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { + const addProducts = useAdminAddProductsToSalesChannel( + salesChannelId + ) + // ... + + const handleAddProducts = (productId: string) => { + addProducts.mutate({ + product_ids: [ + { + id: productId, + }, + ], + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.id) + } + }) + } + + // ... + } + + export default SalesChannel - lang: Shell label: cURL source: > @@ -17322,6 +23121,42 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminDeleteProductsFromSalesChannel, + } from "medusa-react" + + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { + const deleteProducts = useAdminDeleteProductsFromSalesChannel( + salesChannelId + ) + // ... + + const handleDeleteProducts = (productId: string) => { + deleteProducts.mutate({ + product_ids: [ + { + id: productId, + }, + ], + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.id) + } + }) + } + + // ... + } + + export default SalesChannel - lang: Shell label: cURL source: > @@ -17403,6 +23238,37 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminAddLocationToSalesChannel + } from "medusa-react" + + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { + const addLocation = useAdminAddLocationToSalesChannel() + // ... + + const handleAddLocation = (locationId: string) => { + addLocation.mutate({ + sales_channel_id: salesChannelId, + location_id: locationId + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.locations) + } + }) + } + + // ... + } + + export default SalesChannel - lang: Shell label: cURL source: > @@ -17482,6 +23348,37 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminRemoveLocationFromSalesChannel + } from "medusa-react" + + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { + const removeLocation = useAdminRemoveLocationFromSalesChannel() + // ... + + const handleRemoveLocation = (locationId: string) => { + removeLocation.mutate({ + sales_channel_id: salesChannelId, + location_id: locationId + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.locations) + } + }) + } + + // ... + } + + export default SalesChannel - lang: Shell label: cURL source: > @@ -17563,6 +23460,36 @@ paths: .then(({ shipping_options, count }) => { console.log(shipping_options.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminShippingOptions } from "medusa-react" + + const ShippingOptions = () => { + const { + shipping_options, + isLoading + } = useAdminShippingOptions() + + return ( +
+ {isLoading && Loading...} + {shipping_options && !shipping_options.length && ( + No Shipping Options + )} + {shipping_options && shipping_options.length > 0 && ( +
    + {shipping_options.map((option) => ( +
  • {option.name}
    • + ))} +
+ )} +
+ ) + } + + export default ShippingOptions - lang: Shell label: cURL source: | @@ -17628,6 +23555,45 @@ paths: .then(({ shipping_option }) => { console.log(shipping_option.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateShippingOption } from "medusa-react" + + type CreateShippingOption = { + name: string + provider_id: string + data: Record + price_type: string + amount: number + } + + type Props = { + regionId: string + } + + const Region = ({ regionId }: Props) => { + const createShippingOption = useAdminCreateShippingOption() + // ... + + const handleCreate = ( + data: CreateShippingOption + ) => { + createShippingOption.mutate({ + ...data, + region_id: regionId + }, { + onSuccess: ({ shipping_option }) => { + console.log(shipping_option.id) + } + }) + } + + // ... + } + + export default Region - lang: Shell label: cURL source: | @@ -17697,6 +23663,33 @@ paths: .then(({ shipping_option }) => { console.log(shipping_option.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminShippingOption } from "medusa-react" + + type Props = { + shippingOptionId: string + } + + const ShippingOption = ({ shippingOptionId }: Props) => { + const { + shipping_option, + isLoading + } = useAdminShippingOption( + shippingOptionId + ) + + return ( +
+ {isLoading && Loading...} + {shipping_option && {shipping_option.name}} +
+ ) + } + + export default ShippingOption - lang: Shell label: cURL source: | @@ -17771,6 +23764,44 @@ paths: .then(({ shipping_option }) => { console.log(shipping_option.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateShippingOption } from "medusa-react" + + type Props = { + shippingOptionId: string + } + + const ShippingOption = ({ shippingOptionId }: Props) => { + const updateShippingOption = useAdminUpdateShippingOption( + shippingOptionId + ) + // ... + + const handleUpdate = ( + name: string, + requirements: { + id: string, + type: string, + amount: number + }[] + ) => { + updateShippingOption.mutate({ + name, + requirements + }, { + onSuccess: ({ shipping_option }) => { + console.log(shipping_option.requirements) + } + }) + } + + // ... + } + + export default ShippingOption - lang: Shell label: cURL source: | @@ -17842,6 +23873,34 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteShippingOption } from "medusa-react" + + type Props = { + shippingOptionId: string + } + + const ShippingOption = ({ shippingOptionId }: Props) => { + const deleteShippingOption = useAdminDeleteShippingOption( + shippingOptionId + ) + // ... + + const handleDelete = () => { + deleteShippingOption.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default ShippingOption - lang: Shell label: cURL source: | @@ -17896,6 +23955,36 @@ paths: .then(({ shipping_profiles }) => { console.log(shipping_profiles.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminShippingProfiles } from "medusa-react" + + const ShippingProfiles = () => { + const { + shipping_profiles, + isLoading + } = useAdminShippingProfiles() + + return ( +
+ {isLoading && Loading...} + {shipping_profiles && !shipping_profiles.length && ( + No Shipping Profiles + )} + {shipping_profiles && shipping_profiles.length > 0 && ( +
    + {shipping_profiles.map((profile) => ( +
  • {profile.name}
    • + ))} +
+ )} +
+ ) + } + + export default ShippingProfiles - lang: Shell label: cURL source: | @@ -17956,6 +24045,35 @@ paths: .then(({ shipping_profile }) => { console.log(shipping_profile.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { ShippingProfileType } from "@medusajs/medusa" + import { useAdminCreateShippingProfile } from "medusa-react" + + const CreateShippingProfile = () => { + const createShippingProfile = useAdminCreateShippingProfile() + // ... + + const handleCreate = ( + name: string, + type: ShippingProfileType + ) => { + createShippingProfile.mutate({ + name, + type + }, { + onSuccess: ({ shipping_profile }) => { + console.log(shipping_profile.id) + } + }) + } + + // ... + } + + export default CreateShippingProfile - lang: Shell label: cURL source: | @@ -18021,6 +24139,35 @@ paths: .then(({ shipping_profile }) => { console.log(shipping_profile.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminShippingProfile } from "medusa-react" + + type Props = { + shippingProfileId: string + } + + const ShippingProfile = ({ shippingProfileId }: Props) => { + const { + shipping_profile, + isLoading + } = useAdminShippingProfile( + shippingProfileId + ) + + return ( +
+ {isLoading && Loading...} + {shipping_profile && ( + {shipping_profile.name} + )} +
+ ) + } + + export default ShippingProfile - lang: Shell label: cURL source: | @@ -18087,6 +24234,41 @@ paths: .then(({ shipping_profile }) => { console.log(shipping_profile.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { ShippingProfileType } from "@medusajs/medusa" + import { useAdminUpdateShippingProfile } from "medusa-react" + + type Props = { + shippingProfileId: string + } + + const ShippingProfile = ({ shippingProfileId }: Props) => { + const updateShippingProfile = useAdminUpdateShippingProfile( + shippingProfileId + ) + // ... + + const handleUpdate = ( + name: string, + type: ShippingProfileType + ) => { + updateShippingProfile.mutate({ + name, + type + }, { + onSuccess: ({ shipping_profile }) => { + console.log(shipping_profile.name) + } + }) + } + + // ... + } + + export default ShippingProfile - lang: Shell label: cURL source: | @@ -18153,6 +24335,34 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteShippingProfile } from "medusa-react" + + type Props = { + shippingProfileId: string + } + + const ShippingProfile = ({ shippingProfileId }: Props) => { + const deleteShippingProfile = useAdminDeleteShippingProfile( + shippingProfileId + ) + // ... + + const handleDelete = () => { + deleteShippingProfile.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default ShippingProfile - lang: Shell label: cURL source: | @@ -18323,6 +24533,38 @@ paths: .then(({ stock_locations, limit, offset, count }) => { console.log(stock_locations.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminStockLocations } from "medusa-react" + + function StockLocations() { + const { + stock_locations, + isLoading + } = useAdminStockLocations() + + return ( +
+ {isLoading && Loading...} + {stock_locations && !stock_locations.length && ( + No Locations + )} + {stock_locations && stock_locations.length > 0 && ( +
    + {stock_locations.map( + (location) => ( +
  • {location.name}
    • + ) + )} +
+ )} +
+ ) + } + + export default StockLocations - lang: Shell label: cURL source: | @@ -18398,6 +24640,30 @@ paths: .then(({ stock_location }) => { console.log(stock_location.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateStockLocation } from "medusa-react" + + const CreateStockLocation = () => { + const createStockLocation = useAdminCreateStockLocation() + // ... + + const handleCreate = (name: string) => { + createStockLocation.mutate({ + name, + }, { + onSuccess: ({ stock_location }) => { + console.log(stock_location.id) + } + }) + } + + // ... + } + + export default CreateStockLocation - lang: Shell label: cURL source: | @@ -18478,6 +24744,33 @@ paths: .then(({ stock_location }) => { console.log(stock_location.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminStockLocation } from "medusa-react" + + type Props = { + stockLocationId: string + } + + const StockLocation = ({ stockLocationId }: Props) => { + const { + stock_location, + isLoading + } = useAdminStockLocation(stockLocationId) + + return ( +
+ {isLoading && Loading...} + {stock_location && ( + {stock_location.name} + )} +
+ ) + } + + export default StockLocation - lang: Shell label: cURL source: | @@ -18547,6 +24840,36 @@ paths: .then(({ stock_location }) => { console.log(stock_location.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateStockLocation } from "medusa-react" + + type Props = { + stockLocationId: string + } + + const StockLocation = ({ stockLocationId }: Props) => { + const updateLocation = useAdminUpdateStockLocation( + stockLocationId + ) + // ... + + const handleUpdate = ( + name: string + ) => { + updateLocation.mutate({ + name + }, { + onSuccess: ({ stock_location }) => { + console.log(stock_location.name) + } + }) + } + } + + export default StockLocation - lang: Shell label: cURL source: | @@ -18609,6 +24932,32 @@ paths: .then(({ id, object, deleted }) => { console.log(id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteStockLocation } from "medusa-react" + + type Props = { + stockLocationId: string + } + + const StockLocation = ({ stockLocationId }: Props) => { + const deleteLocation = useAdminDeleteStockLocation( + stockLocationId + ) + // ... + + const handleDelete = () => { + deleteLocation.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + } + + export default StockLocation - lang: Shell label: cURL source: | @@ -18653,6 +25002,27 @@ paths: .then(({ store }) => { console.log(store.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminStore } from "medusa-react" + + const Store = () => { + const { + store, + isLoading + } = useAdminStore() + + return ( +
+ {isLoading && Loading...} + {store && {store.name}} +
+ ) + } + + export default Store - lang: Shell label: cURL source: | @@ -18713,6 +25083,30 @@ paths: .then(({ store }) => { console.log(store.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateStore } from "medusa-react" + + function Store() { + const updateStore = useAdminUpdateStore() + // ... + + const handleUpdate = ( + name: string + ) => { + updateStore.mutate({ + name + }, { + onSuccess: ({ store }) => { + console.log(store.name) + } + }) + } + } + + export default Store - lang: Shell label: cURL source: | @@ -18785,6 +25179,28 @@ paths: .then(({ store }) => { console.log(store.currencies); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminAddStoreCurrency } from "medusa-react" + + const Store = () => { + const addCurrency = useAdminAddStoreCurrency() + // ... + + const handleAdd = (code: string) => { + addCurrency.mutate(code, { + onSuccess: ({ store }) => { + console.log(store.currencies) + } + }) + } + + // ... + } + + export default Store - lang: Shell label: cURL source: > @@ -18853,6 +25269,28 @@ paths: .then(({ store }) => { console.log(store.currencies); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteStoreCurrency } from "medusa-react" + + const Store = () => { + const deleteCurrency = useAdminDeleteStoreCurrency() + // ... + + const handleAdd = (code: string) => { + deleteCurrency.mutate(code, { + onSuccess: ({ store }) => { + console.log(store.currencies) + } + }) + } + + // ... + } + + export default Store - lang: Shell label: cURL source: > @@ -18909,6 +25347,37 @@ paths: .then(({ payment_providers }) => { console.log(payment_providers.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminStorePaymentProviders } from "medusa-react" + + const PaymentProviders = () => { + const { + payment_providers, + isLoading + } = useAdminStorePaymentProviders() + + return ( +
+ {isLoading && Loading...} + {payment_providers && !payment_providers.length && ( + No Payment Providers + )} + {payment_providers && + payment_providers.length > 0 &&( +
    + {payment_providers.map((provider) => ( +
  • {provider.id}
    • + ))} +
+ )} +
+ ) + } + + export default PaymentProviders - lang: Shell label: cURL source: | @@ -18963,6 +25432,37 @@ paths: .then(({ tax_providers }) => { console.log(tax_providers.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminStoreTaxProviders } from "medusa-react" + + const TaxProviders = () => { + const { + tax_providers, + isLoading + } = useAdminStoreTaxProviders() + + return ( +
+ {isLoading && Loading...} + {tax_providers && !tax_providers.length && ( + No Tax Providers + )} + {tax_providers && + tax_providers.length > 0 &&( +
    + {tax_providers.map((provider) => ( +
  • {provider.id}
    • + ))} +
+ )} +
+ ) + } + + export default TaxProviders - lang: Shell label: cURL source: | @@ -19031,6 +25531,31 @@ paths: .then(({ swaps }) => { console.log(swaps.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminSwaps } from "medusa-react" + + const Swaps = () => { + const { swaps, isLoading } = useAdminSwaps() + + return ( +
+ {isLoading && Loading...} + {swaps && !swaps.length && No Swaps} + {swaps && swaps.length > 0 && ( +
    + {swaps.map((swap) => ( +
  • {swap.payment_status}
    • + ))} +
+ )} +
+ ) + } + + export default Swaps - lang: Shell label: cURL source: | @@ -19092,6 +25617,28 @@ paths: .then(({ swap }) => { console.log(swap.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminSwap } from "medusa-react" + + type Props = { + swapId: string + } + + const Swap = ({ swapId }: Props) => { + const { swap, isLoading } = useAdminSwap(swapId) + + return ( +
+ {isLoading && Loading...} + {swap && {swap.id}} +
+ ) + } + + export default Swap - lang: Shell label: cURL source: | @@ -19227,6 +25774,36 @@ paths: .then(({ tax_rates, limit, offset, count }) => { console.log(tax_rates.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminTaxRates } from "medusa-react" + + const TaxRates = () => { + const { + tax_rates, + isLoading + } = useAdminTaxRates() + + return ( +
+ {isLoading && Loading...} + {tax_rates && !tax_rates.length && ( + No Tax Rates + )} + {tax_rates && tax_rates.length > 0 && ( +
    + {tax_rates.map((tax_rate) => ( +
  • {tax_rate.code}
    • + ))} +
+ )} +
+ ) + } + + export default TaxRates - lang: Shell label: cURL source: | @@ -19313,6 +25890,41 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateTaxRate } from "medusa-react" + + type Props = { + regionId: string + } + + const CreateTaxRate = ({ regionId }: Props) => { + const createTaxRate = useAdminCreateTaxRate() + // ... + + const handleCreate = ( + code: string, + name: string, + rate: number + ) => { + createTaxRate.mutate({ + code, + name, + region_id: regionId, + rate, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.id) + } + }) + } + + // ... + } + + export default CreateTaxRate - lang: Shell label: cURL source: | @@ -19403,6 +26015,28 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminTaxRate } from "medusa-react" + + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { + const { tax_rate, isLoading } = useAdminTaxRate(taxRateId) + + return ( +
+ {isLoading && Loading...} + {tax_rate && {tax_rate.code}} +
+ ) + } + + export default TaxRate - lang: Shell label: cURL source: | @@ -19493,6 +26127,36 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateTaxRate } from "medusa-react" + + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { + const updateTaxRate = useAdminUpdateTaxRate(taxRateId) + // ... + + const handleUpdate = ( + name: string + ) => { + updateTaxRate.mutate({ + name + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.name) + } + }) + } + + // ... + } + + export default TaxRate - lang: Shell label: cURL source: | @@ -19559,6 +26223,32 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteTaxRate } from "medusa-react" + + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { + const deleteTaxRate = useAdminDeleteTaxRate(taxRateId) + // ... + + const handleDelete = () => { + deleteTaxRate.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default TaxRate - lang: Shell label: cURL source: | @@ -19652,6 +26342,38 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminCreateProductTypeTaxRates, + } from "medusa-react" + + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { + const addProductTypes = useAdminCreateProductTypeTaxRates( + taxRateId + ) + // ... + + const handleAddProductTypes = (productTypeIds: string[]) => { + addProductTypes.mutate({ + product_types: productTypeIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.product_types) + } + }) + } + + // ... + } + + export default TaxRate - lang: Shell label: cURL source: > @@ -19757,6 +26479,40 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { + useAdminDeleteProductTypeTaxRates, + } from "medusa-react" + + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { + const removeProductTypes = useAdminDeleteProductTypeTaxRates( + taxRateId + ) + // ... + + const handleRemoveProductTypes = ( + productTypeIds: string[] + ) => { + removeProductTypes.mutate({ + product_types: productTypeIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.product_types) + } + }) + } + + // ... + } + + export default TaxRate - lang: Shell label: cURL source: > @@ -19860,6 +26616,34 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateProductTaxRates } from "medusa-react" + + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { + const addProduct = useAdminCreateProductTaxRates(taxRateId) + // ... + + const handleAddProduct = (productIds: string[]) => { + addProduct.mutate({ + products: productIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.products) + } + }) + } + + // ... + } + + export default TaxRate - lang: Shell label: cURL source: | @@ -19960,6 +26744,34 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteProductTaxRates } from "medusa-react" + + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { + const removeProduct = useAdminDeleteProductTaxRates(taxRateId) + // ... + + const handleRemoveProduct = (productIds: string[]) => { + removeProduct.mutate({ + products: productIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.products) + } + }) + } + + // ... + } + + export default TaxRate - lang: Shell label: cURL source: | @@ -20059,6 +26871,38 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateShippingTaxRates } from "medusa-react" + + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { + const addShippingOption = useAdminCreateShippingTaxRates( + taxRateId + ) + // ... + + const handleAddShippingOptions = ( + shippingOptionIds: string[] + ) => { + addShippingOption.mutate({ + shipping_options: shippingOptionIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.shipping_options) + } + }) + } + + // ... + } + + export default TaxRate - lang: Shell label: cURL source: > @@ -20165,6 +27009,38 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteShippingTaxRates } from "medusa-react" + + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { + const removeShippingOptions = useAdminDeleteShippingTaxRates( + taxRateId + ) + // ... + + const handleRemoveShippingOptions = ( + shippingOptionIds: string[] + ) => { + removeShippingOptions.mutate({ + shipping_options: shippingOptionIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.shipping_options) + } + }) + } + + // ... + } + + export default TaxRate - lang: Shell label: cURL source: > @@ -20238,6 +27114,28 @@ paths: .then(({ uploads }) => { console.log(uploads.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUploadFile } from "medusa-react" + + const UploadFile = () => { + const uploadFile = useAdminUploadFile() + // ... + + const handleFileUpload = (file: File) => { + uploadFile.mutate(file, { + onSuccess: ({ uploads }) => { + console.log(uploads[0].key) + } + }) + } + + // ... + } + + export default UploadFile - lang: Shell label: cURL source: | @@ -20301,6 +27199,30 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteFile } from "medusa-react" + + const Image = () => { + const deleteFile = useAdminDeleteFile() + // ... + + const handleDeleteFile = (fileKey: string) => { + deleteFile.mutate({ + file_key: fileKey + }, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default Image - lang: Shell label: cURL source: | @@ -20367,6 +27289,30 @@ paths: .then(({ download_url }) => { console.log(download_url); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreatePresignedDownloadUrl } from "medusa-react" + + const Image = () => { + const createPresignedUrl = useAdminCreatePresignedDownloadUrl() + // ... + + const handlePresignedUrl = (fileKey: string) => { + createPresignedUrl.mutate({ + file_key: fileKey + }, { + onSuccess: ({ download_url }) => { + console.log(download_url) + } + }) + } + + // ... + } + + export default Image - lang: Shell label: cURL source: | @@ -20434,6 +27380,28 @@ paths: .then(({ uploads }) => { console.log(uploads.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUploadProtectedFile } from "medusa-react" + + const UploadFile = () => { + const uploadFile = useAdminUploadProtectedFile() + // ... + + const handleFileUpload = (file: File) => { + uploadFile.mutate(file, { + onSuccess: ({ uploads }) => { + console.log(uploads[0].key) + } + }) + } + + // ... + } + + export default UploadFile - lang: Shell label: cURL source: | @@ -20491,6 +27459,31 @@ paths: .then(({ users }) => { console.log(users.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUsers } from "medusa-react" + + const Users = () => { + const { users, isLoading } = useAdminUsers() + + return ( +
+ {isLoading && Loading...} + {users && !users.length && No Users} + {users && users.length > 0 && ( +
    + {users.map((user) => ( +
  • {user.email}
    • + ))} +
+ )} +
+ ) + } + + export default Users - lang: Shell label: cURL source: | @@ -20555,6 +27548,31 @@ paths: .then(({ user }) => { console.log(user.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminCreateUser } from "medusa-react" + + const CreateUser = () => { + const createUser = useAdminCreateUser() + // ... + + const handleCreateUser = () => { + createUser.mutate({ + email: "user@example.com", + password: "supersecret", + }, { + onSuccess: ({ user }) => { + console.log(user.id) + } + }) + } + + // ... + } + + export default CreateUser - lang: Shell label: cURL source: | @@ -20636,6 +27654,32 @@ paths: .catch(() => { // error occurred }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminSendResetPasswordToken } from "medusa-react" + + const Login = () => { + const requestPasswordReset = useAdminSendResetPasswordToken() + // ... + + const handleResetPassword = ( + email: string + ) => { + requestPasswordReset.mutate({ + email + }, { + onSuccess: () => { + // successful + } + }) + } + + // ... + } + + export default Login - lang: Shell label: cURL source: | @@ -20704,6 +27748,34 @@ paths: .then(({ user }) => { console.log(user.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminResetPassword } from "medusa-react" + + const ResetPassword = () => { + const resetPassword = useAdminResetPassword() + // ... + + const handleResetPassword = ( + token: string, + password: string + ) => { + resetPassword.mutate({ + token, + password, + }, { + onSuccess: ({ user }) => { + console.log(user.id) + } + }) + } + + // ... + } + + export default ResetPassword - lang: Shell label: cURL source: | @@ -20770,6 +27842,30 @@ paths: .then(({ user }) => { console.log(user.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUser } from "medusa-react" + + type Props = { + userId: string + } + + const User = ({ userId }: Props) => { + const { user, isLoading } = useAdminUser( + userId + ) + + return ( +
+ {isLoading && Loading...} + {user && {user.first_name} {user.last_name}} +
+ ) + } + + export default User - lang: Shell label: cURL source: | @@ -20837,6 +27933,36 @@ paths: .then(({ user }) => { console.log(user.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminUpdateUser } from "medusa-react" + + type Props = { + userId: string + } + + const User = ({ userId }: Props) => { + const updateUser = useAdminUpdateUser(userId) + // ... + + const handleUpdateUser = ( + firstName: string + ) => { + updateUser.mutate({ + first_name: firstName, + }, { + onSuccess: ({ user }) => { + console.log(user.first_name) + } + }) + } + + // ... + } + + export default User - lang: Shell label: cURL source: | @@ -20903,6 +28029,32 @@ paths: .then(({ id, object, deleted }) => { console.log(id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminDeleteUser } from "medusa-react" + + type Props = { + userId: string + } + + const User = ({ userId }: Props) => { + const deleteUser = useAdminDeleteUser(userId) + // ... + + const handleDeleteUser = () => { + deleteUser.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) + } + + // ... + } + + export default User - lang: Shell label: cURL source: | @@ -21084,6 +28236,33 @@ paths: .then(({ variants, limit, offset, count }) => { console.log(variants.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminVariants } from "medusa-react" + + const Variants = () => { + const { variants, isLoading } = useAdminVariants() + + return ( +
+ {isLoading && Loading...} + {variants && !variants.length && ( + No Variants + )} + {variants && variants.length > 0 && ( +
    + {variants.map((variant) => ( +
  • {variant.title}
    • + ))} +
+ )} +
+ ) + } + + export default Variants - lang: Shell label: cURL source: | @@ -21160,6 +28339,30 @@ paths: .then(({ variant }) => { console.log(variant.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminVariant } from "medusa-react" + + type Props = { + variantId: string + } + + const Variant = ({ variantId }: Props) => { + const { variant, isLoading } = useAdminVariant( + variantId + ) + + return ( +
+ {isLoading && Loading...} + {variant && {variant.title}} +
+ ) + } + + export default Variant - lang: Shell label: cURL source: | @@ -21221,6 +28424,39 @@ paths: .then(({ variant }) => { console.log(variant.inventory, variant.sales_channel_availability) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAdminVariantsInventory } from "medusa-react" + + type Props = { + variantId: string + } + + const VariantInventory = ({ variantId }: Props) => { + const { variant, isLoading } = useAdminVariantsInventory( + variantId + ) + + return ( +
+ {isLoading && Loading...} + {variant && variant.inventory.length === 0 && ( + Variant doesn't have inventory details + )} + {variant && variant.inventory.length > 0 && ( +
    + {variant.inventory.map((inventory) => ( +
  • {inventory.title}
    • + ))} +
+ )} +
+ ) + } + + export default VariantInventory - lang: Shell label: cURL source: | @@ -21903,6 +29139,7 @@ components: $ref: '#/components/schemas/Customer' AdminDeleteCustomerGroupsGroupCustomerBatchReq: type: object + description: The customers to remove from the customer group. required: - customer_ids properties: @@ -21936,14 +29173,16 @@ components: type: string AdminDeletePriceListPricesPricesReq: type: object + description: The details of the prices to delete. properties: price_ids: - description: The price IDs of the Money Amounts to delete. + description: The IDs of the prices to delete. type: array items: type: string AdminDeletePriceListsPriceListProductsPricesBatchReq: type: object + description: The details of the products' prices to delete. properties: product_ids: description: The IDs of the products to delete their associated prices. @@ -21952,11 +29191,12 @@ components: type: string AdminDeleteProductCategoriesCategoryProductsBatchReq: type: object + description: The details of the products to delete from the product category. required: - product_ids properties: product_ids: - description: The IDs of the products to delete from the Product Category. + description: The IDs of the products to delete from the product category. type: array items: type: object @@ -21968,6 +29208,7 @@ components: type: string AdminDeleteProductsFromCollectionReq: type: object + description: The details of the products to remove from the collection. required: - product_ids properties: @@ -22000,6 +29241,9 @@ components: type: string AdminDeletePublishableApiKeySalesChannelsBatchReq: type: object + description: >- + The details of the sales channels to remove from the publishable API + key. required: - sales_channel_ids properties: @@ -22016,11 +29260,12 @@ components: description: The ID of the sales channel AdminDeleteSalesChannelsChannelProductsBatchReq: type: object + description: The details of the products to delete from the sales channel. required: - product_ids properties: product_ids: - description: The IDs of the products to remove from the Sales Channel. + description: The IDs of the products to remove from the sales channel. type: array items: type: object @@ -22071,6 +29316,9 @@ components: type: string AdminDeleteTaxRatesTaxRateProductsReq: type: object + description: >- + The details of the products to remove their associated with the tax + rate. required: - products properties: @@ -22083,6 +29331,9 @@ components: type: string AdminDeleteTaxRatesTaxRateShippingOptionsReq: type: object + description: >- + The details of the shipping options to remove their associate with the + tax rate. required: - shipping_options properties: @@ -22095,6 +29346,7 @@ components: type: string AdminDeleteUploadsReq: type: object + description: The details of the file to delete. required: - file_key properties: @@ -23097,6 +30349,7 @@ components: default: true AdminPaymentCollectionsRes: type: object + description: The payment collection's details. x-expanded-relations: field: payment_collection relations: @@ -23150,6 +30403,7 @@ components: description: The code for the generated token. AdminPostAuthReq: type: object + description: The admin's credentials used to log in. required: - email - password @@ -23164,6 +30418,7 @@ components: format: password AdminPostBatchesReq: type: object + description: The details of the batch job to create. required: - type - context @@ -23203,6 +30458,7 @@ components: default: false AdminPostCollectionsCollectionReq: type: object + description: The product collection's details to update. properties: title: type: string @@ -23223,6 +30479,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostCollectionsReq: type: object + description: The product collection's details. required: - title properties: @@ -23245,6 +30502,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostCurrenciesCurrencyReq: type: object + description: The details to update in the currency properties: includes_tax: type: boolean @@ -23252,6 +30510,7 @@ components: description: Tax included in prices of currency. AdminPostCustomerGroupsGroupCustomersBatchReq: type: object + description: The customers to add to the customer group. required: - customer_ids properties: @@ -23268,6 +30527,7 @@ components: type: string AdminPostCustomerGroupsGroupReq: type: object + description: The details to update in the customer group. properties: name: description: Name of the customer group @@ -23283,6 +30543,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostCustomerGroupsReq: type: object + description: The details of the customer group to create. required: - name properties: @@ -23300,6 +30561,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostCustomersCustomerReq: type: object + description: The details of the customer to update. properties: email: type: string @@ -23342,6 +30604,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostCustomersReq: type: object + description: The details of the customer to create. required: - email - first_name @@ -23452,6 +30715,7 @@ components: type: string AdminPostDiscountsDiscountConditionsConditionBatchReq: type: object + description: The details of the resources to add. required: - resources properties: @@ -23468,6 +30732,7 @@ components: type: string AdminPostDiscountsDiscountDynamicCodesReq: type: object + description: The details of the dynamic discount to create. required: - code properties: @@ -23489,6 +30754,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostDiscountsDiscountReq: type: object + description: The details of the discount to update. properties: code: type: string @@ -23618,6 +30884,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostDiscountsReq: type: object + description: The details of the discount to create. required: - code - rule @@ -23766,6 +31033,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostDraftOrdersDraftOrderLineItemsItemReq: type: object + description: The details to update of the line item. properties: unit_price: description: >- @@ -23791,6 +31059,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostDraftOrdersDraftOrderLineItemsReq: type: object + description: The details of the line item to create. required: - quantity properties: @@ -23833,6 +31102,7 @@ components: $ref: '#/components/schemas/Order' AdminPostDraftOrdersDraftOrderReq: type: object + description: The details of the draft order to update. properties: region_id: type: string @@ -23880,6 +31150,7 @@ components: type: string AdminPostDraftOrdersReq: type: object + description: The details of the draft order to create. required: - email - region_id @@ -23998,6 +31269,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostGiftCardsGiftCardReq: type: object + description: The details to update of the gift card. properties: balance: type: integer @@ -24027,6 +31299,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostGiftCardsReq: type: object + description: The details of the gift card to create. required: - region_id properties: @@ -24131,6 +31404,7 @@ components: type: number AdminPostInventoryItemsItemLocationLevelsReq: type: object + description: The details of the location level to create. required: - location_id - stocked_quantity @@ -24146,6 +31420,7 @@ components: type: number AdminPostInventoryItemsReq: type: object + description: The details of the inventory item to create. required: - variant_id properties: @@ -24294,6 +31569,7 @@ components: - developer AdminPostNotesNoteReq: type: object + description: The details to update of the note. required: - value properties: @@ -24302,6 +31578,7 @@ components: description: The description of the Note. AdminPostNotesReq: type: object + description: The details of the note to be created. required: - resource_id - resource_type @@ -24322,6 +31599,7 @@ components: description: The content of the Note to create. AdminPostNotificationsNotificationResendReq: type: object + description: The resend details. properties: to: description: >- @@ -24331,6 +31609,7 @@ components: type: string AdminPostOrderEditsEditLineItemsLineItemReq: type: object + description: The details to create or update of the line item change. required: - quantity properties: @@ -24339,6 +31618,7 @@ components: type: number AdminPostOrderEditsEditLineItemsReq: type: object + description: The details of the line item change to create. required: - variant_id - quantity @@ -24360,12 +31640,14 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostOrderEditsOrderEditReq: type: object + description: The details to update of the order edit. properties: internal_note: description: An optional note to create or update in the order edit. type: string AdminPostOrderEditsReq: type: object + description: The details of the order edit to create. required: - order_id properties: @@ -24679,6 +31961,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostOrdersOrderRefundsReq: type: object + description: The details of the order refund. required: - amount - reason @@ -24701,6 +31984,7 @@ components: type: boolean AdminPostOrdersOrderReq: type: object + description: The details to update of the order. properties: email: description: The email associated with the order @@ -24765,6 +32049,7 @@ components: type: boolean AdminPostOrdersOrderReturnsReq: type: object + description: The details of the requested return. required: - items properties: @@ -24823,6 +32108,7 @@ components: type: string AdminPostOrdersOrderShipmentReq: type: object + description: The details of the shipment to create. required: - fulfillment_id properties: @@ -24861,6 +32147,7 @@ components: Method. This depends on the Fulfillment Provider. AdminPostOrdersOrderSwapsReq: type: object + description: The details of the swap to create. required: - return_items properties: @@ -24984,6 +32271,7 @@ components: type: boolean AdminPostPaymentRefundsReq: type: object + description: The details of the refund to create. required: - amount - reason @@ -24999,6 +32287,7 @@ components: type: string AdminPostPriceListPricesPricesReq: type: object + description: The details of the prices to add. properties: prices: description: The prices to update or add. @@ -25044,6 +32333,7 @@ components: type: boolean AdminPostPriceListsPriceListPriceListReq: type: object + description: The details to update of the payment collection. properties: name: description: The name of the Price List @@ -25128,6 +32418,7 @@ components: type: boolean AdminPostPriceListsPriceListReq: type: object + description: The details of the price list to create. required: - name - description @@ -25214,11 +32505,12 @@ components: type: boolean AdminPostProductCategoriesCategoryProductsBatchReq: type: object + description: The details of the products to add to the product category. required: - product_ids properties: product_ids: - description: The IDs of the products to add to the Product Category + description: The IDs of the products to add to the product category type: array items: type: object @@ -25230,6 +32522,7 @@ components: description: The ID of the product AdminPostProductCategoriesCategoryReq: type: object + description: The details to update of the product category. properties: name: type: string @@ -25263,6 +32556,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostProductCategoriesReq: type: object + description: The details of the product category to create. required: - name properties: @@ -25322,6 +32616,7 @@ components: type: string AdminPostProductsProductOptionsReq: type: object + description: The details of the product option to create. required: - title properties: @@ -25331,6 +32626,7 @@ components: example: Size AdminPostProductsProductReq: type: object + description: The details to update of the product. properties: title: description: The title of the Product @@ -25609,6 +32905,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostProductsProductVariantsReq: type: object + description: The details of the product variant to create. required: - title - prices @@ -25854,6 +33151,7 @@ components: type: string AdminPostProductsReq: type: object + description: The details of the product to create. required: - title properties: @@ -26152,6 +33450,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostProductsToCollectionReq: type: object + description: The details of the products to add to the collection. required: - product_ids properties: @@ -26163,6 +33462,7 @@ components: type: string AdminPostPublishableApiKeySalesChannelsBatchReq: type: object + description: The details of the sales channels to add to the publishable API key. required: - sales_channel_ids properties: @@ -26179,12 +33479,14 @@ components: description: The ID of the sales channel AdminPostPublishableApiKeysPublishableApiKeyReq: type: object + description: The details to update of the publishable API key. properties: title: description: The title of the Publishable API Key. type: string AdminPostPublishableApiKeysReq: type: object + description: The details of the publishable API key to create. required: - title properties: @@ -26193,6 +33495,7 @@ components: type: string AdminPostRegionsRegionCountriesReq: type: object + description: The details of the country to add to the region. required: - country_code properties: @@ -26205,6 +33508,7 @@ components: description: See a list of codes. AdminPostRegionsRegionFulfillmentProvidersReq: type: object + description: The details of the fulfillment provider to add to the region. required: - provider_id properties: @@ -26213,6 +33517,7 @@ components: type: string AdminPostRegionsRegionPaymentProvidersReq: type: object + description: The details of the payment provider to add to the region. required: - provider_id properties: @@ -26221,6 +33526,7 @@ components: type: string AdminPostRegionsRegionReq: type: object + description: The details to update of the regions. properties: name: description: The name of the Region @@ -26278,6 +33584,7 @@ components: type: string AdminPostRegionsReq: type: object + description: The details of the region to create. required: - name - currency_code @@ -26326,6 +33633,7 @@ components: type: boolean AdminPostReservationsReq: type: object + description: The details of the reservation to create. required: - location_id - inventory_item_id @@ -26357,6 +33665,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostReservationsReservationReq: type: object + description: The details to update of the reservation. properties: location_id: description: The ID of the location associated with the reservation. @@ -26378,6 +33687,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostReturnReasonsReasonReq: type: object + description: The details to update of the return reason. properties: label: description: The label to display to the Customer. @@ -26399,6 +33709,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostReturnReasonsReq: type: object + description: The details of the return reason to create. required: - label - value @@ -26426,6 +33737,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostReturnsReturnReceiveReq: type: object + description: The details of the received return. required: - items properties: @@ -26452,11 +33764,12 @@ components: type: string AdminPostSalesChannelsChannelProductsBatchReq: type: object + description: The details of the products to add to the sales channel. required: - product_ids properties: product_ids: - description: The IDs of the products to add to the Sales Channel + description: The IDs of the products to add to the sales channel type: array items: type: object @@ -26476,6 +33789,7 @@ components: type: string AdminPostSalesChannelsReq: type: object + description: The details of the sales channel to create. required: - name properties: @@ -26490,6 +33804,7 @@ components: type: boolean AdminPostSalesChannelsSalesChannelReq: type: object + description: The details to update of the sales channel. properties: name: type: string @@ -26502,6 +33817,7 @@ components: description: Whether the Sales Channel is disabled. AdminPostShippingOptionsOptionReq: type: object + description: The details to update of the shipping option. required: - requirements properties: @@ -26560,6 +33876,7 @@ components: type: boolean AdminPostShippingOptionsReq: type: object + description: The details of the shipping option to create. required: - name - region_id @@ -26645,6 +33962,7 @@ components: type: boolean AdminPostShippingProfilesProfileReq: type: object + description: The detail to update of the shipping profile. properties: name: description: The name of the Shipping Profile @@ -26673,6 +33991,7 @@ components: type: array AdminPostShippingProfilesReq: type: object + description: The details of the shipping profile to create. required: - name - type @@ -26698,6 +34017,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostStockLocationsLocationReq: type: object + description: The details to update of the stock location. properties: name: description: the name of the stock location @@ -26721,6 +34041,7 @@ components: $ref: '#/components/schemas/StockLocationAddressInput' AdminPostStockLocationsReq: type: object + description: The details of the stock location to create. required: - name properties: @@ -26790,6 +34111,7 @@ components: example: Sinaloa AdminPostStoreReq: type: object + description: The details to update of the store. properties: name: description: The name of the Store @@ -26839,6 +34161,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostTaxRatesReq: type: object + description: The details of the tax rate to create. required: - code - name @@ -26884,6 +34207,7 @@ components: type: string AdminPostTaxRatesTaxRateProductsReq: type: object + description: The details of the products to associat with the tax rate. required: - products properties: @@ -26894,6 +34218,7 @@ components: type: string AdminPostTaxRatesTaxRateReq: type: object + description: The details to update of the tax rate. properties: code: type: string @@ -26924,6 +34249,7 @@ components: type: string AdminPostTaxRatesTaxRateShippingOptionsReq: type: object + description: The details of the shipping options to associate with the tax rate. required: - shipping_options properties: @@ -26934,6 +34260,7 @@ components: type: string AdminPostUploadsDownloadUrlReq: type: object + description: The details of the file to retrieve its download URL. required: - file_key properties: @@ -27604,6 +34931,7 @@ components: $ref: '#/components/schemas/ReservationItemDTO' AdminResetPasswordRequest: type: object + description: The details of the password reset request. required: - token - password @@ -27623,6 +34951,7 @@ components: format: password AdminResetPasswordTokenRequest: type: object + description: The details of the password reset token request. required: - email properties: @@ -27968,6 +35297,7 @@ components: properties: stock_locations: type: array + description: The list of stock locations. items: $ref: '#/components/schemas/StockLocationExpandedDTO' count: @@ -28112,6 +35442,7 @@ components: $ref: '#/components/schemas/TaxRate' AdminUpdatePaymentCollectionsReq: type: object + description: The details to update of the payment collection. properties: description: description: A description to create or update the payment collection. diff --git a/www/apps/api-reference/specs/admin/paths/admin_auth.yaml b/www/apps/api-reference/specs/admin/paths/admin_auth.yaml index e2018ecdb5e0e..b4c2e8f4f1710 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_auth.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_auth.yaml @@ -10,6 +10,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_auth/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_auth/getundefined - lang: Shell label: cURL source: @@ -60,6 +64,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_auth/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_auth/postundefined - lang: Shell label: cURL source: @@ -101,6 +109,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_auth/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_auth/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_batch-jobs.yaml b/www/apps/api-reference/specs/admin/paths/admin_batch-jobs.yaml index 833dc09b6482a..faff8f3c18233 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_batch-jobs.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_batch-jobs.yaml @@ -235,6 +235,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_batch-jobs/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_batch-jobs/getundefined - lang: Shell label: cURL source: @@ -287,6 +291,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_batch-jobs/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_batch-jobs/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}.yaml index 0a90b4937f09f..7c0267d11cc9b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_batch-jobs_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_batch-jobs_{id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}_cancel.yaml index 903bf34307bf7..275f30edb75ba 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}_cancel.yaml @@ -19,6 +19,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_batch-jobs_{id}_cancel/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_batch-jobs_{id}_cancel/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}_confirm.yaml index e0b5031b40435..2803f0e740fa6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}_confirm.yaml @@ -20,6 +20,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_batch-jobs_{id}_confirm/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_batch-jobs_{id}_confirm/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml index 5e4e5d81d9c7b..d1d384a300b3b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml @@ -113,6 +113,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_collections/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_collections/getundefined - lang: Shell label: cURL source: @@ -159,6 +163,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_collections/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_collections/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml index b14e49c3b708b..39692b09049af 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml @@ -19,6 +19,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_collections_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_collections_{id}/getundefined - lang: Shell label: cURL source: @@ -72,6 +76,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_collections_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_collections_{id}/postundefined - lang: Shell label: cURL source: @@ -120,6 +128,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_collections_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_collections_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products_batch.yaml index 6b5c104f7eba3..b22423ec05061 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products_batch.yaml @@ -23,6 +23,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_collections_{id}_products_batch/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_collections_{id}_products_batch/postundefined - lang: Shell label: cURL source: @@ -79,6 +84,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_collections_{id}_products_batch/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_collections_{id}_products_batch/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml index 55114ee20571b..ebc510fe9a69a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml @@ -42,6 +42,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_currencies/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_currencies/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml b/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml index 4f6752a96ee8e..b8ea4d9738ab7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml @@ -22,6 +22,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_currencies_{code}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_currencies_{code}/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml index 724adab038e73..aa98753fd0ebf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml @@ -133,6 +133,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_customer-groups/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_customer-groups/getundefined - lang: Shell label: cURL source: @@ -179,6 +183,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_customer-groups/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_customer-groups/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml index 46ececd9bd64f..607b8bd1875e0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml @@ -34,6 +34,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_customer-groups_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_customer-groups_{id}/getundefined - lang: Shell label: cURL source: @@ -87,6 +91,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_customer-groups_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_customer-groups_{id}/postundefined - lang: Shell label: cURL source: @@ -137,6 +145,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_customer-groups_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_customer-groups_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml index 2538dabea638f..dbf71cceb70f5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml @@ -44,6 +44,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_customer-groups_{id}_customers/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_customer-groups_{id}_customers/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers_batch.yaml index 594edf81aba1c..156e819ad36d6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers_batch.yaml @@ -24,6 +24,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_customer-groups_{id}_customers_batch/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_customer-groups_{id}_customers_batch/postundefined - lang: Shell label: cURL source: @@ -82,6 +87,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_customer-groups_{id}_customers_batch/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_customer-groups_{id}_customers_batch/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml index c5ec96ce6a1c6..c0f48ddb61a31 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -47,6 +47,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_customers/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_customers/getundefined - lang: Shell label: cURL source: @@ -93,6 +97,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_customers/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_customers/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml index 280882dd8fcdb..7be8cd5827ad1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml @@ -29,6 +29,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_customers_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_customers_{id}/getundefined - lang: Shell label: cURL source: @@ -96,6 +100,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_customers_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_customers_{id}/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts.yaml index 52013a8b64007..4002e4822f483 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts.yaml @@ -67,6 +67,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_discounts/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_discounts/getundefined - lang: Shell label: cURL source: @@ -131,6 +135,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_discounts/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_discounts/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts_code_{code}.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts_code_{code}.yaml index 387b53f21ab98..46f9df2596331 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts_code_{code}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts_code_{code}.yaml @@ -30,6 +30,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_discounts_code_{code}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_discounts_code_{code}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions.yaml index 48711b426b33c..6747c77b1700b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions.yaml @@ -41,6 +41,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_discounts_{discount_id}_conditions/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_discounts_{discount_id}_conditions/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}.yaml index 91fd9659be4d9..47f6e081a04b4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}.yaml @@ -39,6 +39,11 @@ get: source: $ref: >- ../code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/getundefined - lang: Shell label: cURL source: @@ -119,6 +124,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/postundefined - lang: Shell label: cURL source: @@ -190,6 +200,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}_batch.yaml index 256b97e5c2423..332bf4680991c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}_batch.yaml @@ -47,6 +47,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}_batch/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}_batch/postundefined - lang: Shell label: cURL source: @@ -124,6 +129,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}_batch/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_discounts_{discount_id}_conditions_{condition_id}_batch/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}.yaml index 173c0a61a6906..6b1c16ffb65a2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}.yaml @@ -30,6 +30,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_discounts_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_discounts_{id}/getundefined - lang: Shell label: cURL source: @@ -100,6 +104,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_discounts_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_discounts_{id}/postundefined - lang: Shell label: cURL source: @@ -150,6 +158,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_discounts_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_discounts_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}_dynamic-codes.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}_dynamic-codes.yaml index 4cfa69d06d1b2..ed5e27774526e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}_dynamic-codes.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}_dynamic-codes.yaml @@ -25,6 +25,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_discounts_{id}_dynamic-codes/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_discounts_{id}_dynamic-codes/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}_dynamic-codes_{code}.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}_dynamic-codes_{code}.yaml index c91926aa95e9f..a3aa1bdd58579 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}_dynamic-codes_{code}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}_dynamic-codes_{code}.yaml @@ -24,6 +24,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_discounts_{id}_dynamic-codes_{code}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_discounts_{id}_dynamic-codes_{code}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}_regions_{region_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}_regions_{region_id}.yaml index d9bda810938a4..95162434c13f2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}_regions_{region_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}_regions_{region_id}.yaml @@ -24,6 +24,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_discounts_{id}_regions_{region_id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_discounts_{id}_regions_{region_id}/postundefined - lang: Shell label: cURL source: @@ -82,6 +87,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_discounts_{id}_regions_{region_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_discounts_{id}_regions_{region_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml index afb7ce7a99510..97be490ee11df 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml @@ -33,6 +33,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_draft-orders/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_draft-orders/getundefined - lang: Shell label: cURL source: @@ -81,6 +85,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_draft-orders/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_draft-orders/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml index b4e1aee1b717c..a6e23ca2ea4fa 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_draft-orders_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_draft-orders_{id}/getundefined - lang: Shell label: cURL source: @@ -70,6 +74,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_draft-orders_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_draft-orders_{id}/postundefined - lang: Shell label: cURL source: @@ -118,6 +126,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_draft-orders_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_draft-orders_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_line-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_line-items.yaml index d5951d8b1dcbe..b7b2d4d4d2a83 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_line-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_line-items.yaml @@ -23,6 +23,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_draft-orders_{id}_line-items/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_draft-orders_{id}_line-items/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_line-items_{line_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_line-items_{line_id}.yaml index dfe87b82e4f0d..bcd56ca1f3984 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_line-items_{line_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_line-items_{line_id}.yaml @@ -30,6 +30,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_draft-orders_{id}_line-items_{line_id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_draft-orders_{id}_line-items_{line_id}/postundefined - lang: Shell label: cURL source: @@ -86,6 +91,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_draft-orders_{id}_line-items_{line_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_draft-orders_{id}_line-items_{line_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_pay.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_pay.yaml index f65b8e39508a7..5a0c51c8a0b38 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_pay.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_pay.yaml @@ -22,6 +22,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_draft-orders_{id}_pay/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_draft-orders_{id}_pay/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_gift-cards.yaml b/www/apps/api-reference/specs/admin/paths/admin_gift-cards.yaml index e1f34b4bcb42b..73f7827f22012 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_gift-cards.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_gift-cards.yaml @@ -31,6 +31,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_gift-cards/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_gift-cards/getundefined - lang: Shell label: cURL source: @@ -79,6 +83,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_gift-cards/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_gift-cards/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_gift-cards_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_gift-cards_{id}.yaml index 6b76009bf6ab0..d99023f74cddf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_gift-cards_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_gift-cards_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_gift-cards_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_gift-cards_{id}/getundefined - lang: Shell label: cURL source: @@ -70,6 +74,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_gift-cards_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_gift-cards_{id}/postundefined - lang: Shell label: cURL source: @@ -118,6 +126,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_gift-cards_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_gift-cards_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml index 7929bec39ddd5..80115ee411660 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml @@ -120,6 +120,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_inventory-items/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_inventory-items/getundefined - lang: Shell label: cURL source: @@ -183,6 +187,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_inventory-items/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_inventory-items/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml index a71356cde4b85..035240b1cce03 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml @@ -32,6 +32,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_inventory-items_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_inventory-items_{id}/getundefined - lang: Shell label: cURL source: @@ -100,6 +104,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_inventory-items_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_inventory-items_{id}/postundefined - lang: Shell label: cURL source: @@ -150,6 +158,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_inventory-items_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_inventory-items_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml index 688cad9b67872..be6e70151fde7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml @@ -44,6 +44,11 @@ get: source: $ref: >- ../code_samples/JavaScript/admin_inventory-items_{id}_location-levels/get.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_inventory-items_{id}_location-levels/getundefined - lang: Shell label: cURL source: @@ -115,6 +120,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_inventory-items_{id}_location-levels/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_inventory-items_{id}_location-levels/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml index d49fef0278dc3..7ce47e7e20796 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml @@ -45,6 +45,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_inventory-items_{id}_location-levels_{location_id}/postundefined - lang: Shell label: cURL source: @@ -101,6 +106,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_inventory-items_{id}_location-levels_{location_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml index ea31a60d8a1c3..347fc4bb99efe 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml @@ -18,6 +18,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_invites_accept/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_invites_accept/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_{invite_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{invite_id}.yaml index 9868bfd344acb..b569761311b59 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{invite_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{invite_id}.yaml @@ -17,6 +17,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_invites_{invite_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_invites_{invite_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_{invite_id}_resend.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{invite_id}_resend.yaml index 10bc9178495a0..6eb360d7afd8c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{invite_id}_resend.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{invite_id}_resend.yaml @@ -22,6 +22,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_invites_{invite_id}_resend/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_invites_{invite_id}_resend/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_notes.yaml b/www/apps/api-reference/specs/admin/paths/admin_notes.yaml index 00099556308c6..2593827f27171 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notes.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notes.yaml @@ -31,6 +31,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_notes/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_notes/getundefined - lang: Shell label: cURL source: @@ -77,6 +81,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_notes/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_notes/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_notes_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_notes_{id}.yaml index 8c769e2ab11cb..89cd2ab7ac91c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notes_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notes_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_notes_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_notes_{id}/getundefined - lang: Shell label: cURL source: @@ -70,6 +74,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_notes_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_notes_{id}/postundefined - lang: Shell label: cURL source: @@ -118,6 +126,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_notes_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_notes_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml index 46112bb6ba7bf..fceb70a740d5f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml @@ -75,6 +75,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_notifications/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_notifications/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}_resend.yaml b/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}_resend.yaml index 4e0cd0e148b99..bb29184aea692 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}_resend.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}_resend.yaml @@ -25,6 +25,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_notifications_{id}_resend/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_notifications_{id}_resend/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml index 3ff3cf8dcbe6c..dc8589a9ffd02 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml @@ -50,6 +50,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_order-edits/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_order-edits/getundefined - lang: Shell label: cURL source: @@ -96,6 +100,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_order-edits/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_order-edits/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml index d7f7aa2a6c9b7..a6edb0f990cb4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml @@ -32,6 +32,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_order-edits_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_order-edits_{id}/getundefined - lang: Shell label: cURL source: @@ -85,6 +89,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_order-edits_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_order-edits_{id}/postundefined - lang: Shell label: cURL source: @@ -135,6 +143,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_order-edits_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_order-edits_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_cancel.yaml index d42fd817b89e9..d5f8a85cfdbf5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_cancel.yaml @@ -17,6 +17,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_order-edits_{id}_cancel/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_order-edits_{id}_cancel/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_changes_{change_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_changes_{change_id}.yaml index d320b384b6931..d0277fa95d921 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_changes_{change_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_changes_{change_id}.yaml @@ -26,6 +26,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_order-edits_{id}_changes_{change_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_order-edits_{id}_changes_{change_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml index 8e999d27e72e0..a7d4432a29587 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml @@ -19,6 +19,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_order-edits_{id}_confirm/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_order-edits_{id}_confirm/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml index 9062a00f2a859..e0f88f92631b9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml @@ -25,6 +25,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_order-edits_{id}_items/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_order-edits_{id}_items/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{item_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{item_id}.yaml index 3796c23df0ea9..a4a8a0467b2a5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{item_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{item_id}.yaml @@ -34,6 +34,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_order-edits_{id}_items_{item_id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_order-edits_{id}_items_{item_id}/postundefined - lang: Shell label: cURL source: @@ -92,6 +97,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_order-edits_{id}_items_{item_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_order-edits_{id}_items_{item_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml index 247398242f787..f4862c08a2bd6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml @@ -20,6 +20,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_order-edits_{id}_request/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_order-edits_{id}_request/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml index 2f4011e055b2f..92dc66dc8b857 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -223,6 +223,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml index 91959c7fc9641..f2fcec1303805 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml @@ -28,6 +28,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}/getundefined - lang: Shell label: cURL source: @@ -92,6 +96,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml index ce70a458dea90..534ed11fef566 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml @@ -28,6 +28,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}_archive/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}_archive/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml index fc56bcf4493c8..26676164089d8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml @@ -31,6 +31,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}_cancel/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}_cancel/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_capture.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_capture.yaml index 94a4465917d3f..9230b9ceba803 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_capture.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_capture.yaml @@ -30,6 +30,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}_capture/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}_capture/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims.yaml index 3d187e7d12883..bd6d840507cba 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims.yaml @@ -39,6 +39,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}_claims/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}_claims/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}.yaml index bf2d2c24a040b..107dd50c6d2f6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}.yaml @@ -39,6 +39,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}_claims_{claim_id}/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_cancel.yaml index 943ddf94b8c41..da4ef2f48e9ad 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_cancel.yaml @@ -41,6 +41,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_cancel/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_orders_{id}_claims_{claim_id}_cancel/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments.yaml index aca31dbcfc472..43b839c0e94a4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments.yaml @@ -48,6 +48,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_orders_{id}_claims_{claim_id}_fulfillments/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml index 211fd8723f3c0..bff407f3e44c7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -43,6 +43,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_shipments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_shipments.yaml index bcf12abcfedae..0b2960c4c29a4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_shipments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_shipments.yaml @@ -47,6 +47,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_shipments/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_orders_{id}_claims_{claim_id}_shipments/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml index b82339360d7df..a2332aff18a01 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml @@ -30,6 +30,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}_complete/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}_complete/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillment.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillment.yaml index 780fe5c48912e..4dbaee4eb561b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillment.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillment.yaml @@ -39,6 +39,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}_fulfillment/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}_fulfillment/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml index f7cdd71af466b..0a48f17e026f1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -37,6 +37,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_refund.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_refund.yaml index 483335062e127..a2861f9d61177 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_refund.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_refund.yaml @@ -35,6 +35,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}_refund/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}_refund/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_return.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_return.yaml index 525c25b0d3873..18964ba718dca 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_return.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_return.yaml @@ -38,6 +38,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}_return/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}_return/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipment.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipment.yaml index 1643e0de78070..8b6fad6785604 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipment.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipment.yaml @@ -39,6 +39,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}_shipment/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}_shipment/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipping-methods.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipping-methods.yaml index 2cc7add549612..848d29e111ab2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipping-methods.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipping-methods.yaml @@ -35,6 +35,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}_shipping-methods/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}_shipping-methods/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps.yaml index de3befdec0a09..2797c81e50b76 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps.yaml @@ -38,6 +38,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_orders_{id}_swaps/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_orders_{id}_swaps/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_cancel.yaml index 0bc43ab43ca2e..7196d52a5e328 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_cancel.yaml @@ -38,6 +38,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_cancel/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_cancel/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments.yaml index 7744bb6576bba..9819e76966014 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments.yaml @@ -47,6 +47,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_fulfillments/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml index 86fb0d493bfe6..5364c0b0a938d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -41,6 +41,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_process-payment.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_process-payment.yaml index 042d487504f35..a069bf940e375 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_process-payment.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_process-payment.yaml @@ -42,6 +42,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_process-payment/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_process-payment/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_shipments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_shipments.yaml index a4e97a836ef50..7165e23c63dd4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_shipments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_shipments.yaml @@ -46,6 +46,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_shipments/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_orders_{id}_swaps_{swap_id}_shipments/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml index 5964ea94de73c..9607ba9443b75 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml @@ -32,6 +32,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_payment-collections_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_payment-collections_{id}/getundefined - lang: Shell label: cURL source: @@ -85,6 +89,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_payment-collections_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_payment-collections_{id}/postundefined - lang: Shell label: cURL source: @@ -135,6 +143,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_payment-collections_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_payment-collections_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_authorize.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_authorize.yaml index 68c3c8e10bb60..9c8589aade539 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_authorize.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_authorize.yaml @@ -20,6 +20,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_payment-collections_{id}_authorize/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_payment-collections_{id}_authorize/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml index 4b0e0ae4c0407..4df6652835c67 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml @@ -18,6 +18,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_payments_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_payments_{id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml index 6fa99e386c455..d2b2b0d931c41 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml @@ -17,6 +17,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_payments_{id}_capture/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_payments_{id}_capture/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml index f2ec83b4dffd5..7e2432271f9a7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml @@ -22,6 +22,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_payments_{id}_refund/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_payments_{id}_refund/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml index 9508360bab3b0..371ca3a60269e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml @@ -161,6 +161,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_price-lists/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_price-lists/getundefined - lang: Shell label: cURL source: @@ -207,6 +211,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_price-lists/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_price-lists/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml index 0ee136ed51f9b..c68178526c58d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_price-lists_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_price-lists_{id}/getundefined - lang: Shell label: cURL source: @@ -70,6 +74,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_price-lists_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_price-lists_{id}/postundefined - lang: Shell label: cURL source: @@ -118,6 +126,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_price-lists_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_price-lists_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml index eafa65d63f45c..c56dadfead323 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml @@ -22,6 +22,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_price-lists_{id}_prices_batch/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_price-lists_{id}_prices_batch/postundefined - lang: Shell label: cURL source: @@ -76,6 +80,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_price-lists_{id}_prices_batch/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_price-lists_{id}_prices_batch/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml index 08add2fcdfe2f..77992018f43bf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml @@ -188,6 +188,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_price-lists_{id}_products/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_price-lists_{id}_products/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products_prices_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products_prices_batch.yaml index fd1187b069e02..e32df4e876994 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products_prices_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products_prices_batch.yaml @@ -18,6 +18,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_price-lists_{id}_products_prices_batch/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_price-lists_{id}_products_prices_batch/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products_{product_id}_prices.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products_{product_id}_prices.yaml index 843211c6c4ac3..940db4d0c5a6d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products_{product_id}_prices.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products_{product_id}_prices.yaml @@ -24,6 +24,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_price-lists_{id}_products_{product_id}_prices/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_price-lists_{id}_products_{product_id}_prices/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_variants_{variant_id}_prices.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_variants_{variant_id}_prices.yaml index cd4a364cc94a6..f9824721646f9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_variants_{variant_id}_prices.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_variants_{variant_id}_prices.yaml @@ -24,6 +24,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_price-lists_{id}_variants_{variant_id}_prices/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_price-lists_{id}_variants_{variant_id}_prices/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml index b63f002b30088..71e6e1efdd0d9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml @@ -76,6 +76,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_product-categories/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_product-categories/getundefined - lang: Shell label: cURL source: @@ -139,6 +143,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_product-categories/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_product-categories/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml index e7efd2baad2ad..22a166b3e5e2d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml @@ -33,6 +33,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_product-categories_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_product-categories_{id}/getundefined - lang: Shell label: cURL source: @@ -102,6 +106,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_product-categories_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_product-categories_{id}/postundefined - lang: Shell label: cURL source: @@ -151,6 +159,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_product-categories_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_product-categories_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products_batch.yaml index 0e580abb016ed..aa72405b594aa 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products_batch.yaml @@ -40,6 +40,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_product-categories_{id}_products_batch/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_product-categories_{id}_products_batch/postundefined - lang: Shell label: cURL source: @@ -112,6 +117,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_product-categories_{id}_products_batch/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_product-categories_{id}_products_batch/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml index 0b18e9a56ddec..0d31950ae3a7e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml @@ -105,6 +105,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_product-tags/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_product-tags/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml index 64351423d9cda..f5aec8cd5f28f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml @@ -106,6 +106,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_product-types/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_product-types/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_products.yaml index 63396230d9509..cb1a13968c3a7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products.yaml @@ -247,6 +247,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_products/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_products/getundefined - lang: Shell label: cURL source: @@ -295,6 +299,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_products/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_products/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_tag-usage.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_tag-usage.yaml index ef89b9df882bd..748e3b4d4223d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_tag-usage.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_tag-usage.yaml @@ -12,6 +12,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_products_tag-usage/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_products_tag-usage/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml index 7e4feec862ecb..e2a4f359c44da 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_products_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_products_{id}/getundefined - lang: Shell label: cURL source: @@ -70,6 +74,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_products_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_products_{id}/postundefined - lang: Shell label: cURL source: @@ -118,6 +126,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_products_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_products_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml index 653f28d55d919..3f0c5dbd056f0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml @@ -22,6 +22,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_products_{id}_options/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_products_{id}_options/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml index 6229d22b8adb2..0e4c51c22c8ab 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml @@ -29,6 +29,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_products_{id}_options_{option_id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_products_{id}_options_{option_id}/postundefined - lang: Shell label: cURL source: @@ -86,6 +91,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_products_{id}_options_{option_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_products_{id}_options_{option_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml index 615092234c9f7..e45e2cd64e309 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml @@ -104,6 +104,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_products_{id}_variants/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_products_{id}_variants/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml index c97cfbd584396..17f92ec34dadd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml @@ -30,6 +30,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_products_{id}_variants_{variant_id}/postundefined - lang: Shell label: cURL source: @@ -86,6 +91,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_products_{id}_variants_{variant_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml index 34ec7233860f7..99de392329ff5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml @@ -48,6 +48,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_publishable-api-keys/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_publishable-api-keys/getundefined - lang: Shell label: cURL source: @@ -94,6 +98,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_publishable-api-keys/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_publishable-api-keys/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}.yaml index 7259f2977e24f..d8df49a5e1ac5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_publishable-api-keys_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_publishable-api-keys_{id}/getundefined - lang: Shell label: cURL source: @@ -71,6 +75,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_publishable-api-keys_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_publishable-api-keys_{id}/postundefined - lang: Shell label: cURL source: @@ -121,6 +129,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_publishable-api-keys_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_publishable-api-keys_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_revoke.yaml b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_revoke.yaml index 5621c662835dc..89f6a19a09d9a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_revoke.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_revoke.yaml @@ -20,6 +20,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_publishable-api-keys_{id}_revoke/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_publishable-api-keys_{id}_revoke/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_sales-channels.yaml index 21ee5e4b33d81..450af1659b11c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_sales-channels.yaml @@ -26,6 +26,11 @@ get: source: $ref: >- ../code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels/get.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_sales-channels_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_sales-channels_batch.yaml index c909368259233..1002e0fa3b1fc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_sales-channels_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_sales-channels_batch.yaml @@ -24,6 +24,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels_batch/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels_batch/postundefined - lang: Shell label: cURL source: @@ -83,6 +88,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels_batch/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_publishable-api-keys_{id}_sales-channels_batch/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml index fbbe631664ce6..45897c8337395 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -97,6 +97,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_regions/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_regions/getundefined - lang: Shell label: cURL source: @@ -143,6 +147,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_regions/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_regions/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml index 941c3b025d613..c1c84271c5a1b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_regions_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_regions_{id}/getundefined - lang: Shell label: cURL source: @@ -70,6 +74,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_regions_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_regions_{id}/postundefined - lang: Shell label: cURL source: @@ -120,6 +128,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_regions_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_regions_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_countries.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_countries.yaml index 94441efa6aaf2..9658422b8ee1d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_countries.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_countries.yaml @@ -22,6 +22,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_regions_{id}_countries/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_regions_{id}_countries/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_countries_{country_code}.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_countries_{country_code}.yaml index 96ffdc2ba96b4..0db6225b1e772 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_countries_{country_code}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_countries_{country_code}.yaml @@ -29,6 +29,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_regions_{id}_countries_{country_code}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_regions_{id}_countries_{country_code}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_fulfillment-options.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_fulfillment-options.yaml index c700c03cbd63f..0c488fbddad7e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_fulfillment-options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_fulfillment-options.yaml @@ -18,6 +18,11 @@ get: source: $ref: >- ../code_samples/JavaScript/admin_regions_{id}_fulfillment-options/get.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_regions_{id}_fulfillment-options/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_fulfillment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_fulfillment-providers.yaml index d6eef10d40eca..70e61845e60f8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_fulfillment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_fulfillment-providers.yaml @@ -24,6 +24,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_regions_{id}_fulfillment-providers/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_regions_{id}_fulfillment-providers/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_fulfillment-providers_{provider_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_fulfillment-providers_{provider_id}.yaml index 9c08077c1ded5..7389294d72dbd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_fulfillment-providers_{provider_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_fulfillment-providers_{provider_id}.yaml @@ -26,6 +26,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_regions_{id}_fulfillment-providers_{provider_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_regions_{id}_fulfillment-providers_{provider_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_payment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_payment-providers.yaml index 07931ac48152a..24d8840434818 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_payment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_payment-providers.yaml @@ -23,6 +23,10 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_regions_{id}_payment-providers/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_regions_{id}_payment-providers/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_payment-providers_{provider_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_payment-providers_{provider_id}.yaml index 8076aecb2149f..c81f86587e397 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_payment-providers_{provider_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_payment-providers_{provider_id}.yaml @@ -26,6 +26,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_regions_{id}_payment-providers_{provider_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_regions_{id}_payment-providers_{provider_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml index 1432c1a84e9d1..4ddbe499a93a2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -127,6 +127,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_reservations/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_reservations/getundefined - lang: Shell label: cURL source: @@ -173,6 +177,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_reservations/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_reservations/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml index 29c6ea2f43c3a..4e77892f3e4f8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml @@ -15,6 +15,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_reservations_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_reservations_{id}/getundefined - lang: Shell label: cURL source: @@ -66,6 +70,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_reservations_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_reservations_{id}/postundefined - lang: Shell label: cURL source: @@ -116,6 +124,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_reservations_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_reservations_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml b/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml index a6c81a91087ad..8a6d16ba21df1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml @@ -10,6 +10,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_return-reasons/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_return-reasons/getundefined - lang: Shell label: cURL source: @@ -56,6 +60,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_return-reasons/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_return-reasons/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml index adaf2c6f1e25a..fac2b9ecd233e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_return-reasons_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_return-reasons_{id}/getundefined - lang: Shell label: cURL source: @@ -70,6 +74,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_return-reasons_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_return-reasons_{id}/postundefined - lang: Shell label: cURL source: @@ -118,6 +126,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_return-reasons_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_return-reasons_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml index f27d4d7e69376..b9130418068ae 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -23,6 +23,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_returns/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_returns/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml index ec82fd5e548cb..bdc449a1d403f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml @@ -18,6 +18,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_returns_{id}_cancel/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_returns_{id}_cancel/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml index 8d2ea5efbebc6..1c8cc905d2e21 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml @@ -23,6 +23,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_returns_{id}_receive/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_returns_{id}_receive/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml index 0e3f42f97f0e3..1116100c1bcbd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml @@ -132,6 +132,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_sales-channels/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_sales-channels/getundefined - lang: Shell label: cURL source: @@ -178,6 +182,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_sales-channels/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_sales-channels/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml index 294f49094a3de..887e5c59233ce 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_sales-channels_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_sales-channels_{id}/getundefined - lang: Shell label: cURL source: @@ -70,6 +74,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_sales-channels_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_sales-channels_{id}/postundefined - lang: Shell label: cURL source: @@ -120,6 +128,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_sales-channels_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_sales-channels_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products_batch.yaml index 639175a1ab6b6..aba8b471c3633 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products_batch.yaml @@ -24,6 +24,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_sales-channels_{id}_products_batch/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_sales-channels_{id}_products_batch/postundefined - lang: Shell label: cURL source: @@ -82,6 +87,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_sales-channels_{id}_products_batch/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_sales-channels_{id}_products_batch/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_stock-locations.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_stock-locations.yaml index dafaeaf99ea88..705d3e33f2f0d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_stock-locations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_stock-locations.yaml @@ -24,6 +24,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_sales-channels_{id}_stock-locations/postundefined - lang: Shell label: cURL source: @@ -83,6 +88,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_sales-channels_{id}_stock-locations/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml index 8d55615a766f4..b169ff4482a94 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml @@ -29,6 +29,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_shipping-options/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_shipping-options/getundefined - lang: Shell label: cURL source: @@ -75,6 +79,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_shipping-options/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_shipping-options/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml index 600faae0aa470..137746074d429 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_shipping-options_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_shipping-options_{id}/getundefined - lang: Shell label: cURL source: @@ -70,6 +74,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_shipping-options_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_shipping-options_{id}/postundefined - lang: Shell label: cURL source: @@ -120,6 +128,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_shipping-options_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_shipping-options_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml index cec79817fbec1..365e742a867ac 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml @@ -10,6 +10,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_shipping-profiles/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_shipping-profiles/getundefined - lang: Shell label: cURL source: @@ -56,6 +60,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_shipping-profiles/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_shipping-profiles/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml index 98b25f75c4686..e9a7962dce36b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_shipping-profiles_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_shipping-profiles_{id}/getundefined - lang: Shell label: cURL source: @@ -69,6 +73,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_shipping-profiles_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_shipping-profiles_{id}/postundefined - lang: Shell label: cURL source: @@ -117,6 +125,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_shipping-profiles_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_shipping-profiles_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml index 7392a2be4eb69..7d2a2e6569b1a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml @@ -124,6 +124,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_stock-locations/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_stock-locations/getundefined - lang: Shell label: cURL source: @@ -185,6 +189,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_stock-locations/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_stock-locations/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml index 6c32ee92f01b3..98666c1c3468b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml @@ -32,6 +32,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_stock-locations_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_stock-locations_{id}/getundefined - lang: Shell label: cURL source: @@ -87,6 +91,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_stock-locations_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_stock-locations_{id}/postundefined - lang: Shell label: cURL source: @@ -133,6 +141,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_stock-locations_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_stock-locations_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_store.yaml b/www/apps/api-reference/specs/admin/paths/admin_store.yaml index 53fc288f4c793..5d1e5d687d8c4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_store.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_store.yaml @@ -10,6 +10,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_store/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_store/getundefined - lang: Shell label: cURL source: @@ -56,6 +60,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_store/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_store/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_store_currencies_{code}.yaml b/www/apps/api-reference/specs/admin/paths/admin_store_currencies_{code}.yaml index 19c72d0a82bc5..81f5aa0901d7c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_store_currencies_{code}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_store_currencies_{code}.yaml @@ -24,6 +24,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_store_currencies_{code}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_store_currencies_{code}/postundefined - lang: Shell label: cURL source: @@ -78,6 +82,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_store_currencies_{code}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_store_currencies_{code}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_store_payment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_store_payment-providers.yaml index 210b75345e790..e2c007f67735c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_store_payment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_store_payment-providers.yaml @@ -10,6 +10,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_store_payment-providers/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_store_payment-providers/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_store_tax-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_store_tax-providers.yaml index 79710f4b311b1..bdb7dcf378cc0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_store_tax-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_store_tax-providers.yaml @@ -10,6 +10,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_store_tax-providers/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_store_tax-providers/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_swaps.yaml b/www/apps/api-reference/specs/admin/paths/admin_swaps.yaml index 3a011d78c2b3c..d57352ef85ced 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_swaps.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_swaps.yaml @@ -24,6 +24,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_swaps/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_swaps/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_swaps_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_swaps_{id}.yaml index 34643c3a2172f..50f0751248791 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_swaps_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_swaps_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_swaps_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_swaps_{id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml index dc4cde14697dd..922db8a48ddf5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml @@ -89,6 +89,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_tax-rates/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_tax-rates/getundefined - lang: Shell label: cURL source: @@ -157,6 +161,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_tax-rates/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_tax-rates/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml index 7c4d58c1a9b56..f11fcb72eec97 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml @@ -38,6 +38,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_tax-rates_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_tax-rates_{id}/getundefined - lang: Shell label: cURL source: @@ -112,6 +116,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_tax-rates_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_tax-rates_{id}/postundefined - lang: Shell label: cURL source: @@ -162,6 +170,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_tax-rates_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_tax-rates_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_product-types_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_product-types_batch.yaml index ceb2f01cf0987..7634a60cd2d9f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_product-types_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_product-types_batch.yaml @@ -44,6 +44,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_tax-rates_{id}_product-types_batch/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_tax-rates_{id}_product-types_batch/postundefined - lang: Shell label: cURL source: @@ -122,6 +127,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_tax-rates_{id}_product-types_batch/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_tax-rates_{id}_product-types_batch/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_products_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_products_batch.yaml index ae9e5af20e4d0..a9c3098d52e91 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_products_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_products_batch.yaml @@ -43,6 +43,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_tax-rates_{id}_products_batch/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_tax-rates_{id}_products_batch/postundefined - lang: Shell label: cURL source: @@ -120,6 +124,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_tax-rates_{id}_products_batch/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_tax-rates_{id}_products_batch/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_shipping-options_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_shipping-options_batch.yaml index bc72d985e431f..7b0b6adc5f86d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_shipping-options_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_shipping-options_batch.yaml @@ -45,6 +45,11 @@ post: source: $ref: >- ../code_samples/JavaScript/admin_tax-rates_{id}_shipping-options_batch/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_tax-rates_{id}_shipping-options_batch/postundefined - lang: Shell label: cURL source: @@ -125,6 +130,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/admin_tax-rates_{id}_shipping-options_batch/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/admin_tax-rates_{id}_shipping-options_batch/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml index a3b30c1920fe9..fc1acb2ccbb76 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml @@ -19,6 +19,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_uploads/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_uploads/postundefined - lang: Shell label: cURL source: @@ -65,6 +69,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_uploads/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_uploads/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads_download-url.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads_download-url.yaml index f3b8a50d519b7..9f81ea0af16af 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads_download-url.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads_download-url.yaml @@ -15,6 +15,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_uploads_download-url/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_uploads_download-url/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads_protected.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads_protected.yaml index b371268c7ce56..190a80b21ea2a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads_protected.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads_protected.yaml @@ -19,6 +19,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_uploads_protected/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_uploads_protected/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_users.yaml b/www/apps/api-reference/specs/admin/paths/admin_users.yaml index 7eb24a167624d..72cbef814c2f1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users.yaml @@ -10,6 +10,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_users/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_users/getundefined - lang: Shell label: cURL source: @@ -59,6 +63,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_users/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_users/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_password-token.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_password-token.yaml index e52047fd499bd..b54eedb45cba6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_password-token.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_password-token.yaml @@ -26,6 +26,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_users_password-token/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_users_password-token/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_reset-password.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_reset-password.yaml index 441098566af82..d0c88879dffa0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_reset-password.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_reset-password.yaml @@ -21,6 +21,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_users_reset-password/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_users_reset-password/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml index b290619be0f97..0ce02c73db61e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_users_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_users_{id}/getundefined - lang: Shell label: cURL source: @@ -70,6 +74,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/admin_users_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_users_{id}/postundefined - lang: Shell label: cURL source: @@ -120,6 +128,10 @@ delete: label: JS Client source: $ref: ../code_samples/JavaScript/admin_users_{id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_users_{id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_variants.yaml index a451dfb1b2449..5b9958dee5fa5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_variants.yaml @@ -134,6 +134,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_variants/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_variants/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_variants_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_variants_{id}.yaml index 10f111875dc5b..f18259be5e006 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_variants_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_variants_{id}.yaml @@ -32,6 +32,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_variants_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_variants_{id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/admin/paths/admin_variants_{id}_inventory.yaml b/www/apps/api-reference/specs/admin/paths/admin_variants_{id}_inventory.yaml index 60379900e29f9..16ff1dd35269d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_variants_{id}_inventory.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_variants_{id}_inventory.yaml @@ -17,6 +17,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/admin_variants_{id}_inventory/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/admin_variants_{id}_inventory/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts/postundefined new file mode 100644 index 0000000000000..c36ba4eeaa30e --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useCreateCart } from "medusa-react" + +type Props = { + regionId: string +} + +const Cart = ({ regionId }: Props) => { + const createCart = useCreateCart() + + const handleCreate = () => { + createCart.mutate({ + region_id: regionId + // creates an empty cart + }, { + onSuccess: ({ cart }) => { + console.log(cart.items) + } + }) + } + + // ... +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}/getundefined new file mode 100644 index 0000000000000..fe6cb42205a8a --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}/getundefined @@ -0,0 +1,28 @@ +import React from "react" +import { useGetCart } from "medusa-react" + +type Props = { + cartId: string +} + +const Cart = ({ cartId }: Props) => { + const { cart, isLoading } = useGetCart(cartId) + + return ( +
+ {isLoading && Loading...} + {cart && cart.items.length === 0 && ( + Cart is empty + )} + {cart && cart.items.length > 0 && ( +
    + {cart.items.map((item) => ( +
  • {item.title}
    • + ))} +
+ )} +
+ ) +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}/postundefined new file mode 100644 index 0000000000000..ead0e6cbf6077 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}/postundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useUpdateCart } from "medusa-react" + +type Props = { + cartId: string +} + +const Cart = ({ cartId }: Props) => { + const updateCart = useUpdateCart(cartId) + + const handleUpdate = ( + email: string + ) => { + updateCart.mutate({ + email + }, { + onSuccess: ({ cart }) => { + console.log(cart.email) + } + }) + } + + // ... +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_complete/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_complete/postundefined new file mode 100644 index 0000000000000..874a66f2c82ae --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_complete/postundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useCompleteCart } from "medusa-react" + +type Props = { + cartId: string +} + +const Cart = ({ cartId }: Props) => { + const completeCart = useCompleteCart(cartId) + + const handleComplete = () => { + completeCart.mutate(void 0, { + onSuccess: ({ data, type }) => { + console.log(data.id, type) + } + }) + } + + // ... +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_line-items/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_line-items/postundefined new file mode 100644 index 0000000000000..5c417e22e4cd3 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_line-items/postundefined @@ -0,0 +1,28 @@ +import React from "react" +import { useCreateLineItem } from "medusa-react" + +type Props = { + cartId: string +} + +const Cart = ({ cartId }: Props) => { + const createLineItem = useCreateLineItem(cartId) + + const handleAddItem = ( + variantId: string, + quantity: number + ) => { + createLineItem.mutate({ + variant_id: variantId, + quantity, + }, { + onSuccess: ({ cart }) => { + console.log(cart.items) + } + }) + } + + // ... +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_line-items_{line_id}/deleteundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_line-items_{line_id}/deleteundefined new file mode 100644 index 0000000000000..20f97ee859c1b --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_line-items_{line_id}/deleteundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useDeleteLineItem } from "medusa-react" + +type Props = { + cartId: string +} + +const Cart = ({ cartId }: Props) => { + const deleteLineItem = useDeleteLineItem(cartId) + + const handleDeleteItem = ( + lineItemId: string + ) => { + deleteLineItem.mutate({ + lineId: lineItemId, + }, { + onSuccess: ({ cart }) => { + console.log(cart.items) + } + }) + } + + // ... +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_line-items_{line_id}/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_line-items_{line_id}/postundefined new file mode 100644 index 0000000000000..628821d3b6c6a --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_line-items_{line_id}/postundefined @@ -0,0 +1,28 @@ +import React from "react" +import { useUpdateLineItem } from "medusa-react" + +type Props = { + cartId: string +} + +const Cart = ({ cartId }: Props) => { + const updateLineItem = useUpdateLineItem(cartId) + + const handleUpdateItem = ( + lineItemId: string, + quantity: number + ) => { + updateLineItem.mutate({ + lineId: lineItemId, + quantity, + }, { + onSuccess: ({ cart }) => { + console.log(cart.items) + } + }) + } + + // ... +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-session/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-session/postundefined new file mode 100644 index 0000000000000..a4c04460ab47f --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-session/postundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useSetPaymentSession } from "medusa-react" + +type Props = { + cartId: string +} + +const Cart = ({ cartId }: Props) => { + const setPaymentSession = useSetPaymentSession(cartId) + + const handleSetPaymentSession = ( + providerId: string + ) => { + setPaymentSession.mutate({ + provider_id: providerId, + }, { + onSuccess: ({ cart }) => { + console.log(cart.payment_session) + } + }) + } + + // ... +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions/postundefined new file mode 100644 index 0000000000000..7d87bea9e83ac --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions/postundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useCreatePaymentSession } from "medusa-react" + +type Props = { + cartId: string +} + +const Cart = ({ cartId }: Props) => { + const createPaymentSession = useCreatePaymentSession(cartId) + + const handleComplete = () => { + createPaymentSession.mutate(void 0, { + onSuccess: ({ cart }) => { + console.log(cart.payment_sessions) + } + }) + } + + // ... +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/deleteundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/deleteundefined new file mode 100644 index 0000000000000..aa3a9dd1ff697 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/deleteundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useDeletePaymentSession } from "medusa-react" + +type Props = { + cartId: string +} + +const Cart = ({ cartId }: Props) => { + const deletePaymentSession = useDeletePaymentSession(cartId) + + const handleDeletePaymentSession = ( + providerId: string + ) => { + deletePaymentSession.mutate({ + provider_id: providerId, + }, { + onSuccess: ({ cart }) => { + console.log(cart.payment_sessions) + } + }) + } + + // ... +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/postundefined new file mode 100644 index 0000000000000..65b49954d46fb --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/postundefined @@ -0,0 +1,28 @@ +import React from "react" +import { useUpdatePaymentSession } from "medusa-react" + +type Props = { + cartId: string +} + +const Cart = ({ cartId }: Props) => { + const updatePaymentSession = useUpdatePaymentSession(cartId) + + const handleUpdate = ( + providerId: string, + data: Record + ) => { + updatePaymentSession.mutate({ + provider_id: providerId, + data + }, { + onSuccess: ({ cart }) => { + console.log(cart.payment_session) + } + }) + } + + // ... +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}_refresh/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}_refresh/postundefined new file mode 100644 index 0000000000000..d509ad98d4e36 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}_refresh/postundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useRefreshPaymentSession } from "medusa-react" + +type Props = { + cartId: string +} + +const Cart = ({ cartId }: Props) => { + const refreshPaymentSession = useRefreshPaymentSession(cartId) + + const handleRefresh = ( + providerId: string + ) => { + refreshPaymentSession.mutate({ + provider_id: providerId, + }, { + onSuccess: ({ cart }) => { + console.log(cart.payment_sessions) + } + }) + } + + // ... +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_shipping-methods/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_shipping-methods/postundefined new file mode 100644 index 0000000000000..a58b003c15cc7 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_carts_{id}_shipping-methods/postundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useAddShippingMethodToCart } from "medusa-react" + +type Props = { + cartId: string +} + +const Cart = ({ cartId }: Props) => { + const addShippingMethod = useAddShippingMethodToCart(cartId) + + const handleAddShippingMethod = ( + optionId: string + ) => { + addShippingMethod.mutate({ + option_id: optionId, + }, { + onSuccess: ({ cart }) => { + console.log(cart.shipping_methods) + } + }) + } + + // ... +} + +export default Cart diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_collections/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_collections/getundefined new file mode 100644 index 0000000000000..23dd8ed79b67e --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_collections/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useCollections } from "medusa-react" + +const ProductCollections = () => { + const { collections, isLoading } = useCollections() + + return ( +
+ {isLoading && Loading...} + {collections && collections.length === 0 && ( + No Product Collections + )} + {collections && collections.length > 0 && ( +
    + {collections.map((collection) => ( +
  • {collection.title}
    • + ))} +
+ )} +
+ ) +} + +export default ProductCollections diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_collections_{id}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_collections_{id}/getundefined new file mode 100644 index 0000000000000..b5d751af58b0b --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_collections_{id}/getundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useCollection } from "medusa-react" + +type Props = { + collectionId: string +} + +const ProductCollection = ({ collectionId }: Props) => { + const { collection, isLoading } = useCollection(collectionId) + + return ( +
+ {isLoading && Loading...} + {collection && {collection.title}} +
+ ) +} + +export default ProductCollection diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_customers/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_customers/postundefined new file mode 100644 index 0000000000000..548ab3efaff6f --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_customers/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useCreateCustomer } from "medusa-react" + +const RegisterCustomer = () => { + const createCustomer = useCreateCustomer() + // ... + + const handleCreate = ( + customerData: { + first_name: string + last_name: string + email: string + password: string + } + ) => { + // ... + createCustomer.mutate(customerData, { + onSuccess: ({ customer }) => { + console.log(customer.id) + } + }) + } + + // ... +} + +export default RegisterCustomer diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_customers_me/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_customers_me/getundefined new file mode 100644 index 0000000000000..ce95652d66507 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_customers_me/getundefined @@ -0,0 +1,17 @@ +import React from "react" +import { useMeCustomer } from "medusa-react" + +const Customer = () => { + const { customer, isLoading } = useMeCustomer() + + return ( +
+ {isLoading && Loading...} + {customer && ( + {customer.first_name} {customer.last_name} + )} +
+ ) +} + +export default Customer diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_customers_me/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_customers_me/postundefined new file mode 100644 index 0000000000000..8e6a6aa413bd5 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_customers_me/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useUpdateMe } from "medusa-react" + +type Props = { + customerId: string +} + +const Customer = ({ customerId }: Props) => { + const updateCustomer = useUpdateMe() + // ... + + const handleUpdate = ( + firstName: string + ) => { + // ... + updateCustomer.mutate({ + id: customerId, + first_name: firstName, + }, { + onSuccess: ({ customer }) => { + console.log(customer.first_name) + } + }) + } + + // ... +} + +export default Customer diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_customers_me_orders/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_customers_me_orders/getundefined new file mode 100644 index 0000000000000..7c52e6b0c3089 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_customers_me_orders/getundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useCustomerOrders } from "medusa-react" + +const Orders = () => { + // refetch a function that can be used to + // re-retrieve orders after the customer logs in + const { orders, isLoading } = useCustomerOrders() + + return ( +
+ {isLoading && Loading orders...} + {orders?.length && ( +
    + {orders.map((order) => ( +
  • {order.display_id}
    • + ))} +
+ )} +
+ ) +} + +export default Orders diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_gift-cards_{code}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_gift-cards_{code}/getundefined new file mode 100644 index 0000000000000..2102428d0b635 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_gift-cards_{code}/getundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useGiftCard } from "medusa-react" + +type Props = { + giftCardCode: string +} + +const GiftCard = ({ giftCardCode }: Props) => { + const { gift_card, isLoading, isError } = useGiftCard( + giftCardCode + ) + + return ( +
+ {isLoading && Loading...} + {gift_card && {gift_card.value}} + {isError && Gift Card does not exist} +
+ ) +} + +export default GiftCard diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_order-edits_{id}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_order-edits_{id}/getundefined new file mode 100644 index 0000000000000..1b45b93e74257 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_order-edits_{id}/getundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useOrderEdit } from "medusa-react" + +type Props = { + orderEditId: string +} + +const OrderEdit = ({ orderEditId }: Props) => { + const { order_edit, isLoading } = useOrderEdit(orderEditId) + + return ( +
+ {isLoading && Loading...} + {order_edit && ( +
    + {order_edit.changes.map((change) => ( +
  • {change.type}
    • + ))} +
+ )} +
+ ) +} + +export default OrderEdit diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_order-edits_{id}_complete/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_order-edits_{id}_complete/postundefined new file mode 100644 index 0000000000000..339cbea3d5b27 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_order-edits_{id}_complete/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useCompleteOrderEdit } from "medusa-react" + +type Props = { + orderEditId: string +} + +const OrderEdit = ({ orderEditId }: Props) => { + const completeOrderEdit = useCompleteOrderEdit( + orderEditId + ) + // ... + + const handleCompleteOrderEdit = () => { + completeOrderEdit.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.confirmed_at) + } + }) + } + + // ... +} + +export default OrderEdit diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_order-edits_{id}_decline/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_order-edits_{id}_decline/postundefined new file mode 100644 index 0000000000000..669564255f175 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_order-edits_{id}_decline/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useDeclineOrderEdit } from "medusa-react" + +type Props = { + orderEditId: string +} + +const OrderEdit = ({ orderEditId }: Props) => { + const declineOrderEdit = useDeclineOrderEdit(orderEditId) + // ... + + const handleDeclineOrderEdit = ( + declinedReason: string + ) => { + declineOrderEdit.mutate({ + declined_reason: declinedReason, + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.declined_at) + } + }) + } + + // ... +} + +export default OrderEdit diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_orders/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_orders/getundefined new file mode 100644 index 0000000000000..c1155eb5ec086 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_orders/getundefined @@ -0,0 +1,30 @@ +import React from "react" +import { useOrders } from "medusa-react" + +type Props = { + displayId: number + email: string +} + +const Order = ({ + displayId, + email +}: Props) => { + const { + order, + isLoading, + } = useOrders({ + display_id: displayId, + email, + }) + + return ( +
+ {isLoading && Loading...} + {order && {order.display_id}} + +
+ ) +} + +export default Order diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_orders_batch_customer_token/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_orders_batch_customer_token/postundefined new file mode 100644 index 0000000000000..4c6135561a775 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_orders_batch_customer_token/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useRequestOrderAccess } from "medusa-react" + +const ClaimOrder = () => { + const claimOrder = useRequestOrderAccess() + + const handleClaimOrder = ( + orderIds: string[] + ) => { + claimOrder.mutate({ + order_ids: orderIds + }, { + onSuccess: () => { + // successful + }, + onError: () => { + // an error occurred. + } + }) + } + + // ... +} + +export default ClaimOrder diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_orders_cart_{cart_id}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_orders_cart_{cart_id}/getundefined new file mode 100644 index 0000000000000..7607d71ff3d14 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_orders_cart_{cart_id}/getundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useCartOrder } from "medusa-react" + +type Props = { + cartId: string +} + +const Order = ({ cartId }: Props) => { + const { + order, + isLoading, + } = useCartOrder(cartId) + + return ( +
+ {isLoading && Loading...} + {order && {order.display_id}} + +
+ ) +} + +export default Order diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_orders_customer_confirm/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_orders_customer_confirm/postundefined new file mode 100644 index 0000000000000..defce9a56ffc0 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_orders_customer_confirm/postundefined @@ -0,0 +1,25 @@ +import React from "react" +import { useGrantOrderAccess } from "medusa-react" + +const ClaimOrder = () => { + const confirmOrderRequest = useGrantOrderAccess() + + const handleOrderRequestConfirmation = ( + token: string + ) => { + confirmOrderRequest.mutate({ + token + }, { + onSuccess: () => { + // successful + }, + onError: () => { + // an error occurred. + } + }) + } + + // ... +} + +export default ClaimOrder diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_orders_{id}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_orders_{id}/getundefined new file mode 100644 index 0000000000000..b8b6ecbb87d7b --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_orders_{id}/getundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useOrder } from "medusa-react" + +type Props = { + orderId: string +} + +const Order = ({ orderId }: Props) => { + const { + order, + isLoading, + } = useOrder(orderId) + + return ( +
+ {isLoading && Loading...} + {order && {order.display_id}} + +
+ ) +} + +export default Order diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}/getundefined new file mode 100644 index 0000000000000..eaf8e3a0ee66c --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}/getundefined @@ -0,0 +1,28 @@ +import React from "react" +import { usePaymentCollection } from "medusa-react" + +type Props = { + paymentCollectionId: string +} + +const PaymentCollection = ({ + paymentCollectionId +}: Props) => { + const { + payment_collection, + isLoading + } = usePaymentCollection( + paymentCollectionId + ) + + return ( +
+ {isLoading && Loading...} + {payment_collection && ( + {payment_collection.status} + )} +
+ ) +} + +export default PaymentCollection diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions/postundefined new file mode 100644 index 0000000000000..216c504128571 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions/postundefined @@ -0,0 +1,30 @@ +import React from "react" +import { useManagePaymentSession } from "medusa-react" + +type Props = { + paymentCollectionId: string +} + +const PaymentCollection = ({ + paymentCollectionId +}: Props) => { + const managePaymentSession = useManagePaymentSession( + paymentCollectionId + ) + + const handleManagePaymentSession = ( + providerId: string + ) => { + managePaymentSession.mutate({ + provider_id: providerId + }, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.payment_sessions) + } + }) + } + + // ... +} + +export default PaymentCollection diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_batch/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_batch/postundefined new file mode 100644 index 0000000000000..934d364c3008e --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_batch/postundefined @@ -0,0 +1,55 @@ +import React from "react" +import { useManageMultiplePaymentSessions } from "medusa-react" + +type Props = { + paymentCollectionId: string +} + +const PaymentCollection = ({ + paymentCollectionId +}: Props) => { + const managePaymentSessions = useManageMultiplePaymentSessions( + paymentCollectionId + ) + + const handleManagePaymentSessions = () => { + // Total amount = 10000 + + // Example 1: Adding two new sessions + managePaymentSessions.mutate({ + sessions: [ + { + provider_id: "stripe", + amount: 5000, + }, + { + provider_id: "manual", + amount: 5000, + }, + ] + }, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.payment_sessions) + } + }) + + // Example 2: Updating one session and removing the other + managePaymentSessions.mutate({ + sessions: [ + { + provider_id: "stripe", + amount: 10000, + session_id: "ps_123456" + }, + ] + }, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.payment_sessions) + } + }) + } + + // ... +} + +export default PaymentCollection diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_batch_authorize/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_batch_authorize/postundefined new file mode 100644 index 0000000000000..8e3459019f35a --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_batch_authorize/postundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useAuthorizePaymentSessionsBatch } from "medusa-react" + +type Props = { + paymentCollectionId: string +} + +const PaymentCollection = ({ + paymentCollectionId +}: Props) => { + const authorizePaymentSessions = useAuthorizePaymentSessionsBatch( + paymentCollectionId + ) + // ... + + const handleAuthorizePayments = (paymentSessionIds: string[]) => { + authorizePaymentSessions.mutate({ + session_ids: paymentSessionIds + }, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.payment_sessions) + } + }) + } + + // ... +} + +export default PaymentCollection diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}/postundefined new file mode 100644 index 0000000000000..dba59b0c5df09 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { usePaymentCollectionRefreshPaymentSession } from "medusa-react" + +type Props = { + paymentCollectionId: string +} + +const PaymentCollection = ({ + paymentCollectionId +}: Props) => { + const refreshPaymentSession = usePaymentCollectionRefreshPaymentSession( + paymentCollectionId + ) + // ... + + const handleRefreshPaymentSession = (paymentSessionId: string) => { + refreshPaymentSession.mutate(paymentSessionId, { + onSuccess: ({ payment_session }) => { + console.log(payment_session.status) + } + }) + } + + // ... +} + +export default PaymentCollection diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}_authorize/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}_authorize/postundefined new file mode 100644 index 0000000000000..6ed3e575490c4 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}_authorize/postundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useAuthorizePaymentSession } from "medusa-react" + +type Props = { + paymentCollectionId: string +} + +const PaymentCollection = ({ + paymentCollectionId +}: Props) => { + const authorizePaymentSession = useAuthorizePaymentSession( + paymentCollectionId + ) + // ... + + const handleAuthorizePayment = (paymentSessionId: string) => { + authorizePaymentSession.mutate(paymentSessionId, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.payment_sessions) + } + }) + } + + // ... +} + +export default PaymentCollection diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_product-categories/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_product-categories/getundefined new file mode 100644 index 0000000000000..0cc7622151718 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_product-categories/getundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useProductCategories } from "medusa-react" + +function Categories() { + const { + product_categories, + isLoading, + } = useProductCategories() + + return ( +
+ {isLoading && Loading...} + {product_categories && !product_categories.length && ( + No Categories + )} + {product_categories && product_categories.length > 0 && ( +
    + {product_categories.map( + (category) => ( +
  • {category.name}
    • + ) + )} +
+ )} +
+ ) +} + +export default Categories diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_product-categories_{id}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_product-categories_{id}/getundefined new file mode 100644 index 0000000000000..d2ce454ac8c78 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_product-categories_{id}/getundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useProductCategory } from "medusa-react" + +type Props = { + categoryId: string +} + +const Category = ({ categoryId }: Props) => { + const { product_category, isLoading } = useProductCategory( + categoryId + ) + + return ( +
+ {isLoading && Loading...} + {product_category && {product_category.name}} +
+ ) +} + +export default Category diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_product-tags/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_product-tags/getundefined new file mode 100644 index 0000000000000..61ef45f793b83 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_product-tags/getundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useProductTags } from "medusa-react" + +function Tags() { + const { + product_tags, + isLoading, + } = useProductTags() + + return ( +
+ {isLoading && Loading...} + {product_tags && !product_tags.length && ( + No Product Tags + )} + {product_tags && product_tags.length > 0 && ( +
    + {product_tags.map( + (tag) => ( +
  • {tag.value}
    • + ) + )} +
+ )} +
+ ) +} + +export default Tags diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_product-types/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_product-types/getundefined new file mode 100644 index 0000000000000..aa48e9ff68c24 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_product-types/getundefined @@ -0,0 +1,29 @@ +import React from "react" +import { useProductTypes } from "medusa-react" + +function Types() { + const { + product_types, + isLoading, + } = useProductTypes() + + return ( +
+ {isLoading && Loading...} + {product_types && !product_types.length && ( + No Product Types + )} + {product_types && product_types.length > 0 && ( +
    + {product_types.map( + (type) => ( +
  • {type.value}
    • + ) + )} +
+ )} +
+ ) +} + +export default Types diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_products/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_products/getundefined new file mode 100644 index 0000000000000..52017119da45e --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_products/getundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useProducts } from "medusa-react" + +function Product () { + const { products, isLoading } = useProducts() + + return ( +
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
+ ) +} + +export default Products diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_products_{id}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_products_{id}/getundefined new file mode 100644 index 0000000000000..efb6a91f5bad8 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_products_{id}/getundefined @@ -0,0 +1,19 @@ +import React from "react" +import { useProduct } from "medusa-react" + +type Props = { + productId: string +} + +const Product = ({ productId }: Props) => { + const { product, isLoading } = useProduct(productId) + + return ( +
+ {isLoading && Loading...} + {product && {product.title}} +
+ ) +} + +export default Product diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_regions/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_regions/getundefined new file mode 100644 index 0000000000000..f8353df871551 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_regions/getundefined @@ -0,0 +1,23 @@ +import React from "react" +import { useRegions } from "medusa-react" + +const Regions = () => { + const { regions, isLoading } = useRegions() + + return ( +
+ {isLoading && Loading...} + {regions?.length && ( +
    + {regions.map((region) => ( +
  • + {region.name} +
    • + ))} +
+ )} +
+ ) +} + +export default Regions diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_regions_{id}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_regions_{id}/getundefined new file mode 100644 index 0000000000000..e09ef20244fce --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_regions_{id}/getundefined @@ -0,0 +1,21 @@ +import React from "react" +import { useRegion } from "medusa-react" + +type Props = { + regionId: string +} + +const Region = ({ regionId }: Props) => { + const { region, isLoading } = useRegion( + regionId + ) + + return ( +
+ {isLoading && Loading...} + {region && {region.name}} +
+ ) +} + +export default Region diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_return-reasons/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_return-reasons/getundefined new file mode 100644 index 0000000000000..3e4d3929797f1 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_return-reasons/getundefined @@ -0,0 +1,26 @@ +import React from "react" +import { useReturnReasons } from "medusa-react" + +const ReturnReasons = () => { + const { + return_reasons, + isLoading + } = useReturnReasons() + + return ( +
+ {isLoading && Loading...} + {return_reasons?.length && ( +
    + {return_reasons.map((returnReason) => ( +
  • + {returnReason.label} +
    • + ))} +
+ )} +
+ ) +} + +export default ReturnReasons diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_return-reasons_{id}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_return-reasons_{id}/getundefined new file mode 100644 index 0000000000000..f9a3247f64dee --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_return-reasons_{id}/getundefined @@ -0,0 +1,24 @@ +import React from "react" +import { useReturnReason } from "medusa-react" + +type Props = { + returnReasonId: string +} + +const ReturnReason = ({ returnReasonId }: Props) => { + const { + return_reason, + isLoading + } = useReturnReason( + returnReasonId + ) + + return ( +
+ {isLoading && Loading...} + {return_reason && {return_reason.label}} +
+ ) +} + +export default ReturnReason diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_returns/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_returns/postundefined new file mode 100644 index 0000000000000..fc53926cb412f --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_returns/postundefined @@ -0,0 +1,36 @@ +import React from "react" +import { useCreateReturn } from "medusa-react" + +type CreateReturnData = { + items: { + item_id: string, + quantity: number + }[] + return_shipping: { + option_id: string + } +} + +type Props = { + orderId: string +} + +const CreateReturn = ({ orderId }: Props) => { + const createReturn = useCreateReturn() + // ... + + const handleCreate = (data: CreateReturnData) => { + createReturn.mutate({ + ...data, + order_id: orderId + }, { + onSuccess: ({ return: returnData }) => { + console.log(returnData.id) + } + }) + } + + // ... +} + +export default CreateReturn diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_shipping-options/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_shipping-options/getundefined new file mode 100644 index 0000000000000..cffe845c9038a --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_shipping-options/getundefined @@ -0,0 +1,27 @@ +import React from "react" +import { useShippingOptions } from "medusa-react" + +const ShippingOptions = () => { + const { + shipping_options, + isLoading, + } = useShippingOptions() + + return ( +
+ {isLoading && Loading...} + {shipping_options?.length && + shipping_options?.length > 0 && ( +
    + {shipping_options?.map((shipping_option) => ( +
  • + {shipping_option.id} +
    • + ))} +
+ )} +
+ ) +} + +export default ShippingOptions diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_shipping-options_{cart_id}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_shipping-options_{cart_id}/getundefined new file mode 100644 index 0000000000000..feaf93d957051 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_shipping-options_{cart_id}/getundefined @@ -0,0 +1,33 @@ +import React from "react" +import { useCartShippingOptions } from "medusa-react" + +type Props = { + cartId: string +} + +const ShippingOptions = ({ cartId }: Props) => { + const { shipping_options, isLoading } = + useCartShippingOptions(cartId) + + return ( +
+ {isLoading && Loading...} + {shipping_options && !shipping_options.length && ( + No shipping options + )} + {shipping_options && ( +
    + {shipping_options.map( + (shipping_option) => ( +
  • + {shipping_option.name} +
    • + ) + )} +
+ )} +
+ ) +} + +export default ShippingOptions diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_swaps/postundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_swaps/postundefined new file mode 100644 index 0000000000000..17f7c7d3cde5a --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_swaps/postundefined @@ -0,0 +1,42 @@ +import React from "react" +import { useCreateSwap } from "medusa-react" + +type Props = { + orderId: string +} + +type CreateData = { + return_items: { + item_id: string + quantity: number + }[] + additional_items: { + variant_id: string + quantity: number + }[] + return_shipping_option: string +} + +const CreateSwap = ({ + orderId +}: Props) => { + const createSwap = useCreateSwap() + // ... + + const handleCreate = ( + data: CreateData + ) => { + createSwap.mutate({ + ...data, + order_id: orderId + }, { + onSuccess: ({ swap }) => { + console.log(swap.id) + } + }) + } + + // ... +} + +export default CreateSwap diff --git a/www/apps/api-reference/specs/store/code_samples/tsx/store_swaps_{cart_id}/getundefined b/www/apps/api-reference/specs/store/code_samples/tsx/store_swaps_{cart_id}/getundefined new file mode 100644 index 0000000000000..6a73a86df752f --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/tsx/store_swaps_{cart_id}/getundefined @@ -0,0 +1,22 @@ +import React from "react" +import { useCartSwap } from "medusa-react" +type Props = { + cartId: string +} + +const Swap = ({ cartId }: Props) => { + const { + swap, + isLoading, + } = useCartSwap(cartId) + + return ( +
+ {isLoading && Loading...} + {swap && {swap.id}} + +
+ ) +} + +export default Swap diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionSessionsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionSessionsReq.yaml index 121bde50951fa..6355462bdff6d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionSessionsReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionSessionsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the payment session to manage. required: - provider_id properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsSessionRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsSessionRes.yaml index 182f41c280f79..9eef53e30333c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsSessionRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsSessionRes.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the payment session. required: - payment_session properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml index 08f84fd8b8788..811b1f8f1071c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the line item. required: - quantity properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsReq.yaml index 13728fbc1d503..4cb9dc35e80e5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the line item to create. required: - variant_id - quantity diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartPaymentSessionReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartPaymentSessionReq.yaml index 121bde50951fa..d8874ca7d075c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartPaymentSessionReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartPaymentSessionReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the payment session to set. required: - provider_id properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartReq.yaml index 93a1140b097f8..316c1a1aaf0e9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the cart. properties: region_id: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartShippingMethodReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartShippingMethodReq.yaml index 3226d410995a4..7d9a0fe839b2d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartShippingMethodReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartShippingMethodReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the shipping method to add to the cart. required: - option_id properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAcceptClaimReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAcceptClaimReq.yaml index ce517bc7a55eb..8e4c9cd4320ba 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAcceptClaimReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAcceptClaimReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details necessary to grant order access. required: - token properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerOrderClaimReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerOrderClaimReq.yaml index dad38b1c3bf92..e614f770e2846 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerOrderClaimReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerOrderClaimReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the orders to claim. required: - order_ids properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerReq.yaml index fd46bd0b68915..5e17043272e79 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details to update of the customer. properties: first_name: description: The customer's first name. diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersReq.yaml index ead1b666bb57f..2ecd1312aaa13 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the customer to create. required: - first_name - last_name diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostOrderEditsOrderEditDecline.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostOrderEditsOrderEditDecline.yaml index be411e5559269..1ffe6e5eaf79d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostOrderEditsOrderEditDecline.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostOrderEditsOrderEditDecline.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the order edit's decline. properties: declined_reason: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.yaml index fd8d3fa660d66..1b8dcea0f5636 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the payment sessions to authorize. required: - session_ids properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml index 9a83dc01063bf..7737b9721cda9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the payment sessions to manage. required: - sessions properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReq.yaml index bd74058acc7af..9a52840e998d9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the return to create. required: - order_id - items diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostSwapsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostSwapsReq.yaml index d6aca5a21e277..202bd36bddf8d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostSwapsReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostSwapsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the swap to create. required: - order_id - return_items diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 58b52e0bfbc8c..ab22fd96b29c4 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -460,6 +460,34 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCreateCart } from "medusa-react" + + type Props = { + regionId: string + } + + const Cart = ({ regionId }: Props) => { + const createCart = useCreateCart() + + const handleCreate = () => { + createCart.mutate({ + region_id: regionId + // creates an empty cart + }, { + onSuccess: ({ cart }) => { + console.log(cart.items) + } + }) + } + + // ... + } + + export default Cart - lang: Shell label: cURL source: | @@ -511,6 +539,37 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useGetCart } from "medusa-react" + + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { + const { cart, isLoading } = useGetCart(cartId) + + return ( +
+ {isLoading && Loading...} + {cart && cart.items.length === 0 && ( + Cart is empty + )} + {cart && cart.items.length > 0 && ( +
    + {cart.items.map((item) => ( +
  • {item.title}
    • + ))} +
+ )} +
+ ) + } + + export default Cart - lang: Shell label: cURL source: | @@ -571,6 +630,35 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useUpdateCart } from "medusa-react" + + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { + const updateCart = useUpdateCart(cartId) + + const handleUpdate = ( + email: string + ) => { + updateCart.mutate({ + email + }, { + onSuccess: ({ cart }) => { + console.log(cart.email) + } + }) + } + + // ... + } + + export default Cart - lang: Shell label: cURL source: | @@ -646,6 +734,31 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCompleteCart } from "medusa-react" + + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { + const completeCart = useCompleteCart(cartId) + + const handleComplete = () => { + completeCart.mutate(void 0, { + onSuccess: ({ data, type }) => { + console.log(data.id, type) + } + }) + } + + // ... + } + + export default Cart - lang: Shell label: cURL source: | @@ -774,6 +887,37 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCreateLineItem } from "medusa-react" + + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { + const createLineItem = useCreateLineItem(cartId) + + const handleAddItem = ( + variantId: string, + quantity: number + ) => { + createLineItem.mutate({ + variant_id: variantId, + quantity, + }, { + onSuccess: ({ cart }) => { + console.log(cart.items) + } + }) + } + + // ... + } + + export default Cart - lang: Shell label: cURL source: | @@ -843,6 +987,37 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useUpdateLineItem } from "medusa-react" + + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { + const updateLineItem = useUpdateLineItem(cartId) + + const handleUpdateItem = ( + lineItemId: string, + quantity: number + ) => { + updateLineItem.mutate({ + lineId: lineItemId, + quantity, + }, { + onSuccess: ({ cart }) => { + console.log(cart.items) + } + }) + } + + // ... + } + + export default Cart - lang: Shell label: cURL source: | @@ -905,6 +1080,35 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useDeleteLineItem } from "medusa-react" + + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { + const deleteLineItem = useDeleteLineItem(cartId) + + const handleDeleteItem = ( + lineItemId: string + ) => { + deleteLineItem.mutate({ + lineId: lineItemId, + }, { + onSuccess: ({ cart }) => { + console.log(cart.items) + } + }) + } + + // ... + } + + export default Cart - lang: Shell label: cURL source: | @@ -966,6 +1170,35 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useSetPaymentSession } from "medusa-react" + + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { + const setPaymentSession = useSetPaymentSession(cartId) + + const handleSetPaymentSession = ( + providerId: string + ) => { + setPaymentSession.mutate({ + provider_id: providerId, + }, { + onSuccess: ({ cart }) => { + console.log(cart.payment_session) + } + }) + } + + // ... + } + + export default Cart - lang: Shell label: cURL source: | @@ -1026,6 +1259,31 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCreatePaymentSession } from "medusa-react" + + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { + const createPaymentSession = useCreatePaymentSession(cartId) + + const handleComplete = () => { + createPaymentSession.mutate(void 0, { + onSuccess: ({ cart }) => { + console.log(cart.payment_sessions) + } + }) + } + + // ... + } + + export default Cart - lang: Shell label: cURL source: | @@ -1095,6 +1353,37 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useUpdatePaymentSession } from "medusa-react" + + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { + const updatePaymentSession = useUpdatePaymentSession(cartId) + + const handleUpdate = ( + providerId: string, + data: Record + ) => { + updatePaymentSession.mutate({ + provider_id: providerId, + data + }, { + onSuccess: ({ cart }) => { + console.log(cart.payment_session) + } + }) + } + + // ... + } + + export default Cart - lang: Shell label: cURL source: > @@ -1162,6 +1451,35 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useDeletePaymentSession } from "medusa-react" + + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { + const deletePaymentSession = useDeletePaymentSession(cartId) + + const handleDeletePaymentSession = ( + providerId: string + ) => { + deletePaymentSession.mutate({ + provider_id: providerId, + }, { + onSuccess: ({ cart }) => { + console.log(cart.payment_sessions) + } + }) + } + + // ... + } + + export default Cart - lang: Shell label: cURL source: > @@ -1224,6 +1542,35 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useRefreshPaymentSession } from "medusa-react" + + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { + const refreshPaymentSession = useRefreshPaymentSession(cartId) + + const handleRefresh = ( + providerId: string + ) => { + refreshPaymentSession.mutate({ + provider_id: providerId, + }, { + onSuccess: ({ cart }) => { + console.log(cart.payment_sessions) + } + }) + } + + // ... + } + + export default Cart - lang: Shell label: cURL source: > @@ -1285,6 +1632,35 @@ paths: .then(({ cart }) => { console.log(cart.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAddShippingMethodToCart } from "medusa-react" + + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { + const addShippingMethod = useAddShippingMethodToCart(cartId) + + const handleAddShippingMethod = ( + optionId: string + ) => { + addShippingMethod.mutate({ + option_id: optionId, + }, { + onSuccess: ({ cart }) => { + console.log(cart.shipping_methods) + } + }) + } + + // ... + } + + export default Cart - lang: Shell label: cURL source: | @@ -1450,6 +1826,33 @@ paths: .then(({ collections, limit, offset, count }) => { console.log(collections.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCollections } from "medusa-react" + + const ProductCollections = () => { + const { collections, isLoading } = useCollections() + + return ( +
+ {isLoading && Loading...} + {collections && collections.length === 0 && ( + No Product Collections + )} + {collections && collections.length > 0 && ( +
    + {collections.map((collection) => ( +
  • {collection.title}
    • + ))} +
+ )} +
+ ) + } + + export default ProductCollections - lang: Shell label: cURL source: | @@ -1501,6 +1904,28 @@ paths: .then(({ collection }) => { console.log(collection.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCollection } from "medusa-react" + + type Props = { + collectionId: string + } + + const ProductCollection = ({ collectionId }: Props) => { + const { collection, isLoading } = useCollection(collectionId) + + return ( +
+ {isLoading && Loading...} + {collection && {collection.title}} +
+ ) + } + + export default ProductCollection - lang: Shell label: cURL source: | @@ -1560,6 +1985,36 @@ paths: .then(({ customer }) => { console.log(customer.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCreateCustomer } from "medusa-react" + + const RegisterCustomer = () => { + const createCustomer = useCreateCustomer() + // ... + + const handleCreate = ( + customerData: { + first_name: string + last_name: string + email: string + password: string + } + ) => { + // ... + createCustomer.mutate(customerData, { + onSuccess: ({ customer }) => { + console.log(customer.id) + } + }) + } + + // ... + } + + export default RegisterCustomer - lang: Shell label: cURL source: | @@ -1634,6 +2089,26 @@ paths: .then(({ customer }) => { console.log(customer.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useMeCustomer } from "medusa-react" + + const Customer = () => { + const { customer, isLoading } = useMeCustomer() + + return ( +
+ {isLoading && Loading...} + {customer && ( + {customer.first_name} {customer.last_name} + )} +
+ ) + } + + export default Customer - lang: Shell label: cURL source: | @@ -1693,6 +2168,38 @@ paths: .then(({ customer }) => { console.log(customer.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useUpdateMe } from "medusa-react" + + type Props = { + customerId: string + } + + const Customer = ({ customerId }: Props) => { + const updateCustomer = useUpdateMe() + // ... + + const handleUpdate = ( + firstName: string + ) => { + // ... + updateCustomer.mutate({ + id: customerId, + first_name: firstName, + }, { + onSuccess: ({ customer }) => { + console.log(customer.first_name) + } + }) + } + + // ... + } + + export default Customer - lang: Shell label: cURL source: | @@ -2164,6 +2671,32 @@ paths: .then(({ orders, limit, offset, count }) => { console.log(orders); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCustomerOrders } from "medusa-react" + + const Orders = () => { + // refetch a function that can be used to + // re-retrieve orders after the customer logs in + const { orders, isLoading } = useCustomerOrders() + + return ( +
+ {isLoading && Loading orders...} + {orders?.length && ( +
    + {orders.map((order) => ( +
  • {order.display_id}
    • + ))} +
+ )} +
+ ) + } + + export default Orders - lang: Shell label: cURL source: | @@ -2414,6 +2947,31 @@ paths: .then(({ gift_card }) => { console.log(gift_card.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useGiftCard } from "medusa-react" + + type Props = { + giftCardCode: string + } + + const GiftCard = ({ giftCardCode }: Props) => { + const { gift_card, isLoading, isError } = useGiftCard( + giftCardCode + ) + + return ( +
+ {isLoading && Loading...} + {gift_card && {gift_card.value}} + {isError && Gift Card does not exist} +
+ ) + } + + export default GiftCard - lang: Shell label: cURL source: | @@ -2465,6 +3023,34 @@ paths: .then(({ order_edit }) => { console.log(order_edit.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useOrderEdit } from "medusa-react" + + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const { order_edit, isLoading } = useOrderEdit(orderEditId) + + return ( +
+ {isLoading && Loading...} + {order_edit && ( +
    + {order_edit.changes.map((change) => ( +
  • {change.type}
    • + ))} +
+ )} +
+ ) + } + + export default OrderEdit - lang: Shell label: cURL source: | @@ -2524,6 +3110,34 @@ paths: .then(({ order_edit }) => { console.log(order_edit.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCompleteOrderEdit } from "medusa-react" + + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const completeOrderEdit = useCompleteOrderEdit( + orderEditId + ) + // ... + + const handleCompleteOrderEdit = () => { + completeOrderEdit.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.confirmed_at) + } + }) + } + + // ... + } + + export default OrderEdit - lang: Shell label: cURL source: | @@ -2580,6 +3194,36 @@ paths: .then(({ order_edit }) => { console.log(order_edit.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useDeclineOrderEdit } from "medusa-react" + + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const declineOrderEdit = useDeclineOrderEdit(orderEditId) + // ... + + const handleDeclineOrderEdit = ( + declinedReason: string + ) => { + declineOrderEdit.mutate({ + declined_reason: declinedReason, + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.declined_at) + } + }) + } + + // ... + } + + export default OrderEdit - lang: Shell label: cURL source: | @@ -2669,6 +3313,39 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useOrders } from "medusa-react" + + type Props = { + displayId: number + email: string + } + + const Order = ({ + displayId, + email + }: Props) => { + const { + order, + isLoading, + } = useOrders({ + display_id: displayId, + email, + }) + + return ( +
+ {isLoading && Loading...} + {order && {order.display_id}} + +
+ ) + } + + export default Order - lang: Shell label: cURL source: > @@ -2739,6 +3416,34 @@ paths: .catch(() => { // an error occurred }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useRequestOrderAccess } from "medusa-react" + + const ClaimOrder = () => { + const claimOrder = useRequestOrderAccess() + + const handleClaimOrder = ( + orderIds: string[] + ) => { + claimOrder.mutate({ + order_ids: orderIds + }, { + onSuccess: () => { + // successful + }, + onError: () => { + // an error occurred. + } + }) + } + + // ... + } + + export default ClaimOrder - lang: Shell label: cURL source: | @@ -2798,6 +3503,32 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCartOrder } from "medusa-react" + + type Props = { + cartId: string + } + + const Order = ({ cartId }: Props) => { + const { + order, + isLoading, + } = useCartOrder(cartId) + + return ( +
+ {isLoading && Loading...} + {order && {order.display_id}} + +
+ ) + } + + export default Order - lang: Shell label: cURL source: | @@ -2861,6 +3592,34 @@ paths: .catch(() => { // an error occurred }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useGrantOrderAccess } from "medusa-react" + + const ClaimOrder = () => { + const confirmOrderRequest = useGrantOrderAccess() + + const handleOrderRequestConfirmation = ( + token: string + ) => { + confirmOrderRequest.mutate({ + token + }, { + onSuccess: () => { + // successful + }, + onError: () => { + // an error occurred. + } + }) + } + + // ... + } + + export default ClaimOrder - lang: Shell label: cURL source: | @@ -2932,6 +3691,32 @@ paths: .then(({ order }) => { console.log(order.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useOrder } from "medusa-react" + + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { + const { + order, + isLoading, + } = useOrder(orderId) + + return ( +
+ {isLoading && Loading...} + {order && {order.display_id}} + +
+ ) + } + + export default Order - lang: Shell label: cURL source: | @@ -3001,6 +3786,37 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id) }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { usePaymentCollection } from "medusa-react" + + type Props = { + paymentCollectionId: string + } + + const PaymentCollection = ({ + paymentCollectionId + }: Props) => { + const { + payment_collection, + isLoading + } = usePaymentCollection( + paymentCollectionId + ) + + return ( +
+ {isLoading && Loading...} + {payment_collection && ( + {payment_collection.status} + )} +
+ ) + } + + export default PaymentCollection - lang: Shell label: cURL source: | @@ -3066,6 +3882,39 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useManagePaymentSession } from "medusa-react" + + type Props = { + paymentCollectionId: string + } + + const PaymentCollection = ({ + paymentCollectionId + }: Props) => { + const managePaymentSession = useManagePaymentSession( + paymentCollectionId + ) + + const handleManagePaymentSession = ( + providerId: string + ) => { + managePaymentSession.mutate({ + provider_id: providerId + }, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.payment_sessions) + } + }) + } + + // ... + } + + export default PaymentCollection - lang: Shell label: cURL source: > @@ -3174,6 +4023,64 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useManageMultiplePaymentSessions } from "medusa-react" + + type Props = { + paymentCollectionId: string + } + + const PaymentCollection = ({ + paymentCollectionId + }: Props) => { + const managePaymentSessions = useManageMultiplePaymentSessions( + paymentCollectionId + ) + + const handleManagePaymentSessions = () => { + // Total amount = 10000 + + // Example 1: Adding two new sessions + managePaymentSessions.mutate({ + sessions: [ + { + provider_id: "stripe", + amount: 5000, + }, + { + provider_id: "manual", + amount: 5000, + }, + ] + }, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.payment_sessions) + } + }) + + // Example 2: Updating one session and removing the other + managePaymentSessions.mutate({ + sessions: [ + { + provider_id: "stripe", + amount: 10000, + session_id: "ps_123456" + }, + ] + }, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.payment_sessions) + } + }) + } + + // ... + } + + export default PaymentCollection - lang: Shell label: cURL source: > @@ -3255,6 +4162,38 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAuthorizePaymentSessionsBatch } from "medusa-react" + + type Props = { + paymentCollectionId: string + } + + const PaymentCollection = ({ + paymentCollectionId + }: Props) => { + const authorizePaymentSessions = useAuthorizePaymentSessionsBatch( + paymentCollectionId + ) + // ... + + const handleAuthorizePayments = (paymentSessionIds: string[]) => { + authorizePaymentSessions.mutate({ + session_ids: paymentSessionIds + }, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.payment_sessions) + } + }) + } + + // ... + } + + export default PaymentCollection - lang: Shell label: cURL source: > @@ -3322,6 +4261,41 @@ paths: .then(({ payment_session }) => { console.log(payment_session.id); }) + - lang: tsx + label: Medusa React + source: > + import React from "react" + + import { usePaymentCollectionRefreshPaymentSession } from + "medusa-react" + + + type Props = { + paymentCollectionId: string + } + + + const PaymentCollection = ({ + paymentCollectionId + }: Props) => { + const refreshPaymentSession = usePaymentCollectionRefreshPaymentSession( + paymentCollectionId + ) + // ... + + const handleRefreshPaymentSession = (paymentSessionId: string) => { + refreshPaymentSession.mutate(paymentSessionId, { + onSuccess: ({ payment_session }) => { + console.log(payment_session.status) + } + }) + } + + // ... + } + + + export default PaymentCollection - lang: Shell label: cURL source: > @@ -3386,6 +4360,36 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useAuthorizePaymentSession } from "medusa-react" + + type Props = { + paymentCollectionId: string + } + + const PaymentCollection = ({ + paymentCollectionId + }: Props) => { + const authorizePaymentSession = useAuthorizePaymentSession( + paymentCollectionId + ) + // ... + + const handleAuthorizePayment = (paymentSessionId: string) => { + authorizePaymentSession.mutate(paymentSessionId, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.payment_sessions) + } + }) + } + + // ... + } + + export default PaymentCollection - lang: Shell label: cURL source: > @@ -3497,6 +4501,38 @@ paths: .then(({ product_categories, limit, offset, count }) => { console.log(product_categories.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useProductCategories } from "medusa-react" + + function Categories() { + const { + product_categories, + isLoading, + } = useProductCategories() + + return ( +
+ {isLoading && Loading...} + {product_categories && !product_categories.length && ( + No Categories + )} + {product_categories && product_categories.length > 0 && ( +
    + {product_categories.map( + (category) => ( +
  • {category.name}
    • + ) + )} +
+ )} +
+ ) + } + + export default Categories - lang: Shell label: cURL source: | @@ -3573,6 +4609,30 @@ paths: .then(({ product_category }) => { console.log(product_category.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useProductCategory } from "medusa-react" + + type Props = { + categoryId: string + } + + const Category = ({ categoryId }: Props) => { + const { product_category, isLoading } = useProductCategory( + categoryId + ) + + return ( +
+ {isLoading && Loading...} + {product_category && {product_category.name}} +
+ ) + } + + export default Category - lang: Shell label: cURL source: | @@ -3721,6 +4781,38 @@ paths: .then(({ product_tags }) => { console.log(product_tags.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useProductTags } from "medusa-react" + + function Tags() { + const { + product_tags, + isLoading, + } = useProductTags() + + return ( +
+ {isLoading && Loading...} + {product_tags && !product_tags.length && ( + No Product Tags + )} + {product_tags && product_tags.length > 0 && ( +
    + {product_tags.map( + (tag) => ( +
  • {tag.value}
    • + ) + )} +
+ )} +
+ ) + } + + export default Tags - lang: Shell label: cURL source: | @@ -3868,6 +4960,38 @@ paths: .then(({ product_types }) => { console.log(product_types.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useProductTypes } from "medusa-react" + + function Types() { + const { + product_types, + isLoading, + } = useProductTypes() + + return ( +
+ {isLoading && Loading...} + {product_types && !product_types.length && ( + No Product Types + )} + {product_types && product_types.length > 0 && ( +
    + {product_types.map( + (type) => ( +
  • {type.value}
    • + ) + )} +
+ )} +
+ ) + } + + export default Types - lang: Shell label: cURL source: | @@ -4148,6 +5272,31 @@ paths: .then(({ products, limit, offset, count }) => { console.log(products.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useProducts } from "medusa-react" + + const Products = () => { + const { products, isLoading } = useProducts() + + return ( +
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
+ ) + } + + export default Products - lang: Shell label: cURL source: | @@ -4321,6 +5470,28 @@ paths: .then(({ product }) => { console.log(product.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useProduct } from "medusa-react" + + type Props = { + productId: string + } + + const Product = ({ productId }: Props) => { + const { product, isLoading } = useProduct(productId) + + return ( +
+ {isLoading && Loading...} + {product && {product.title}} +
+ ) + } + + export default Product - lang: Shell label: cURL source: | @@ -4430,6 +5601,32 @@ paths: .then(({ regions, count, limit, offset }) => { console.log(regions.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useRegions } from "medusa-react" + + const Regions = () => { + const { regions, isLoading } = useRegions() + + return ( +
+ {isLoading && Loading...} + {regions?.length && ( +
    + {regions.map((region) => ( +
  • + {region.name} +
    • + ))} +
+ )} +
+ ) + } + + export default Regions - lang: Shell label: cURL source: | @@ -4481,6 +5678,30 @@ paths: .then(({ region }) => { console.log(region.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useRegion } from "medusa-react" + + type Props = { + regionId: string + } + + const Region = ({ regionId }: Props) => { + const { region, isLoading } = useRegion( + regionId + ) + + return ( +
+ {isLoading && Loading...} + {region && {region.name}} +
+ ) + } + + export default Region - lang: Shell label: cURL source: | @@ -4527,6 +5748,35 @@ paths: .then(({ return_reasons }) => { console.log(return_reasons.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useReturnReasons } from "medusa-react" + + const ReturnReasons = () => { + const { + return_reasons, + isLoading + } = useReturnReasons() + + return ( +
+ {isLoading && Loading...} + {return_reasons?.length && ( +
    + {return_reasons.map((returnReason) => ( +
  • + {returnReason.label} +
    • + ))} +
+ )} +
+ ) + } + + export default ReturnReasons - lang: Shell label: cURL source: | @@ -4578,6 +5828,33 @@ paths: .then(({ return_reason }) => { console.log(return_reason.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useReturnReason } from "medusa-react" + + type Props = { + returnReasonId: string + } + + const ReturnReason = ({ returnReasonId }: Props) => { + const { + return_reason, + isLoading + } = useReturnReason( + returnReasonId + ) + + return ( +
+ {isLoading && Loading...} + {return_reason && {return_reason.label}} +
+ ) + } + + export default ReturnReason - lang: Shell label: cURL source: | @@ -4640,6 +5917,45 @@ paths: .then((data) => { console.log(data.return.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCreateReturn } from "medusa-react" + + type CreateReturnData = { + items: { + item_id: string, + quantity: number + }[] + return_shipping: { + option_id: string + } + } + + type Props = { + orderId: string + } + + const CreateReturn = ({ orderId }: Props) => { + const createReturn = useCreateReturn() + // ... + + const handleCreate = (data: CreateReturnData) => { + createReturn.mutate({ + ...data, + order_id: orderId + }, { + onSuccess: ({ return: returnData }) => { + console.log(returnData.id) + } + }) + } + + // ... + } + + export default CreateReturn - lang: Shell label: cURL source: | @@ -4718,6 +6034,36 @@ paths: .then(({ shipping_options }) => { console.log(shipping_options.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useShippingOptions } from "medusa-react" + + const ShippingOptions = () => { + const { + shipping_options, + isLoading, + } = useShippingOptions() + + return ( +
+ {isLoading && Loading...} + {shipping_options?.length && + shipping_options?.length > 0 && ( +
    + {shipping_options?.map((shipping_option) => ( +
  • + {shipping_option.id} +
    • + ))} +
+ )} +
+ ) + } + + export default ShippingOptions - lang: Shell label: cURL source: | @@ -4773,6 +6119,42 @@ paths: .then(({ shipping_options }) => { console.log(shipping_options.length); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCartShippingOptions } from "medusa-react" + + type Props = { + cartId: string + } + + const ShippingOptions = ({ cartId }: Props) => { + const { shipping_options, isLoading } = + useCartShippingOptions(cartId) + + return ( +
+ {isLoading && Loading...} + {shipping_options && !shipping_options.length && ( + No shipping options + )} + {shipping_options && ( +
    + {shipping_options.map( + (shipping_option) => ( +
  • + {shipping_option.name} +
    • + ) + )} +
+ )} +
+ ) + } + + export default ShippingOptions - lang: Shell label: cURL source: | @@ -4855,6 +6237,51 @@ paths: .then(({ swap }) => { console.log(swap.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCreateSwap } from "medusa-react" + + type Props = { + orderId: string + } + + type CreateData = { + return_items: { + item_id: string + quantity: number + }[] + additional_items: { + variant_id: string + quantity: number + }[] + return_shipping_option: string + } + + const CreateSwap = ({ + orderId + }: Props) => { + const createSwap = useCreateSwap() + // ... + + const handleCreate = ( + data: CreateData + ) => { + createSwap.mutate({ + ...data, + order_id: orderId + }, { + onSuccess: ({ swap }) => { + console.log(swap.id) + } + }) + } + + // ... + } + + export default CreateSwap - lang: Shell label: cURL source: | @@ -4922,6 +6349,31 @@ paths: .then(({ swap }) => { console.log(swap.id); }) + - lang: tsx + label: Medusa React + source: | + import React from "react" + import { useCartSwap } from "medusa-react" + type Props = { + cartId: string + } + + const Swap = ({ cartId }: Props) => { + const { + swap, + isLoading, + } = useCartSwap(cartId) + + return ( +
+ {isLoading && Loading...} + {swap && {swap.id}} + +
+ ) + } + + export default Swap - lang: Shell label: cURL source: | @@ -13210,6 +14662,7 @@ components: $ref: '#/components/schemas/Order' StorePaymentCollectionSessionsReq: type: object + description: The details of the payment session to manage. required: - provider_id properties: @@ -13235,6 +14688,7 @@ components: $ref: '#/components/schemas/PaymentCollection' StorePaymentCollectionsSessionRes: type: object + description: The details of the payment session. required: - payment_session properties: @@ -13314,6 +14768,7 @@ components: user_agent: Chrome StorePostCartsCartLineItemsItemReq: type: object + description: The details to update of the line item. required: - quantity properties: @@ -13333,6 +14788,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute StorePostCartsCartLineItemsReq: type: object + description: The details of the line item to create. required: - variant_id - quantity @@ -13356,6 +14812,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute StorePostCartsCartPaymentSessionReq: type: object + description: The details of the payment session to set. required: - provider_id properties: @@ -13372,6 +14829,7 @@ components: description: The data to update the payment session with. StorePostCartsCartReq: type: object + description: The details to update of the cart. properties: region_id: type: string @@ -13451,6 +14909,7 @@ components: user_agent: Chrome StorePostCartsCartShippingMethodReq: type: object + description: The details of the shipping method to add to the cart. required: - option_id properties: @@ -13465,6 +14924,7 @@ components: provider you're using. StorePostCustomersCustomerAcceptClaimReq: type: object + description: The details necessary to grant order access. required: - token properties: @@ -13486,6 +14946,7 @@ components: $ref: '#/components/schemas/AddressCreatePayload' StorePostCustomersCustomerOrderClaimReq: type: object + description: The details of the orders to claim. required: - order_ids properties: @@ -13505,6 +14966,7 @@ components: format: email StorePostCustomersCustomerReq: type: object + description: The details to update of the customer. properties: first_name: description: The customer's first name. @@ -13539,6 +15001,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute StorePostCustomersReq: type: object + description: The details of the customer to create. required: - first_name - last_name @@ -13582,12 +15045,14 @@ components: type: string StorePostOrderEditsOrderEditDecline: type: object + description: The details of the order edit's decline. properties: declined_reason: type: string description: The reason for declining the Order Edit. StorePostPaymentCollectionsBatchSessionsAuthorizeReq: type: object + description: The details of the payment sessions to authorize. required: - session_ids properties: @@ -13598,6 +15063,7 @@ components: type: string StorePostPaymentCollectionsBatchSessionsReq: type: object + description: The details of the payment sessions to manage. required: - sessions properties: @@ -13625,6 +15091,7 @@ components: provided, a new payment session is created. StorePostReturnsReq: type: object + description: The details of the return to create. required: - order_id - items @@ -13697,6 +15164,7 @@ components: - type: object StorePostSwapsReq: type: object + description: The details of the swap to create. required: - order_id - return_items diff --git a/www/apps/api-reference/specs/store/paths/store_carts.yaml b/www/apps/api-reference/specs/store/paths/store_carts.yaml index cf9b4035e0e1a..c876671fbd52b 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts.yaml @@ -24,6 +24,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_carts/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_carts/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml index 821ee29ae5531..dc67f514baf0c 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml @@ -16,6 +16,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_carts_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_carts_{id}/getundefined - lang: Shell label: cURL source: @@ -65,6 +69,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_carts_{id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_carts_{id}/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml index e4bdb138a2a76..d5e19567d38ef 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml @@ -34,6 +34,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_carts_{id}_complete/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_carts_{id}_complete/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml index c542c8af1297a..efa934965b581 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml @@ -21,6 +21,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_carts_{id}_line-items/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_carts_{id}_line-items/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml index f6bd24c0c0b10..b47e280b42066 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml @@ -28,6 +28,11 @@ post: source: $ref: >- ../code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/store_carts_{id}_line-items_{line_id}/postundefined - lang: Shell label: cURL source: @@ -78,6 +83,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/store_carts_{id}_line-items_{line_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-session.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-session.yaml index 7a6f27e24abbd..577f3381a3487 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-session.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-session.yaml @@ -24,6 +24,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_carts_{id}_payment-session/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_carts_{id}_payment-session/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml index 242657d9d1120..55d64a93db735 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml @@ -20,6 +20,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_carts_{id}_payment-sessions/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_carts_{id}_payment-sessions/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}.yaml index 1423e5afde851..f28d4659635e1 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}.yaml @@ -31,6 +31,11 @@ post: source: $ref: >- ../code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/postundefined - lang: Shell label: cURL source: @@ -84,6 +89,11 @@ delete: source: $ref: >- ../code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/delete.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/deleteundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}_refresh.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}_refresh.yaml index 8f3a0f1361a9e..b2ce47082818b 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}_refresh.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}_refresh.yaml @@ -27,6 +27,11 @@ post: source: $ref: >- ../code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}_refresh/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml index 38a899f2a77ce..ce8d8093ba53e 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml @@ -23,6 +23,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_carts_{id}_shipping-methods/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_carts_{id}_shipping-methods/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_collections.yaml b/www/apps/api-reference/specs/store/paths/store_collections.yaml index 89db538f6f904..b7d013a7fb2c5 100644 --- a/www/apps/api-reference/specs/store/paths/store_collections.yaml +++ b/www/apps/api-reference/specs/store/paths/store_collections.yaml @@ -81,6 +81,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_collections/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_collections/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml index fb9a6775debbc..deae8fc2e2e36 100644 --- a/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml @@ -16,6 +16,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_collections_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_collections_{id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_customers.yaml b/www/apps/api-reference/specs/store/paths/store_customers.yaml index fc9dae89fd873..243ecc32af2dc 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers.yaml @@ -19,6 +19,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_customers/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_customers/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml index b85d631c5c5f0..d7d83fe2d8d1f 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml @@ -10,6 +10,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_customers_me/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_customers_me/getundefined - lang: Shell label: cURL source: @@ -55,6 +59,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_customers_me/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_customers_me/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_orders.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_orders.yaml index b22f72150d6d5..c437a28621110 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me_orders.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me_orders.yaml @@ -204,6 +204,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_customers_me_orders/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_customers_me_orders/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_gift-cards_{code}.yaml b/www/apps/api-reference/specs/store/paths/store_gift-cards_{code}.yaml index 7ae718781bfdd..c3fa88a3de581 100644 --- a/www/apps/api-reference/specs/store/paths/store_gift-cards_{code}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_gift-cards_{code}.yaml @@ -16,6 +16,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_gift-cards_{code}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_gift-cards_{code}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_order-edits_{id}.yaml index 78432bf61d06d..3abdb3c8fdf33 100644 --- a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_order-edits_{id}.yaml @@ -16,6 +16,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_order-edits_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_order-edits_{id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_complete.yaml b/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_complete.yaml index 358296f3ccfb4..d56050141fc3b 100644 --- a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_complete.yaml +++ b/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_complete.yaml @@ -22,6 +22,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_order-edits_{id}_complete/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_order-edits_{id}_complete/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_decline.yaml b/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_decline.yaml index b596bb85440c0..78d018ed8ed66 100644 --- a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_decline.yaml +++ b/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_decline.yaml @@ -21,6 +21,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_order-edits_{id}_decline/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_order-edits_{id}_decline/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_orders.yaml b/www/apps/api-reference/specs/store/paths/store_orders.yaml index e649f00c70706..6dea58f0291e7 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders.yaml @@ -49,6 +49,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_orders/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_orders/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_orders_batch_customer_token.yaml b/www/apps/api-reference/specs/store/paths/store_orders_batch_customer_token.yaml index 7b321c464b30f..96fc1760c4d83 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_batch_customer_token.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_batch_customer_token.yaml @@ -25,6 +25,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_orders_batch_customer_token/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_orders_batch_customer_token/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_orders_cart_{cart_id}.yaml b/www/apps/api-reference/specs/store/paths/store_orders_cart_{cart_id}.yaml index 1e354fcbd34cc..8de225126f7f6 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_cart_{cart_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_cart_{cart_id}.yaml @@ -18,6 +18,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_orders_cart_{cart_id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_orders_cart_{cart_id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_orders_customer_confirm.yaml b/www/apps/api-reference/specs/store/paths/store_orders_customer_confirm.yaml index 7013b0cc4966d..47ae9bbc0dcf0 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_customer_confirm.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_customer_confirm.yaml @@ -19,6 +19,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_orders_customer_confirm/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_orders_customer_confirm/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml index c0e3c1cdd53f8..8620f73831fff 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml @@ -26,6 +26,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_orders_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_orders_{id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}.yaml index 0795a003b70ba..fdf679fad9c0d 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}.yaml @@ -32,6 +32,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_payment-collections_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_payment-collections_{id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions.yaml index 27c99ffc41743..cb639711d60bf 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions.yaml @@ -23,6 +23,11 @@ post: source: $ref: >- ../code_samples/JavaScript/store_payment-collections_{id}_sessions/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/store_payment-collections_{id}_sessions/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml index dc53193384856..5cb5db978459d 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml @@ -27,6 +27,11 @@ post: source: $ref: >- ../code_samples/JavaScript/store_payment-collections_{id}_sessions_batch/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/store_payment-collections_{id}_sessions_batch/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch_authorize.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch_authorize.yaml index 89e7b415a85bf..44246966d883b 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch_authorize.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch_authorize.yaml @@ -24,6 +24,11 @@ post: source: $ref: >- ../code_samples/JavaScript/store_payment-collections_{id}_sessions_batch_authorize/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/store_payment-collections_{id}_sessions_batch_authorize/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}.yaml index 4d417ffce210f..bb13dd01d3624 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}.yaml @@ -26,6 +26,11 @@ post: source: $ref: >- ../code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml index 6319d711e00ff..027073342e5a7 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml @@ -24,6 +24,11 @@ post: source: $ref: >- ../code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}_authorize/post.js + - lang: tsx + label: Medusa React + source: + $ref: >- + ../code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}_authorize/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml index 780d0cb26f2d8..dfa55d05ff778 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml @@ -70,6 +70,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_product-categories/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_product-categories/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml index 6bc026824c5c6..d6c68744f64b9 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml @@ -32,6 +32,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_product-categories_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_product-categories_{id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_product-tags.yaml b/www/apps/api-reference/specs/store/paths/store_product-tags.yaml index 5221ed8ae2bdf..fe223363b39a3 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-tags.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-tags.yaml @@ -105,6 +105,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_product-tags/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_product-tags/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_product-types.yaml b/www/apps/api-reference/specs/store/paths/store_product-types.yaml index c240626323ecc..c2c4464279481 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-types.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-types.yaml @@ -106,6 +106,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_product-types/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_product-types/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_products.yaml b/www/apps/api-reference/specs/store/paths/store_products.yaml index d2088223a9d6f..1dea7e73fba02 100644 --- a/www/apps/api-reference/specs/store/paths/store_products.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products.yaml @@ -237,6 +237,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_products/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_products/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml index c4d0a3520feba..1bea1f59af364 100644 --- a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml @@ -76,6 +76,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_products_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_products_{id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_regions.yaml b/www/apps/api-reference/specs/store/paths/store_regions.yaml index 3541266894e23..9b7281db06618 100644 --- a/www/apps/api-reference/specs/store/paths/store_regions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_regions.yaml @@ -74,6 +74,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_regions/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_regions/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml index a3300e413a45b..0685fe0d2eb5c 100644 --- a/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml @@ -16,6 +16,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_regions_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_regions_{id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml b/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml index 8ad0f52a7a9f2..ac732ae6b5ea8 100644 --- a/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml +++ b/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml @@ -11,6 +11,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_return-reasons/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_return-reasons/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml index 5d7176ee736c3..21bd015421184 100644 --- a/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml @@ -16,6 +16,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_return-reasons_{id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_return-reasons_{id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_returns.yaml b/www/apps/api-reference/specs/store/paths/store_returns.yaml index 3cd268be36aad..bab47098a1b95 100644 --- a/www/apps/api-reference/specs/store/paths/store_returns.yaml +++ b/www/apps/api-reference/specs/store/paths/store_returns.yaml @@ -19,6 +19,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_returns/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_returns/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml index 6c7fc4e3602cf..46c0a96171530 100644 --- a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml +++ b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml @@ -33,6 +33,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_shipping-options/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_shipping-options/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml b/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml index 0303724297e77..fdae31e141c28 100644 --- a/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml @@ -20,6 +20,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_shipping-options_{cart_id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_shipping-options_{cart_id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_swaps.yaml b/www/apps/api-reference/specs/store/paths/store_swaps.yaml index 12afefc0a8bca..1684c22a377eb 100644 --- a/www/apps/api-reference/specs/store/paths/store_swaps.yaml +++ b/www/apps/api-reference/specs/store/paths/store_swaps.yaml @@ -33,6 +33,10 @@ post: label: JS Client source: $ref: ../code_samples/JavaScript/store_swaps/post.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_swaps/postundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_swaps_{cart_id}.yaml b/www/apps/api-reference/specs/store/paths/store_swaps_{cart_id}.yaml index d01ff474b74da..b8071c211277e 100644 --- a/www/apps/api-reference/specs/store/paths/store_swaps_{cart_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_swaps_{cart_id}.yaml @@ -16,6 +16,10 @@ get: label: JS Client source: $ref: ../code_samples/JavaScript/store_swaps_{cart_id}/get.js + - lang: tsx + label: Medusa React + source: + $ref: ../code_samples/tsx/store_swaps_{cart_id}/getundefined - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/utils/get-paths-of-tag.ts b/www/apps/api-reference/utils/get-paths-of-tag.ts index 5f9496c1f21a9..630ded00069d5 100644 --- a/www/apps/api-reference/utils/get-paths-of-tag.ts +++ b/www/apps/api-reference/utils/get-paths-of-tag.ts @@ -64,11 +64,16 @@ export default async function getPathsOfTag( }) // resolve references in paths - paths = (await OpenAPIParser.dereference( - `${basePath}/`, - paths, - {} - )) as unknown as Document + paths = (await OpenAPIParser.dereference(`${basePath}/`, paths, { + parse: { + text: { + // This ensures that all files are parsed as expected + // resolving the error with incorrect new lines for + // example files having `undefined` extension. + canParse: /.*/, + }, + }, + })) as unknown as Document return paths } diff --git a/www/apps/docs/content/development/batch-jobs/create.mdx b/www/apps/docs/content/development/batch-jobs/create.mdx index bcd21f4ebcf03..7e8726ae393d3 100644 --- a/www/apps/docs/content/development/batch-jobs/create.mdx +++ b/www/apps/docs/content/development/batch-jobs/create.mdx @@ -295,7 +295,7 @@ For example, this creates a batch job of the type `publish-products`: - ```jsx + ```ts medusa.admin.batchJobs.create({ type: "publish-products", context: { }, @@ -306,10 +306,38 @@ For example, this creates a batch job of the type `publish-products`: }) ``` + + + + ```tsx + import { useAdminCreateBatchJob } from "medusa-react" + + const CreateBatchJob = () => { + const createBatchJob = useAdminCreateBatchJob() + // ... + + const handleCreateBatchJob = () => { + createBatchJob.mutate({ + type: "publish-products", + context: {}, + dry_run: true + }, { + onSuccess: ({ batch_job }) => { + console.log(batch_job) + } + }) + } + + // ... + } + + export default CreateBatchJob + ``` + - ```jsx + ```ts fetch(`/admin/batch-jobs`, { method: "POST", credentials: "include", @@ -356,17 +384,41 @@ You can retrieve the batch job afterward to get its status and view details abou - ```jsx + ```ts medusa.admin.batchJobs.retrieve(batchJobId) .then(( batch_job ) => { console.log(batch_job.status, batch_job.result) }) ``` + + + + ```tsx + import { useAdminBatchJob } from "medusa-react" + + type Props = { + batchJobId: string + } + + const BatchJob = ({ batchJobId }: Props) => { + const { batch_job, isLoading } = useAdminBatchJob(batchJobId) + + return ( +
+ {isLoading && Loading...} + {batch_job && {batch_job.created_by}} +
+ ) + } + + export default BatchJob + ``` + - ```jsx + ```ts fetch(`/admin/batch-jobs/${batchJobId}`, { credentials: "include", }) @@ -411,17 +463,45 @@ To process the batch job, send a request to [confirm the batch job](https://docs - ```jsx + ```ts medusa.admin.batchJobs.confirm(batchJobId) .then(( batch_job ) => { console.log(batch_job.status) }) ``` + + + + ```tsx + import { useAdminConfirmBatchJob } from "medusa-react" + + type Props = { + batchJobId: string + } + + const BatchJob = ({ batchJobId }: Props) => { + const confirmBatchJob = useAdminConfirmBatchJob(batchJobId) + // ... + + const handleConfirm = () => { + confirmBatchJob.mutate(undefined, { + onSuccess: ({ batch_job }) => { + console.log(batch_job) + } + }) + } + + // ... + } + + export default BatchJob + ``` + - ```jsx + ```ts fetch(`/admin/batch-jobs/${batchJobId}/confirm`, { method: "POST", credentials: "include", diff --git a/www/apps/docs/content/development/publishable-api-keys/admin/manage-publishable-api-keys.mdx b/www/apps/docs/content/development/publishable-api-keys/admin/manage-publishable-api-keys.mdx index 2396035ee9f55..45783833c5d80 100644 --- a/www/apps/docs/content/development/publishable-api-keys/admin/manage-publishable-api-keys.mdx +++ b/www/apps/docs/content/development/publishable-api-keys/admin/manage-publishable-api-keys.mdx @@ -179,6 +179,10 @@ You can create a publishable API key by sending a request to the [Create Publish const handleCreate = (title: string) => { createKey.mutate({ title, + }, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.id) + } }) } @@ -249,9 +253,15 @@ You can update a publishable API key’s details by sending a request to the [Up ```tsx - import { useAdminUpdatePublishableApiKey } from "medusa-react" + import { useAdminUpdatePublishableApiKey } from "medusa-react" + + type Props = { + publishableApiKeyId: string + } - const UpdatePublishableApiKey = () => { + const PublishableApiKey = ({ + publishableApiKeyId + }: Props) => { const updateKey = useAdminUpdatePublishableApiKey( publishableApiKeyId ) @@ -260,13 +270,17 @@ You can update a publishable API key’s details by sending a request to the [Up const handleUpdate = (title: string) => { updateKey.mutate({ title, + }, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.id) + } }) } // ... } - export default UpdatePublishableApiKey + export default PublishableApiKey ``` @@ -334,14 +348,24 @@ You can revoke a publishable API key by sending a request to the [Revoke Publish ```tsx import { useAdminRevokePublishableApiKey } from "medusa-react" - const PublishableApiKey = () => { + type Props = { + publishableApiKeyId: string + } + + const PublishableApiKey = ({ + publishableApiKeyId + }: Props) => { const revokeKey = useAdminRevokePublishableApiKey( publishableApiKeyId ) // ... const handleRevoke = () => { - revokeKey.mutate() + revokeKey.mutate(void 0, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.revoked_at) + } + }) } // ... @@ -404,14 +428,24 @@ You can delete a publishable API key by sending a request to the [Delete Publish ```tsx import { useAdminDeletePublishableApiKey } from "medusa-react" - const PublishableApiKey = () => { + type Props = { + publishableApiKeyId: string + } + + const PublishableApiKey = ({ + publishableApiKeyId + }: Props) => { const deleteKey = useAdminDeletePublishableApiKey( publishableApiKeyId ) // ... const handleDelete = () => { - deleteKey.mutate() + deleteKey.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... @@ -480,12 +514,17 @@ You can retrieve the list of sales channels associated with a publishable API ke ```tsx - import { SalesChannel } from "@medusajs/medusa" import { useAdminPublishableApiKeySalesChannels, } from "medusa-react" - const SalesChannels = () => { + type Props = { + publishableApiKeyId: string + } + + const SalesChannels = ({ + publishableApiKeyId + }: Props) => { const { sales_channels, isLoading } = useAdminPublishableApiKeySalesChannels( publishableApiKeyId @@ -499,7 +538,7 @@ You can retrieve the list of sales channels associated with a publishable API ke )} {sales_channels && sales_channels.length > 0 && (
    - {sales_channels.map((salesChannel: SalesChannel) => ( + {sales_channels.map((salesChannel) => (
  • {salesChannel.name}
    • ))}
@@ -575,7 +614,13 @@ You can add a sales channel to a publishable API key by sending a request to the useAdminAddPublishableKeySalesChannelsBatch, } from "medusa-react" - const PublishableApiKey = () => { + type Props = { + publishableApiKeyId: string + } + + const PublishableApiKey = ({ + publishableApiKeyId + }: Props) => { const addSalesChannels = useAdminAddPublishableKeySalesChannelsBatch( publishableApiKeyId @@ -589,6 +634,10 @@ You can add a sales channel to a publishable API key by sending a request to the id: salesChannelId, }, ], + }, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.id) + } }) } @@ -685,13 +734,19 @@ You can delete a sales channel from a publishable API key by sending a request t useAdminRemovePublishableKeySalesChannelsBatch, } from "medusa-react" - const PublishableApiKey = () => { + type Props = { + publishableApiKeyId: string + } + + const PublishableApiKey = ({ + publishableApiKeyId + }: Props) => { const deleteSalesChannels = useAdminRemovePublishableKeySalesChannelsBatch( publishableApiKeyId ) // ... - + const handleDelete = (salesChannelId: string) => { deleteSalesChannels.mutate({ sales_channel_ids: [ @@ -699,12 +754,16 @@ You can delete a sales channel from a publishable API key by sending a request t id: salesChannelId, }, ], + }, { + onSuccess: ({ publishable_api_key }) => { + console.log(publishable_api_key.id) + } }) } - + // ... } - + export default PublishableApiKey ``` diff --git a/www/apps/docs/content/homepage.mdx b/www/apps/docs/content/homepage.mdx index 2a014d7b3a82d..b3e86201a11dc 100644 --- a/www/apps/docs/content/homepage.mdx +++ b/www/apps/docs/content/homepage.mdx @@ -162,33 +162,29 @@ Learn about all the new features and enhancements in Medusa. diff --git a/www/apps/docs/content/js-client/overview.mdx b/www/apps/docs/content/js-client/overview.mdx index b877d4c063ef9..f6b7f02636524 100644 --- a/www/apps/docs/content/js-client/overview.mdx +++ b/www/apps/docs/content/js-client/overview.mdx @@ -117,7 +117,7 @@ const medusa = new Medusa({ ### JWT Token -You can use a JWT token to authenticate both admin users and customers. Authentication state is managed by the client, which is ideal for Jamstack applications and mobile applications. +You can use a JWT token to authenticate both admin users and customers. Authentication state is managed by the client, which is ideal for Jamstack and mobile applications. You can authenticate the admin user using the [admin.auth.getToken](../references/js_client/classes/js_client.AdminAuthResource.mdx#getToken) method, and the customer using the [auth.getToken](../references/js_client/classes/js_client.AuthResource.mdx#getToken) method. @@ -209,7 +209,7 @@ For example: You can authenticate admin users with a personal API Token. -If a user doesn't have a personal API token, create one with the [admin.users.update](../references/js_client/classes/js_client.AdminUsersResource.mdx#update) method: +If a user doesn't have a personal API token, create one with the [admin.users.update](../references/js_client/classes/js_client.AdminUsersResource.mdx#update) method or the [Update User API route](https://docs.medusajs.com/api/admin#users_postusersuser): diff --git a/www/apps/docs/content/medusa-react/overview.mdx b/www/apps/docs/content/medusa-react/overview.mdx index d8a20946a2a42..71b02ed49f55c 100644 --- a/www/apps/docs/content/medusa-react/overview.mdx +++ b/www/apps/docs/content/medusa-react/overview.mdx @@ -7,13 +7,11 @@ import TabItem from '@theme/TabItem'; # Medusa React -[Medusa React](https://www.npmjs.com/package/medusa-react) is a React library that provides a set of utilities and hooks for interacting seamlessly with the Medusa backend. It can be used to build custom React-based storefronts or admin dashboards. +[Medusa React](https://www.npmjs.com/package/medusa-react) is a React library that provides a set of utilities and hooks for interacting seamlessly with the Medusa backend. -:::tip +For example, if you're creating a storefront with frameworks like Nuxt, you can send requests to the backend using this client. You can also use it in your Medusa admin customizations. -Alternatively, you can use Medusa’s [JS Client](../js-client/overview.mdx) or the [REST APIs](https://docs.medusajs.com/api/store). - -::: +This reference provides details on the available hooks, providers, and utilities, including examples of each. ## Installation @@ -25,15 +23,8 @@ npm install medusa-react @tanstack/react-query@4.22 @medusajs/medusa In addition to the `medusa-react` library, you need the following libraries: -1\. `@tanstack/react-query`: `medusa-react` is built on top of [Tanstack Query v4.22](https://tanstack.com/query/v4/docs/react/overview). You’ll learn later in this reference how you can use Mutations and Queries with Medusa React. - -:::note - -Versions of Medusa React prior to v4.0.2 used React Query v3 instead of Tanstack Query. Check out [this upgrade guide](../upgrade-guides/medusa-react/4-0-2.md) to learn how you can update your storefront. - -::: - -2\. `@medusajs/medusa`: The core Medusa package. This is used to import types used by Medusa React and while developing with it. +1. `@tanstack/react-query`: `medusa-react` is built on top of [Tanstack Query v4.22](https://tanstack.com/query/v4/docs/react/overview). You’ll learn later in this reference how you can use Mutations and Queries with Medusa React. +2. `@medusajs/medusa`: The core Medusa package. This is used to import types used by Medusa React and while developing with it. :::info @@ -45,13 +36,15 @@ Part of the Medusa roadmap is to move the types into a separate package, removin ## Usage -To use the hooks exposed by Medusa React, you need to include the `MedusaProvider` somewhere up in your component tree. +To use the hooks exposed by Medusa React, include the `MedusaProvider` somewhere up in your component tree. The `MedusaProvider` requires two props: 1. `baseUrl`: The URL to your Medusa backend 2. `queryClientProviderProps`: An object used to set the Tanstack Query client. The object requires a `client` property, which should be an instance of [QueryClient](https://tanstack.com/query/v4/docs/react/reference/QueryClient). +Learn about other optional props in [this reference](../references/medusa_react/Providers/medusa_react.Providers.Medusa.mdx) + For example: ```tsx title="src/App.ts" @@ -76,44 +69,51 @@ const App = () => { export default App ``` -In the example above, you wrap the `Storefront` component with the `MedusaProvider`. `Storefront` is assumed to be the top-level component of your storefront, but you can place `MedusaProvider` at any point in your tree. Only children of `MedusaProvider` can benefit from its hooks. +In the example above, you wrap the `Storefront` component with the `MedusaProvider`. `Storefront` is assumed to be the top-level component of your storefront, but you can place `MedusaProvider` at any point in your tree. -The `Storefront` component and its child components can now use hooks exposed by Medusa React. +Only children of `MedusaProvider` can benefit from its hooks. So, the `Storefront` component and its child components can now use hooks exposed by Medusa React. -### Troubleshooting: Could not find a declaration file for module 'medusa-react' +
+ Troubleshooting: Could not find a declaration file for module 'medusa-react' -If you import `medusa-react` in your code and see the following TypeScript error: + If you import `medusa-react` in your code and see the following TypeScript error: -```bash -Could not find a declaration file for module 'medusa-react' -``` + ```bash + Could not find a declaration file for module 'medusa-react' + ``` -Make sure to set `moduleResolution` in your `tsconfig.json` to `nodenext` or `node`: + Make sure to set `moduleResolution` in your `tsconfig.json` to `nodenext` or `node`: -```json title="tsconfig.json" -{ - "compilerOptions": { - "moduleResolution": "nodenext", + ```json title="tsconfig.json" + { + "compilerOptions": { + "moduleResolution": "nodenext", + // ... + }, // ... - }, - // ... -} -``` + } + ``` +
+ +## How to Use this Reference -### MedusaProvider Optional Props +You'll find in the sidebar three main categories to explore: -You can also pass the following props to Medusa Provider: +- Hooks: Includes all hooks used to send requests to the backend. Hooks are also split into Admin hooks that send requests to the admin, and Store hooks, that send requests to the store. +- Providers: Includes React providers helpful for your development using Medusa React. +- Utilities: Utility functions that are mainly useful for displaying product and variant pricing. -| Props | Default | Description | -| ------------------- | ------------------------- | --------------------------------------------------------- | -| `apiKey` | `''` | Optional API key used for authenticating admin requests. Follow [this guide](https://docs.medusajs.com/api/admin#authentication) to learn how to create an API key for an admin user. | -| `publishableApiKey` | `''` | Optional publishable API key used for storefront requests. You can create a publishable API key either using the [admin APIs](../development/publishable-api-keys/admin/manage-publishable-api-keys.mdx) or the [Medusa admin](../user-guide/settings/publishable-api-keys.mdx). | -| `maxRetries` | `3` | Number of times to retry a request if it fails. | -| `customHeaders` | `{}` | An object of custom headers to pass with every request. Each key of the object is the name of the header, and its value is the header's value. | +--- + +## Queries and Mutations + +Since Medusa React is built on top of Tanstack Queries, hooks can either be queries or mutations. ### Queries -To fetch data from the Medusa backend (in other words, perform `GET` requests), you can use [Queries](https://tanstack.com/query/v4/docs/react/guides/queries). Query hooks simply wrap around Tanstack Query's `useQuery` hook to fetch data from your Medusa backend. +To fetch data from the Medusa backend (in other words, perform `GET` requests), you can use [Queries](https://tanstack.com/query/v4/docs/react/guides/queries). + +Query hooks simply wrap around Tanstack Query's `useQuery` hook to fetch data from your Medusa backend. For example, to fetch products from your Medusa backend: @@ -142,23 +142,17 @@ const Products = () => { export default Products ``` -In the example above, you import the `useProducts` hook from `medusa-react`. This hook, and every other query hook exposed by `medusa-react`, returns everything that `useQuery` [returns in Tanstack Query](https://tanstack.com/query/v4/docs/react/reference/useQuery), except for the `data` field. +In the example above, you import the `useProducts` hook from `medusa-react`. -Instead of the `data` field, the response data is flattened and is part of the hooks’ returned fields. In the example above, the List Products API Route returns a `products` array. So, `useProducts` returns a `products` array along with other fields returned by `useQuery`. - -If the request accepts any parameters, they can be passed as parameters to the `mutate` request. For example: - -```tsx title="src/Products.ts" -const { products } = useProducts({ - expand: "variants", - }) -``` +This hook, and every other query hook exposed by `medusa-react`, returns everything that `useQuery` [returns in Tanstack Query](https://tanstack.com/query/v4/docs/react/reference/useQuery), except for the `data` field. Instead of the `data` field, the response data is flattened and is part of the hooks’ returned fields (see `products` in the example above). You can learn more about using queries in [Tanstack Query’s documentation](https://tanstack.com/query/v4/docs/react/guides/queries). ### Mutations -To create, update, or delete data on the Medusa backend (in other words, perform `POST`, `PUT`, and `DELETE` requests), you can use [Mutations](https://tanstack.com/query/v4/docs/react/guides/mutations). Mutation hooks wrap around Tanstack Query's `useMutation` to mutate data on your Medusa backend. +To create, update, or delete data on the Medusa backend (in other words, perform `POST`, `PUT`, and `DELETE` requests), you can use [Mutations](https://tanstack.com/query/v4/docs/react/guides/mutations). + +Mutation hooks wrap around Tanstack Query's `useMutation` to mutate data on your Medusa backend. For example, to create a cart: @@ -201,590 +195,607 @@ createCart.mutate({ }) ``` -Once the cart is created, you can access it in the `data` field returned by the mutation hook. This field includes all data returned in the response. - -:::note - -The example above does not store in the browser the ID of the cart created, so the cart’s data will be gone on release. You would have to do that using the browser’s [Local Storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). - -::: - Instead of using `mutate`, you can use `mutateAsync` to receive a Promise that resolves on success or throws on error. Learn more about how you can use mutations in [Tanstack Query’s documentation](https://tanstack.com/query/v4/docs/react/guides/mutations). -### Custom Hooks - -Medusa React provides three utility hooks that allows developers to consume their admin custom API Routes using the same Medusa React methods and conventions. - -#### useAdminCustomQuery - -The `useAdminCustomQuery` utility hook can be used to send a `GET` request to a custom API Route in your Medusa backend and retrieve data. It's a generic function, so you can pass a type for the request and the response if you're using TypeScript in your development. The first type parameter is the type of the request body, and the second type parameter is the type of the expected response body: +--- -```ts -useAdminCustomQuery -``` +## Authentication -The hook accepts the following parameters: +### Admin Authentication -1. `path`: (required) the first parameter is a string indicating the path of your API Route. For example, if you have custom API Routes that begin with `/admin/vendors`, the value of this parameter would be `vendors`. The `/admin` prefix will be added automatically. -2. `queryKey`: (required) the second parameter is a string used to generate query keys, which are used by Tanstack Query for caching. When a mutation related to this same key succeeds, the key will be automatically invalidated. -3. `query`: (optional) the third parameter is an object that can be used to pass query parameters to the API Route. For example, if you want to pass an `expand` query parameter you can pass it within this object. Each query parameter's name is a key in the object. There are no limitations on what the type of the value can be, so you can pass an array or simply a string as a value. -4. `options`: (optional) the fourth parameter is an object of [TanStack Query options](https://tanstack.com/query/v4/docs/react/reference/useQuery). +There are two ways to authenticate an admin user: -The request returns an object containing keys like `data` which is an object that includes the data returned in the response, and `isLoading` which is a boolean value indicating whether the request is still in progress. You can learn more about the returned object's properties in [TanStack Query's documentation](https://tanstack.com/query/v4/docs/react/reference/useQuery). +1. Using the [useAdminLogin hook](../references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Auth.mdx#useadminlogin). This hook tries to authenticate the user by their email and password credential and, if successful, attaches the cookie session ID to subsequent requests. +2. Using the `apiKey` option of the [MedusaProvider](../references/medusa_react/Providers/medusa_react.Providers.Medusa.mdx#medusaprovider) if the admin has an API key. If the admin doesn't have an API key, you can create one using the [useAdminUpdateUser hook](../references/medusa_react/Hooks/Admin/medusa_react.Hooks.Admin.Users.mdx#useAdminUpdateUser) or the [Update User API route](https://docs.medusajs.com/api/admin#users_postusersuser). For example: - - - - ```tsx - import { useAdminCustomQuery } from "medusa-react" - import { useParams } from "react-router-dom" - - type BlogPost = { - title: string, - content: string, - author_id: string, + + + + ```ts + import React from "react" + import { useAdminLogin } from "medusa-react" + + const Login = () => { + const adminLogin = useAdminLogin() + // ... + + const handleLogin = () => { + adminLogin.mutate({ + email: "user@example.com", + password: "supersecret", + }, { + onSuccess: ({ user }) => { + console.log(user) + // send authenticated requests now + } + }) + } + + // ... } - // Single post - type AdminBlogPostQuery = { - expand?: string, - fields?: string - } + export default Login + ``` - type AdminBlogPostRes = { - post: BlogPost, - } + + - const BlogPost = () => { - const { id } = useParams() - - const { data, isLoading } = useAdminCustomQuery< - AdminBlogPostQuery, - AdminBlogPostRes - >( - `/blog/posts/${id}`, // path - ["blog-post", id], // queryKey - { - expand: "author", // query - } - ) + ```tsx + import { MedusaProvider } from "medusa-react" + import Storefront from "./Storefront" + import { QueryClient } from "@tanstack/react-query" + import React from "react" + const queryClient = new QueryClient() + + const App = () => { return ( - <> - {isLoading && Loading...} - {data && data.post && {data.post.title}} - + + + ) } - export default BlogPost + export default App ``` - + - ```tsx - import { useAdminCustomQuery } from "medusa-react" - import { useParams } from "react-router-dom" +### Customer Authentication - type BlogPost = { - title: string, - content: string, - author_id: string, - } +To authenticate a customer, use the [useMedusa hook](../references/medusa_react/Providers/medusa_react.Providers.Medusa.mdx#usemedusa) to access the underlying [Medusa JS Client](../js-client/overview.mdx) instance and use one of its [authentication methods](../js-client/overview.mdx#authentication), such as the [authenticate](../references/js_client/classes/js_client.AuthResource.mdx#authenticate) method. - type AdminBlogPostsRes = { - posts: BlogPost[], - count: number - } +For example: - type AdminBlogPostsQuery = { - author_id: string, - created_at?: string, - expand?: string, - fields?: string - } +```tsx +import React from "react" +import { useMeCustomer, useMedusa } from "medusa-react" - const AuthorsBlogPosts = () => { - const { id } = useParams() - - const { data, isLoading } = useAdminCustomQuery< - AdminBlogPostsQuery, AdminBlogPostsRes - >( - `/blog/posts`, // path - ["blog-posts", "list", id], // queryKey - { - expand: "author", // query - author_id: "auth_123", - } - ) +const CustomerLogin = () => { + const { client } = useMedusa() + const { refetch: refetchCustomer } = useMeCustomer() + // ... - return ( - <> - {isLoading && Loading...} - {data && data.posts && ( - - {data.posts.map((post, index) => ( - {post.title} - ))} - - )} - - ) - } + const handleLogin = ( + email: string, + password: string + ) => { + client.auth.authenticate({ + email, + password, + }) + .then(() => { + // customer is logged-in successfully + // send authenticated requests now + refetchCustomer() + }) + .catch(() => { + // an error occurred. + }) + } - export default AuthorsBlogPosts - ``` + // ... +} +``` +:::note - - +The refetch method is available through [Tanstack Query's useQuery hook](https://tanstack.com/query/v4/docs/react/reference/useQuery). It allows you to refetch data if a change occurs. In this case, you refetch the logged-in customer after authentication. -#### useAdminCustomPost +::: -The `useAdminCustomPost` utility hook can be used to send a `POST` request to a custom API Route in your Medusa backend. It's a generic function, so you can pass a type for the request and the response if you're using TypeScript in your development. The first type parameter is the type of the request body, and the second type parameter is the type of the expected response body: +--- -```ts -useAdminCustomPost -``` +## Publishable API Key -The hook accepts the following parameters: +Publishable API Keys allow you to send a request to Store API routes with a pre-defined scope. You can associate the publishable API key with one or more resources, such as sales channels, then include the publishable API key in the header of your requests. -1. `path`: (required) the first parameter is a string indicating the path of your API Route. For example, if you have custom API Routes that begin with `/admin/vendors`, the value of this parameter would be `vendors`. The `/admin` prefix will be added automatically. -2. `queryKey`: (required) the second parameter is a string used to generate query keys, which are used by Tanstack Query for caching. When the mutation succeeds, the key will be automatically invalidated. -3. `relatedDomains`: (optional) the third parameter is an object that can be used to specify domains related to this custom hook. This will ensure that Tanstack Query invalidates the keys for those domains when your custom mutations succeed. For example, if your custom API Route is related to products, you can pass `["products"]` as the value of this parameter. Then, when you use your custom mutation and it succeeds, the product's key `adminProductKeys.all` will be invalidated automatically, and all products will be re-fetched. -4. `options`: (optional) the fourth parameter is an object of [Mutation options](https://tanstack.com/query/v4/docs/react/reference/useMutation). +The Medusa backend will infer the scope of the current request based on the publishable API key. At the moment, publishable API keys only work with sales channels. -The request returns an object containing keys like `mutation` which is a function that can be used to send the `POST` request at a later point. You can learn more about the returned object's properties in [TanStack Query's documentation](https://tanstack.com/query/v4/docs/react/reference/useMutation). +It's highly recommended to create a publishable API key and pass it as an initialization option of the Medusa client. -For example: +You can learn more about publishable API keys and how to use them in [this documentation](../development/publishable-api-keys/index.mdx). -```tsx title="src/admin/routes/blog/posts/page.tsx" -import { useAdminCustomPost } from "medusa-react" -import { useNavigate } from "react-router-dom" +### Create a Publishable API Key -type BlogPost = { - id: string - title: string, - content: string, - author_id: string, -} +You can create a publishable API key either using the [admin REST APIs](../development/publishable-api-keys/admin/manage-publishable-api-keys.mdx), or using the [Medusa admin dashboard](../user-guide/settings/publishable-api-keys.mdx). -type AdminBlogPostReq = { - title: string, - content: string, - author_id: string, -} +### Use a Publishable API Key -type AdminBlogPostRes = { - post: BlogPost, -} +To use the publishable API key, pass it as a prop to the [MedusaProvider](../references/medusa_react/Providers/medusa_react.Providers.Medusa.mdx#medusaprovider). -const CreateBlogPost = () => { - const navigate = useNavigate() - - const { mutate, isLoading } = useAdminCustomPost< - AdminBlogPostReq, - AdminBlogPostRes - >( - `/blog/posts`, - ["blog-posts"], - { - product: true, - } - ) +For example: - const handleCreate = (args: AdminBlogPostReq) => { - return mutate(args, { - onSuccess: (data) => { - navigate(`blog/posts/${data.post.id}`) - }, - }) - } +```tsx +import { MedusaProvider } from "medusa-react" +import Storefront from "./Storefront" +import { QueryClient } from "@tanstack/react-query" +import React from "react" - // TODO replace with actual form +const queryClient = new QueryClient() + +const App = () => { return ( - + + + ) } -export default CreateBlogPost -``` - -#### useAdminCustomDelete - -The `useAdminCustomDelete` utility hook can be used to send a `DELETE` request to a custom API Route in your Medusa backend. It's a generic function, so you can pass a type for the expected response if you're using TypeScript in your development: - -```ts -useAdminCustomDelete +export default App ``` -The hook accepts the following parameters: +--- -1. `path`: (required) the first parameter is a string indicating the path of your API Route. For example, if you have custom API Routes that begin with `/admin/vendors`, the value of this parameter would be `vendors`. The `/admin` prefix will be added automatically. -2. `queryKey`: (required) the second parameter is a string used to generate query keys, which are used by Tanstack Query for caching. When the mutation succeeds, the key will be automatically invalidated. -3. `relatedDomains`: (optional) the third parameter is an object that can be used to specify domains related to this custom hook. This will ensure that Tanstack Query invalidates the keys for those domains when your custom mutations succeed. For example, if your custom API Route is related to products, you can pass `["products"]` as the value of this parameter. Then, when you use your custom mutation and it succeeds, the product's key `adminProductKeys.all` will be invalidated automatically, and all products will be re-fetched. -4. `options`: (optional) the fourth parameter is an object of [Mutation options](https://tanstack.com/query/v4/docs/react/reference/useMutation). +## HTTP Compression -The request returns an object containing keys like `mutation` which is a function that can be used to send the `DELETE` request at a later point. You can learn more about the returned object's properties in [TanStack Query's documentation](https://tanstack.com/query/v4/docs/react/reference/useMutation). +If you've enabled HTTP Compression in your Medusa backend configurations, and you want to disable it for your requests with Medusa React, you can pass the `x-no-compression` header in the `customHeaders` prop of the [MedusaProvider](../references/medusa_react/Providers/medusa_react.Providers.Medusa.mdx#medusaprovider). For example: -```tsx title="src/admin/routes/blog/posts/[id]/page.tsx" -import { useAdminCustomDelete } from "medusa-react" -import { useNavigate, useParams } from "react-router-dom" - -type AdminBlogPostDeleteRes = { - id: string, - type: string -} - -const BlogPost = () => { - const { id } = useParams() - const navigate = useNavigate() - - const { mutate, isLoading } = useAdminCustomDelete< - AdminBlogPostDeleteRes - >( - `/blog/posts/${id}`, - ["blog-posts"], - { - product: true, - } - ) +```tsx +import { MedusaProvider } from "medusa-react" +import Storefront from "./Storefront" +import { QueryClient } from "@tanstack/react-query" +import React from "react" - const handleDelete = () => { - return mutate(undefined, { - onSuccess: () => { - navigate("..") - }, - }) - } +const queryClient = new QueryClient() - // TODO replace with actual form +const App = () => { return ( - + + + ) } -export default BlogPost +export default App ``` --- -## Utilities +## Expanding Fields -`medusa-react` exposes a set of utility functions that are mainly used to retrieve or format the price of a product variant. +In many hooks you'll find an `expand` property that can be accepted within one of the hooks's parameters. You can use the `expand` property to unpack an entity's relations and return them in the response. -### formatVariantPrice +:::warning -This utility function can be used to compute the price of a variant for a region and retrieve the formatted amount. For example, `$20.00`. +The relations you pass to `expand` replace any relations that are expanded by default in the request. -It accepts an object with the following properties: +::: -- `variant`: A variant object retrieved from the Medusa backend. It should mainly include the `prices` array in the object. -- `region`: A region object retrieved from the Medusa backend. -- `includeTaxes`: (optional) A boolean value that indicates whether the computed price should include taxes or not. The default value is `true`. -- `minimumFractionDigits`: (optional) The minimum number of fraction digits to use when formatting the price. This is passed as an option to `Intl.NumberFormat` in the underlying layer. You can learn more about this method’s options in [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). -- `maximumFractionDigits`: (optional) The maximum number of fraction digits to use when formatting the price. This is passed as an option to `Intl.NumberFormat` which is used within the utility method. You can learn more about this method’s options in [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). -- `locale`: (optional) A string with a BCP 47 language tag. The default value is `en-US`. This is passed as a first parameter to `Intl.NumberFormat` which is used within the utility method. You can learn more about this method’s parameters in [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). +### Expanding One Relation -For example: +For example, when you retrieve products, you can retrieve their collection by passing to the `expand` query parameter the value `collection`: -```tsx title="src/Products.ts" -import { formatVariantPrice } from "medusa-react" -import { Product, ProductVariant } from "@medusajs/medusa" +```tsx +import React from "react" +import { useAdminProducts } from "medusa-react" const Products = () => { - // ... + const { products, isLoading } = useAdminProducts({ + expand: "collection" + }) + return ( -
    - {products?.map((product: Product) => ( -
  • - {product.title} -
      - {product.variants.map((variant: ProductVariant) => ( -
    • - {formatVariantPrice({ - variant, - region, // should be retrieved earlier - })} -
      • - ))} -
    -
    • - ))} -
+
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
) } -``` - -### computeVariantPrice -This utility function can be used to compute the price of a variant for a region and retrieve the amount without formatting. For example, `20`. This method is used by `formatVariantPrice` before applying the price formatting. +export default Products +``` -It accepts an object with the following properties: +### Expanding Multiple Relations -- `variant`: A variant object retrieved from the Medusa backend. It should mainly include the `prices` array in the variant. -- `region`: A region object retrieved from the Medusa backend. -- `includeTaxes`: (optional) A boolean value that indicates whether the computed price should include taxes or not. The default value is `true`. +You can expand more than one relation by separating the relations in the `expand` query parameter with a comma. -For example: +For example, to retrieve both the variants and the collection of products, pass to the `expand` query parameter the value `variants,collection`: -```tsx title="src/Products.ts" -import { computeVariantPrice } from "medusa-react" -import { Product, ProductVariant } from "@medusajs/medusa" +```tsx +import React from "react" +import { useAdminProducts } from "medusa-react" const Products = () => { - // ... + const { products, isLoading } = useAdminProducts({ + expand: "variants,collection" + }) + return ( -
    - {products?.map((product: Product) => ( -
  • - {product.title} -
      - {product.variants.map((variant: ProductVariant) => ( -
    • - {computeVariantPrice({ - variant, - region, // should be retrieved earlier - })} -
      • - ))} -
    -
    • - ))} -
+
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
) } -``` - -### formatAmount -This utility function can be used to compute the price of an amount for a region and retrieve the formatted amount. For example, `$20.00`. - -The main difference between this utility function and `formatVariantPrice` is that you don’t need to pass a complete variant object. This can be used with any number. +export default Products +``` -It accepts an object with the following properties: +### Prevent Expanding Relations -- `amount`: A number that should be used for computation. -- `region`: A region object retrieved from the Medusa backend. -- `includeTaxes`: (optional) A boolean value that indicates whether the computed price should include taxes or not. The default value is `true`. -- `minimumFractionDigits`: (optional) The minimum number of fraction digits to use when formatting the price. This is passed as an option to `Intl.NumberFormat` in the underlying layer. You can learn more about this method’s options in [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). -- `maximumFractionDigits`: (optional) The maximum number of fraction digits to use when formatting the price. This is passed as an option to `Intl.NumberFormat` which is used within the utility method. You can learn more about this method’s options in [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). -- `locale`: (optional) A string with a BCP 47 language tag. The default value is `en-US`. This is passed as a first parameter to `Intl.NumberFormat` which is used within the utility method. You can learn more about this method’s parameters in [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). +Some requests expand relations by default. You can prevent that by passing an empty expand value to retrieve an entity without any extra relations. For example: -```tsx title="src/MyComponent.ts" -import { formatAmount } from "medusa-react" +```tsx +import React from "react" +import { useAdminProducts } from "medusa-react" + +const Products = () => { + const { products, isLoading } = useAdminProducts({ + expand: "" + }) -const MyComponent = () => { - // ... return (
- {formatAmount({ - amount, - region, // should be retrieved earlier - })} + {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )}
) } + +export default Products ``` -### computeAmount +This would retrieve each product with only its properties, without any relations like `collection`. -This utility function can be used to compute the price of an amount for a region and retrieve the amount without formatting. For example, `20`. This method is used by `formatAmount` before applying the price formatting. +--- -The main difference between this utility function and `computeVariantPrice` is that you don’t need to pass a complete variant object. This can be used with any number. +## Selecting Fields -It accepts an object with the following properties: +In many hooks you'll find a `fields` property that can be accepted within one of the hooks's parameters. You can use the `fields` property to specify which +fields in the entity should be returned in the response. -- `amount`: A number that should be used for computation. -- `region`: A region object retrieved from the Medusa backend. -- `includeTaxes`: (optional) A boolean value that indicates whether the computed price should include taxes or not. The default value is `true`. +:::warning -For example: +If you pass a `fields` query parameter, only the fields you pass in the value along with the `id` of the entity will be returned in the response. -```tsx title="src/MyComponent.ts" -import { computeAmount } from "medusa-react" +::: + +The `fields` query parameter does not affect the expanded relations. You'll have to use the [Expand parameter](#expanding-fields) instead. + +### Selecting One Field + +For example, when you retrieve a list of products, you can retrieve only the titles of the products by passing `title` as a value to the `fields` query parameter: + +```tsx +import React from "react" +import { useAdminProducts } from "medusa-react" + +const Products = () => { + const { products, isLoading } = useAdminProducts({ + fields: "title", + }) -const MyComponent = () => { - // ... return (
- {computeAmount({ - amount, - region, // should be retrieved earlier - })} + {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )}
) } -``` - ---- -## Content Providers +export default Products +``` -:::info +As mentioned above, the expanded relations such as `variants` will still be returned as they're not affected by the `fields` parameter. -This is an experimental feature. +You can ensure that only the `title` field is returned by passing an empty value to the `expand` query parameter. For example: -::: +```tsx +import React from "react" +import { useAdminProducts } from "medusa-react" -To facilitate building custom storefronts, `medusa-react` also exposes a `CartProvider` and a `SessionCartProvider`. +const Products = () => { + const { products, isLoading } = useAdminProducts({ + fields: "title", + expand: "" + }) -### CartProvider + return ( +
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
+ ) +} -`CartProvider` makes use of some of the hooks already exposed by `medusa-react` to perform cart operations on the Medusa backend. You can use it to create a cart, start the checkout flow, authorize payment sessions, and so on. +export default Products +``` -It also manages one single global piece of state which represents a cart, exactly like the one created on your Medusa backend. +### Selecting Multiple Fields -To use `CartProvider`, you first have to insert it somewhere in your component tree below the `MedusaProvider`. +You can pass more than one field by separating the field names in the `fields` query parameter with a comma. -For example: +For example, to select the `title` and `handle` of products: -```tsx title="src/App.ts" -import { CartProvider, MedusaProvider } from "medusa-react" -import Storefront from "./Storefront" -import { QueryClient } from "@tanstack/react-query" +```tsx import React from "react" +import { useAdminProducts } from "medusa-react" -const queryClient = new QueryClient() +const Products = () => { + const { products, isLoading } = useAdminProducts({ + fields: "title,handle", + }) -function App() { return ( - - - - - +
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
) } -export default App +export default Products ``` -Then, in any of the child components, you can use the `useCart` hook exposed by `medusa-react` to get access to cart operations and data. - -The `useCart` hook returns an object with the following properties: +### Retrieve Only the ID -- `cart`: A state variable holding the cart object. This is set if the `createCart` mutation is executed or if `setCart` is manually used. -- `setCart`: A state function used to set the cart object. -- `totalItems`: The number of items in the cart. -- `createCart`: A mutation used to create a cart. -- `updateCart`: A mutation used to update a cart’s details such as region, customer email, shipping address, and more. -- `startCheckout`: A mutation used to initialize payment sessions during checkout. -- `pay`: A mutation used to select a payment processor during checkout. -- `addShippingMethod`: A mutation used to add a shipping method to the cart during checkout. -- `completeCheckout`: A mutation used to complete the cart and place the order. +You can pass an empty `fields` query parameter to return only the ID of an entity. For example: -```tsx title="src/Cart.ts" -import * as React from "react" +```tsx +import React from "react" +import { useAdminProducts } from "medusa-react" -import { useCart } from "medusa-react" +const Products = () => { + const { products, isLoading } = useAdminProducts({ + fields: "", + }) -const Cart = () => { - const handleClick = () => { - createCart.mutate({}) // create an empty cart - } + return ( +
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.id}
    • + ))} +
+ )} +
+ ) +} - const { cart, createCart } = useCart() +export default Products +``` + +You can also pair with an empty `expand` query parameter to ensure that the relations aren't retrieved as well. For example: + +```tsx +import React from "react" +import { useAdminProducts } from "medusa-react" + +const Products = () => { + const { products, isLoading } = useAdminProducts({ + fields: "", + expand: "" + }) return (
- {createCart.isLoading &&
Loading...
} - {!cart?.id && ( - - )} - {cart?.id && ( -
Cart ID: {cart.id}
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.id}
    • + ))} +
)}
) } -export default Cart +export default Products ``` -In the example above, you retrieve the `createCart` mutation and `cart` state object using the `useCart` hook. If the `cart` is not set, a button is shown. When the button is clicked, the `createCart` mutation is executed, which interacts with the backend and creates a new cart. +--- -After the cart is created, the `cart` state variable is set and its ID is shown instead of the button. +## Pagination -:::note +### Query Parameters -The example above does not store in the browser the ID of the cart created, so the cart’s data will be gone on refresh. You would have to do that using the browser’s [Local Storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). +In listing hooks, such as list customers or list products, you can control the pagination using the query parameters `limit` and `offset`. -::: +`limit` is used to specify the maximum number of items that can be return in the response. `offset` is used to specify how many items to skip before returning the resulting entities. -### SessionProvider +You can use the `offset` query parameter to change between pages. For example, if the limit is `50`, at page one the offset should be `0`; at page two the offset should be `50`, and so on. -Unlike the `CartProvider`, `SessionProvider` never interacts with the Medusa backend. It can be used to implement the user experience related to managing a cart’s items. Its state variables are JavaScript objects living in the browser, but are in no way communicated with the backend. +For example, to limit the number of products retrieved: -You can use the `SessionProvider` as a lightweight client-side cart functionality. It’s not stored in any database or on the Medusa backend. +```tsx +import React from "react" +import { useAdminProducts } from "medusa-react" -To use `SessionProvider`, you first have to insert it somewhere in your component tree below the `MedusaProvider`. +const Products = () => { + const { + products, + limit, + offset, + isLoading + } = useAdminProducts({ + limit: 20, + offset: 0 + }) -For example: + return ( +
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
+ ) +} -```tsx title="src/App.ts" -import { SessionProvider, MedusaProvider } from "medusa-react" -import Storefront from "./Storefront" -import { QueryClient } from "@tanstack/react-query" +export default Products +``` + +### Response Fields + +In the response of listing hooks, aside from the entities retrieved, there are three pagination-related fields returned: + +- `limit`: the maximum number of items that can be returned in the response. +- `offset`: the number of items that were skipped before the entities in the result. +- `count`: the total number of available items of this entity. It can be used to determine how many pages are there. + +For example, if the `count` is `100` and the `limit` is `50`, you can divide the `count` by the `limit` to get the number of pages: `100/50 = 2 pages`. + +### Sort Order + +The `order` field, available on hooks supporting pagination, allows you to sort the retrieved items by an attribute of that item. For example, you can sort products by their `created_at` attribute by setting `order` to `created_at`: + +```ts import React from "react" +import { useAdminProducts } from "medusa-react" -const queryClient = new QueryClient() +const Products = () => { + const { + products, + isLoading + } = useAdminProducts({ + order: "created_at", + }) -const App = () => { return ( - - - - - +
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
) } -export default App +export default Products ``` -Then, in any of the child components, you can use the `useSessionHook` hook exposed by `medusa-react` to get access to client-side cart item functionalities. +By default, the sort direction will be ascending. To change it to descending, pass a dash (`-`) before the attribute name. For example: -For example: +```ts +import React from "react" +import { useAdminProducts } from "medusa-react" -```tsx title="src/Products.ts" const Products = () => { - const { addItem } = useSessionCart() - // ... + const { + products, + isLoading + } = useAdminProducts({ + order: "-created_at", + }) - function addToCart(variant: ProductVariant) { - addItem({ - variant: variant, - quantity: 1, - }) - } + return ( +
+ {isLoading && Loading...} + {products && !products.length && No Products} + {products && products.length > 0 && ( +
    + {products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} +
+ ) } + +export default Products ``` + +This sorts the products by their `created_at` attribute in the descending order. diff --git a/www/apps/docs/content/modules/carts-and-checkout/storefront/implement-cart.mdx b/www/apps/docs/content/modules/carts-and-checkout/storefront/implement-cart.mdx index abb1b0cbe5a2b..c2ac372aa1fcc 100644 --- a/www/apps/docs/content/modules/carts-and-checkout/storefront/implement-cart.mdx +++ b/www/apps/docs/content/modules/carts-and-checkout/storefront/implement-cart.mdx @@ -475,10 +475,17 @@ To create a line item of a product and add it to a cart, you can use the followi const createLineItem = useCreateLineItem(cart_id) - const handleAddItem = () => { + const handleAddItem = ( + variantId: string, + quantity: amount + ) => { createLineItem.mutate({ - variant_id, + variant_id: variantId, quantity, + }, { + onSuccess: ({ cart }) => { + console.log(cart.items) + } }) } @@ -549,10 +556,17 @@ To update a line item's quantity in the cart, you can use the following code sni const updateLineItem = useUpdateLineItem(cart_id) - const handleUpdateItem = () => { + const handleUpdateItem = ( + lineItemId: string, + quantity: number + ) => { updateLineItem.mutate({ - lineId, - quantity: 3, + lineId: lineItemId, + quantity, + }, { + onSuccess: ({ cart }) => { + console.log(cart.items) + } }) } @@ -614,9 +628,15 @@ To delete a line item from the cart, you can use the following code snippet: const deleteLineItem = useDeleteLineItem(cart_id) - const handleDeleteItem = () => { + const handleDeleteItem = ( + lineItemId: string + ) => { deleteLineItem.mutate({ - lineId, + lineId: lineItemId, + }, { + onSuccess: ({ cart }) => { + console.log(cart.items) + } }) } diff --git a/www/apps/docs/content/modules/carts-and-checkout/storefront/implement-checkout-flow.mdx b/www/apps/docs/content/modules/carts-and-checkout/storefront/implement-checkout-flow.mdx index 8751c378bced3..39f7f230191b3 100644 --- a/www/apps/docs/content/modules/carts-and-checkout/storefront/implement-checkout-flow.mdx +++ b/www/apps/docs/content/modules/carts-and-checkout/storefront/implement-checkout-flow.mdx @@ -253,22 +253,30 @@ Once the customer chooses one of the available shipping options, send a `POST` r ```tsx import { useAddShippingMethodToCart } from "medusa-react" - // ... - const ShippingOptions = ({ cartId }: Props) => { - // ... + type Props = { + cartId: string + } + + const Cart = ({ cartId }: Props) => { const addShippingMethod = useAddShippingMethodToCart(cartId) - const handleAddShippingMethod = (option_id: string) => { + const handleAddShippingMethod = ( + optionId: string + ) => { addShippingMethod.mutate({ - option_id, + option_id: optionId, + }, { + onSuccess: ({ cart }) => { + console.log(cart.shipping_methods) + } }) } - + // ... } - export default ShippingOptions + export default Cart ``` diff --git a/www/apps/docs/content/modules/customers/admin/manage-customer-groups.mdx b/www/apps/docs/content/modules/customers/admin/manage-customer-groups.mdx index dca59c0a3da8b..276450adc886f 100644 --- a/www/apps/docs/content/modules/customers/admin/manage-customer-groups.mdx +++ b/www/apps/docs/content/modules/customers/admin/manage-customer-groups.mdx @@ -72,19 +72,13 @@ You can create a customer group by sending a request to the Create Customer Grou const createCustomerGroup = useAdminCreateCustomerGroup() // ... - const handleCreate = () => { + const handleCreate = (name: string) => { createCustomerGroup.mutate({ name, }) } // ... - - return ( -
- {/* Render form */} -
- ) } export default CreateCustomerGroup @@ -147,7 +141,6 @@ You can get a list of all customer groups by sending a request to the List Custo ```tsx - import { CustomerGroup } from "@medusajs/medusa" import { useAdminCustomerGroups } from "medusa-react" const CustomerGroups = () => { @@ -165,7 +158,7 @@ You can get a list of all customer groups by sending a request to the List Custo {customer_groups && customer_groups.length > 0 && (
    {customer_groups.map( - (customerGroup: CustomerGroup) => ( + (customerGroup) => (
  • {customerGroup.name}
    • @@ -301,28 +294,26 @@ You can update a customer group’s data by sending a request to the Update Cust ```tsx import { useAdminUpdateCustomerGroup } from "medusa-react" - const UpdateCustomerGroup = () => { + type Props = { + customerGroupId: string + } + + const CustomerGroup = ({ customerGroupId }: Props) => { const updateCustomerGroup = useAdminUpdateCustomerGroup( customerGroupId ) // .. - const handleUpdate = () => { + const handleUpdate = (name: string) => { updateCustomerGroup.mutate({ name, }) } // ... - - return ( -
    - {/* Render form */} -
    - ) } - export default UpdateCustomerGroup + export default CustomerGroup ``` @@ -391,7 +382,11 @@ You can delete a customer group by sending a request to the Delete a Customer Gr ```tsx import { useAdminDeleteCustomerGroup } from "medusa-react" - const CustomerGroup = () => { + type Props = { + customerGroupId: string + } + + const CustomerGroup = ({ customerGroupId }: Props) => { const deleteCustomerGroup = useAdminDeleteCustomerGroup( customerGroupId ) @@ -468,13 +463,13 @@ You can add a customer to a group by sending a request to the Customer Group’s import { useAdminAddCustomersToCustomerGroup, } from "medusa-react" - - const CustomerGroup = () => { + + const CustomerGroup = (customerGroupId: string) => { const addCustomers = useAdminAddCustomersToCustomerGroup( customerGroupId ) // ... - + const handleAddCustomers= (customerId: string) => { addCustomers.mutate({ customer_ids: [ @@ -484,10 +479,10 @@ You can add a customer to a group by sending a request to the Customer Group’s ], }) } - + // ... } - + export default CustomerGroup ``` @@ -559,10 +554,13 @@ You can retrieve a list of all customers in a customer group using the List Cust ```tsx - import { Customer } from "@medusajs/medusa" import { useAdminCustomerGroupCustomers } from "medusa-react" - const CustomerGroup = () => { + type Props = { + customerGroupId: string + } + + const CustomerGroup = ({ customerGroupId }: Props) => { const { customers, isLoading, @@ -578,7 +576,7 @@ You can retrieve a list of all customers in a customer group using the List Cust )} {customers && customers.length > 0 && (
      - {customers.map((customer: Customer) => ( + {customers.map((customer) => (
    • {customer.first_name}
      • ))}
    @@ -651,23 +649,26 @@ You can remove customers from a customer group by sending a request to the Remov ```tsx - import { Customer } from "@medusajs/medusa" import { useAdminRemoveCustomersFromCustomerGroup, } from "medusa-react" - const CustomerGroup = () => { + type Props = { + customerGroupId: string + } + + const CustomerGroup = ({ customerGroupId }: Props) => { const removeCustomers = useAdminRemoveCustomersFromCustomerGroup( customerGroupId ) // ... - const handleRemoveCustomer = (customer_id: string) => { + const handleRemoveCustomer = (customerId: string) => { removeCustomers.mutate({ customer_ids: [ { - id: customer_id, + id: customerId, }, ], }) diff --git a/www/apps/docs/content/modules/customers/admin/manage-customers.mdx b/www/apps/docs/content/modules/customers/admin/manage-customers.mdx index e16be036d9aef..2e074d2b18b0f 100644 --- a/www/apps/docs/content/modules/customers/admin/manage-customers.mdx +++ b/www/apps/docs/content/modules/customers/admin/manage-customers.mdx @@ -68,7 +68,6 @@ You can show a list of customers by sending a request to the [List Customers API ```tsx - import { Customer } from "@medusajs/medusa" import { useAdminCustomers } from "medusa-react" const Customers = () => { @@ -82,7 +81,7 @@ You can show a list of customers by sending a request to the [List Customers API )} {customers && customers.length > 0 && (
      - {customers.map((customer: Customer) => ( + {customers.map((customer) => (
    • {customer.first_name}
      • ))}
    @@ -162,27 +161,26 @@ You can create a customer account by sending a request to the [Create a Customer ```tsx import { useAdminCreateCustomer } from "medusa-react" + type CustomerData = { + first_name: string + last_name: string + email: string + password: string + } + const CreateCustomer = () => { const createCustomer = useAdminCreateCustomer() // ... - const handleCreate = () => { - // ... - createCustomer.mutate({ - first_name, - last_name, - email, - password, + const handleCreate = (customerData: CustomerData) => { + createCustomer.mutate(customerData, { + onSuccess: ({ customer }) => { + console.log(customer.id) + } }) } // ... - - return ( -
    - {/* Render form */} -
    - ) } export default CreateCustomer @@ -265,31 +263,30 @@ You can edit a customer’s information by sending a request to the [Update a Cu ```tsx import { useAdminUpdateCustomer } from "medusa-react" + + type CustomerData = { + first_name: string + last_name: string + email: string + password: string + } + + type Props = { + customerId: string + } - const UpdateCustomer = () => { + const Customer = ({ customerId }: Props) => { const updateCustomer = useAdminUpdateCustomer(customerId) // ... - - const handleUpdate = () => { - // ... - updateCustomer.mutate({ - email, - password, - first_name, - last_name, - }) + + const handleUpdate = (customerData: CustomerData) => { + updateCustomer.mutate(customerData) } - + // ... - - return ( -
    - {/* Render form */} -
    - ) } - - export default UpdateCustomer + + export default Customer ```     diff --git a/www/apps/docs/content/modules/customers/storefront/implement-customer-profiles.mdx b/www/apps/docs/content/modules/customers/storefront/implement-customer-profiles.mdx index 8433135a8dbb1..7e7d18a933fc5 100644 --- a/www/apps/docs/content/modules/customers/storefront/implement-customer-profiles.mdx +++ b/www/apps/docs/content/modules/customers/storefront/implement-customer-profiles.mdx @@ -85,23 +85,23 @@ You can register a new customer by sending a request to the [Create a Customer A const createCustomer = useCreateCustomer() // ... - const handleCreate = () => { + const handleCreate = ( + customerData: { + first_name: string + last_name: string + email: string + password: string + } + ) => { // ... - createCustomer.mutate({ - first_name, - last_name, - email, - password, + createCustomer.mutate(customerData, { + onSuccess: ({ customer }) => { + console.log(customer.id) + } }) } // ... - - return ( -
    - {/* Render form */} -
    - ) } export default RegisterCustomer @@ -370,28 +370,32 @@ You can edit a customer’s info using the [Update Customer API Route](https://d ```tsx import { useUpdateMe } from "medusa-react" - const UpdateCustomer = () => { + type Props = { + customerId: string + } + + const Customer = ({ customerId }: Props) => { const updateCustomer = useUpdateMe() // ... - const handleUpdate = () => { + const handleUpdate = ( + firstName: string + ) => { // ... updateCustomer.mutate({ - id: customer_id, - first_name, + id: customerId, + first_name: firstName, + }, { + onSuccess: ({ customer }) => { + console.log(customer.first_name) + } }) } // ... - - return ( -
    - {/* Render form */} -
    - ) } - export default UpdateCustomer + export default Customer ```     @@ -612,19 +616,18 @@ You can retrieve a customer’s orders by sending a request to the [List Orders ```tsx import { useCustomerOrders } from "medusa-react" - import { Order } from "@medusajs/medusa" const Orders = () => { // refetch a function that can be used to // re-retrieve orders after the customer logs in - const { orders, isLoading, refetch } = useCustomerOrders() + const { orders, isLoading } = useCustomerOrders() return (
    {isLoading && Loading orders...} {orders?.length && (
      - {orders.map((order: Order) => ( + {orders.map((order) => (
    • {order.display_id}
      • ))}
    diff --git a/www/apps/docs/content/modules/discounts/admin/manage-discounts.mdx b/www/apps/docs/content/modules/discounts/admin/manage-discounts.mdx index 9541ff18b0c58..19fe35c71d67a 100644 --- a/www/apps/docs/content/modules/discounts/admin/manage-discounts.mdx +++ b/www/apps/docs/content/modules/discounts/admin/manage-discounts.mdx @@ -104,15 +104,18 @@ You can create a discount by sending a request to the [Create Discount API Route AllocationType, DiscountRuleType, } from "@medusajs/medusa" - + const CreateDiscount = () => { const createDiscount = useAdminCreateDiscount() // ... - - const handleCreate = () => { + + const handleCreate = ( + currencyCode: string, + regionId: string + ) => { // ... createDiscount.mutate({ - code, + code: currencyCode, rule: { type: DiscountRuleType.FIXED, value: 10, @@ -125,10 +128,10 @@ You can create a discount by sending a request to the [Create Discount API Route is_disabled: false, }) } - + // ... } - + export default CreateDiscount ``` @@ -224,21 +227,24 @@ For example, you can update the discount’s description and status by sending t ```tsx import { useAdminUpdateDiscount } from "medusa-react" - const UpdateDiscount = () => { - const updateDiscount = useAdminUpdateDiscount(discount_id) + type Props = { + discountId: string + } + + const Discount = ({ discountId }: Props) => { + const updateDiscount = useAdminUpdateDiscount(discountId) // ... - const handleUpdate = () => { - // ... + const handleUpdate = (isDisabled: boolean) => { updateDiscount.mutate({ - is_disabled: true, + is_disabled: isDisabled, }) } // ... } - export default UpdateDiscount + export default Discount ``` @@ -317,25 +323,28 @@ You can send a request to the [Create Condition API Route](https://docs.medusajs ```tsx - import { useAdminDiscountCreateCondition } from "medusa-react" import { DiscountConditionOperator } from "@medusajs/medusa" + import { useAdminDiscountCreateCondition } from "medusa-react" - const Discount = () => { - const createCondition = useAdminDiscountCreateCondition( - discount_id - ) + type Props = { + discountId: string + } + + const Discount = ({ discountId }: Props) => { + const createCondition = useAdminDiscountCreateCondition(discountId) // ... const handleCreateCondition = ( - operator: DiscountConditionOperator, - productId: string + operator: DiscountConditionOperator, + products: string[] ) => { - // ... createCondition.mutate({ operator, - products: [ - productId, - ], + products + }, { + onSuccess: ({ discount }) => { + console.log(discount.id) + } }) } @@ -433,32 +442,29 @@ You can retrieve a condition and its resources by sending a request to the [Get ```tsx import { useAdminGetDiscountCondition } from "medusa-react" - import { Product } from "@medusajs/medusa" - const DiscountCondition = () => { + type Props = { + discountId: string + discountConditionId: string + } + + const DiscountCondition = ({ + discountId, + discountConditionId + }: Props) => { const { discount_condition, - isLoading, + isLoading } = useAdminGetDiscountCondition( - discount_id, - conditionId + discountId, + discountConditionId ) - // ... return (
    - {isLoading && Loading} + {isLoading && Loading...} {discount_condition && ( - <> - {discount_condition.id} -
      - {discount_condition.products.map( - (product: Product) => ( -
    • {product.title}
      • - ) - )} -
    - + {discount_condition.type} )}
    ) @@ -533,18 +539,31 @@ For example, to update the products in a condition: ```tsx import { useAdminDiscountUpdateCondition } from "medusa-react" - import { Product } from "@medusajs/medusa" - const DiscountCondition = () => { - const updateCondition = useAdminDiscountUpdateCondition( - discount_id, + type Props = { + discountId: string + conditionId: string + } + + const DiscountCondition = ({ + discountId, + conditionId + }: Props) => { + const update = useAdminDiscountUpdateCondition( + discountId, conditionId ) // ... - const handleUpdateCondition = (productIds: string[]) => { - updateCondition.mutate({ - products: productIds, + const handleUpdate = ( + products: string[] + ) => { + update.mutate({ + products + }, { + onSuccess: ({ discount }) => { + console.log(discount.id) + } }) } @@ -629,14 +648,24 @@ You can delete a condition by sending a request to the [Delete Condition API Rou ```tsx import { useAdminDiscountRemoveCondition } from "medusa-react" - const Discount = () => { + type Props = { + discountId: string + } + + const Discount = ({ discountId }: Props) => { const deleteCondition = useAdminDiscountRemoveCondition( - discount_id + discountId ) // ... - const handleUpdateCondition = (conditionId: string) => { - deleteCondition.mutate(conditionId) + const handleDelete = ( + conditionId: string + ) => { + deleteCondition.mutate(conditionId, { + onSuccess: ({ id, object, deleted }) => { + console.log(deleted) + } + }) } // ... diff --git a/www/apps/docs/content/modules/gift-cards/admin/manage-gift-cards.mdx b/www/apps/docs/content/modules/gift-cards/admin/manage-gift-cards.mdx index 1d104fa2a7b36..cad213ce6123f 100644 --- a/www/apps/docs/content/modules/gift-cards/admin/manage-gift-cards.mdx +++ b/www/apps/docs/content/modules/gift-cards/admin/manage-gift-cards.mdx @@ -373,20 +373,30 @@ You can update a gift card product’s details by sending a request to the [Upda ```tsx import { useAdminUpdateProduct } from "medusa-react" - const UpdateGiftCard = () => { - const createGiftCard = useAdminUpdateProduct(giftCardId) + type Props = { + giftCardId: string + } + + const GiftCard = ({ + giftCardId + }: Props) => { + const updateGiftCard = useAdminUpdateProduct(giftCardId) // ... const handleUpdate = () => { - createGiftCard.mutate({ + updateGiftCard.mutate({ description: "The best gift card", + }, { + onSuccess: ({ product }) => { + console.log(product.description) + } }) } // ... } - export default UpdateGiftCard + export default GiftCard ```     @@ -450,12 +460,20 @@ You can delete a gift card product by sending a request to the [Delete a Product ```tsx import { useAdminDeleteProduct } from "medusa-react" - const GiftCard = () => { + type Props = { + giftCardId: string + } + + const GiftCard = ({ giftCardId }: Props) => { const deleteGiftCard = useAdminDeleteProduct(giftCardId) // ... const handleDelete = () => { - deleteGiftCard.mutate() + deleteGiftCard.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... @@ -521,7 +539,6 @@ You can retrieve all custom gift cards by sending a request to the [List Gift Ca ```tsx - import { GiftCard } from "@medusajs/medusa" import { useAdminGiftCards } from "medusa-react" const CustomGiftCards = () => { @@ -535,7 +552,7 @@ You can retrieve all custom gift cards by sending a request to the [List Gift Ca )} {gift_cards && gift_cards.length > 0 && (
      - {gift_cards.map((giftCard: GiftCard) => ( + {gift_cards.map((giftCard) => (
    • {giftCard.code}
      • ))}
    @@ -604,10 +621,17 @@ You can create a custom gift card by sending a request to the [Create a Gift Car const createGiftCard = useAdminCreateGiftCard() // ... - const handleCreate = (regionId: string, value: number) => { + const handleCreate = ( + regionId: string, + value: number + ) => { createGiftCard.mutate({ region_id: regionId, value, + }, { + onSuccess: ({ gift_card }) => { + console.log(gift_card.id) + } }) } @@ -684,7 +708,11 @@ You can update a gift card by sending a request to the [Update a Gift Card API R ```tsx import { useAdminUpdateGiftCard } from "medusa-react" - const UpdateCustomGiftCards = () => { + type Props = { + customGiftCardId: string + } + + const CustomGiftCard = ({ customGiftCardId }: Props) => { const updateGiftCard = useAdminUpdateGiftCard( customGiftCardId ) @@ -699,7 +727,7 @@ You can update a gift card by sending a request to the [Update a Gift Card API R // ... } - export default UpdateCustomGiftCards + export default CustomGiftCard ```     @@ -763,14 +791,22 @@ You can delete a custom gift card by sending a request to the [Delete a Gift Car ```tsx import { useAdminDeleteGiftCard } from "medusa-react" - const CustomGiftCard = () => { + type Props = { + customGiftCardId: string + } + + const CustomGiftCard = ({ customGiftCardId }: Props) => { const deleteGiftCard = useAdminDeleteGiftCard( customGiftCardId ) // ... const handleDelete = () => { - deleteGiftCard.mutate() + deleteGiftCard.mutate(void 0, { + onSuccess: ({ id, object, deleted}) => { + console.log(id) + } + }) } // ... diff --git a/www/apps/docs/content/modules/gift-cards/storefront/use-gift-cards.mdx b/www/apps/docs/content/modules/gift-cards/storefront/use-gift-cards.mdx index 5021b9c4117f1..056cc2e2665cd 100644 --- a/www/apps/docs/content/modules/gift-cards/storefront/use-gift-cards.mdx +++ b/www/apps/docs/content/modules/gift-cards/storefront/use-gift-cards.mdx @@ -168,8 +168,14 @@ You can retrieve the details of a gift card by sending a request to the [Get Gif ```tsx import { useGiftCard } from "medusa-react" - const GiftCard = () => { - const { gift_card, isLoading, isError } = useGiftCard("code") + type Props = { + giftCardCode: string + } + + const GiftCard = ({ giftCardCode }: Props) => { + const { gift_card, isLoading, isError } = useGiftCard( + giftCardCode + ) return (
    diff --git a/www/apps/docs/content/modules/multiwarehouse/admin/manage-inventory-items.mdx b/www/apps/docs/content/modules/multiwarehouse/admin/manage-inventory-items.mdx index 2e07035328e76..579e4472366c3 100644 --- a/www/apps/docs/content/modules/multiwarehouse/admin/manage-inventory-items.mdx +++ b/www/apps/docs/content/modules/multiwarehouse/admin/manage-inventory-items.mdx @@ -78,7 +78,8 @@ You can list inventory items by sending a request to the [List Inventory Items A function InventoryItems() { const { inventory_items, - isLoading } = useAdminInventoryItems() + isLoading + } = useAdminInventoryItems() return (
    @@ -164,9 +165,13 @@ You can create an inventory item by sending a request to the [Create Inventory I const createInventoryItem = useAdminCreateInventoryItem() // ... - const handleCreate = () => { + const handleCreate = (variantId: string) => { createInventoryItem.mutate({ - variant_id, + variant_id: variantId, + }, { + onSuccess: ({ inventory_item }) => { + console.log(inventory_item.id) + } }) } @@ -237,10 +242,15 @@ You can retrieve an inventory item by sending a request to the [Get Inventory It ```tsx import { useAdminInventoryItem } from "medusa-react" - function InventoryItem() { + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { const { inventory_item, - isLoading } = useAdminInventoryItem(inventoryItemId) + isLoading + } = useAdminInventoryItem(inventoryItemId) return (
    @@ -309,22 +319,30 @@ You can update an inventory item by sending a request to the [Update Inventory I ```tsx import { useAdminUpdateInventoryItem } from "medusa-react" - const UpdateInventoryItem = () => { + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { const updateInventoryItem = useAdminUpdateInventoryItem( inventoryItemId ) // ... - const handleUpdate = () => { + const handleUpdate = (origin_country: string) => { updateInventoryItem.mutate({ - origin_country: "US", + origin_country, + }, { + onSuccess: ({ inventory_item }) => { + console.log(inventory_item.origin_country) + } }) } // ... } - export default UpdateInventoryItem + export default InventoryItem ``` @@ -395,13 +413,17 @@ You can list inventory levels of an inventory item by sending a request to the [ import { useAdminInventoryItemLocationLevels, } from "medusa-react" - - function InventoryItem() { + + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { const { inventory_item, isLoading, } = useAdminInventoryItemLocationLevels(inventoryItemId) - + return (
    {isLoading && Loading...} @@ -415,7 +437,7 @@ You can list inventory levels of an inventory item by sending a request to the [
    ) } - + export default InventoryItem ``` @@ -475,23 +497,34 @@ You can create a location level by sending a request to the [Create Inventory Le ```tsx import { useAdminCreateLocationLevel } from "medusa-react" - const CreateLocationLevel = () => { + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { const createLocationLevel = useAdminCreateLocationLevel( inventoryItemId ) // ... - const handleCreate = () => { + const handleCreateLocationLevel = ( + locationId: string, + stockedQuantity: number + ) => { createLocationLevel.mutate({ - location_id, - stocked_quantity: 10, + location_id: locationId, + stocked_quantity: stockedQuantity, + }, { + onSuccess: ({ inventory_item }) => { + console.log(inventory_item.id) + } }) } // ... } - export default CreateLocationLevel + export default InventoryItem ``` @@ -568,23 +601,34 @@ You can update a location level by sending a request to the [Update Location Lev ```tsx import { useAdminUpdateLocationLevel } from "medusa-react" - const UpdateLocationLevel = () => { + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { const updateLocationLevel = useAdminUpdateLocationLevel( inventoryItemId ) // ... - const handleUpdate = () => { + const handleUpdate = ( + stockLocationId: string, + stockedQuantity: number + ) => { updateLocationLevel.mutate({ stockLocationId, - stocked_quantity: 10, + stocked_quantity: stockedQuantity, + }, { + onSuccess: ({ inventory_item }) => { + console.log(inventory_item.id) + } }) } // ... } - export default UpdateLocationLevel + export default InventoryItem ``` @@ -653,20 +697,26 @@ You can delete a location level of an inventory item by sending a request to the ```tsx import { useAdminDeleteLocationLevel } from "medusa-react" - const DeleteLocationLevel = () => { + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { const deleteLocationLevel = useAdminDeleteLocationLevel( inventoryItemId ) // ... - const handleDelete = () => { + const handleDelete = ( + locationId: string + ) => { deleteLocationLevel.mutate(locationId) } // ... } - export default DeleteLocationLevel + export default InventoryItem ``` @@ -722,7 +772,11 @@ You can delete an inventory item by sending a request to the [Delete Inventory I ```tsx import { useAdminDeleteInventoryItem } from "medusa-react" - const DeleteInventoryItem = () => { + type Props = { + inventoryItemId: string + } + + const InventoryItem = ({ inventoryItemId }: Props) => { const deleteInventoryItem = useAdminDeleteInventoryItem( inventoryItemId ) @@ -735,7 +789,7 @@ You can delete an inventory item by sending a request to the [Delete Inventory I // ... } - export default DeleteInventoryItem + export default InventoryItem ``` diff --git a/www/apps/docs/content/modules/multiwarehouse/admin/manage-item-allocations-in-orders.mdx b/www/apps/docs/content/modules/multiwarehouse/admin/manage-item-allocations-in-orders.mdx index 1905c9c0b8699..a0302dbd58c78 100644 --- a/www/apps/docs/content/modules/multiwarehouse/admin/manage-item-allocations-in-orders.mdx +++ b/www/apps/docs/content/modules/multiwarehouse/admin/manage-item-allocations-in-orders.mdx @@ -267,16 +267,20 @@ You can retrieve a single item allocation by its ID using the [Get a Reservation ```tsx import { useAdminReservation } from "medusa-react" - function Reservation() { - const { - reservation, - isLoading } = useAdminReservation(reservationId) + type Props = { + reservationId: string + } + + const Reservation = ({ reservationId }: Props) => { + const { reservation, isLoading } = useAdminReservation( + reservationId + ) return (
    {isLoading && Loading...} {reservation && ( - {reservation.quantity} + {reservation.inventory_item_id} )}
    ) @@ -335,22 +339,30 @@ You can update an item allocation to change the location to allocate from or the ```tsx import { useAdminUpdateReservation } from "medusa-react" - const UpdateReservation = () => { + type Props = { + reservationId: string + } + + const Reservation = ({ reservationId }: Props) => { const updateReservation = useAdminUpdateReservation( reservationId ) // ... - const handleCreate = () => { + const handleCreate = (quantity: number) => { updateReservation.mutate({ quantity, + }, { + onSuccess: ({ reservation }) => { + console.log(reservation.id) + } }) } // ... } - export default UpdateReservation + export default Reservation ``` @@ -420,20 +432,28 @@ You can delete an item allocation by sending a request to the [Delete Reservatio ```tsx import { useAdminDeleteReservation } from "medusa-react" - const DeleteReservation = () => { + type Props = { + reservationId: string + } + + const Reservation = ({ reservationId }: Props) => { const deleteReservation = useAdminDeleteReservation( reservationId ) // ... const handleDelete = () => { - deleteReservation.mutate() + deleteReservation.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... } - export default DeleteReservation + export default Reservation ``` @@ -596,7 +616,7 @@ When requesting a return, you can specify the location to return the item to by location_id, }) .then(({ order }) => { - console.log(order.id) + console.log(order.returns) }) ``` @@ -606,7 +626,11 @@ When requesting a return, you can specify the location to return the item to by ```tsx import { useAdminRequestReturn } from "medusa-react" - const RequestReturn = () => { + type Props = { + orderId: string + } + + const RequestReturn = ({ orderId }: Props) => { const requestReturn = useAdminRequestReturn(orderId) // ... @@ -620,6 +644,10 @@ When requesting a return, you can specify the location to return the item to by ], // ...other parameters location_id, + }, { + onSuccess: ({ order }) => { + console.log(order.returns) + } }) } diff --git a/www/apps/docs/content/modules/multiwarehouse/admin/manage-reservations.mdx b/www/apps/docs/content/modules/multiwarehouse/admin/manage-reservations.mdx index 7a90eebe47fa6..12428b14d59a3 100644 --- a/www/apps/docs/content/modules/multiwarehouse/admin/manage-reservations.mdx +++ b/www/apps/docs/content/modules/multiwarehouse/admin/manage-reservations.mdx @@ -174,11 +174,19 @@ You can create a reservation by sending a request to the [Create Reservation API const createReservation = useAdminCreateReservation() // ... - const handleCreate = () => { + const handleCreate = ( + locationId: string, + inventoryItemId: string, + quantity: number + ) => { createReservation.mutate({ - location_id, - inventory_item_id, + location_id: locationId, + inventory_item_id: inventoryItemId, quantity, + }, { + onSuccess: ({ reservation }) => { + console.log(reservation.id) + } }) } @@ -259,13 +267,19 @@ You can update a reservation by sending a request to the [Update Reservation API ```tsx import { useAdminUpdateReservation } from "medusa-react" - const UpdateReservation = () => { + type Props = { + reservationId: string + } + + const Reservation = ({ reservationId }: Props) => { const updateReservation = useAdminUpdateReservation( reservationId ) // ... - const handleCreate = () => { + const handleUpdate = ( + quantity: number + ) => { updateReservation.mutate({ quantity, }) @@ -274,7 +288,7 @@ You can update a reservation by sending a request to the [Update Reservation API // ... } - export default UpdateReservation + export default Reservation ``` @@ -344,20 +358,28 @@ You can delete a reservation by sending a request to the [Delete Reservation API ```tsx import { useAdminDeleteReservation } from "medusa-react" - const DeleteReservation = () => { + type Props = { + reservationId: string + } + + const Reservation = ({ reservationId }: Props) => { const deleteReservation = useAdminDeleteReservation( reservationId ) // ... const handleDelete = () => { - deleteReservation.mutate() + deleteReservation.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... } - export default DeleteReservation + export default Reservation ``` diff --git a/www/apps/docs/content/modules/multiwarehouse/admin/manage-stock-locations.mdx b/www/apps/docs/content/modules/multiwarehouse/admin/manage-stock-locations.mdx index 1ceca79d1b41b..e6c1f463cbe47 100644 --- a/www/apps/docs/content/modules/multiwarehouse/admin/manage-stock-locations.mdx +++ b/www/apps/docs/content/modules/multiwarehouse/admin/manage-stock-locations.mdx @@ -80,7 +80,8 @@ You can list stock locations by using the [List Stock Locations API Route](https function StockLocations() { const { stock_locations, - isLoading } = useAdminStockLocations() + isLoading + } = useAdminStockLocations() return (
    @@ -160,9 +161,13 @@ You can create a stock location using the [Create a Stock Location API Route](ht const createStockLocation = useAdminCreateStockLocation() // ... - const handleCreate = () => { + const handleCreate = (name: string) => { createStockLocation.mutate({ - name: "Main Warehouse", + name, + }, { + onSuccess: ({ stock_location }) => { + console.log(stock_location.id) + } }) } @@ -233,10 +238,15 @@ You can retrieve a stock location by sending a request to the [Get Stock Locatio ```tsx import { useAdminStockLocation } from "medusa-react" - function StockLocation() { + type Props = { + stockLocationId: string + } + + const StockLocation = ({ stockLocationId }: Props) => { const { stock_location, - isLoading } = useAdminStockLocation(stockLocationId) + isLoading + } = useAdminStockLocation(stockLocationId) return (
    @@ -303,21 +313,33 @@ You can associate a stock location with a sales channel by sending a request to ```tsx - import { useAdminAddLocationToSalesChannel } from "medusa-react" + import { + useAdminAddLocationToSalesChannel + } from "medusa-react" + + type Props = { + salesChannelId: string + } - function StockLocation() { + const SalesChannel = ({ salesChannelId }: Props) => { const addLocation = useAdminAddLocationToSalesChannel() // ... - const handleAdd = () => { + const handleAddLocation = (locationId: string) => { addLocation.mutate({ - sales_channel_id, - location_id, + sales_channel_id: salesChannelId, + location_id: locationId + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.locations) + } }) } + + // ... } - export default StockLocation + export default SalesChannel ``` @@ -390,23 +412,32 @@ You can remove the association between a stock location and a sales channel by s ```tsx import { - useAdminRemoveLocationFromSalesChannel, + useAdminRemoveLocationFromSalesChannel } from "medusa-react" - - function StockLocation() { - const removeLocation = - useAdminRemoveLocationFromSalesChannel() + + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { + const removeLocation = useAdminRemoveLocationFromSalesChannel() // ... - - const handleRemove = () => { + + const handleRemoveLocation = (locationId: string) => { removeLocation.mutate({ - sales_channel_id, - location_id, + sales_channel_id: salesChannelId, + location_id: locationId + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.locations) + } }) } + + // ... } - - export default StockLocation + + export default SalesChannel ``` @@ -484,15 +515,25 @@ You can update a stock location by sending a request to the [Update Stock Locati ```tsx import { useAdminUpdateStockLocation } from "medusa-react" - function StockLocation() { + type Props = { + stockLocationId: string + } + + const StockLocation = ({ stockLocationId }: Props) => { const updateLocation = useAdminUpdateStockLocation( stockLocationId ) // ... - const handleRemove = () => { + const handleUpdate = ( + name: string + ) => { updateLocation.mutate({ - name: "Warehouse", + name + }, { + onSuccess: ({ stock_location }) => { + console.log(stock_location.name) + } }) } } @@ -563,14 +604,22 @@ You can delete a stock location by sending a request to the [Delete Stock Locati ```tsx import { useAdminDeleteStockLocation } from "medusa-react" - function StockLocation() { + type Props = { + stockLocationId: string + } + + const StockLocation = ({ stockLocationId }: Props) => { const deleteLocation = useAdminDeleteStockLocation( stockLocationId ) // ... const handleDelete = () => { - deleteLocation.mutate() + deleteLocation.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } } diff --git a/www/apps/docs/content/modules/orders/admin/edit-order.mdx b/www/apps/docs/content/modules/orders/admin/edit-order.mdx index 911d82ac74954..a62883c42ed4d 100644 --- a/www/apps/docs/content/modules/orders/admin/edit-order.mdx +++ b/www/apps/docs/content/modules/orders/admin/edit-order.mdx @@ -100,19 +100,23 @@ To do that, send a request to the [Create an OrderEdit API Route](https://docs.m ```tsx import { useAdminCreateOrderEdit } from "medusa-react" - const OrderEdit = () => { + const CreateOrderEdit = () => { const createOrderEdit = useAdminCreateOrderEdit() const handleCreateOrderEdit = (orderId: string) => { createOrderEdit.mutate({ order_id: orderId, + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.id) + } }) } // ... } - export default OrderEdit + export default CreateOrderEdit ``` @@ -195,14 +199,24 @@ To add a new item to the original order, send a request to the [Add Line Item AP ```tsx import { useAdminOrderEditAddLineItem } from "medusa-react" - const OrderEdit = () => { - const addLineItem = useAdminOrderEditAddLineItem(orderEditId) + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const addLineItem = useAdminOrderEditAddLineItem( + orderEditId + ) const handleAddLineItem = (quantity: number, variantId: string) => { addLineItem.mutate({ quantity, variant_id: variantId, + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.changes) + } }) } @@ -279,7 +293,10 @@ To update an item, send a request to the [Update Line Item API Route](https://do ```tsx import { useAdminOrderEditUpdateLineItem } from "medusa-react" - const OrderEdit = () => { + const OrderEditItemChange = ( + orderEditId: string, + itemId: string + ) => { const updateLineItem = useAdminOrderEditUpdateLineItem( orderEditId, itemId @@ -288,13 +305,17 @@ To update an item, send a request to the [Update Line Item API Route](https://do const handleUpdateLineItem = (quantity: number) => { updateLineItem.mutate({ quantity, + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.items) + } }) } // ... } - export default OrderEdit + export default OrderEditItemChange ``` @@ -359,20 +380,32 @@ You can remove an item from the original order by sending a request to the [Remo ```tsx import { useAdminOrderEditDeleteLineItem } from "medusa-react" - const OrderEdit = () => { + type Props = { + orderEditId: string + itemId: string + } + + const OrderEditLineItem = ({ + orderEditId, + itemId + }: Props) => { const removeLineItem = useAdminOrderEditDeleteLineItem( orderEditId, itemId ) const handleRemoveLineItem = () => { - removeLineItem.mutate() + removeLineItem.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.changes) + } + }) } // ... } - export default OrderEdit + export default OrderEditLineItem ``` @@ -428,16 +461,23 @@ To revert an item change, send a request to the [Delete Item Change API Route](h ```tsx - import { useAdminDeleteOrderEditItemChange } from "medusa-react" + import { useAdminDeleteOrderEdit } from "medusa-react" - const OrderEdit = () => { - const deleteItemChange = useAdminDeleteOrderEditItemChange( - orderEditId, - itemChangeId + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const deleteOrderEdit = useAdminDeleteOrderEdit( + orderEditId ) - const handleDeleteItemChange = () => { - deleteItemChange.mutate() + const handleDelete = () => { + deleteOrderEdit.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... @@ -513,14 +553,25 @@ To move an Order Edit into the request state, send a request to the [Request Con useAdminRequestOrderEditConfirmation, } from "medusa-react" - const OrderEdit = () => { + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { const requestOrderConfirmation = useAdminRequestOrderEditConfirmation( orderEditId ) const handleRequestConfirmation = () => { - requestOrderConfirmation.mutate() + requestOrderConfirmation.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log( + order_edit.requested_at, + order_edit.requested_by + ) + } + }) } // ... @@ -604,11 +655,24 @@ To confirm an Order Edit, send a request to the [Confirm Order Edit API Route](h ```tsx import { useAdminConfirmOrderEdit } from "medusa-react" - const OrderEdit = () => { - const confirmOrderEdit = useAdminConfirmOrderEdit(orderEditId) + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const confirmOrderEdit = useAdminConfirmOrderEdit( + orderEditId + ) const handleConfirmOrderEdit = () => { - confirmOrderEdit.mutate() + confirmOrderEdit.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log( + order_edit.confirmed_at, + order_edit.confirmed_by + ) + } + }) } // ... @@ -687,13 +751,22 @@ If the payment is authorized by the customer, it can be captured by sending a re ```tsx import { useAdminPaymentsCapturePayment } from "medusa-react" - const OrderEditPayment = () => { - const capturePayment = useAdminPaymentsCapturePayment( + type Props = { + paymentId: string + } + + const OrderEditPayment = ({ paymentId }: Props) => { + const capture = useAdminPaymentsCapturePayment( paymentId ) - - const handleCapturePayment = () => { - capturePayment.mutate() + // ... + + const handleCapture = () => { + capture.mutate(void 0, { + onSuccess: ({ payment }) => { + console.log(payment.amount) + } + }) } // ... @@ -757,24 +830,39 @@ To refund the difference to the customer, send a request to the [Refund Payment ```tsx - import { useAdminPaymentsRefundPayment } from "medusa-react" import { RefundReason } from "@medusajs/medusa" + import { useAdminPaymentsRefundPayment } from "medusa-react" - const OrderEditPayment = () => { - const refundPayment = useAdminPaymentsRefundPayment(paymentId) - - const handleRefundPayment = - (amount: number, reason: RefundReason) => { - refundPayment.mutate({ - amount, - reason, - }) - } + type Props = { + paymentId: string + } + + const Payment = ({ paymentId }: Props) => { + const refund = useAdminPaymentsRefundPayment( + paymentId + ) + // ... + + const handleRefund = ( + amount: number, + reason: RefundReason, + note: string + ) => { + refund.mutate({ + amount, + reason, + note + }, { + onSuccess: ({ refund }) => { + console.log(refund.amount) + } + }) + } // ... } - export default OrderEditPayment + export default Payment ``` diff --git a/www/apps/docs/content/modules/orders/admin/manage-claims.mdx b/www/apps/docs/content/modules/orders/admin/manage-claims.mdx index ce006d8f1aac4..f91fe06dac25f 100644 --- a/www/apps/docs/content/modules/orders/admin/manage-claims.mdx +++ b/www/apps/docs/content/modules/orders/admin/manage-claims.mdx @@ -163,19 +163,27 @@ You can create a claim by sending a request to the [Create Claim API Route](http ```tsx import { useAdminCreateClaim } from "medusa-react" - const CreateClaim = () => { + type Props = { + orderId: string + } + + const CreateClaim = ({ orderId }: Props) => { const createClaim = useAdminCreateClaim(orderId) // ... - const handleCreate = () => { + const handleCreate = (itemId: string) => { createClaim.mutate({ type: "refund", claim_items: [ { - item_id, + item_id: itemId, quantity: 1, }, ], + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } }) } @@ -275,21 +283,30 @@ You can update a claim by sending a request to the [Update Claim API Route](http ```tsx import { useAdminUpdateClaim } from "medusa-react" - const UpdateClaim = () => { + type Props = { + orderId: string + claimId: string + } + + const Claim = ({ orderId, claimId }: Props) => { const updateClaim = useAdminUpdateClaim(orderId) // ... - + const handleUpdate = () => { updateClaim.mutate({ - claim_id, - no_notification: true, + claim_id: claimId, + no_notification: false + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } }) } - + // ... } - - export default UpdateClaim + + export default Claim ``` @@ -365,20 +382,29 @@ You can create a fulfillment for a claim by sending a request to the [Create Cla ```tsx import { useAdminFulfillClaim } from "medusa-react" - const FulfillClaim = () => { + type Props = { + orderId: string + claimId: string + } + + const Claim = ({ orderId, claimId }: Props) => { const fulfillClaim = useAdminFulfillClaim(orderId) // ... const handleFulfill = () => { fulfillClaim.mutate({ - claim_id, + claim_id: claimId, + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } }) } // ... } - export default FulfillClaim + export default Claim ``` @@ -436,21 +462,30 @@ You can create a shipment for a claim by sending a request to the [Create Claim ```tsx import { useAdminCreateClaimShipment } from "medusa-react" - const CreateShipment = () => { + type Props = { + orderId: string + claimId: string + } + + const Claim = ({ orderId, claimId }: Props) => { const createShipment = useAdminCreateClaimShipment(orderId) // ... - const handleCreate = () => { + const handleCreateShipment = (fulfillmentId: string) => { createShipment.mutate({ - claim_id, - fulfillment_id, + claim_id: claimId, + fulfillment_id: fulfillmentId, + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } }) } // ... } - export default CreateShipment + export default Claim ``` @@ -530,23 +565,32 @@ You can cancel a fulfillment by sending a request to the [Cancel Fulfillment API ```tsx import { useAdminCancelClaimFulfillment } from "medusa-react" - const CancelFulfillment = () => { + type Props = { + orderId: string + claimId: string + } + + const Claim = ({ orderId, claimId }: Props) => { const cancelFulfillment = useAdminCancelClaimFulfillment( orderId ) // ... - const handleCancel = () => { + const handleCancel = (fulfillmentId: string) => { cancelFulfillment.mutate({ - claim_id, - fulfillment_id, + claim_id: claimId, + fulfillment_id: fulfillmentId, + }, { + onSuccess: ({ order }) => { + console.log(order.claims) + } }) } // ... } - export default CancelFulfillment + export default Claim ``` @@ -610,7 +654,12 @@ You can cancel a claim by sending a request to the [Cancel Claim API Route](http ```tsx import { useAdminCancelClaim } from "medusa-react" - const CancelClaim = () => { + type Props = { + orderId: string + claimId: string + } + + const Claim = ({ orderId, claimId }: Props) => { const cancelClaim = useAdminCancelClaim(orderId) // ... @@ -621,7 +670,7 @@ You can cancel a claim by sending a request to the [Cancel Claim API Route](http // ... } - export default CancelClaim + export default Claim ``` diff --git a/www/apps/docs/content/modules/orders/admin/manage-draft-orders.mdx b/www/apps/docs/content/modules/orders/admin/manage-draft-orders.mdx index 07f8c3bc2c865..0e559dd2fa8c0 100644 --- a/www/apps/docs/content/modules/orders/admin/manage-draft-orders.mdx +++ b/www/apps/docs/content/modules/orders/admin/manage-draft-orders.mdx @@ -166,34 +166,28 @@ You can create a draft order by sending a request to the [Create Draft Order API ```tsx import { useAdminCreateDraftOrder } from "medusa-react" + type DraftOrderData = { + email: string + region_id: string + items: { + quantity: number, + variant_id: string + }[] + shipping_methods: { + option_id: string + price: number + }[] + } + const CreateDraftOrder = () => { const createDraftOrder = useAdminCreateDraftOrder() // ... - const handleCreate = () => { - createDraftOrder.mutate({ - email, - region_id, - items: [ - { - // defined product - quantity: 1, - variant_id, - }, - { - // custom product - quantity: 1, - unit_price: 1000, - title: "Custom Product", - }, - ], - shipping_methods: [ - { - option_id, - // for custom shipping price - price, - }, - ], + const handleCreate = (data: DraftOrderData) => { + createDraftOrder.mutate(data, { + onSuccess: ({ draft_order }) => { + console.log(draft_order.id) + } }) } @@ -316,12 +310,16 @@ You can retrieve a draft order by sending a request to the [Get Draft Order API ```tsx import { useAdminDraftOrder } from "medusa-react" - const DraftOrder = () => { + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { const { draft_order, isLoading, } = useAdminDraftOrder(draftOrderId) - + return (
    {isLoading && Loading...} @@ -386,22 +384,30 @@ You can update a draft order by sending a request to the [Update Draft Order API ```tsx import { useAdminUpdateDraftOrder } from "medusa-react" - const UpdateDraftOrder = () => { + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { const updateDraftOrder = useAdminUpdateDraftOrder( draftOrderId ) // ... - - const handleUpdate = () => { + + const handleUpdate = (email: string) => { updateDraftOrder.mutate({ - email: "user@example.com", + email, + }, { + onSuccess: ({ draft_order }) => { + console.log(draft_order.id) + } }) } - + // ... } - - export default UpdateDraftOrder + + export default DraftOrder ``` @@ -471,22 +477,30 @@ You can add line items to a draft order by sending a request to the [Create Line ```tsx import { useAdminDraftOrderAddLineItem } from "medusa-react" - const AddLineItem = () => { + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { const addLineItem = useAdminDraftOrderAddLineItem( draftOrderId ) // ... - const handleAdd = () => { + const handleAdd = (quantity: number) => { addLineItem.mutate({ - quantity: 1, + quantity, + }, { + onSuccess: ({ draft_order }) => { + console.log(draft_order.cart) + } }) } // ... } - export default AddLineItem + export default DraftOrder ``` @@ -561,23 +575,30 @@ You can update a line item by sending a request to the [Update Line Item API Rou ```tsx import { useAdminDraftOrderUpdateLineItem } from "medusa-react" - const UpdateLineItem = () => { + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { const updateLineItem = useAdminDraftOrderUpdateLineItem( draftOrderId ) // ... - const handleUpdate = () => { + const handleUpdate = ( + itemId: string, + quantity: number + ) => { updateLineItem.mutate({ - item_id, - quantity: 1, + item_id: itemId, + quantity, }) } // ... } - export default UpdateLineItem + export default DraftOrder ``` @@ -643,20 +664,24 @@ You can delete a line item by sending a request to the [Delete Line Item API Rou ```tsx import { useAdminDraftOrderRemoveLineItem } from "medusa-react" - const DeleteLineItem = () => { + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { const deleteLineItem = useAdminDraftOrderRemoveLineItem( draftOrderId ) // ... - const handleDelete = () => { + const handleDelete = (itemId: string) => { deleteLineItem.mutate(itemId) } // ... } - export default DeleteLineItem + export default DraftOrder ``` @@ -714,20 +739,28 @@ You can register the draft order payment by sending a request to the [Register D ```tsx import { useAdminDraftOrderRegisterPayment } from "medusa-react" - const RegisterPayment = () => { + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { const registerPayment = useAdminDraftOrderRegisterPayment( draftOrderId ) // ... const handlePayment = () => { - registerPayment.mutate() + registerPayment.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.id) + } + }) } // ... } - export default RegisterPayment + export default DraftOrder ``` @@ -781,20 +814,28 @@ You can delete a draft order by sending a request to the [Delete Draft Order API ```tsx import { useAdminDeleteDraftOrder } from "medusa-react" - const DeleteDraftOrder = () => { + type Props = { + draftOrderId: string + } + + const DraftOrder = ({ draftOrderId }: Props) => { const deleteDraftOrder = useAdminDeleteDraftOrder( draftOrderId ) // ... const handleDelete = () => { - deleteDraftOrder.mutate() + deleteDraftOrder.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... } - export default DeleteDraftOrder + export default DraftOrder ``` diff --git a/www/apps/docs/content/modules/orders/admin/manage-orders.mdx b/www/apps/docs/content/modules/orders/admin/manage-orders.mdx index 9e72cd6bd9612..1c71edbf0cae4 100644 --- a/www/apps/docs/content/modules/orders/admin/manage-orders.mdx +++ b/www/apps/docs/content/modules/orders/admin/manage-orders.mdx @@ -398,7 +398,11 @@ You can retrieve an order by sending a request to the [Get an Order API Route](h ```tsx import { useAdminOrder } from "medusa-react" - const Order = () => { + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { const { order, isLoading, @@ -481,22 +485,31 @@ You can update any of the above details of an order by sending a request to the ```tsx import { useAdminUpdateOrder } from "medusa-react" - const UpdateOrder = () => { + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { const updateOrder = useAdminUpdateOrder( orderId ) - // ... - const handleUpdate = () => { + const handleUpdate = ( + email: string + ) => { updateOrder.mutate({ email, + }, { + onSuccess: ({ order }) => { + console.log(order.email) + } }) } // ... } - export default UpdateOrder + export default Order ``` @@ -564,20 +577,28 @@ You can capture an order’s payment by sending a request to the [Capture Order ```tsx import { useAdminCapturePayment } from "medusa-react" - const CapturePayment = () => { + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { const capturePayment = useAdminCapturePayment( orderId ) // ... const handleCapture = () => { - capturePayment.mutate() + capturePayment.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.status) + } + }) } // ... } - export default CapturePayment + export default Order ``` @@ -634,23 +655,34 @@ To refund payment, send a request to the [Refund Payment API Route](https://docs ```tsx import { useAdminRefundPayment } from "medusa-react" - const RefundPayment = () => { + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { const refundPayment = useAdminRefundPayment( orderId ) // ... - const handleRefund = () => { + const handleRefund = ( + amount: number, + reason: string + ) => { refundPayment.mutate({ amount, reason, + }, { + onSuccess: ({ order }) => { + console.log(order.refunds) + } }) } // ... } - export default RefundPayment + export default Order ``` @@ -732,27 +764,38 @@ You can create a fulfillment by sending a request to the [Create a Fulfillment A ```tsx import { useAdminCreateFulfillment } from "medusa-react" - const CreateFullfillment = () => { + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { const createFulfillment = useAdminCreateFulfillment( orderId ) // ... - const handleCreate = () => { + const handleCreateFulfillment = ( + itemId: string, + quantity: number + ) => { createFulfillment.mutate({ items: [ { - itemId, + item_id: itemId, quantity, }, ], + }, { + onSuccess: ({ order }) => { + console.log(order.fulfillments) + } }) } // ... } - export default CreateFullfillment + export default Order ``` @@ -835,22 +878,32 @@ You can create a shipment for a fulfillment by sending a request to the [Create ```tsx import { useAdminCreateShipment } from "medusa-react" - const CreateShipment = () => { + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { const createShipment = useAdminCreateShipment( orderId ) // ... - const handleCreate = () => { + const handleCreate = ( + fulfillmentId: string + ) => { createShipment.mutate({ - fulfillment_id, + fulfillment_id: fulfillmentId, + }, { + onSuccess: ({ order }) => { + console.log(order.fulfillment_status) + } }) } // ... } - export default CreateShipment + export default Order ``` @@ -914,20 +967,30 @@ You can cancel a fulfillment by sending a request to the [Cancel Fulfillment API ```tsx import { useAdminCancelFulfillment } from "medusa-react" - const CancelFulfillment = () => { + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { const cancelFulfillment = useAdminCancelFulfillment( orderId ) // ... - const handleCancel = () => { - cancelFulfillment.mutate(fulfillment_id) + const handleCancel = ( + fulfillmentId: string + ) => { + cancelFulfillment.mutate(fulfillmentId, { + onSuccess: ({ order }) => { + console.log(order.fulfillments) + } + }) } // ... } - export default CancelFulfillment + export default Order ``` @@ -983,20 +1046,28 @@ You can mark an order completed, changing its status, by sending a request to th ```tsx import { useAdminCompleteOrder } from "medusa-react" - const CompleteOrder = () => { + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { const completeOrder = useAdminCompleteOrder( orderId ) // ... const handleComplete = () => { - completeOrder.mutate() + completeOrder.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.status) + } + }) } // ... } - export default CompleteOrder + export default Order ``` @@ -1050,20 +1121,28 @@ You can cancel an order by sending a request to the [Cancel Order API Route](htt ```tsx import { useAdminCancelOrder } from "medusa-react" - const CancelOrder = () => { + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { const cancelOrder = useAdminCancelOrder( orderId ) // ... const handleCancel = () => { - cancelOrder.mutate() + cancelOrder.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.status) + } + }) } // ... } - export default CancelOrder + export default Order ``` @@ -1117,20 +1196,28 @@ You can archive an order by sending a request to the [Archive Order API Route](h ```tsx import { useAdminArchiveOrder } from "medusa-react" - const ArchiveOrder = () => { + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { const archiveOrder = useAdminArchiveOrder( orderId ) // ... - const handleArchive = () => { - archiveOrder.mutate() + const handleArchivingOrder = () => { + archiveOrder.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.status) + } + }) } // ... } - export default ArchiveOrder + export default Order ``` diff --git a/www/apps/docs/content/modules/orders/admin/manage-returns.mdx b/www/apps/docs/content/modules/orders/admin/manage-returns.mdx index 9c9e140740ce7..081410d2fb0ee 100644 --- a/www/apps/docs/content/modules/orders/admin/manage-returns.mdx +++ b/www/apps/docs/content/modules/orders/admin/manage-returns.mdx @@ -155,10 +155,17 @@ You can create a return reason using the [Create Return Reason API Route](https: const createReturnReason = useAdminCreateReturnReason() // ... - const handleCreate = () => { + const handleCreate = ( + label: string, + value: string + ) => { createReturnReason.mutate({ - label: "Damaged", - value: "damaged", + label, + value, + }, { + onSuccess: ({ return_reason }) => { + console.log(return_reason.id) + } }) } @@ -236,22 +243,32 @@ You can update a return reason by sending a request to the [Update Return Reason ```tsx import { useAdminUpdateReturnReason } from "medusa-react" - const UpdateReturnReason = () => { + type Props = { + returnReasonId: string + } + + const ReturnReason = ({ returnReasonId }: Props) => { const updateReturnReason = useAdminUpdateReturnReason( returnReasonId ) // ... - const handleUpdate = () => { + const handleUpdate = ( + label: string + ) => { updateReturnReason.mutate({ - label: "Damaged", + label, + }, { + onSuccess: ({ return_reason }) => { + console.log(return_reason.label) + } }) } // ... } - export default UpdateReturnReason + export default ReturnReason ``` @@ -315,20 +332,28 @@ You can delete a return reason by sending a request to the [Delete Return Reason ```tsx import { useAdminDeleteReturnReason } from "medusa-react" - const DeleteReturnReason = () => { + type Props = { + returnReasonId: string + } + + const ReturnReason = ({ returnReasonId }: Props) => { const deleteReturnReason = useAdminDeleteReturnReason( returnReasonId ) // ... const handleDelete = () => { - deleteReturnReason.mutate() + deleteReturnReason.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... } - export default DeleteReturnReason + export default ReturnReason ``` @@ -492,22 +517,35 @@ You can mark a return as received by sending a request to the [Receive a Return ```tsx import { useAdminReceiveReturn } from "medusa-react" - const ReceiveReturn = () => { + type ReceiveReturnData = { + items: { + item_id: string + quantity: number + }[] + } + + type Props = { + returnId: string + } + + const Return = ({ returnId }: Props) => { const receiveReturn = useAdminReceiveReturn( returnId ) // ... - const handleReceive = () => { - receiveReturn.mutate({ - email, + const handleReceive = (data: ReceiveReturnData) => { + receiveReturn.mutate(data, { + onSuccess: ({ return: dataReturn }) => { + console.log(dataReturn.status) + } }) } // ... } - export default ReceiveReturn + export default Return ``` @@ -594,20 +632,28 @@ You can cancel a return by sending a request to the [Cancel Return API Route](ht ```tsx import { useAdminCancelReturn } from "medusa-react" - const CancelReturn = () => { + type Props = { + returnId: string + } + + const Return = ({ returnId }: Props) => { const cancelReturn = useAdminCancelReturn( returnId ) // ... const handleCancel = () => { - cancelReturn.mutate() + cancelReturn.mutate(void 0, { + onSuccess: ({ order }) => { + console.log(order.returns) + } + }) } // ... } - export default CancelReturn + export default Return ``` diff --git a/www/apps/docs/content/modules/orders/admin/manage-swaps.mdx b/www/apps/docs/content/modules/orders/admin/manage-swaps.mdx index 98afbdaab3832..198e13e452fe6 100644 --- a/www/apps/docs/content/modules/orders/admin/manage-swaps.mdx +++ b/www/apps/docs/content/modules/orders/admin/manage-swaps.mdx @@ -163,20 +163,32 @@ Regardless of whether you need to refund or capture the payment, you can process ```tsx import { useAdminProcessSwapPayment } from "medusa-react" - const ProcessPayment = () => { + type Props = { + orderId: string, + swapId: string + } + + const Swap = ({ + orderId, + swapId + }: Props) => { const processPayment = useAdminProcessSwapPayment( orderId ) // ... - const handleProcess = () => { - processPayment.mutate(swapId) + const handleProcessPayment = () => { + processPayment.mutate(swapId, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } + }) } // ... } - export default ProcessPayment + export default Swap ``` @@ -239,7 +251,15 @@ You can create a fulfillment for a swap by sending a request to the [Create Swap ```tsx import { useAdminFulfillSwap } from "medusa-react" - const FulfillSwap = () => { + type Props = { + orderId: string, + swapId: string + } + + const Swap = ({ + orderId, + swapId + }: Props) => { const fulfillSwap = useAdminFulfillSwap( orderId ) @@ -248,13 +268,17 @@ You can create a fulfillment for a swap by sending a request to the [Create Swap const handleFulfill = () => { fulfillSwap.mutate({ swap_id: swapId, + }, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } }) } // ... } - export default FulfillSwap + export default Swap ``` @@ -312,23 +336,37 @@ You can create a shipment for a swap’s fulfillment using the [Create Swap Ship ```tsx import { useAdminCreateSwapShipment } from "medusa-react" - const CreateShipment = () => { + type Props = { + orderId: string, + swapId: string + } + + const Swap = ({ + orderId, + swapId + }: Props) => { const createShipment = useAdminCreateSwapShipment( orderId ) // ... - const handleCreate = () => { + const handleCreateShipment = ( + fulfillmentId: string + ) => { createShipment.mutate({ - swap_id, - fulfillment_id, + swap_id: swapId, + fulfillment_id: fulfillmentId, + }, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } }) } // ... } - export default CreateShipment + export default Swap ``` @@ -408,23 +446,33 @@ You can cancel a fulfillment by sending a request to the [Cancel Swap Fulfillmen ```tsx import { useAdminCancelSwapFulfillment } from "medusa-react" - const CancelFulfillment = () => { + type Props = { + orderId: string, + swapId: string + } + + const Swap = ({ + orderId, + swapId + }: Props) => { const cancelFulfillment = useAdminCancelSwapFulfillment( orderId ) // ... - const handleCancel = () => { + const handleCancelFulfillment = ( + fulfillmentId: string + ) => { cancelFulfillment.mutate({ - swap_id, - fulfillment_id, + swap_id: swapId, + fulfillment_id: fulfillmentId, }) } // ... } - export default CancelFulfillment + export default Swap ``` @@ -488,20 +536,32 @@ You can cancel a swap by sending a request to the [Cancel Swap API Route](https: ```tsx import { useAdminCancelSwap } from "medusa-react" - const CancelSwap = () => { + type Props = { + orderId: string, + swapId: string + } + + const Swap = ({ + orderId, + swapId + }: Props) => { const cancelSwap = useAdminCancelSwap( orderId ) // ... const handleCancel = () => { - cancelSwap.mutate(swapId) + cancelSwap.mutate(swapId, { + onSuccess: ({ order }) => { + console.log(order.swaps) + } + }) } // ... } - export default CancelSwap + export default Swap ``` diff --git a/www/apps/docs/content/modules/orders/storefront/create-return.mdx b/www/apps/docs/content/modules/orders/storefront/create-return.mdx index c7e13b1a56792..7608860f9708f 100644 --- a/www/apps/docs/content/modules/orders/storefront/create-return.mdx +++ b/www/apps/docs/content/modules/orders/storefront/create-return.mdx @@ -158,22 +158,32 @@ You can create the return by sending a request to the [Create Return API Route]( ```tsx import { useCreateReturn } from "medusa-react" - const CreateReturn = () => { + type CreateReturnData = { + items: { + item_id: string, + quantity: number + }[] + return_shipping: { + option_id: string + } + } + + type Props = { + orderId: string + } + + const CreateReturn = ({ orderId }: Props) => { const createReturn = useCreateReturn() // ... - const handleCreate = () => { + const handleCreate = (data: CreateReturnData) => { createReturn.mutate({ - order_id, - items: [ - { - item_id, - quantity: 1, - }, - ], - return_shipping: { - option_id, - }, + ...data, + order_id: orderId + }, { + onSuccess: ({ return: returnData }) => { + console.log(returnData.id) + } }) } diff --git a/www/apps/docs/content/modules/orders/storefront/create-swap.mdx b/www/apps/docs/content/modules/orders/storefront/create-swap.mdx index edba5dfe265a3..dc5cbff657d04 100644 --- a/www/apps/docs/content/modules/orders/storefront/create-swap.mdx +++ b/www/apps/docs/content/modules/orders/storefront/create-swap.mdx @@ -113,6 +113,10 @@ After collecting the swap details in step 1, you can create a swap in the Medusa }, ], return_shipping_option, + }, { + onSuccess: ({ swap }) => { + console.log(swap.id) + } }) } @@ -205,8 +209,11 @@ During your checkout flow, you might need to retrieve the swap using the cart’ ```tsx import { useCartSwap } from "medusa-react" + type Props = { + cartId: string + } - const Swap = () => { + const Swap = ({ cartId }: Props) => { const { swap, isLoading, diff --git a/www/apps/docs/content/modules/orders/storefront/handle-order-edits.mdx b/www/apps/docs/content/modules/orders/storefront/handle-order-edits.mdx index 6cdab8249774f..b77c090dbcb4d 100644 --- a/www/apps/docs/content/modules/orders/storefront/handle-order-edits.mdx +++ b/www/apps/docs/content/modules/orders/storefront/handle-order-edits.mdx @@ -89,10 +89,25 @@ You can retrieve a single order edit by its ID by sending a request to the [Get ```tsx import { useOrderEdit } from "medusa-react" - const OrderEdit = () => { + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { const { order_edit, isLoading } = useOrderEdit(orderEditId) - // ... + return ( +
    + {isLoading && Loading...} + {order_edit && ( +
      + {order_edit.changes.map((change) => ( +
    • {change.type}
      • + ))} +
    + )} +
    + ) } export default OrderEdit @@ -220,7 +235,13 @@ If `difference_due` is greater than 0, then additional payment from the customer ```tsx import { useManagePaymentSession } from "medusa-react" - const OrderEditPayment = () => { + type Props = { + paymentCollectionId: string + } + + const OrderEditPayment = ({ + paymentCollectionId + }: Props) => { const managePaymentSession = useManagePaymentSession( paymentCollectionId ) @@ -229,6 +250,10 @@ If `difference_due` is greater than 0, then additional payment from the customer const handleAdditionalPayment = (provider_id: string) => { managePaymentSession.mutate({ provider_id, + }, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.payment_sessions) + } }) } @@ -279,8 +304,8 @@ If `difference_due` is greater than 0, then additional payment from the customer paymentCollectionId, paymentSessionId ) - .then(({ payment_session }) => { - console.log(payment_session.id) + .then(({ payment_collection }) => { + console.log(payment_collection.payment_sessions) }) ``` @@ -290,14 +315,24 @@ If `difference_due` is greater than 0, then additional payment from the customer ```tsx import { useAuthorizePaymentSession } from "medusa-react" - const OrderEditPayment = () => { + type Props = { + paymentCollectionId: string + } + + const OrderEditPayment = ({ + paymentCollectionId + }: Props) => { const authorizePaymentSession = useAuthorizePaymentSession( paymentCollectionId ) // ... const handleAuthorizePayment = (paymentSessionId: string) => { - authorizePaymentSession.mutate(paymentSessionId) + authorizePaymentSession.mutate(paymentSessionId, { + onSuccess: ({ payment_collection }) => { + console.log(payment_collection.payment_sessions) + } + }) } // ... @@ -321,8 +356,8 @@ If `difference_due` is greater than 0, then additional payment from the customer } ) .then((response) => response.json()) - .then(({ payment_session }) => { - console.log(payment_session.id) + .then(({ payment_collection }) => { + console.log(payment_collection.payment_sessions) }) ``` @@ -353,12 +388,22 @@ To confirm and complete the order edit, send a request to the [Complete Order Ed ```tsx import { useCompleteOrderEdit } from "medusa-react" - const OrderEdit = () => { - const completeOrderEdit = useCompleteOrderEdit(orderEditId) + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { + const completeOrderEdit = useCompleteOrderEdit( + orderEditId + ) // ... const handleCompleteOrderEdit = () => { - completeOrderEdit.mutate() + completeOrderEdit.mutate(void 0, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.confirmed_at) + } + }) } // ... @@ -422,13 +467,23 @@ If the customer wants to decline the Order Edit, you can do that by sending a re ```tsx import { useDeclineOrderEdit } from "medusa-react" - const OrderEdit = () => { + type Props = { + orderEditId: string + } + + const OrderEdit = ({ orderEditId }: Props) => { const declineOrderEdit = useDeclineOrderEdit(orderEditId) // ... - const handleDeclineOrderEdit = () => { + const handleDeclineOrderEdit = ( + declinedReason: string + ) => { declineOrderEdit.mutate({ - declined_reason: "I am not satisfied", + declined_reason: declinedReason, + }, { + onSuccess: ({ order_edit }) => { + console.log(order_edit.declined_at) + } }) } diff --git a/www/apps/docs/content/modules/orders/storefront/implement-claim-order.mdx b/www/apps/docs/content/modules/orders/storefront/implement-claim-order.mdx index f5ca8d59bc253..5df9b22831649 100644 --- a/www/apps/docs/content/modules/orders/storefront/implement-claim-order.mdx +++ b/www/apps/docs/content/modules/orders/storefront/implement-claim-order.mdx @@ -96,6 +96,36 @@ To allow the customer to claim an order, send a request to the Claim an Order AP }) ``` + + + + ```tsx + import { useRequestOrderAccess } from "medusa-react" + + const ClaimOrder = () => { + const claimOrder = useRequestOrderAccess() + + const handleClaimOrder = ( + orderIds: string[] + ) => { + claimOrder.mutate({ + order_ids: orderIds + }, { + onSuccess: () => { + // successful + }, + onError: () => { + // an error occurred. + } + }) + } + + // ... + } + + export default ClaimOrder + ``` + @@ -159,15 +189,23 @@ Then, you send a request to the Verify Claim Order API Route: import { useGrantOrderAccess } from "medusa-react" const ClaimOrder = () => { - const grantOrderAccess = useGrantOrderAccess() - // ... - - const handleVerifyOrderClaim = (token: string) => { - grantOrderAccess.mutate(({ - token, - })) + const confirmOrderRequest = useGrantOrderAccess() + + const handleOrderRequestConfirmation = ( + token: string + ) => { + confirmOrderRequest.mutate({ + token + }, { + onSuccess: () => { + // successful + }, + onError: () => { + // an error occurred. + } + }) } - + // ... } diff --git a/www/apps/docs/content/modules/orders/storefront/retrieve-order-details.mdx b/www/apps/docs/content/modules/orders/storefront/retrieve-order-details.mdx index 71d3600c6840b..108ca704bed11 100644 --- a/www/apps/docs/content/modules/orders/storefront/retrieve-order-details.mdx +++ b/www/apps/docs/content/modules/orders/storefront/retrieve-order-details.mdx @@ -54,7 +54,11 @@ You can retrieve an order by its ID using the [Get Order API Route](https://docs ```tsx import { useOrder } from "medusa-react" - const Order = () => { + type Props = { + orderId: string + } + + const Order = ({ orderId }: Props) => { const { order, isLoading, @@ -119,13 +123,21 @@ You can retrieve an order by its display ID using the [Look Up Order API Route]( ```tsx import { useOrders } from "medusa-react" - const Order = () => { + type Props = { + displayId: number + email: string + } + + const Order = ({ + displayId, + email + }: Props) => { const { order, isLoading, } = useOrders({ - display_id: 1, - email: "user@example.com", + display_id: displayId, + email, }) return ( @@ -191,7 +203,11 @@ You can retrieve an order by the cart ID using the [Get by Cart ID API Route](ht ```tsx import { useCartOrder } from "medusa-react" - const Order = () => { + type Props = { + cartId: string + } + + const Order = ({ cartId }: Props) => { const { order, isLoading, diff --git a/www/apps/docs/content/modules/price-lists/admin/_import-prices.mdx b/www/apps/docs/content/modules/price-lists/admin/_import-prices.mdx index 6f025fb3e2a85..28583dfcc96df 100644 --- a/www/apps/docs/content/modules/price-lists/admin/_import-prices.mdx +++ b/www/apps/docs/content/modules/price-lists/admin/_import-prices.mdx @@ -350,7 +350,11 @@ You can retrieve all the details of the batch job, including its status and the ```tsx import { useAdminBatchJob } from "medusa-react" - const ImportPrices = () => { + type Props = { + batchJobId: string + } + + const ImportPrices = ({ batchJobId }: Props) => { const { batch_job, isLoading } = useAdminBatchJob(batchJobId) // ... @@ -440,7 +444,11 @@ To confirm a batch job send the following request: ```tsx import { useAdminConfirmBatchJob } from "medusa-react" - const ImportPrices = () => { + type Props = { + batchJobId: string + } + + const BatchJob = ({ batchJobId }: Props) => { const confirmBatchJob = useAdminConfirmBatchJob(batchJobId) // ... diff --git a/www/apps/docs/content/modules/price-lists/admin/manage-price-lists.mdx b/www/apps/docs/content/modules/price-lists/admin/manage-price-lists.mdx index 4fdbdcb81baa2..23816cece342a 100644 --- a/www/apps/docs/content/modules/price-lists/admin/manage-price-lists.mdx +++ b/www/apps/docs/content/modules/price-lists/admin/manage-price-lists.mdx @@ -114,36 +114,36 @@ For example, sending the following request creates a price list with two prices: ```tsx + import { useAdminCreatePriceList } from "medusa-react" import { PriceListStatus, PriceListType, } from "@medusajs/medusa" - import { useAdminCreatePriceList } from "medusa-react" + + type CreateData = { + name: string + description: string + type: PriceListType + status: PriceListStatus + prices: { + amount: number + variant_id: string + currency_code: string + max_quantity: number + }[] + } const CreatePriceList = () => { const createPriceList = useAdminCreatePriceList() // ... - const handleCreate = () => { - createPriceList.mutate({ - name: "New Price List", - description: "A new price list", - type: PriceListType.SALE, - status: PriceListStatus.ACTIVE, - prices: [ - { - amount: 1000, - variant_id, - currency_code: "eur", - max_quantity: 3, - }, - { - amount: 1500, - variant_id, - currency_code: "eur", - min_quantity: 4, - }, - ], + const handleCreate = ( + data: CreateData + ) => { + createPriceList.mutate(data, { + onSuccess: ({ price_list }) => { + console.log(price_list.id) + } }) } @@ -246,15 +246,20 @@ You can retrieve all of a price list’s details using the Get a Price List API ```tsx - import { CustomerGroup } from "@medusajs/medusa" import { useAdminPriceList } from "medusa-react" - const PriceList = () => { + type Props = { + priceListId: string + } + + const PriceList = ({ + priceListId + }: Props) => { const { price_list, isLoading, } = useAdminPriceList(priceListId) - + return (
    {isLoading && Loading...} @@ -262,7 +267,7 @@ You can retrieve all of a price list’s details using the Get a Price List API
    ) } - + export default PriceList ``` @@ -314,26 +319,34 @@ For example, by sending the following request the end date of the price list wil ```tsx - import { - PriceListStatus, - PriceListType, - } from "@medusajs/medusa" import { useAdminUpdatePriceList } from "medusa-react" - const CreatePriceList = () => { + type Props = { + priceListId: string + } + + const PriceList = ({ + priceListId + }: Props) => { const updatePriceList = useAdminUpdatePriceList(priceListId) // ... - const handleUpdate = () => { + const handleUpdate = ( + endsAt: Date + ) => { updatePriceList.mutate({ - ends_at: "2022-10-11", + ends_at: endsAt, + }, { + onSuccess: ({ price_list }) => { + console.log(price_list.ends_at) + } }) } // ... } - export default CreatePriceList + export default PriceList ``` @@ -411,25 +424,35 @@ For example, sending the following request adds a new price to the price list: ```tsx import { useAdminCreatePriceListPrices } from "medusa-react" - const PriceList = () => { - const addPrice = useAdminCreatePriceListPrices(priceListId) - // ... + type PriceData = { + amount: number + variant_id: string + currency_code: string + } - const handleAddPrice = () => { - addPrice.mutate({ - prices: [ - { - amount: 1200, - variant_id, - currency_code: "eur", - }, - ], + type Props = { + priceListId: string + } + + const PriceList = ({ + priceListId + }: Props) => { + const addPrices = useAdminCreatePriceListPrices(priceListId) + // ... + + const handleAddPrices = (prices: PriceData[]) => { + addPrices.mutate({ + prices + }, { + onSuccess: ({ price_list }) => { + console.log(price_list.prices) + } }) } - + // ... } - + export default PriceList ``` @@ -508,24 +531,36 @@ You can delete all the prices of a product’s variants using the [Delete Produc ```tsx import { - useAdminDeletePriceListProductPrices, + useAdminDeletePriceListProductPrices } from "medusa-react" - - const PriceList = () => { - const deletePrices = useAdminDeletePriceListProductPrices( + + type Props = { + priceListId: string + productId: string + } + + const PriceListProduct = ({ + priceListId, + productId + }: Props) => { + const deleteProductPrices = useAdminDeletePriceListProductPrices( priceListId, productId ) // ... - - const handleDeletePrices = () => { - deletePrices.mutate() + + const handleDeleteProductPrices = () => { + deleteProductPrices.mutate(void 0, { + onSuccess: ({ ids, deleted, object }) => { + console.log(ids) + } + }) } - + // ... } - - export default PriceList + + export default PriceListProduct ```     @@ -582,25 +617,36 @@ You can delete all the prices of a variant using the [Delete Variant Prices API ```tsx import { - useAdminDeletePriceListVariantPrices, + useAdminDeletePriceListVariantPrices } from "medusa-react" - const PriceList = () => { - const deleteVariantPrices = - useAdminDeletePriceListVariantPrices( - priceListId, - variantId - ) + type Props = { + priceListId: string + variantId: string + } + + const PriceListVariant = ({ + priceListId, + variantId + }: Props) => { + const deleteVariantPrices = useAdminDeletePriceListVariantPrices( + priceListId, + variantId + ) // ... - const handleDeletePrices = () => { - deleteVariantPrices.mutate() + const handleDeleteVariantPrices = () => { + deleteVariantPrices.mutate(void 0, { + onSuccess: ({ ids, deleted, object }) => { + console.log(ids) + } + }) } // ... } - export default PriceList + export default PriceListVariant ```     @@ -657,12 +703,22 @@ You can delete a price list, and subsequently all prices defined in it, using th ```tsx import { useAdminDeletePriceList } from "medusa-react" - const PriceList = () => { + type Props = { + priceListId: string + } + + const PriceList = ({ + priceListId + }: Props) => { const deletePriceList = useAdminDeletePriceList(priceListId) // ... - const handleDeletePriceList = () => { - deletePriceList.mutate() + const handleDelete = () => { + deletePriceList.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... diff --git a/www/apps/docs/content/modules/products/admin/import-products.mdx b/www/apps/docs/content/modules/products/admin/import-products.mdx index a7a3d3b74ad1f..6f805518fff08 100644 --- a/www/apps/docs/content/modules/products/admin/import-products.mdx +++ b/www/apps/docs/content/modules/products/admin/import-products.mdx @@ -889,7 +889,11 @@ You can do that by sending the following request to the [Upload Files API Route] // ... const handleFileUpload = (file: File) => { - uploadFile.mutate(file) + uploadFile.mutate(file, { + onSuccess: ({ uploads }) => { + console.log(uploads[0].key) + } + }) } // ... @@ -1067,7 +1071,11 @@ You can retrieve all the details of the batch job, including its status and the ```tsx import { useAdminBatchJob } from "medusa-react" - const ImportProducts = () => { + type Props = { + batchJobId: string + } + + const ImportProducts = ({ batchJobId }: Props) => { const { batch_job, isLoading } = useAdminBatchJob(batchJobId) // ... @@ -1157,7 +1165,11 @@ To confirm a batch job send the following request: ```tsx import { useAdminConfirmBatchJob } from "medusa-react" - const ImportProducts = () => { + type Props = { + batchJobId: string + } + + const BatchJob = ({ batchJobId }: Props) => { const confirmBatchJob = useAdminConfirmBatchJob(batchJobId) // ... diff --git a/www/apps/docs/content/modules/products/admin/manage-categories.mdx b/www/apps/docs/content/modules/products/admin/manage-categories.mdx index a9745b63d873d..d3bff179643f4 100644 --- a/www/apps/docs/content/modules/products/admin/manage-categories.mdx +++ b/www/apps/docs/content/modules/products/admin/manage-categories.mdx @@ -69,12 +69,12 @@ You can retrieve available categories by sending a request to the [List Categori ```tsx import { useAdminProductCategories } from "medusa-react" - import { ProductCategory } from "@medusajs/medusa" function Categories() { const { product_categories, - isLoading } = useAdminProductCategories() + isLoading + } = useAdminProductCategories() return (
    @@ -85,7 +85,7 @@ You can retrieve available categories by sending a request to the [List Categori {product_categories && product_categories.length > 0 && (
      {product_categories.map( - (category: ProductCategory) => ( + (category) => (
    • {category.name}
      • ) )} @@ -155,9 +155,15 @@ You can create a category by sending a request to the [Create a Category API Rou const createCategory = useAdminCreateProductCategory() // ... - const handleCreate = () => { + const handleCreate = ( + name: string + ) => { createCategory.mutate({ - name: "Skinny Jeans", + name, + }, { + onSuccess: ({ product_category }) => { + console.log(product_category.id) + } }) } @@ -233,7 +239,13 @@ You can retrieve a product category by sending a request to the [Get a Product C ```tsx import { useAdminProductCategory } from "medusa-react" - const Category = () => { + type Props = { + productCategoryId: string + } + + const Category = ({ + productCategoryId + }: Props) => { const { product_category, isLoading, @@ -305,22 +317,34 @@ You can edit a product category by sending a request to the [Update a Product Ca ```tsx import { useAdminUpdateProductCategory } from "medusa-react" - const UpdateCategory = () => { + type Props = { + productCategoryId: string + } + + const Category = ({ + productCategoryId + }: Props) => { const updateCategory = useAdminUpdateProductCategory( productCategoryId ) // ... - const handleUpdate = () => { + const handleUpdate = ( + name: string + ) => { updateCategory.mutate({ - name: "Skinny Jeans", + name, + }, { + onSuccess: ({ product_category }) => { + console.log(product_category.id) + } }) } // ... } - export default UpdateCategory + export default Category ``` @@ -407,29 +431,34 @@ You can add more than one product to a category using the [Add Products to a Cat ```tsx import { useAdminAddProductsToCategory } from "medusa-react" - const UpdateProductsInCategory = () => { - const addProductsToCategory = useAdminAddProductsToCategory( + type Props = { + productCategoryId: string + } + + const Category = ({ + productCategoryId + }: Props) => { + const addProducts = useAdminAddProductsToCategory( productCategoryId ) // ... - const handleAdd = () => { - addProductsToCategory.mutate({ - product_ids: [ - { - id: productId1, - }, - { - id: productId2, - }, - ], + const handleAddProducts = ( + productIds: ProductsData[] + ) => { + addProducts.mutate({ + product_ids: productIds + }, { + onSuccess: ({ product_category }) => { + console.log(product_category.products) + } }) } // ... } - export default UpdateProductsInCategory + export default Category ``` @@ -519,32 +548,40 @@ You can remove products from a category by sending a request to the [Delete Prod ```tsx - import { - useAdminDeleteProductsFromCategory, - } from "medusa-react" + import { useAdminDeleteProductsFromCategory } from "medusa-react" - const DeleteProductsFromCategory = () => { - const deleteProductsFromCategory = - useAdminDeleteProductsFromCategory(productCategoryId) + type ProductsData = { + id: string + } + + type Props = { + productCategoryId: string + } + + const Category = ({ + productCategoryId + }: Props) => { + const deleteProducts = useAdminDeleteProductsFromCategory( + productCategoryId + ) // ... - const handleDelete = () => { - deleteProductsFromCategory.mutate({ - product_ids: [ - { - id: productId1, - }, - { - id: productId2, - }, - ], + const handleDeleteProducts = ( + productIds: ProductsData[] + ) => { + deleteProducts.mutate({ + product_ids: productIds + }, { + onSuccess: ({ product_category }) => { + console.log(product_category.products) + } }) } // ... } - export default DeleteProductsFromCategory + export default Category ``` @@ -626,14 +663,24 @@ You can delete a product category by sending a request to the [Delete a Product ```tsx import { useAdminDeleteProductCategory } from "medusa-react" - const Category = () => { + type Props = { + productCategoryId: string + } + + const Category = ({ + productCategoryId + }: Props) => { const deleteCategory = useAdminDeleteProductCategory( productCategoryId ) // ... const handleDelete = () => { - deleteCategory.mutate() + deleteCategory.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... diff --git a/www/apps/docs/content/modules/products/admin/manage-products.mdx b/www/apps/docs/content/modules/products/admin/manage-products.mdx index ba0bdff372375..2381f5010ef16 100644 --- a/www/apps/docs/content/modules/products/admin/manage-products.mdx +++ b/www/apps/docs/content/modules/products/admin/manage-products.mdx @@ -238,6 +238,10 @@ You can create a product by sending a request to the [Create a Product API Route value: tagValue, }, ], + }, { + onSuccess: ({ product }) => { + console.log(product.id) + } }) } @@ -417,7 +421,11 @@ You can retrieve a single product as an admin by sending a request to the [Get a ```tsx import { useAdminProduct } from "medusa-react" - const Product = () => { + type Props = { + productId: string + } + + const Product = ({ productId }: Props) => { const { product, isLoading, @@ -487,22 +495,32 @@ You can update a product by sending a request to the [Update Product API Route]( ```tsx import { useAdminUpdateProduct } from "medusa-react" - const UpdateProduct = () => { + type Props = { + productId: string + } + + const Product = ({ productId }: Props) => { const updateProduct = useAdminUpdateProduct( productId ) // ... - const handleUpdate = () => { + const handleUpdate = ( + title: string + ) => { updateProduct.mutate({ - title: "Shirt", + title, + }, { + onSuccess: ({ product }) => { + console.log(product.id) + } }) } // ... } - export default UpdateProduct + export default Product ``` @@ -578,15 +596,27 @@ You can add a product option to a product by sending a request to the [Add Produ ```tsx import { useAdminCreateProductOption } from "medusa-react" - const CreateProductOption = () => { + type Props = { + productId: string + } + + const CreateProductOption = ({ + productId + }: Props) => { const createOption = useAdminCreateProductOption( productId ) // ... - const handleCreate = () => { + const handleCreate = ( + title: string + ) => { createOption.mutate({ - title: "Size", + title + }, { + onSuccess: ({ product }) => { + console.log(product.options) + } }) } @@ -657,23 +687,37 @@ You can update a product option by sending a request to the [Update Product Opti ```tsx import { useAdminUpdateProductOption } from "medusa-react" - const UpdateProductOption = () => { + type Props = { + productId: string + optionId: string + } + + const ProductOption = ({ + productId, + optionId + }: Props) => { const updateOption = useAdminUpdateProductOption( productId ) // ... - const handleUpdate = () => { + const handleUpdate = ( + title: string + ) => { updateOption.mutate({ - option_id, - title: "Size", + option_id: optionId, + title, + }, { + onSuccess: ({ product }) => { + console.log(product.options) + } }) } // ... } - export default UpdateProductOption + export default ProductOption ``` @@ -739,20 +783,32 @@ You can delete a product option by sending a request to the [Delete Product Opti ```tsx import { useAdminDeleteProductOption } from "medusa-react" - const DeleteProductOption = () => { + type Props = { + productId: string + optionId: string + } + + const ProductOption = ({ + productId, + optionId + }: Props) => { const deleteOption = useAdminDeleteProductOption( productId ) // ... const handleDelete = () => { - deleteOption.mutate(option_id) + deleteOption.mutate(optionId, { + onSuccess: ({ option_id, object, deleted, product }) => { + console.log(product.options) + } + }) } // ... } - export default DeleteProductOption + export default ProductOption ``` @@ -835,27 +891,35 @@ You can create a product variant by sending a request to the [Create Product Var ```tsx import { useAdminCreateVariant } from "medusa-react" - const CreateProductVariant = () => { + type CreateVariantData = { + title: string + prices: { + amount: number + currency_code: string + }[] + options: { + option_id: string + value: string + }[] + } + + type Props = { + productId: string + } + + const CreateProductVariant = ({ productId }: Props) => { const createVariant = useAdminCreateVariant( productId ) // ... - const handleCreate = () => { - createVariant.mutate({ - title: "White Shirt", - prices: [ - { - amount: 1000, - currency_code: "USD", - }, - ], - options: [ - { - option_id, - value: "White", - }, - ], + const handleCreate = ( + variantData: CreateVariantData + ) => { + createVariant.mutate(variantData, { + onSuccess: ({ product }) => { + console.log(product.variants) + } }) } @@ -958,23 +1022,35 @@ You can update a product variant by sending a request to the [Update a Product V ```tsx import { useAdminUpdateVariant } from "medusa-react" - const UpdateProductVariant = () => { + type Props = { + productId: string + variantId: string + } + + const ProductVariant = ({ + productId, + variantId + }: Props) => { const updateVariant = useAdminUpdateVariant( productId ) // ... - const handleUpdate = () => { + const handleUpdate = (title: string) => { updateVariant.mutate({ - variant_id, - title: "White Shirt", + variant_id: variantId, + title, + }, { + onSuccess: ({ product }) => { + console.log(product.variants) + } }) } // ... } - export default UpdateProductVariant + export default ProductVariant ``` @@ -1040,20 +1116,32 @@ You can delete a product variant by sending a request to the [Delete a Product V ```tsx import { useAdminDeleteVariant } from "medusa-react" - const DeleteProductVariant = () => { + type Props = { + productId: string + variantId: string + } + + const ProductVariant = ({ + productId, + variantId + }: Props) => { const deleteVariant = useAdminDeleteVariant( productId ) // ... const handleDelete = () => { - deleteVariant.mutate(variant_id) + deleteVariant.mutate(variantId, { + onSuccess: ({ variant_id, object, deleted, product }) => { + console.log(product.variants) + } + }) } // ... } - export default DeleteProductVariant + export default ProductVariant ``` @@ -1114,20 +1202,28 @@ You can delete a product by sending a request to the [Delete a Product API Route ```tsx import { useAdminDeleteProduct } from "medusa-react" - const DeleteProduct = () => { + type Props = { + productId: string + } + + const Product = ({ productId }: Props) => { const deleteProduct = useAdminDeleteProduct( productId ) // ... const handleDelete = () => { - deleteProduct.mutate() + deleteProduct.mutate(void 0, { + onSuccess: ({ id, object, deleted}) => { + console.log(id) + } + }) } // ... } - export default DeleteProduct + export default Product ``` diff --git a/www/apps/docs/content/modules/products/storefront/show-products.mdx b/www/apps/docs/content/modules/products/storefront/show-products.mdx index f3c05530a67a4..8f1d11ad92760 100644 --- a/www/apps/docs/content/modules/products/storefront/show-products.mdx +++ b/www/apps/docs/content/modules/products/storefront/show-products.mdx @@ -662,7 +662,11 @@ You can retrieve the details of a single product by its ID using the [Get a Prod ```tsx import { useProduct } from "medusa-react" - const Products = () => { + type Props = { + productId: string + } + + const Product = ({ productId }: Props) => { const { product, isLoading } = useProduct(productId) return ( @@ -673,7 +677,7 @@ You can retrieve the details of a single product by its ID using the [Get a Prod ) } - export default Products + export default Product ``` diff --git a/www/apps/docs/content/modules/products/storefront/use-categories.mdx b/www/apps/docs/content/modules/products/storefront/use-categories.mdx index e7d941258a380..6aef4117f4efc 100644 --- a/www/apps/docs/content/modules/products/storefront/use-categories.mdx +++ b/www/apps/docs/content/modules/products/storefront/use-categories.mdx @@ -71,7 +71,6 @@ You can list product categories by sending a request to the [List Product Catego ```tsx import { useProductCategories } from "medusa-react" - import { ProductCategory } from "@medusajs/medusa" function Categories() { const { @@ -88,7 +87,7 @@ You can list product categories by sending a request to the [List Product Catego {product_categories && product_categories.length > 0 && (
        {product_categories.map( - (category: ProductCategory) => ( + (category) => (
      • {category.name}
        • ) )} @@ -178,8 +177,14 @@ You can retrieve a single product category by its ID using the [Get a Product Ca ```tsx import { useProductCategory } from "medusa-react" - function Category() { - const { product_category, isLoading } = useProductCategory() + type Props = { + categoryId: string + } + + const Category = ({ categoryId }: Props) => { + const { product_category, isLoading } = useProductCategory( + categoryId + ) return (
        diff --git a/www/apps/docs/content/modules/regions-and-currencies/admin/manage-currencies.mdx b/www/apps/docs/content/modules/regions-and-currencies/admin/manage-currencies.mdx index 8ce5c4dac31c9..161b7982f6f11 100644 --- a/www/apps/docs/content/modules/regions-and-currencies/admin/manage-currencies.mdx +++ b/www/apps/docs/content/modules/regions-and-currencies/admin/manage-currencies.mdx @@ -154,20 +154,24 @@ You can update a currency by sending a request to the [Update Currency API Route ```tsx import { useAdminUpdateCurrency } from "medusa-react" - const UpdateCode = () => { - const updateCode = useAdminUpdateCurrency(code) + const Currency = (currencyCode: string) => { + const updateCurrency = useAdminUpdateCurrency(currencyCode) // ... - const handleUpdate = () => { - updateCode.mutate({ + const handleUpdate = (includes_tax: boolean) => { + updateCurrency.mutate({ includes_tax, + }, { + onSuccess: ({ currency }) => { + console.log(currency) + } }) } // ... } - export default UpdateCode + export default Currency ``` @@ -321,18 +325,22 @@ You can add a currency to a store using the [Add a Currency Code API Route](http ```tsx import { useAdminAddStoreCurrency } from "medusa-react" - const AddCurrency = () => { - const addCode = useAdminAddStoreCurrency() + const Store = () => { + const addCurrency = useAdminAddStoreCurrency() // ... - const handleAdd = () => { - addCode.mutate(code) + const handleAdd = (code: string) => { + addCurrency.mutate(code, { + onSuccess: ({ store }) => { + console.log(store.currencies) + } + }) } // ... } - export default AddCurrency + export default Store ``` @@ -384,18 +392,22 @@ You can remove a currency from a store by sending a request to the [Delete Curre ```tsx import { useAdminDeleteStoreCurrency } from "medusa-react" - const DeleteCurrency = () => { + const Store = () => { const deleteCurrency = useAdminDeleteStoreCurrency() // ... - const handleDelete = () => { - deleteCurrency.mutate(code) + const handleAdd = (code: string) => { + deleteCurrency.mutate(code, { + onSuccess: ({ store }) => { + console.log(store.currencies) + } + }) } // ... } - export default DeleteCurrency + export default Store ``` diff --git a/www/apps/docs/content/modules/regions-and-currencies/admin/manage-regions.mdx b/www/apps/docs/content/modules/regions-and-currencies/admin/manage-regions.mdx index e8295eee4ae07..1e171a6a6f804 100644 --- a/www/apps/docs/content/modules/regions-and-currencies/admin/manage-regions.mdx +++ b/www/apps/docs/content/modules/regions-and-currencies/admin/manage-regions.mdx @@ -77,7 +77,6 @@ You can retrieve regions available on your backend using the [List Regions API R ```tsx - import { Region } from "@medusajs/medusa" import { useAdminRegions } from "medusa-react" const Regions = () => { @@ -89,7 +88,7 @@ You can retrieve regions available on your backend using the [List Regions API R {regions && !regions.length && No Regions} {regions && regions.length > 0 && (
          - {regions.map((region: Region) => ( + {regions.map((region) => (
        • {region.name}
          • ))}
        @@ -183,6 +182,10 @@ You can create a region by sending a request to the [Create a Region API Route]( countries: [ "DK", ], + }, { + onSuccess: ({ region }) => { + console.log(region.id) + } }) } @@ -291,23 +294,32 @@ Alternatively, you can update the details of a region using the [Update a Region ```tsx import { useAdminUpdateRegion } from "medusa-react" - const UpdateRegion = () => { + type Props = { + regionId: string + } + + const Region = ({ + regionId + }: Props) => { const updateRegion = useAdminUpdateRegion(regionId) // ... - const handleUpdate = () => { + const handleUpdate = ( + countries: string[] + ) => { updateRegion.mutate({ - countries: [ - "DK", - "DE", - ], + countries, + }, { + onSuccess: ({ region }) => { + console.log(region.id) + } }) } // ... } - export default UpdateRegion + export default Region ```         @@ -393,7 +405,11 @@ You can add a shipping option to a region by sending a request to the [Create Sh ```tsx import { useAdminCreateShippingOption } from "medusa-react" - const Region = () => { + type Props = { + regionId: string + } + + const Region = ({ regionId }: Props) => { const createShippingOption = useAdminCreateShippingOption() // ... @@ -406,6 +422,10 @@ You can add a shipping option to a region by sending a request to the [Create Sh }, price_type: "flat_rate", amount: 1000, + }, { + onSuccess: ({ shipping_option }) => { + console.log(shipping_option.id) + } }) } @@ -504,12 +524,20 @@ You can delete a region by sending a request to the [Delete a Region API Route]( ```tsx import { useAdminDeleteRegion } from "medusa-react" - const Region = () => { + type Props = { + regionId: string + } + + const Region = ({ regionId }: Props) => { const deleteRegion = useAdminDeleteRegion(regionId) // ... const handleDelete = () => { - deleteRegion.mutate() + deleteRegion.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... diff --git a/www/apps/docs/content/modules/regions-and-currencies/storefront/use-regions.mdx b/www/apps/docs/content/modules/regions-and-currencies/storefront/use-regions.mdx index 423a38c4a15b5..5ee8c1f8a0524 100644 --- a/www/apps/docs/content/modules/regions-and-currencies/storefront/use-regions.mdx +++ b/www/apps/docs/content/modules/regions-and-currencies/storefront/use-regions.mdx @@ -69,7 +69,6 @@ You can retrieve available regions by sending a request to the [List Regions API ```tsx - import { Region } from "@medusajs/medusa" import { useRegions } from "medusa-react" const Regions = () => { @@ -80,7 +79,7 @@ You can retrieve available regions by sending a request to the [List Regions API {isLoading && Loading...} {regions?.length && (
          - {regions.map((region: Region) => ( + {regions.map((region) => (
        • {region.name}
          • diff --git a/www/apps/docs/content/modules/sales-channels/admin/manage.mdx b/www/apps/docs/content/modules/sales-channels/admin/manage.mdx index 215a305bf7c93..c601c2bbfbf19 100644 --- a/www/apps/docs/content/modules/sales-channels/admin/manage.mdx +++ b/www/apps/docs/content/modules/sales-channels/admin/manage.mdx @@ -81,6 +81,10 @@ You can create a sales channel by sending a request to the Create a Sales Channe createSalesChannel.mutate({ name, description, + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.id) + } }) } @@ -151,7 +155,6 @@ You can list all sales channels by sending a request to the List Sales Channels ```tsx - import { SalesChannel } from "@medusajs/medusa" import { useAdminSalesChannels } from "medusa-react" const SalesChannels = () => { @@ -165,7 +168,7 @@ You can list all sales channels by sending a request to the List Sales Channels )} {sales_channels && sales_channels.length > 0 && (
            - {sales_channels.map((salesChannel: SalesChannel) => ( + {sales_channels.map((salesChannel) => (
          • {salesChannel.name}
            • ))}
          @@ -224,8 +227,12 @@ You can retrieve a sales channel’s details by its ID using the Get Sales Chann ```tsx import { useAdminSalesChannel } from "medusa-react" - - const SalesChannel = () => { + + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { const { sales_channel, isLoading, @@ -292,22 +299,32 @@ You can update a Sales Channel’s details and attributes by sending a request t ```tsx import { useAdminUpdateSalesChannel } from "medusa-react" - const UpdateSalesChannel = () => { + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { const updateSalesChannel = useAdminUpdateSalesChannel( salesChannelId ) // ... - const handleUpdate = () => { + const handleUpdate = ( + is_disabled: boolean + ) => { updateSalesChannel.mutate({ - is_disabled: false, + is_disabled, + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.is_disabled) + } }) } // ... } - export default UpdateSalesChannel + export default SalesChannel ```           @@ -373,14 +390,22 @@ You can delete a sales channel by sending a request to the Delete Sales Channel ```tsx import { useAdminDeleteSalesChannel } from "medusa-react" - const SalesChannel = () => { + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { const deleteSalesChannel = useAdminDeleteSalesChannel( salesChannelId ) // ... const handleDelete = () => { - deleteSalesChannel.mutate() + deleteSalesChannel.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... @@ -446,7 +471,11 @@ To add a product to a sales channel, send a request to the Sales Channel’s Add ```tsx import { useAdminAddProductsToSalesChannel } from "medusa-react" - const SalesChannel = () => { + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { const addProducts = useAdminAddProductsToSalesChannel( salesChannelId ) @@ -459,6 +488,10 @@ To add a product to a sales channel, send a request to the Sales Channel’s Add id: productId, }, ], + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.id) + } }) } @@ -642,7 +675,11 @@ You can delete a product from a sales channel by sending a request to the Sales useAdminDeleteProductsFromSalesChannel, } from "medusa-react" - const SalesChannel = () => { + type Props = { + salesChannelId: string + } + + const SalesChannel = ({ salesChannelId }: Props) => { const deleteProducts = useAdminDeleteProductsFromSalesChannel( salesChannelId ) @@ -655,6 +692,10 @@ You can delete a product from a sales channel by sending a request to the Sales id: productId, }, ], + }, { + onSuccess: ({ sales_channel }) => { + console.log(sales_channel.id) + } }) } diff --git a/www/apps/docs/content/modules/taxes/admin/manage-tax-rates.mdx b/www/apps/docs/content/modules/taxes/admin/manage-tax-rates.mdx index 3099f3b99486b..cfb606b61fb8a 100644 --- a/www/apps/docs/content/modules/taxes/admin/manage-tax-rates.mdx +++ b/www/apps/docs/content/modules/taxes/admin/manage-tax-rates.mdx @@ -291,16 +291,28 @@ You can create a tax rate by sending a request to the [Create Tax Rate API Route ```tsx import { useAdminCreateTaxRate } from "medusa-react" - const CreateTaxRate = () => { + type Props = { + regionId: string + } + + const CreateTaxRate = ({ regionId }: Props) => { const createTaxRate = useAdminCreateTaxRate() // ... - const handleCreate = () => { + const handleCreate = ( + code: string, + name: string, + rate: number + ) => { createTaxRate.mutate({ - code: "TEST", - name: "New Tax Rate", - region_id, - rate: 10, + code, + name, + region_id: regionId, + rate, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.id) + } }) } @@ -391,20 +403,30 @@ You can update a tax rate by sending a request to the [Update Tax Rate API Route ```tsx import { useAdminUpdateTaxRate } from "medusa-react" - const UpdateTaxRate = () => { + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { const updateTaxRate = useAdminUpdateTaxRate(taxRateId) // ... - const handleUpdate = () => { + const handleUpdate = ( + name: string + ) => { updateTaxRate.mutate({ - name: "New Tax Rate", + name + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.name) + } }) } // ... } - export default UpdateTaxRate + export default TaxRate ``` @@ -478,22 +500,28 @@ You can add a product to a tax rate by sending a request to the [Add Products AP ```tsx import { useAdminCreateProductTaxRates } from "medusa-react" - const AddProduct = () => { + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { const addProduct = useAdminCreateProductTaxRates(taxRateId) // ... - const handleAdd = () => { + const handleAddProduct = (productIds: string[]) => { addProduct.mutate({ - products: [ - productId1, - ], + products: productIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.products) + } }) } // ... } - export default AddProduct + export default TaxRate ``` @@ -567,22 +595,26 @@ You can remove a product from a tax rate by sending a request to the [Delete Pro ```tsx import { useAdminDeleteProductTaxRates } from "medusa-react" - const RemoveProduct = () => { + const TaxRate = ( + taxRateId: string + ) => { const removeProduct = useAdminDeleteProductTaxRates(taxRateId) // ... - const handleRemove = () => { + const handleRemoveProduct = (productIds: string[]) => { removeProduct.mutate({ - products: [ - productId1, - ], + products: productIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.products) + } }) } // ... } - export default RemoveProduct + export default TaxRate ``` @@ -664,24 +696,30 @@ You can add a product type to a tax rate by sending a request to the [Add Produc useAdminCreateProductTypeTaxRates, } from "medusa-react" - const AddProductTypes = () => { + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { const addProductTypes = useAdminCreateProductTypeTaxRates( taxRateId ) // ... - const handleAdd = () => { + const handleAddProductTypes = (productTypeIds: string[]) => { addProductTypes.mutate({ - product_types: [ - productTypeId, - ], + product_types: productTypeIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.product_types) + } }) } // ... } - export default AddProductTypes + export default TaxRate ``` @@ -757,24 +795,32 @@ You can remove a product type from a tax rate by sending a request to the [Delet useAdminDeleteProductTypeTaxRates, } from "medusa-react" - const RemoveProductTypes = () => { + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { const removeProductTypes = useAdminDeleteProductTypeTaxRates( taxRateId ) // ... - const handleRemove = () => { + const handleRemoveProductTypes = ( + productTypeIds: string[] + ) => { removeProductTypes.mutate({ - product_types: [ - productTypeId, - ], + product_types: productTypeIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.product_types) + } }) } // ... } - export default RemoveProductTypes + export default TaxRate ``` @@ -854,24 +900,32 @@ You can add a shipping option to a tax rate by sending a request to the [Add Shi ```tsx import { useAdminCreateShippingTaxRates } from "medusa-react" - const AddShippingOptions = () => { + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { const addShippingOption = useAdminCreateShippingTaxRates( taxRateId ) // ... - const handleAdd = () => { + const handleAddShippingOptions = ( + shippingOptionIds: string[] + ) => { addShippingOption.mutate({ - shipping_options: [ - shippingOptionId, - ], + shipping_options: shippingOptionIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.shipping_options) + } }) } // ... } - export default AddShippingOptions + export default TaxRate ``` @@ -945,24 +999,30 @@ You can remove a shipping option from a tax rate by sending a request to the [De ```tsx import { useAdminDeleteShippingTaxRates } from "medusa-react" - const RemoveShippingOptions = () => { + const TaxRate = ( + taxRateId: string + ) => { const removeShippingOptions = useAdminDeleteShippingTaxRates( taxRateId ) // ... - const handleRemove = () => { + const handleRemoveShippingOptions = ( + shippingOptionIds: string[] + ) => { removeShippingOptions.mutate({ - shipping_options: [ - shippingOptionId, - ], + shipping_options: shippingOptionIds, + }, { + onSuccess: ({ tax_rate }) => { + console.log(tax_rate.shipping_options) + } }) } // ... } - export default RemoveShippingOptions + export default TaxRate ``` @@ -1034,18 +1094,26 @@ You can delete a tax rate by sending a request to the [Delete Tax Rate API Route ```tsx import { useAdminDeleteTaxRate } from "medusa-react" - const DeleteTaxRate = () => { + type Props = { + taxRateId: string + } + + const TaxRate = ({ taxRateId }: Props) => { const deleteTaxRate = useAdminDeleteTaxRate(taxRateId) // ... const handleDelete = () => { - deleteTaxRate.mutate() + deleteTaxRate.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... } - export default DeleteTaxRate + export default TaxRate ``` diff --git a/www/apps/docs/content/modules/taxes/admin/manage-tax-settings.mdx b/www/apps/docs/content/modules/taxes/admin/manage-tax-settings.mdx index 37855134d75d4..bfedf0ee0cd11 100644 --- a/www/apps/docs/content/modules/taxes/admin/manage-tax-settings.mdx +++ b/www/apps/docs/content/modules/taxes/admin/manage-tax-settings.mdx @@ -148,20 +148,24 @@ You can change the tax provider of a region using the [Update Region API Route]( ```tsx import { useAdminUpdateRegion } from "medusa-react" - const UpdateRegion = () => { + type Props = { + regionId: string + } + + const Region = ({ regionId }: Props) => { const updateRegion = useAdminUpdateRegion(regionId) // ... - const handleUpdate = () => { + const handleUpdate = (taxProviderId: string) => { updateRegion.mutate({ - tax_provider_id, + tax_provider_id: taxProviderId, }) } // ... } - export default UpdateRegion + export default Region ``` @@ -233,24 +237,30 @@ In addition to changing the tax provider, you can use the same [Update Region AP ```tsx import { useAdminUpdateRegion } from "medusa-react" - const UpdateRegion = () => { + type RegionData = { + tax_provider_id: string + automatic_taxes?: boolean + gift_cards_taxable?: boolean + tax_code: string + tax_rate: number + } + + type Props = { + regionId: string + } + + const Region = ({ regionId }: Props) => { const updateRegion = useAdminUpdateRegion(regionId) // ... - const handleUpdate = () => { - updateRegion.mutate({ - tax_provider_id, - automatic_taxes, - gift_cards_taxable, - tax_code, - tax_rate, - }) + const handleUpdate = (data: RegionData) => { + updateRegion.mutate(data) } // ... } - export default UpdateRegion + export default Region ``` diff --git a/www/apps/docs/content/modules/users/admin/manage-invites.mdx b/www/apps/docs/content/modules/users/admin/manage-invites.mdx index a79a2259fea0c..e78be2bbef41a 100644 --- a/www/apps/docs/content/modules/users/admin/manage-invites.mdx +++ b/www/apps/docs/content/modules/users/admin/manage-invites.mdx @@ -78,7 +78,9 @@ You can list invites by sending a request to the [List Invite API Route](https:/ return (
          {isLoading && Loading...} - {invites && !invites.length && No Invites} + {invites && !invites.length && ( + No Invites + )} {invites && invites.length > 0 && (
            {invites.map((invite) => ( @@ -242,13 +244,18 @@ You can accept an invite by sending a request to the [Accept Invite API Route](h const acceptInvite = useAdminAcceptInvite() // ... - const handleAccept = () => { + const handleAccept = ( + token: string, + firstName: string, + lastName: string, + password: string + ) => { acceptInvite.mutate({ token, user: { - first_name: "Brigitte", - last_name: "Collier", - password: "supersecret", + first_name: firstName, + last_name: lastName, + password, }, }) } @@ -335,7 +342,11 @@ You can resend an invite if it’s not accepted yet. To resend an invite, send a ```tsx import { useAdminResendInvite } from "medusa-react" - const ResendInvite = () => { + type Props = { + inviteId: string + } + + const ResendInvite = ({ inviteId }: Props) => { const resendInvite = useAdminResendInvite(inviteId) // ... @@ -400,18 +411,26 @@ You can delete an invite by sending a request to the [Delete Invite API Route](h ```tsx import { useAdminDeleteInvite } from "medusa-react" - const DeleteInvite = () => { + type Props = { + inviteId: string + } + + const DeleteInvite = ({ inviteId }: Props) => { const deleteInvite = useAdminDeleteInvite(inviteId) // ... const handleDelete = () => { - deleteInvite.mutate() + deleteInvite.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... } - export default DeleteInvite + export default Invite ``` diff --git a/www/apps/docs/content/modules/users/admin/manage-profile.mdx b/www/apps/docs/content/modules/users/admin/manage-profile.mdx index 96a8389c89c3d..a2b14f987e2d1 100644 --- a/www/apps/docs/content/modules/users/admin/manage-profile.mdx +++ b/www/apps/docs/content/modules/users/admin/manage-profile.mdx @@ -283,17 +283,24 @@ You can update a user’s details in their profile by sending a request to the [ ```tsx import { - useAdminDeleteSession, useAdminUpdateUser, } from "medusa-react" - const Profile = () => { + type Props = { + userId: string + } + + const Profile = ({ userId }: Props) => { const updateUser = useAdminUpdateUser(userId) // ... - const handleUpdate = () => { + const handleUpdate = (firstName: string) => { updateUser.mutate({ - first_name: "Marcellus", + first_name: firstName, + }, { + onSuccess: ({ user }) => { + console.log(user.first_name) + } }) } @@ -384,9 +391,15 @@ You can request a password reset by sending a request to the [Request Password R const requestPasswordReset = useAdminSendResetPasswordToken() // ... - const handleResetPassword = () => { + const handleResetPassword = ( + email: string + ) => { requestPasswordReset.mutate({ - email: "user@example.com", + email + }, { + onSuccess: () => { + // successful + } }) } @@ -463,10 +476,17 @@ You can reset the password by sending a request to the [Reset Password API Route const resetPassword = useAdminResetPassword() // ... - const handleResetPassword = () => { + const handleResetPassword = ( + token: string, + password: string + ) => { resetPassword.mutate({ - token: "supersecrettoken", - password: "supersecret", + token, + password, + }, { + onSuccess: ({ user }) => { + console.log(user.id) + } }) } diff --git a/www/apps/docs/content/modules/users/admin/manage-users.mdx b/www/apps/docs/content/modules/users/admin/manage-users.mdx index 0fe90037fd4b3..4e0d60690a92d 100644 --- a/www/apps/docs/content/modules/users/admin/manage-users.mdx +++ b/www/apps/docs/content/modules/users/admin/manage-users.mdx @@ -153,6 +153,10 @@ You can create a user by sending a request to the [Create User API Route](https: createUser.mutate({ email: "user@example.com", password: "supersecret", + }, { + onSuccess: ({ user }) => { + console.log(user.id) + } }) } @@ -232,20 +236,30 @@ You can update a user’s details by sending a request to the [Update User API R ```tsx import { useAdminUpdateUser } from "medusa-react" - const UpdateUser = () => { + type Props = { + userId: string + } + + const User = ({ userId }: Props) => { const updateUser = useAdminUpdateUser(userId) // ... - const handleUpdateUser = () => { + const handleUpdateUser = ( + firstName: string + ) => { updateUser.mutate({ - first_name: "Marcellus", + first_name: firstName, + }, { + onSuccess: ({ user }) => { + console.log(user.first_name) + } }) } // ... } - export default UpdateUser + export default User ``` @@ -311,18 +325,26 @@ You can delete a user by sending a request to the [Delete User API Route](https: ```tsx import { useAdminDeleteUser } from "medusa-react" - const DeleteUser = () => { + type Props = { + userId: string + } + + const User = ({ userId }: Props) => { const deleteUser = useAdminDeleteUser(userId) // ... const handleDeleteUser = () => { - deleteUser.mutate() + deleteUser.mutate(void 0, { + onSuccess: ({ id, object, deleted }) => { + console.log(id) + } + }) } // ... } - export default DeleteUser + export default User ``` diff --git a/www/apps/docs/content/references/CacheTypes/interfaces/types.CacheTypes.ICacheService.mdx b/www/apps/docs/content/references/CacheTypes/interfaces/types.CacheTypes.ICacheService.mdx deleted file mode 100644 index e8ccca73764e8..0000000000000 --- a/www/apps/docs/content/references/CacheTypes/interfaces/types.CacheTypes.ICacheService.mdx +++ /dev/null @@ -1,141 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ICacheService - -## Methods - -### get - -#### Type Parameters - - - -#### Parameters - - - -#### Returns - - - -___ - -### invalidate - -#### Parameters - - - -#### Returns - - - -___ - -### set - -#### Parameters - - - -#### Returns - - diff --git a/www/apps/docs/content/references/CartWorkflow/interfaces/types.WorkflowTypes.CartWorkflow.CreateCartWorkflowInputDTO.mdx b/www/apps/docs/content/references/CartWorkflow/interfaces/types.WorkflowTypes.CartWorkflow.CreateCartWorkflowInputDTO.mdx deleted file mode 100644 index 416c37d52f71b..0000000000000 --- a/www/apps/docs/content/references/CartWorkflow/interfaces/types.WorkflowTypes.CartWorkflow.CreateCartWorkflowInputDTO.mdx +++ /dev/null @@ -1,362 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# CreateCartWorkflowInputDTO - -## Properties - -` \\| `null`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "phone", - "type": "`string` \\| `null`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "postal_code", - "type": "`string` \\| `null`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "province", - "type": "`string` \\| `null`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updated_at", - "type": "`string` \\| `Date`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "billing_address_id", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "context", - "type": "`object`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "country_code", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "customer_id", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "email", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "items", - "type": "[CreateLineItemInputDTO](types.WorkflowTypes.CartWorkflow.CreateLineItemInputDTO.mdx)[]", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "quantity", - "type": "`number`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "variant_id", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "region_id", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "sales_channel_id", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "shipping_address", - "type": "[AddressDTO](../../types/types/types.AddressDTO.mdx)", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "address_1", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "address_2", - "type": "`string` \\| `null`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "city", - "type": "`string` \\| `null`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "company", - "type": "`string` \\| `null`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "country_code", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "created_at", - "type": "`string` \\| `Date`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleted_at", - "type": "`string` \\| `Date` \\| `null`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record` \\| `null`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "phone", - "type": "`string` \\| `null`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "postal_code", - "type": "`string` \\| `null`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "province", - "type": "`string` \\| `null`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updated_at", - "type": "`string` \\| `Date`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "shipping_address_id", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/CartWorkflow/interfaces/types.WorkflowTypes.CartWorkflow.CreateLineItemInputDTO.mdx b/www/apps/docs/content/references/CartWorkflow/interfaces/types.WorkflowTypes.CartWorkflow.CreateLineItemInputDTO.mdx deleted file mode 100644 index 14dc37ce7d016..0000000000000 --- a/www/apps/docs/content/references/CartWorkflow/interfaces/types.WorkflowTypes.CartWorkflow.CreateLineItemInputDTO.mdx +++ /dev/null @@ -1,26 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# CreateLineItemInputDTO - -## Properties - - diff --git a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.AddressCreatePayload.mdx b/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.AddressCreatePayload.mdx deleted file mode 100644 index f118903f9ae42..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.AddressCreatePayload.mdx +++ /dev/null @@ -1,107 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# AddressCreatePayload - -## Properties - - diff --git a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.AddressPayload.mdx b/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.AddressPayload.mdx deleted file mode 100644 index c92b38d50756d..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.AddressPayload.mdx +++ /dev/null @@ -1,107 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# AddressPayload - -## Properties - -`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "phone", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "postal_code", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "province", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.BaseEntity.mdx b/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.BaseEntity.mdx deleted file mode 100644 index e882f33dcf94e..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.BaseEntity.mdx +++ /dev/null @@ -1,35 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# BaseEntity - -## Properties - - diff --git a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.CustomFindOptions.mdx b/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.CustomFindOptions.mdx deleted file mode 100644 index ad966792dddd2..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.CustomFindOptions.mdx +++ /dev/null @@ -1,76 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# CustomFindOptions - -## Type parameters - - - -## Properties - - diff --git a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.DateComparisonOperator.mdx b/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.DateComparisonOperator.mdx deleted file mode 100644 index 1f087903372b5..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.DateComparisonOperator.mdx +++ /dev/null @@ -1,44 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# DateComparisonOperator - -## Properties - - diff --git a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.FindConfig.mdx b/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.FindConfig.mdx deleted file mode 100644 index c0af6353bd065..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.FindConfig.mdx +++ /dev/null @@ -1,79 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# FindConfig - -An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class, -which provides correct typing of field names in its properties. - -## Type parameters - - - -## Properties - - diff --git a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.FindPaginationParams.mdx b/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.FindPaginationParams.mdx deleted file mode 100644 index 4b3a17950f7a8..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.FindPaginationParams.mdx +++ /dev/null @@ -1,26 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# FindPaginationParams - -## Properties - - diff --git a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.FindParams.mdx b/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.FindParams.mdx deleted file mode 100644 index 3b6bcf1967794..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.FindParams.mdx +++ /dev/null @@ -1,26 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# FindParams - -## Properties - - diff --git a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.NumericalComparisonOperator.mdx b/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.NumericalComparisonOperator.mdx deleted file mode 100644 index ee5a781792283..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.NumericalComparisonOperator.mdx +++ /dev/null @@ -1,44 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# NumericalComparisonOperator - -## Properties - - diff --git a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.SoftDeletableEntity.mdx b/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.SoftDeletableEntity.mdx deleted file mode 100644 index 9c5a112748dd5..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.SoftDeletableEntity.mdx +++ /dev/null @@ -1,44 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# SoftDeletableEntity - -## Properties - - diff --git a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.StringComparisonOperator.mdx b/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.StringComparisonOperator.mdx deleted file mode 100644 index 6f6591604a41a..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/interfaces/types.CommonTypes.StringComparisonOperator.mdx +++ /dev/null @@ -1,71 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# StringComparisonOperator - -## Properties - - diff --git a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.ConfigModule.mdx b/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.ConfigModule.mdx deleted file mode 100644 index 6219008b62a0a..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.ConfigModule.mdx +++ /dev/null @@ -1,284 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ConfigModule - - **ConfigModule**: `Object` - -## Type declaration - -`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "modules", - "type": "`Record`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "plugins", - "type": "(`object` \\| `string`)[]", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "projectConfig", - "type": "[ProjectConfigOptions](types.CommonTypes.ProjectConfigOptions.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "admin_cors", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "cookie_secret", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database_database", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database_extra", - "type": "`Record` & `object`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "ssl", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "database_logging", - "type": "`LoggerOptions`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database_schema", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database_type", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database_url", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "http_compression", - "type": "[HttpCompressionOptions](types.CommonTypes.HttpCompressionOptions.mdx)", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enabled", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "level", - "type": "`number`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "memLevel", - "type": "`number`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "threshold", - "type": "`number` \\| `string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "jwt_secret", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "redis_options", - "type": "`RedisOptions`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "redis_prefix", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "redis_url", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "session_options", - "type": "[SessionOptions](../../types/types/types.SessionOptions.mdx)", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "name", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "resave", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "rolling", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "saveUninitialized", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "secret", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "ttl", - "type": "`number`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "store_cors", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.DeleteResponse.mdx b/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.DeleteResponse.mdx deleted file mode 100644 index 7e15137ecf374..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.DeleteResponse.mdx +++ /dev/null @@ -1,39 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# DeleteResponse - - **DeleteResponse**: `Object` - -The fields returned in the response of a DELETE request. - -## Type declaration - - diff --git a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.HttpCompressionOptions.mdx b/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.HttpCompressionOptions.mdx deleted file mode 100644 index f5fbdb4c6ee2a..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.HttpCompressionOptions.mdx +++ /dev/null @@ -1,46 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# HttpCompressionOptions - - **HttpCompressionOptions**: `Object` - -## Type declaration - - diff --git a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.PaginatedResponse.mdx b/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.PaginatedResponse.mdx deleted file mode 100644 index 4b8db9c25054f..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.PaginatedResponse.mdx +++ /dev/null @@ -1,37 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# PaginatedResponse - - **PaginatedResponse**: `Object` - -## Type declaration - - diff --git a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.PartialPick.mdx b/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.PartialPick.mdx deleted file mode 100644 index 73d01962fb045..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.PartialPick.mdx +++ /dev/null @@ -1,28 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# PartialPick - - **PartialPick**: { [P in K]?: T[P] } - -## Type Parameters - - diff --git a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.ProjectConfigOptions.mdx b/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.ProjectConfigOptions.mdx deleted file mode 100644 index 08734655e5b47..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.ProjectConfigOptions.mdx +++ /dev/null @@ -1,257 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ProjectConfigOptions - - **ProjectConfigOptions**: `Object` - -## Type declaration - -` & `object`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "ssl", - "type": "`object`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "rejectUnauthorized", - "type": "`false`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } - ] - }, - { - "name": "database_logging", - "type": "`LoggerOptions`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database_schema", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database_type", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database_url", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "http_compression", - "type": "[HttpCompressionOptions](types.CommonTypes.HttpCompressionOptions.mdx)", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enabled", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "level", - "type": "`number`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "memLevel", - "type": "`number`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "threshold", - "type": "`number` \\| `string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "jwt_secret", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "redis_options", - "type": "`RedisOptions`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "redis_prefix", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "redis_url", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "session_options", - "type": "[SessionOptions](../../types/types/types.SessionOptions.mdx)", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "name", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "resave", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "rolling", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "saveUninitialized", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "secret", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "ttl", - "type": "`number`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "store_cors", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.QueryConfig.mdx b/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.QueryConfig.mdx deleted file mode 100644 index 3efe95772cf67..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.QueryConfig.mdx +++ /dev/null @@ -1,106 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# QueryConfig - - **QueryConfig**: `Object` - -## Type Parameters - - - -## Type declaration - - diff --git a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.QuerySelector.mdx b/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.QuerySelector.mdx deleted file mode 100644 index 2a44d5370a085..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.QuerySelector.mdx +++ /dev/null @@ -1,19 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# QuerySelector - - **QuerySelector**: [Selector](types.CommonTypes.Selector.mdx)<TEntity> & `object` - -## Type Parameters - - diff --git a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.RequestQueryFields.mdx b/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.RequestQueryFields.mdx deleted file mode 100644 index 280672f5931a9..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.RequestQueryFields.mdx +++ /dev/null @@ -1,55 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# RequestQueryFields - - **RequestQueryFields**: `Object` - -## Type declaration - - diff --git a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.WithRequiredProperty.mdx b/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.WithRequiredProperty.mdx deleted file mode 100644 index 643d76203ca08..0000000000000 --- a/www/apps/docs/content/references/CommonTypes/types/types.CommonTypes.WithRequiredProperty.mdx +++ /dev/null @@ -1,30 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# WithRequiredProperty - - **WithRequiredProperty**: `T` & { [Property in K]-?: T[Property] } - -Utility type used to remove some optional attributes (coming from K) from a type T - -## Type Parameters - - diff --git a/www/apps/docs/content/references/CommonWorkflow/interfaces/types.WorkflowTypes.CommonWorkflow.WorkflowInputConfig.mdx b/www/apps/docs/content/references/CommonWorkflow/interfaces/types.WorkflowTypes.CommonWorkflow.WorkflowInputConfig.mdx deleted file mode 100644 index 6b1fe09287edf..0000000000000 --- a/www/apps/docs/content/references/CommonWorkflow/interfaces/types.WorkflowTypes.CommonWorkflow.WorkflowInputConfig.mdx +++ /dev/null @@ -1,100 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# WorkflowInputConfig - -## Properties - - diff --git a/www/apps/docs/content/references/DAL/interfaces/types.DAL.BaseFilterable.mdx b/www/apps/docs/content/references/DAL/interfaces/types.DAL.BaseFilterable.mdx deleted file mode 100644 index efec246fe4a03..0000000000000 --- a/www/apps/docs/content/references/DAL/interfaces/types.DAL.BaseFilterable.mdx +++ /dev/null @@ -1,42 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# BaseFilterable - -An object used to allow specifying flexible queries with and/or conditions. - -## Type parameters - - - -## Properties - - diff --git a/www/apps/docs/content/references/DAL/interfaces/types.DAL.OptionsQuery.mdx b/www/apps/docs/content/references/DAL/interfaces/types.DAL.OptionsQuery.mdx deleted file mode 100644 index 6473f07e7a64f..0000000000000 --- a/www/apps/docs/content/references/DAL/interfaces/types.DAL.OptionsQuery.mdx +++ /dev/null @@ -1,94 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# OptionsQuery - -## Type parameters - - - -## Properties - - diff --git a/www/apps/docs/content/references/DAL/interfaces/types.DAL.RepositoryService.mdx b/www/apps/docs/content/references/DAL/interfaces/types.DAL.RepositoryService.mdx deleted file mode 100644 index 76f61dcad9480..0000000000000 --- a/www/apps/docs/content/references/DAL/interfaces/types.DAL.RepositoryService.mdx +++ /dev/null @@ -1,1202 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# RepositoryService - -Data access layer (DAL) interface to implements for any repository service. -This layer helps to separate the business logic (service layer) from accessing the -ORM directly and allows to switch to another ORM without changing the business logic. - -## Type parameters - - - -## Methods - -### create - -#### Parameters - - - -#### Returns - - - -___ - -### delete - -#### Parameters - - - -#### Returns - - - -___ - -### find - -#### Parameters - - - -#### Returns - - - -___ - -### findAndCount - -#### Parameters - - - -#### Returns - - - -___ - -### getActiveManager - -#### Type Parameters - - - -#### Returns - - - -___ - -### getFreshManager - -#### Type Parameters - - - -#### Returns - - - -___ - -### restore - -#### Parameters - - - -#### Returns - -`", - "optional": false, - "defaultValue": "", - "description": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -___ - -### serialize - -#### Type Parameters - - - -#### Parameters - - - -#### Returns - - - -___ - -### softDelete - -Soft delete entities and cascade to related entities if configured. - -#### Parameters - - - -#### Returns - -`", - "optional": false, - "defaultValue": "", - "description": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -___ - -### transaction - -#### Type Parameters - - - -#### Parameters - - Promise<any>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "context", - "type": "`object`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transaction", - "type": "`TManager`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "context.enableNestedTransactions", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "context.isolationLevel", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "context.transaction", - "type": "`TManager`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> - -#### Returns - - - -___ - -### update - -#### Parameters - - - -#### Returns - - diff --git a/www/apps/docs/content/references/DAL/interfaces/types.DAL.RestoreReturn.mdx b/www/apps/docs/content/references/DAL/interfaces/types.DAL.RestoreReturn.mdx deleted file mode 100644 index 0118544648d70..0000000000000 --- a/www/apps/docs/content/references/DAL/interfaces/types.DAL.RestoreReturn.mdx +++ /dev/null @@ -1,33 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# RestoreReturn - -An object that is used to specify an entity's related entities that should be restored when the main entity is restored. - -## Type parameters - - - -## Properties - - diff --git a/www/apps/docs/content/references/DAL/interfaces/types.DAL.SoftDeleteReturn.mdx b/www/apps/docs/content/references/DAL/interfaces/types.DAL.SoftDeleteReturn.mdx deleted file mode 100644 index 4319d0ca4bac0..0000000000000 --- a/www/apps/docs/content/references/DAL/interfaces/types.DAL.SoftDeleteReturn.mdx +++ /dev/null @@ -1,33 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# SoftDeleteReturn - -An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted. - -## Type parameters - - - -## Properties - - diff --git a/www/apps/docs/content/references/DAL/interfaces/types.DAL.TreeRepositoryService.mdx b/www/apps/docs/content/references/DAL/interfaces/types.DAL.TreeRepositoryService.mdx deleted file mode 100644 index f3eac9c916107..0000000000000 --- a/www/apps/docs/content/references/DAL/interfaces/types.DAL.TreeRepositoryService.mdx +++ /dev/null @@ -1,889 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# TreeRepositoryService - -Data access layer (DAL) interface to implements for any repository service. -This layer helps to separate the business logic (service layer) from accessing the -ORM directly and allows to switch to another ORM without changing the business logic. - -## Type parameters - - - -## Methods - -### create - -#### Parameters - - - -#### Returns - - - -___ - -### delete - -#### Parameters - - - -#### Returns - - - -___ - -### find - -#### Parameters - - - -#### Returns - - - -___ - -### findAndCount - -#### Parameters - - - -#### Returns - - - -___ - -### getActiveManager - -#### Type Parameters - - - -#### Returns - - - -___ - -### getFreshManager - -#### Type Parameters - - - -#### Returns - - - -___ - -### serialize - -#### Type Parameters - - - -#### Parameters - - - -#### Returns - - - -___ - -### transaction - -#### Type Parameters - - - -#### Parameters - - Promise<any>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "context", - "type": "`object`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transaction", - "type": "`TManager`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "context.enableNestedTransactions", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "context.isolationLevel", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "context.transaction", - "type": "`TManager`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> - -#### Returns - - diff --git a/www/apps/docs/content/references/DAL/types/types.DAL.FindOptions.mdx b/www/apps/docs/content/references/DAL/types/types.DAL.FindOptions.mdx deleted file mode 100644 index 8c949451f8945..0000000000000 --- a/www/apps/docs/content/references/DAL/types/types.DAL.FindOptions.mdx +++ /dev/null @@ -1,125 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# FindOptions - - **FindOptions**: `Object` - -## Type Parameters - - - -## Type declaration - - diff --git a/www/apps/docs/content/references/EventBusTypes/interfaces/types.EventBusTypes.IEventBusModuleService.mdx b/www/apps/docs/content/references/EventBusTypes/interfaces/types.EventBusTypes.IEventBusModuleService.mdx deleted file mode 100644 index a04c42dffe3e1..0000000000000 --- a/www/apps/docs/content/references/EventBusTypes/interfaces/types.EventBusTypes.IEventBusModuleService.mdx +++ /dev/null @@ -1,297 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# IEventBusModuleService - -## Methods - -### emit - -`**emit**(eventName, data, options?): Promise<void>` - -#### Type Parameters - - - -#### Parameters - -`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> - -#### Returns - - - -`**emit**(data): Promise<void>` - -#### Type Parameters - - - -#### Parameters - -`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -#### Returns - - - -___ - -### subscribe - -#### Parameters - - - -#### Returns - -`(`eventName`: `string`, `data`: `T`, `options?`: `Record`) => Promise<void>``(`data`: [EmitData](../types/types.EventBusTypes.EmitData.mdx)<T>[]) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "subscribe", - "type": "(`eventName`: `string` \\| `symbol`, `subscriber`: [Subscriber](../types/types.EventBusTypes.Subscriber.mdx), `context?`: [SubscriberContext](../types/types.EventBusTypes.SubscriberContext.mdx)) => [IEventBusModuleService](types.EventBusTypes.IEventBusModuleService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "unsubscribe", - "type": "(`eventName`: `string` \\| `symbol`, `subscriber`: [Subscriber](../types/types.EventBusTypes.Subscriber.mdx), `context?`: [SubscriberContext](../types/types.EventBusTypes.SubscriberContext.mdx)) => [IEventBusModuleService](types.EventBusTypes.IEventBusModuleService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> - -___ - -### unsubscribe - -#### Parameters - - - -#### Returns - -`(`eventName`: `string`, `data`: `T`, `options?`: `Record`) => Promise<void>``(`data`: [EmitData](../types/types.EventBusTypes.EmitData.mdx)<T>[]) => Promise<void>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "subscribe", - "type": "(`eventName`: `string` \\| `symbol`, `subscriber`: [Subscriber](../types/types.EventBusTypes.Subscriber.mdx), `context?`: [SubscriberContext](../types/types.EventBusTypes.SubscriberContext.mdx)) => [IEventBusModuleService](types.EventBusTypes.IEventBusModuleService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "unsubscribe", - "type": "(`eventName`: `string` \\| `symbol`, `subscriber`: [Subscriber](../types/types.EventBusTypes.Subscriber.mdx), `context?`: [SubscriberContext](../types/types.EventBusTypes.SubscriberContext.mdx)) => [IEventBusModuleService](types.EventBusTypes.IEventBusModuleService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService.mdx b/www/apps/docs/content/references/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService.mdx deleted file mode 100644 index 90af2c06d374f..0000000000000 --- a/www/apps/docs/content/references/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService.mdx +++ /dev/null @@ -1,310 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# IEventBusService - -## Methods - -### emit - -#### Type Parameters - - - -#### Parameters - - - -#### Returns - - - -___ - -### subscribe - -#### Parameters - - - -#### Returns - -`(`event`: `string`, `data`: `T`, `options?`: `unknown`) => Promise<unknown>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "subscribe", - "type": "(`eventName`: `string` \\| `symbol`, `subscriber`: [Subscriber](../types/types.EventBusTypes.Subscriber.mdx), `context?`: [SubscriberContext](../types/types.EventBusTypes.SubscriberContext.mdx)) => [IEventBusService](types.EventBusTypes.IEventBusService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "unsubscribe", - "type": "(`eventName`: `string` \\| `symbol`, `subscriber`: [Subscriber](../types/types.EventBusTypes.Subscriber.mdx), `context?`: [SubscriberContext](../types/types.EventBusTypes.SubscriberContext.mdx)) => [IEventBusService](types.EventBusTypes.IEventBusService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "withTransaction", - "type": "(`transactionManager?`: `EntityManager`) => [IEventBusService](types.EventBusTypes.IEventBusService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> - -___ - -### unsubscribe - -#### Parameters - - - -#### Returns - -`(`event`: `string`, `data`: `T`, `options?`: `unknown`) => Promise<unknown>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "subscribe", - "type": "(`eventName`: `string` \\| `symbol`, `subscriber`: [Subscriber](../types/types.EventBusTypes.Subscriber.mdx), `context?`: [SubscriberContext](../types/types.EventBusTypes.SubscriberContext.mdx)) => [IEventBusService](types.EventBusTypes.IEventBusService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "unsubscribe", - "type": "(`eventName`: `string` \\| `symbol`, `subscriber`: [Subscriber](../types/types.EventBusTypes.Subscriber.mdx), `context?`: [SubscriberContext](../types/types.EventBusTypes.SubscriberContext.mdx)) => [IEventBusService](types.EventBusTypes.IEventBusService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "withTransaction", - "type": "(`transactionManager?`: `EntityManager`) => [IEventBusService](types.EventBusTypes.IEventBusService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> - -___ - -### withTransaction - -#### Parameters - - - -#### Returns - -`(`event`: `string`, `data`: `T`, `options?`: `unknown`) => Promise<unknown>", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "subscribe", - "type": "(`eventName`: `string` \\| `symbol`, `subscriber`: [Subscriber](../types/types.EventBusTypes.Subscriber.mdx), `context?`: [SubscriberContext](../types/types.EventBusTypes.SubscriberContext.mdx)) => [IEventBusService](types.EventBusTypes.IEventBusService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "unsubscribe", - "type": "(`eventName`: `string` \\| `symbol`, `subscriber`: [Subscriber](../types/types.EventBusTypes.Subscriber.mdx), `context?`: [SubscriberContext](../types/types.EventBusTypes.SubscriberContext.mdx)) => [IEventBusService](types.EventBusTypes.IEventBusService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "withTransaction", - "type": "(`transactionManager?`: `EntityManager`) => [IEventBusService](types.EventBusTypes.IEventBusService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.EmitData.mdx b/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.EmitData.mdx deleted file mode 100644 index 49fcfecbdd1f7..0000000000000 --- a/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.EmitData.mdx +++ /dev/null @@ -1,51 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# EmitData - - **EmitData**: `Object` - -## Type Parameters - - - -## Type declaration - -`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.EventHandler.mdx b/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.EventHandler.mdx deleted file mode 100644 index 7fc79ce7a8657..0000000000000 --- a/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.EventHandler.mdx +++ /dev/null @@ -1,58 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# EventHandler - - **EventHandler**: (`data`: `T`, `eventName`: `string`) => Promise<void> - -## Type Parameters - - - -## Type declaration - -### Parameters - - - -### Returns - - diff --git a/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.Subscriber.mdx b/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.Subscriber.mdx deleted file mode 100644 index 2a1aa42e15b9e..0000000000000 --- a/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.Subscriber.mdx +++ /dev/null @@ -1,58 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# Subscriber - - **Subscriber**: (`data`: `T`, `eventName`: `string`) => Promise<void> - -## Type Parameters - - - -## Type declaration - -### Parameters - - - -### Returns - - diff --git a/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.SubscriberContext.mdx b/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.SubscriberContext.mdx deleted file mode 100644 index ff12860bac944..0000000000000 --- a/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.SubscriberContext.mdx +++ /dev/null @@ -1,19 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# SubscriberContext - - **SubscriberContext**: `Object` - -## Type declaration - - diff --git a/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.SubscriberDescriptor.mdx b/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.SubscriberDescriptor.mdx deleted file mode 100644 index bdf042bda2fbd..0000000000000 --- a/www/apps/docs/content/references/EventBusTypes/types/types.EventBusTypes.SubscriberDescriptor.mdx +++ /dev/null @@ -1,28 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# SubscriberDescriptor - - **SubscriberDescriptor**: `Object` - -## Type declaration - - diff --git a/www/apps/docs/content/references/FeatureFlagTypes/interfaces/types.FeatureFlagTypes.IFlagRouter.mdx b/www/apps/docs/content/references/FeatureFlagTypes/interfaces/types.FeatureFlagTypes.IFlagRouter.mdx deleted file mode 100644 index 63d49cb7d824a..0000000000000 --- a/www/apps/docs/content/references/FeatureFlagTypes/interfaces/types.FeatureFlagTypes.IFlagRouter.mdx +++ /dev/null @@ -1,26 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# IFlagRouter - -## Properties - - `boolean`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "listFlags", - "type": "() => [FeatureFlagsResponse](../types/types.FeatureFlagTypes.FeatureFlagsResponse.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/FeatureFlagTypes/types/types.FeatureFlagTypes.FlagSettings.mdx b/www/apps/docs/content/references/FeatureFlagTypes/types/types.FeatureFlagTypes.FlagSettings.mdx deleted file mode 100644 index ea8144d088ca5..0000000000000 --- a/www/apps/docs/content/references/FeatureFlagTypes/types/types.FeatureFlagTypes.FlagSettings.mdx +++ /dev/null @@ -1,46 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# FlagSettings - - **FlagSettings**: `Object` - -## Type declaration - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.adjustInventory.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.adjustInventory.mdx deleted file mode 100644 index 902477144e910..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.adjustInventory.mdx +++ /dev/null @@ -1,202 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/adjustInventory -sidebar_label: adjustInventory ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# adjustInventory - Inventory Module Reference - -This documentation provides a reference to the `adjustInventory` method. This belongs to the Inventory Module. - -This method is used to adjust the inventory level's stocked quantity. The inventory level is identified by the IDs of its associated inventory item and location. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function adjustInventory ( - inventoryItemId: string, - locationId: string, - adjustment: number -) { - const inventoryModule = await initializeInventoryModule({}) - - const inventoryLevel = await inventoryModule.adjustInventory( - inventoryItemId, - locationId, - adjustment - ) - - // do something with the inventory level or return it. -} -``` - -## Parameters - - - -## 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": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.confirmInventory.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.confirmInventory.mdx deleted file mode 100644 index 32e5cee0c813d..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.confirmInventory.mdx +++ /dev/null @@ -1,119 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/confirmInventory -sidebar_label: confirmInventory ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# confirmInventory - Inventory Module Reference - -This documentation provides a reference to the `confirmInventory` method. This belongs to the Inventory Module. - -This method is used to confirm whether the specified quantity of an inventory item is available in the specified locations. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function confirmInventory ( - inventoryItemId: string, - locationIds: string[], - quantity: number -) { - const inventoryModule = await initializeInventoryModule({}) - - return await inventoryModule.confirmInventory( - inventoryItemId, - locationIds, - quantity - ) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryItem.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryItem.mdx deleted file mode 100644 index 85f061358fcd8..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryItem.mdx +++ /dev/null @@ -1,380 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/createInventoryItem -sidebar_label: createInventoryItem ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createInventoryItem - Inventory Module Reference - -This documentation provides a reference to the `createInventoryItem` method. This belongs to the Inventory Module. - -This method is used to create an inventory item. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function createInventoryItem (item: { - sku: string, - requires_shipping: boolean -}) { - const inventoryModule = await initializeInventoryModule({}) - - const inventoryItem = await inventoryModule.createInventoryItem( - item - ) - - // do something with the inventory item or return it -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`null` \\| `string`", - "description": "The MID code of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "origin_country", - "type": "`null` \\| `string`", - "description": "The origin country of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "requires_shipping", - "type": "`boolean`", - "description": "Whether the inventory item requires shipping.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "sku", - "type": "`null` \\| `string`", - "description": "The SKU of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "thumbnail", - "type": "`null` \\| `string`", - "description": "The thumbnail of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`null` \\| `string`", - "description": "The title of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "weight", - "type": "`null` \\| `number`", - "description": "The weight of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`null` \\| `number`", - "description": "The width of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "context", - "type": "[SharedContext](../../inventory/interfaces/inventory.SharedContext.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "manager", - "type": "`EntityManager`", - "description": "An instance of an entity manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`EntityManager`", - "description": "An instance of a transaction manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## 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": "requires_shipping", - "type": "`boolean`", - "description": "Whether the item requires shipping.", - "optional": false, - "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": "updated_at", - "type": "`string` \\| `Date`", - "description": "The date with timezone at which the resource was updated.", - "optional": false, - "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/IInventoryService/methods/inventory.IInventoryService.createInventoryItems.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryItems.mdx deleted file mode 100644 index 2f68ee287b6b8..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryItems.mdx +++ /dev/null @@ -1,237 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/createInventoryItems -sidebar_label: createInventoryItems ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createInventoryItems - Inventory Module Reference - -This documentation provides a reference to the `createInventoryItems` method. This belongs to the Inventory Module. - -This method is used to create inventory items. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function createInventoryItems (items: { - sku: string, - requires_shipping: boolean -}[]) { - const inventoryModule = await initializeInventoryModule({}) - - const inventoryItems = await inventoryModule.createInventoryItems( - items - ) - - // do something with the inventory items or return them -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`null` \\| `string`", - "description": "The MID code of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "origin_country", - "type": "`null` \\| `string`", - "description": "The origin country of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "requires_shipping", - "type": "`boolean`", - "description": "Whether the inventory item requires shipping.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "sku", - "type": "`null` \\| `string`", - "description": "The SKU of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "thumbnail", - "type": "`null` \\| `string`", - "description": "The thumbnail of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`null` \\| `string`", - "description": "The title of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "weight", - "type": "`null` \\| `number`", - "description": "The weight of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`null` \\| `number`", - "description": "The width of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "context", - "type": "[SharedContext](../../inventory/interfaces/inventory.SharedContext.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "manager", - "type": "`EntityManager`", - "description": "An instance of an entity manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`EntityManager`", - "description": "An instance of a transaction manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryLevel.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryLevel.mdx deleted file mode 100644 index 09631f6408935..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryLevel.mdx +++ /dev/null @@ -1,228 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/createInventoryLevel -sidebar_label: createInventoryLevel ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createInventoryLevel - Inventory Module Reference - -This documentation provides a reference to the `createInventoryLevel` method. This belongs to the Inventory Module. - -This method is used to create inventory level. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function createInventoryLevel (item: { - inventory_item_id: string - location_id: string - stocked_quantity: number -}) { - const inventoryModule = await initializeInventoryModule({}) - - const inventoryLevel = await inventoryModule.createInventoryLevel( - item - ) - - // do something with the inventory level or return it -} -``` - -## Parameters - - - -## 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": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryLevels.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryLevels.mdx deleted file mode 100644 index 1d04838d9f467..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createInventoryLevels.mdx +++ /dev/null @@ -1,157 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/createInventoryLevels -sidebar_label: createInventoryLevels ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createInventoryLevels - Inventory Module Reference - -This documentation provides a reference to the `createInventoryLevels` method. This belongs to the Inventory Module. - -This method is used to create inventory levels. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function createInventoryLevels (items: { - inventory_item_id: string - location_id: string - stocked_quantity: number -}[]) { - const inventoryModule = await initializeInventoryModule({}) - - const inventoryLevels = await inventoryModule.createInventoryLevels( - items - ) - - // do something with the inventory levels or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createReservationItem.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createReservationItem.mdx deleted file mode 100644 index 32fd584e9728f..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createReservationItem.mdx +++ /dev/null @@ -1,264 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/createReservationItem -sidebar_label: createReservationItem ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createReservationItem - Inventory Module Reference - -This documentation provides a reference to the `createReservationItem` method. This belongs to the Inventory Module. - -This method is used to create a reservation item. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function createReservationItem (item: { - inventory_item_id: string, - location_id: string, - quantity: number -}) { - const inventoryModule = await initializeInventoryModule({}) - - const reservationItem = await inventoryModule.createReservationItems( - item - ) - - // do something with the reservation item or return them -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "quantity", - "type": "`number`", - "description": "The reserved quantity.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "context", - "type": "[SharedContext](../../inventory/interfaces/inventory.SharedContext.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "manager", - "type": "`EntityManager`", - "description": "An instance of an entity manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`EntityManager`", - "description": "An instance of a transaction manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## 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": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createReservationItems.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createReservationItems.mdx deleted file mode 100644 index 08a9faad3283b..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.createReservationItems.mdx +++ /dev/null @@ -1,184 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/createReservationItems -sidebar_label: createReservationItems ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createReservationItems - Inventory Module Reference - -This documentation provides a reference to the `createReservationItems` method. This belongs to the Inventory Module. - -This method is used to create reservation items. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function createReservationItems (items: { - inventory_item_id: string, - location_id: string, - quantity: number -}[]) { - const inventoryModule = await initializeInventoryModule({}) - - const reservationItems = await inventoryModule.createReservationItems( - items - ) - - // do something with the reservation items or return them -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "quantity", - "type": "`number`", - "description": "The reserved quantity.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "context", - "type": "[SharedContext](../../inventory/interfaces/inventory.SharedContext.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "manager", - "type": "`EntityManager`", - "description": "An instance of an entity manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`EntityManager`", - "description": "An instance of a transaction manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteInventoryItem.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteInventoryItem.mdx deleted file mode 100644 index 621c91897aff7..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteInventoryItem.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/deleteInventoryItem -sidebar_label: deleteInventoryItem ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteInventoryItem - Inventory Module Reference - -This documentation provides a reference to the `deleteInventoryItem` method. This belongs to the Inventory Module. - -This method is used to delete an inventory item or multiple inventory items. The inventory items are only soft deleted and can be restored using the -[restoreInventoryItem](inventory.IInventoryService.restoreInventoryItem.mdx) method. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function deleteInventoryItem ( - inventoryItems: string[] -) { - const inventoryModule = await initializeInventoryModule({}) - - await inventoryModule.deleteInventoryItem( - inventoryItems - ) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteInventoryItemLevelByLocationId.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteInventoryItemLevelByLocationId.mdx deleted file mode 100644 index 0baa11c59441c..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteInventoryItemLevelByLocationId.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/deleteInventoryItemLevelByLocationId -sidebar_label: deleteInventoryItemLevelByLocationId ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteInventoryItemLevelByLocationId - Inventory Module Reference - -This documentation provides a reference to the `deleteInventoryItemLevelByLocationId` method. This belongs to the Inventory Module. - -This method deletes the inventory item level(s) for the ID(s) of associated location(s). - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function deleteInventoryItemLevelByLocationId ( - locationIds: string[] -) { - const inventoryModule = await initializeInventoryModule({}) - - await inventoryModule.deleteInventoryItemLevelByLocationId( - locationIds - ) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteInventoryLevel.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteInventoryLevel.mdx deleted file mode 100644 index fa27448ee4c69..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteInventoryLevel.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/deleteInventoryLevel -sidebar_label: deleteInventoryLevel ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteInventoryLevel - Inventory Module Reference - -This documentation provides a reference to the `deleteInventoryLevel` method. This belongs to the Inventory Module. - -This method is used to delete an inventory level. The inventory level is identified by the IDs of its associated inventory item and location. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function deleteInventoryLevel ( - inventoryItemId: string, - locationId: string -) { - const inventoryModule = await initializeInventoryModule({}) - - await inventoryModule.deleteInventoryLevel( - inventoryItemId, - locationId - ) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteReservationItem.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteReservationItem.mdx deleted file mode 100644 index c4d0a3bc861b0..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteReservationItem.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/deleteReservationItem -sidebar_label: deleteReservationItem ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteReservationItem - Inventory Module Reference - -This documentation provides a reference to the `deleteReservationItem` method. This belongs to the Inventory Module. - -This method is used to delete a reservation item or multiple reservation items by their IDs. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function deleteReservationItems ( - reservationItemIds: string[] -) { - const inventoryModule = await initializeInventoryModule({}) - - await inventoryModule.deleteReservationItem( - reservationItemIds - ) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteReservationItemByLocationId.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteReservationItemByLocationId.mdx deleted file mode 100644 index 970a33396a109..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteReservationItemByLocationId.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/deleteReservationItemByLocationId -sidebar_label: deleteReservationItemByLocationId ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteReservationItemByLocationId - Inventory Module Reference - -This documentation provides a reference to the `deleteReservationItemByLocationId` method. This belongs to the Inventory Module. - -This method deletes reservation item(s) by the ID(s) of associated location(s). - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function deleteReservationItemByLocationId ( - locationIds: string[] -) { - const inventoryModule = await initializeInventoryModule({}) - - await inventoryModule.deleteReservationItemByLocationId( - locationIds - ) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteReservationItemsByLineItem.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteReservationItemsByLineItem.mdx deleted file mode 100644 index ee3aa49dc8ed1..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.deleteReservationItemsByLineItem.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/deleteReservationItemsByLineItem -sidebar_label: deleteReservationItemsByLineItem ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteReservationItemsByLineItem - Inventory Module Reference - -This documentation provides a reference to the `deleteReservationItemsByLineItem` method. This belongs to the Inventory Module. - -This method is used to delete the reservation items associated with a line item or multiple line items. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function deleteReservationItemsByLineItem ( - lineItemIds: string[] -) { - const inventoryModule = await initializeInventoryModule({}) - - await inventoryModule.deleteReservationItemsByLineItem( - lineItemIds - ) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.listInventoryItems.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.listInventoryItems.mdx deleted file mode 100644 index 42a3eeefcebf0..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.listInventoryItems.mdx +++ /dev/null @@ -1,278 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/listInventoryItems -sidebar_label: listInventoryItems ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listInventoryItems - Inventory Module Reference - -This documentation provides a reference to the `listInventoryItems` method. This belongs to the Inventory Module. - -This method is used to retrieve a paginated list of inventory items along with the total count of available inventory items satisfying the provided filters. - -## Example - -To retrieve a list of inventory items using their IDs: - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveInventoryItems (ids: string[]) { - const inventoryModule = await initializeInventoryModule({}) - - const [inventoryItems, count] = await inventoryModule.listInventoryItems({ - id: ids - }) - - // do something with the inventory items or return them -} -``` - -To specify relations that should be retrieved within the inventory items: - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveInventoryItems (ids: string[]) { - const inventoryModule = await initializeInventoryModule({}) - - const [inventoryItems, count] = await inventoryModule.listInventoryItems({ - id: ids - }, { - relations: ["inventory_level"] - }) - - // do something with the inventory items or return them -} -``` - -By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveInventoryItems (ids: string[], skip: number, take: number) { - const inventoryModule = await initializeInventoryModule({}) - - const [inventoryItems, count] = await inventoryModule.listInventoryItems({ - id: ids - }, { - relations: ["inventory_level"], - skip, - take - }) - - // do something with the inventory items or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.listInventoryLevels.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.listInventoryLevels.mdx deleted file mode 100644 index 8f02895f3b47e..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.listInventoryLevels.mdx +++ /dev/null @@ -1,260 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/listInventoryLevels -sidebar_label: listInventoryLevels ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listInventoryLevels - Inventory Module Reference - -This documentation provides a reference to the `listInventoryLevels` method. This belongs to the Inventory Module. - -This method is used to retrieve a paginated list of inventory levels along with the total count of available inventory levels satisfying the provided filters. - -## Example - -To retrieve a list of inventory levels using their IDs: - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveInventoryLevels (inventoryItemIds: string[]) { - const inventoryModule = await initializeInventoryModule({}) - - const [inventoryLevels, count] = await inventoryModule.listInventoryLevels({ - inventory_item_id: inventoryItemIds - }) - - // do something with the inventory levels or return them -} -``` - -To specify relations that should be retrieved within the inventory levels: - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveInventoryLevels (inventoryItemIds: string[]) { - const inventoryModule = await initializeInventoryModule({}) - - const [inventoryLevels, count] = await inventoryModule.listInventoryLevels({ - inventory_item_id: inventoryItemIds - }, { - relations: ["inventory_item"] - }) - - // do something with the inventory levels or return them -} -``` - -By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number, take: number) { - const inventoryModule = await initializeInventoryModule({}) - - const [inventoryLevels, count] = await inventoryModule.listInventoryLevels({ - inventory_item_id: inventoryItemIds - }, { - relations: ["inventory_item"], - skip, - take - }) - - // do something with the inventory levels or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.listReservationItems.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.listReservationItems.mdx deleted file mode 100644 index e1d2c5b57baf2..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.listReservationItems.mdx +++ /dev/null @@ -1,278 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/listReservationItems -sidebar_label: listReservationItems ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listReservationItems - Inventory Module Reference - -This documentation provides a reference to the `listReservationItems` method. This belongs to the Inventory Module. - -This method is used to retrieve a paginated list of reservation items along with the total count of available reservation items satisfying the provided filters. - -## Example - -To retrieve a list of reservation items using their IDs: - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveReservationItems (ids: string[]) { - const inventoryModule = await initializeInventoryModule({}) - - const [reservationItems, count] = await inventoryModule.listReservationItems({ - id: ids - }) - - // do something with the reservation items or return them -} -``` - -To specify relations that should be retrieved within the reservation items: - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveReservationItems (ids: string[]) { - const inventoryModule = await initializeInventoryModule({}) - - const [reservationItems, count] = await inventoryModule.listReservationItems({ - id: ids - }, { - relations: ["inventory_item"] - }) - - // do something with the reservation items or return them -} -``` - -By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveReservationItems (ids: string[], skip: number, take: number) { - const inventoryModule = await initializeInventoryModule({}) - - const [reservationItems, count] = await inventoryModule.listReservationItems({ - id: ids - }, { - relations: ["inventory_item"], - skip, - take - }) - - // do something with the reservation items or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.restoreInventoryItem.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.restoreInventoryItem.mdx deleted file mode 100644 index a4794940e03d7..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.restoreInventoryItem.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/restoreInventoryItem -sidebar_label: restoreInventoryItem ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# restoreInventoryItem - Inventory Module Reference - -This documentation provides a reference to the `restoreInventoryItem` method. This belongs to the Inventory Module. - -This method is used to restore an inventory item or multiple inventory items that were previously deleted using the [deleteInventoryItem](inventory.IInventoryService.deleteInventoryItem.mdx) method. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function restoreInventoryItem ( - inventoryItems: string[] -) { - const inventoryModule = await initializeInventoryModule({}) - - await inventoryModule.restoreInventoryItem( - inventoryItems - ) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveAvailableQuantity.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveAvailableQuantity.mdx deleted file mode 100644 index 35890dbb42457..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveAvailableQuantity.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/retrieveAvailableQuantity -sidebar_label: retrieveAvailableQuantity ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveAvailableQuantity - Inventory Module Reference - -This documentation provides a reference to the `retrieveAvailableQuantity` method. This belongs to the Inventory Module. - -This method is used to retrieve the available quantity of an inventory item within the specified locations. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveAvailableQuantity ( - inventoryItemId: string, - locationIds: string[], -) { - const inventoryModule = await initializeInventoryModule({}) - - const quantity = await inventoryModule.retrieveAvailableQuantity( - inventoryItemId, - locationIds, - ) - - // do something with the quantity or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryItem.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryItem.mdx deleted file mode 100644 index 0f8f18547bd00..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryItem.mdx +++ /dev/null @@ -1,332 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/retrieveInventoryItem -sidebar_label: retrieveInventoryItem ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveInventoryItem - Inventory Module Reference - -This documentation provides a reference to the `retrieveInventoryItem` method. This belongs to the Inventory Module. - -This method is used to retrieve an inventory item by its ID - -## Example - -A simple example that retrieves a inventory item by its ID: - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveInventoryItem (id: string) { - const inventoryModule = await initializeInventoryModule({}) - - const inventoryItem = await inventoryModule.retrieveInventoryItem(id) - - // do something with the inventory item or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveInventoryItem (id: string) { - const inventoryModule = await initializeInventoryModule({}) - - const inventoryItem = await inventoryModule.retrieveInventoryItem(id, { - relations: ["inventory_level"] - }) - - // do something with the inventory item or return it -} -``` - -## Parameters - - - -## 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": "requires_shipping", - "type": "`boolean`", - "description": "Whether the item requires shipping.", - "optional": false, - "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": "updated_at", - "type": "`string` \\| `Date`", - "description": "The date with timezone at which the resource was updated.", - "optional": false, - "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/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryLevel.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryLevel.mdx deleted file mode 100644 index 665b80b471e63..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryLevel.mdx +++ /dev/null @@ -1,191 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/retrieveInventoryLevel -sidebar_label: retrieveInventoryLevel ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveInventoryLevel - Inventory Module Reference - -This documentation provides a reference to the `retrieveInventoryLevel` method. This belongs to the Inventory Module. - -This method is used to retrieve an inventory level for an inventory item and a location. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveInventoryLevel ( - inventoryItemId: string, - locationId: string -) { - const inventoryModule = await initializeInventoryModule({}) - - const inventoryLevel = await inventoryModule.retrieveInventoryLevel( - inventoryItemId, - locationId - ) - - // do something with the inventory level or return it -} -``` - -## Parameters - - - -## 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": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveReservationItem.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveReservationItem.mdx deleted file mode 100644 index 1a22e6f78ca11..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveReservationItem.mdx +++ /dev/null @@ -1,185 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/retrieveReservationItem -sidebar_label: retrieveReservationItem ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveReservationItem - Inventory Module Reference - -This documentation provides a reference to the `retrieveReservationItem` method. This belongs to the Inventory Module. - -This method is used to retrieve a reservation item by its ID. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveReservationItem (id: string) { - const inventoryModule = await initializeInventoryModule({}) - - const reservationItem = await inventoryModule.retrieveReservationItem(id) - - // do something with the reservation item or return it -} -``` - -## Parameters - - - -## 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": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveReservedQuantity.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveReservedQuantity.mdx deleted file mode 100644 index 093512946f673..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveReservedQuantity.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/retrieveReservedQuantity -sidebar_label: retrieveReservedQuantity ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveReservedQuantity - Inventory Module Reference - -This documentation provides a reference to the `retrieveReservedQuantity` method. This belongs to the Inventory Module. - -This method is used to retrieve the reserved quantity of an inventory item within the specified locations. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveReservedQuantity ( - inventoryItemId: string, - locationIds: string[], -) { - const inventoryModule = await initializeInventoryModule({}) - - const quantity = await inventoryModule.retrieveReservedQuantity( - inventoryItemId, - locationIds, - ) - - // do something with the quantity or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveStockedQuantity.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveStockedQuantity.mdx deleted file mode 100644 index d7d1bcc9a0976..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.retrieveStockedQuantity.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/retrieveStockedQuantity -sidebar_label: retrieveStockedQuantity ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveStockedQuantity - Inventory Module Reference - -This documentation provides a reference to the `retrieveStockedQuantity` method. This belongs to the Inventory Module. - -This method is used to retrieve the stocked quantity of an inventory item within the specified locations. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function retrieveStockedQuantity ( - inventoryItemId: string, - locationIds: string[], -) { - const inventoryModule = await initializeInventoryModule({}) - - const quantity = await inventoryModule.retrieveStockedQuantity( - inventoryItemId, - locationIds, - ) - - // do something with the quantity or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateInventoryItem.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateInventoryItem.mdx deleted file mode 100644 index 40562bdda975d..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateInventoryItem.mdx +++ /dev/null @@ -1,392 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/updateInventoryItem -sidebar_label: updateInventoryItem ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateInventoryItem - Inventory Module Reference - -This documentation provides a reference to the `updateInventoryItem` method. This belongs to the Inventory Module. - -This method is used to update an inventory item. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function updateInventoryItem ( - inventoryItemId: string, - sku: string -) { - const inventoryModule = await initializeInventoryModule({}) - - const inventoryItem = await inventoryModule.updateInventoryItem( - inventoryItemId, - { - sku - } - ) - - // do something with the inventory item or return it -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`null` \\| `string`", - "description": "The MID code of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "origin_country", - "type": "`null` \\| `string`", - "description": "The origin country of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "requires_shipping", - "type": "`boolean`", - "description": "Whether the inventory item requires shipping.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "sku", - "type": "`null` \\| `string`", - "description": "The SKU of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "thumbnail", - "type": "`null` \\| `string`", - "description": "The thumbnail of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`null` \\| `string`", - "description": "The title of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "weight", - "type": "`null` \\| `number`", - "description": "The weight of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`null` \\| `number`", - "description": "The width of the inventory item.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "context", - "type": "[SharedContext](../../inventory/interfaces/inventory.SharedContext.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "manager", - "type": "`EntityManager`", - "description": "An instance of an entity manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`EntityManager`", - "description": "An instance of a transaction manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## 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": "requires_shipping", - "type": "`boolean`", - "description": "Whether the item requires shipping.", - "optional": false, - "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": "updated_at", - "type": "`string` \\| `Date`", - "description": "The date with timezone at which the resource was updated.", - "optional": false, - "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/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevel.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevel.mdx deleted file mode 100644 index ce02cf96ee69b..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevel.mdx +++ /dev/null @@ -1,223 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/updateInventoryLevel -sidebar_label: updateInventoryLevel ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateInventoryLevel - Inventory Module Reference - -This documentation provides a reference to the `updateInventoryLevel` method. This belongs to the Inventory Module. - -This method is used to update an inventory level. The inventory level is identified by the IDs of its associated inventory item and location. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function updateInventoryLevel ( - inventoryItemId: string, - locationId: string, - stockedQuantity: number -) { - const inventoryModule = await initializeInventoryModule({}) - - const inventoryLevel = await inventoryModule.updateInventoryLevels( - inventoryItemId, - locationId, - { - stocked_quantity: stockedQuantity - } - ) - - // do something with the inventory level or return it -} -``` - -## Parameters - - - -## 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": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevels.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevels.mdx deleted file mode 100644 index 719185d5ac0b8..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevels.mdx +++ /dev/null @@ -1,148 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/updateInventoryLevels -sidebar_label: updateInventoryLevels ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateInventoryLevels - Inventory Module Reference - -This documentation provides a reference to the `updateInventoryLevels` method. This belongs to the Inventory Module. - -This method is used to update inventory levels. Each inventory level is identified by the IDs of its associated inventory item and location. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function updateInventoryLevels (items: { - inventory_item_id: string, - location_id: string, - stocked_quantity: number -}[]) { - const inventoryModule = await initializeInventoryModule({}) - - const inventoryLevels = await inventoryModule.updateInventoryLevels( - items - ) - - // do something with the inventory levels or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateReservationItem.mdx b/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateReservationItem.mdx deleted file mode 100644 index 25bc99ab4b974..0000000000000 --- a/www/apps/docs/content/references/IInventoryService/methods/inventory.IInventoryService.updateReservationItem.mdx +++ /dev/null @@ -1,239 +0,0 @@ ---- -displayed_sidebar: inventoryReference -slug: /references/inventory/updateReservationItem -sidebar_label: updateReservationItem ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateReservationItem - Inventory Module Reference - -This documentation provides a reference to the `updateReservationItem` method. This belongs to the Inventory Module. - -This method is used to update a reservation item. - -## Example - -```ts -import { - initialize as initializeInventoryModule, -} from "@medusajs/inventory" - -async function updateReservationItem ( - reservationItemId: string, - quantity: number -) { - const inventoryModule = await initializeInventoryModule({}) - - const reservationItem = await inventoryModule.updateReservationItem( - reservationItemId, - { - quantity - } - ) - - // do something with the reservation item or return it -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "quantity", - "type": "`number`", - "description": "The reserved quantity.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "context", - "type": "[SharedContext](../../inventory/interfaces/inventory.SharedContext.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "manager", - "type": "`EntityManager`", - "description": "An instance of an entity manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`EntityManager`", - "description": "An instance of a transaction manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## 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": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices.mdx deleted file mode 100644 index 62c6787980777..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices.mdx +++ /dev/null @@ -1,225 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/addPriceListPrices -sidebar_label: addPriceListPrices ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# addPriceListPrices - Pricing Module Reference - -This documentation provides a reference to the `addPriceListPrices` method. This belongs to the Pricing Module. - -This method is used to add prices to price lists. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function addPriceListPrices (items: { - priceListId: string, - prices: { - currency_code: string, - amount: number, - price_set_id: string - }[] -}[]) { - const pricingService = await initializePricingModule() - - const priceLists = await pricingService.addPriceListPrices(items) - - // do something with the price lists or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx deleted file mode 100644 index 49f1ee43f4e14..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx +++ /dev/null @@ -1,645 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/addPrices -sidebar_label: addPrices ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# addPrices - Pricing Module Reference - -This documentation provides a reference to the `addPrices` method. This belongs to the Pricing Module. - -## addPrices(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)> - -This method adds prices to a price set. - -### Example - -To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function addPricesToPriceSet (priceSetId: string) { - const pricingService = await initializePricingModule() - - const priceSet = await pricingService.addPrices({ - priceSetId, - prices: [ - { - amount: 500, - currency_code: "USD", - rules: {}, - }, - ], - }) - - // do something with the price set or return it -} -``` - -To add prices with rules: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function addPricesToPriceSet (priceSetId: string) { - const pricingService = await initializePricingModule() - - const priceSet = await pricingService.addPrices({ - priceSetId, - prices: [ - { - amount: 300, - currency_code: "EUR", - rules: { - region_id: "PL", - city: "krakow" - }, - }, - { - amount: 400, - currency_code: "EUR", - min_quantity: 0, - max_quantity: 4, - rules: { - region_id: "PL" - }, - }, - { - amount: 450, - currency_code: "EUR", - rules: { - city: "krakow" - }, - } - ], - }) - - // do something with the price set or return it -} -``` - -### Parameters - -`", - "description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../pricing/interfaces/pricing.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -### Returns - - - -## addPrices(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]> - -This method adds prices to multiple price sets. - -### Example - -To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function addPricesToPriceSet (priceSetId: string) { - const pricingService = await initializePricingModule() - - const priceSets = await pricingService.addPrices([{ - priceSetId, - prices: [ - { - amount: 500, - currency_code: "USD", - rules: {}, - }, - ], - }]) - - // do something with the price sets or return them -} -``` - -To add prices with rules: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function addPricesToPriceSet (priceSetId: string) { - const pricingService = await initializePricingModule() - - const priceSets = await pricingService.addPrices([{ - priceSetId, - prices: [ - { - amount: 300, - currency_code: "EUR", - rules: { - region_id: "PL", - city: "krakow" - }, - }, - { - amount: 400, - currency_code: "EUR", - min_quantity: 0, - max_quantity: 4, - rules: { - region_id: "PL" - }, - }, - { - amount: 450, - currency_code: "EUR", - rules: { - city: "krakow" - }, - } - ], - }]) - - // do something with the price sets or return them -} -``` - -### Parameters - -`", - "description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../pricing/interfaces/pricing.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -### Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addRules.mdx deleted file mode 100644 index 213e65bbd462c..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addRules.mdx +++ /dev/null @@ -1,437 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/addRules -sidebar_label: addRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# addRules - Pricing Module Reference - -This documentation provides a reference to the `addRules` method. This belongs to the Pricing Module. - -## addRules(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)> - -This method adds rules to a price set. - -### Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function addRulesToPriceSet (priceSetId: string) { - const pricingService = await initializePricingModule() - - const priceSet = await pricingService.addRules({ - priceSetId, - rules: [{ - attribute: "region_id" - }] - }) - - // do something with the price set or return it -} -``` - -### Parameters - - - -### Returns - - - -## addRules(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]> - -This method adds rules to multiple price sets. - -### Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function addRulesToPriceSet (priceSetId: string) { - const pricingService = await initializePricingModule() - - const priceSets = await pricingService.addRules([{ - priceSetId, - rules: [{ - attribute: "region_id" - }] - }]) - - // do something with the price sets or return them -} -``` - -### Parameters - - - -### Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices.mdx deleted file mode 100644 index 1ad5409efb23c..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices.mdx +++ /dev/null @@ -1,218 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/calculatePrices -sidebar_label: calculatePrices ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# calculatePrices - Pricing Module Reference - -This documentation provides a reference to the `calculatePrices` method. This belongs to the Pricing Module. - -This method is used to calculate prices based on the provided filters and context. - -## Example - -When you calculate prices, you must at least specify the currency code: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" -async function calculatePrice (priceSetId: string, currencyCode: string) { - const pricingService = await initializePricingModule() - - const price = await pricingService.calculatePrices( - { id: [priceSetId] }, - { - context: { - currency_code: currencyCode - } - } - ) - - // do something with the price or return it -} -``` - -To calculate prices for specific minimum and/or maximum quantity: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" -async function calculatePrice (priceSetId: string, currencyCode: string) { - const pricingService = await initializePricingModule() - - const price = await pricingService.calculatePrices( - { id: [priceSetId] }, - { - context: { - currency_code: currencyCode, - min_quantity: 4 - } - } - ) - - // do something with the price or return it -} -``` - -To calculate prices for custom rule types: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" -async function calculatePrice (priceSetId: string, currencyCode: string) { - const pricingService = await initializePricingModule() - - const price = await pricingService.calculatePrices( - { id: [priceSetId] }, - { - context: { - currency_code: currencyCode, - region_id: "US" - } - } - ) - - // do something with the price or return it -} -``` - -## Parameters - -`", - "description": "an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../pricing/interfaces/pricing.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.create.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.create.mdx deleted file mode 100644 index 8acd3cb9daea5..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.create.mdx +++ /dev/null @@ -1,680 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/create -sidebar_label: create ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# create - Pricing Module Reference - -This documentation provides a reference to the `create` method. This belongs to the Pricing Module. - -## create(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)> - -This method is used to create a new price set. - -### Example - -To create a default price set, don't pass any rules. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function createPriceSet () { - const pricingService = await initializePricingModule() - - const priceSet = await pricingService.create( - { - rules: [], - prices: [ - { - amount: 500, - currency_code: "USD", - min_quantity: 0, - max_quantity: 4, - rules: {}, - }, - { - amount: 400, - currency_code: "USD", - min_quantity: 5, - max_quantity: 10, - rules: {}, - }, - ], - }, - ) - - // do something with the price set or return it -} -``` - -To create a price set and associate it with rule types: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function createPriceSet () { - const pricingService = await initializePricingModule() - - const priceSet = await pricingService.create( - { - rules: [{ rule_attribute: "region_id" }, { rule_attribute: "city" }], - prices: [ - { - amount: 300, - currency_code: "EUR", - rules: { - region_id: "PL", - city: "krakow" - }, - }, - { - amount: 400, - currency_code: "EUR", - rules: { - region_id: "PL" - }, - }, - { - amount: 450, - currency_code: "EUR", - rules: { - city: "krakow" - }, - } - ], - }, - ) - - // do something with the price set or return it -} -``` - -### Parameters - -`", - "description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "rules", - "type": "`object`[]", - "description": "The rules to associate with the price set.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "rule_attribute", - "type": "`string`", - "description": "the value of the rule's `rule_attribute` attribute.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../pricing/interfaces/pricing.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -### Returns - - - -## create(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]> - -This method is used to create multiple price sets. - -### Example - -To create price sets with a default price, don't pass any rules and make sure to pass the `currency_code` of the price. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function createPriceSets () { - const pricingService = await initializePricingModule() - - const priceSets = await pricingService.create([ - { - rules: [], - prices: [ - { - amount: 500, - currency_code: "USD", - rules: {}, - }, - ], - }, - ]) - - // do something with the price sets or return them -} -``` - -To create price sets and associate them with rule types: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function createPriceSets () { - const pricingService = await initializePricingModule() - - const priceSets = await pricingService.create([ - { - rules: [{ rule_attribute: "region_id" }, { rule_attribute: "city" }], - prices: [ - { - amount: 300, - currency_code: "EUR", - rules: { - region_id: "PL", - city: "krakow" - }, - }, - { - amount: 400, - currency_code: "EUR", - min_quantity: 0, - max_quantity: 4, - rules: { - region_id: "PL" - }, - }, - { - amount: 450, - currency_code: "EUR", - rules: { - city: "krakow" - }, - } - ], - }, - ]) - - // do something with the price sets or return them -} -``` - -### Parameters - -`", - "description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "rules", - "type": "`object`[]", - "description": "The rules to associate with the price set.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "rule_attribute", - "type": "`string`", - "description": "the value of the rule's `rule_attribute` attribute.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../pricing/interfaces/pricing.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -### Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createCurrencies.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createCurrencies.mdx deleted file mode 100644 index 767e2d03f1b6d..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createCurrencies.mdx +++ /dev/null @@ -1,179 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/createCurrencies -sidebar_label: createCurrencies ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createCurrencies - Pricing Module Reference - -This documentation provides a reference to the `createCurrencies` method. This belongs to the Pricing Module. - -This method is used to create new currencies. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function createCurrencies () { - const pricingService = await initializePricingModule() - - const currencies = await pricingService.createCurrencies([ - { - code: "USD", - symbol: "$", - symbol_native: "$", - name: "US Dollar", - } - ]) - - // do something with the currencies or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createMoneyAmounts.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createMoneyAmounts.mdx deleted file mode 100644 index 6d4aeb22b1c8d..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createMoneyAmounts.mdx +++ /dev/null @@ -1,238 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/createMoneyAmounts -sidebar_label: createMoneyAmounts ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createMoneyAmounts - Pricing Module Reference - -This documentation provides a reference to the `createMoneyAmounts` method. This belongs to the Pricing Module. - -This method creates money amounts. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveMoneyAmounts () { - const pricingService = await initializePricingModule() - - const moneyAmounts = await pricingService.createMoneyAmounts([ - { - amount: 500, - currency_code: "USD", - }, - { - amount: 400, - currency_code: "USD", - min_quantity: 0, - max_quantity: 4 - } - ]) - - // do something with the money amounts or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceListRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceListRules.mdx deleted file mode 100644 index 1d10933e272b9..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceListRules.mdx +++ /dev/null @@ -1,175 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/createPriceListRules -sidebar_label: createPriceListRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createPriceListRules - Pricing Module Reference - -This documentation provides a reference to the `createPriceListRules` method. This belongs to the Pricing Module. - -This method is used to create price list rules. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function createPriceListRules (items: { - rule_type_id: string - price_list_id: string -}[]) { - const pricingService = await initializePricingModule() - - const priceListRules = await pricingService.createPriceListRules(items) - - // do something with the price list rule or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists.mdx deleted file mode 100644 index 651e917cd41e6..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists.mdx +++ /dev/null @@ -1,324 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/createPriceLists -sidebar_label: createPriceLists ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createPriceLists - Pricing Module Reference - -This documentation provides a reference to the `createPriceLists` method. This belongs to the Pricing Module. - -This method is used to create price lists. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function createPriceList (items: { - title: string - description: string - starts_at?: string - ends_at?: string -}[]) { - const pricingService = await initializePricingModule() - - const priceList = await pricingService.createPriceLists(items) - - // do something with the price lists or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules.mdx deleted file mode 100644 index b7e6839bd025c..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules.mdx +++ /dev/null @@ -1,206 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/createPriceRules -sidebar_label: createPriceRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createPriceRules - Pricing Module Reference - -This documentation provides a reference to the `createPriceRules` method. This belongs to the Pricing Module. - -This method is used to create new price rules based on the provided data. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function createPriceRules ( - id: string, - priceSetId: string, - ruleTypeId: string, - value: string, - priceSetMoneyAmountId: string, - priceListId: string -) { - const pricingService = await initializePricingModule() - - const priceRules = await pricingService.createPriceRules([ - { - id, - price_set_id: priceSetId, - rule_type_id: ruleTypeId, - value, - price_set_money_amount_id: priceSetMoneyAmountId, - price_list_id: priceListId - } - ]) - - // do something with the price rules or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSetMoneyAmountRules.mdx deleted file mode 100644 index 237411bb2cce6..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSetMoneyAmountRules.mdx +++ /dev/null @@ -1,170 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/createPriceSetMoneyAmountRules -sidebar_label: createPriceSetMoneyAmountRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createPriceSetMoneyAmountRules - Pricing Module Reference - -This documentation provides a reference to the `createPriceSetMoneyAmountRules` method. This belongs to the Pricing Module. - -This method is used to create new price set money amount rules. A price set money amount rule creates an association between a price set money amount and -a rule type. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ruleTypeId: string, value: string) { - const pricingService = await initializePricingModule() - - const priceSetMoneyAmountRules = await pricingService.createPriceSetMoneyAmountRules([ - { - price_set_money_amount: priceSetMoneyAmountId, - rule_type: ruleTypeId, - value - } - ]) - - // do something with the price set money amount rules or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createRuleTypes.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createRuleTypes.mdx deleted file mode 100644 index 977ef6e13795f..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.createRuleTypes.mdx +++ /dev/null @@ -1,177 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/createRuleTypes -sidebar_label: createRuleTypes ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createRuleTypes - Pricing Module Reference - -This documentation provides a reference to the `createRuleTypes` method. This belongs to the Pricing Module. - -This method is used to create new rule types. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function createRuleTypes () { - const pricingService = await initializePricingModule() - - const ruleTypes = await pricingService.createRuleTypes([ - { - name: "Region", - rule_attribute: "region_id" - } - ]) - - // do something with the rule types or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.delete.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.delete.mdx deleted file mode 100644 index d839a01e2896c..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.delete.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/delete -sidebar_label: delete ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# delete - Pricing Module Reference - -This documentation provides a reference to the `delete` method. This belongs to the Pricing Module. - -This method deletes price sets by their IDs. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function removePriceSetRule (priceSetIds: string[]) { - const pricingService = await initializePricingModule() - - await pricingService.delete(priceSetIds) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deleteCurrencies.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deleteCurrencies.mdx deleted file mode 100644 index 94382f77af9bd..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deleteCurrencies.mdx +++ /dev/null @@ -1,114 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/deleteCurrencies -sidebar_label: deleteCurrencies ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteCurrencies - Pricing Module Reference - -This documentation provides a reference to the `deleteCurrencies` method. This belongs to the Pricing Module. - -This method is used to delete currencies based on their currency code. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function deleteCurrencies () { - const pricingService = await initializePricingModule() - - await pricingService.deleteCurrencies(["USD"]) - -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deleteMoneyAmounts.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deleteMoneyAmounts.mdx deleted file mode 100644 index 26cad9b0e94dd..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deleteMoneyAmounts.mdx +++ /dev/null @@ -1,115 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/deleteMoneyAmounts -sidebar_label: deleteMoneyAmounts ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteMoneyAmounts - Pricing Module Reference - -This documentation provides a reference to the `deleteMoneyAmounts` method. This belongs to the Pricing Module. - -This method deletes money amounts by their IDs. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function deleteMoneyAmounts (moneyAmountIds: string[]) { - const pricingService = await initializePricingModule() - - await pricingService.deleteMoneyAmounts( - moneyAmountIds - ) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules.mdx deleted file mode 100644 index 0bccddee15d22..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/deletePriceListRules -sidebar_label: deletePriceListRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deletePriceListRules - Pricing Module Reference - -This documentation provides a reference to the `deletePriceListRules` method. This belongs to the Pricing Module. - -This method is used to delete price list rules. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function deletePriceListRules (priceListRuleIds: string[]) { - const pricingService = await initializePricingModule() - - await pricingService.deletePriceListRules(priceListRuleIds) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists.mdx deleted file mode 100644 index a81beb2e27633..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/deletePriceLists -sidebar_label: deletePriceLists ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deletePriceLists - Pricing Module Reference - -This documentation provides a reference to the `deletePriceLists` method. This belongs to the Pricing Module. - -This method is used to delete price lists. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function deletePriceLists (ids: string[]) { - const pricingService = await initializePricingModule() - - await pricingService.deletePriceLists(ids) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules.mdx deleted file mode 100644 index f2462230d56f1..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules.mdx +++ /dev/null @@ -1,115 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/deletePriceRules -sidebar_label: deletePriceRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deletePriceRules - Pricing Module Reference - -This documentation provides a reference to the `deletePriceRules` method. This belongs to the Pricing Module. - -This method is used to delete price rules based on the specified IDs. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function deletePriceRules ( - id: string, -) { - const pricingService = await initializePricingModule() - - await pricingService.deletePriceRules([id]) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSetMoneyAmountRules.mdx deleted file mode 100644 index fdc06a30a3e4b..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSetMoneyAmountRules.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/deletePriceSetMoneyAmountRules -sidebar_label: deletePriceSetMoneyAmountRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deletePriceSetMoneyAmountRules - Pricing Module Reference - -This documentation provides a reference to the `deletePriceSetMoneyAmountRules` method. This belongs to the Pricing Module. - -This method is used to delete price set money amount rules based on the specified IDs. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function deletePriceSetMoneyAmountRule (id: string) { - const pricingService = await initializePricingModule() - - await pricingService.deletePriceSetMoneyAmountRules([id]) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deleteRuleTypes.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deleteRuleTypes.mdx deleted file mode 100644 index e86120f1e74d6..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.deleteRuleTypes.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/deleteRuleTypes -sidebar_label: deleteRuleTypes ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteRuleTypes - Pricing Module Reference - -This documentation provides a reference to the `deleteRuleTypes` method. This belongs to the Pricing Module. - -This method is used to delete rule types based on the provided IDs. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function deleteRuleTypes (ruleTypeId: string) { - const pricingService = await initializePricingModule() - - await pricingService.deleteRuleTypes([ruleTypeId]) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.list.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.list.mdx deleted file mode 100644 index d9c5841d3de10..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.list.mdx +++ /dev/null @@ -1,361 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/list -sidebar_label: list ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# list - Pricing Module Reference - -This documentation provides a reference to the `list` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of price sets based on optional filters and configuration. - -## Example - -To retrieve a list of price sets using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSets (priceSetIds: string[]) { - const pricingService = await initializePricingModule() - - const priceSets = await pricingService.list( - { - id: priceSetIds - }, - ) - - // do something with the price sets or return them -} -``` - -To specify relations that should be retrieved within the price sets: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSets (priceSetIds: string[]) { - const pricingService = await initializePricingModule() - - const priceSets = await pricingService.list( - { - id: priceSetIds - }, - { - relations: ["money_amounts"] - } - ) - - // do something with the price sets or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSets (priceSetIds: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const priceSets = await pricingService.list( - { - id: priceSetIds - }, - { - relations: ["money_amounts"], - skip, - take - } - ) - - // do something with the price sets or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const priceSets = await pricingService.list( - { - $and: [ - { - id: priceSetIds - }, - { - money_amounts: { - id: moneyAmountIds - } - } - ] - }, - { - relations: ["money_amounts"], - skip, - take - } - ) - - // do something with the price sets or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCount.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCount.mdx deleted file mode 100644 index 749f338bd5e90..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCount.mdx +++ /dev/null @@ -1,360 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listAndCount -sidebar_label: listAndCount ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCount - Pricing Module Reference - -This documentation provides a reference to the `listAndCount` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of price sets along with the total count of available price sets satisfying the provided filters. - -## Example - -To retrieve a list of prices sets using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSets (priceSetIds: string[]) { - const pricingService = await initializePricingModule() - - const [priceSets, count] = await pricingService.listAndCount( - { - id: priceSetIds - }, - ) - - // do something with the price sets or return them -} -``` - -To specify relations that should be retrieved within the price sets: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSets (priceSetIds: string[]) { - const pricingService = await initializePricingModule() - - const [priceSets, count] = await pricingService.listAndCount( - { - id: priceSetIds - }, - { - relations: ["money_amounts"] - } - ) - - // do something with the price sets or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSets (priceSetIds: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [priceSets, count] = await pricingService.listAndCount( - { - id: priceSetIds - }, - { - relations: ["money_amounts"], - skip, - take - } - ) - - // do something with the price sets or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [priceSets, count] = await pricingService.listAndCount( - { - $and: [ - { - id: priceSetIds - }, - { - money_amounts: { - id: moneyAmountIds - } - } - ] - }, - { - relations: ["money_amounts"], - skip, - take - } - ) - - // do something with the price sets or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountCurrencies.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountCurrencies.mdx deleted file mode 100644 index 47fcb067840f2..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountCurrencies.mdx +++ /dev/null @@ -1,280 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listAndCountCurrencies -sidebar_label: listAndCountCurrencies ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountCurrencies - Pricing Module Reference - -This documentation provides a reference to the `listAndCountCurrencies` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of currencies along with the total count of available currencies satisfying the provided filters. - -## Example - -To retrieve a list of currencies using their codes: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveCurrencies (codes: string[]) { - const pricingService = await initializePricingModule() - - const [currencies, count] = await pricingService.listAndCountCurrencies( - { - code: codes - }, - ) - - // do something with the currencies or return them -} -``` - -To specify attributes that should be retrieved within the money amounts: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveCurrencies (codes: string[]) { - const pricingService = await initializePricingModule() - - const [currencies, count] = await pricingService.listAndCountCurrencies( - { - code: codes - }, - { - select: ["symbol_native"] - } - ) - - // do something with the currencies or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveCurrencies (codes: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [currencies, count] = await pricingService.listAndCountCurrencies( - { - code: codes - }, - { - select: ["symbol_native"], - skip, - take - } - ) - - // do something with the currencies or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountMoneyAmounts.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountMoneyAmounts.mdx deleted file mode 100644 index c8f0a8a755f45..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountMoneyAmounts.mdx +++ /dev/null @@ -1,321 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listAndCountMoneyAmounts -sidebar_label: listAndCountMoneyAmounts ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountMoneyAmounts - Pricing Module Reference - -This documentation provides a reference to the `listAndCountMoneyAmounts` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of money amounts along with the total count of available money amounts satisfying the provided filters. - -## Example - -To retrieve a list of money amounts using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveMoneyAmounts (moneyAmountIds: string[]) { - const pricingService = await initializePricingModule() - - const [moneyAmounts, count] = await pricingService.listAndCountMoneyAmounts( - { - id: moneyAmountIds - } - ) - - // do something with the money amounts or return them -} -``` - -To specify relations that should be retrieved within the money amounts: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveMoneyAmounts (moneyAmountIds: string[]) { - const pricingService = await initializePricingModule() - - const [moneyAmounts, count] = await pricingService.listAndCountMoneyAmounts( - { - id: moneyAmountIds - }, - { - relations: ["currency"] - } - ) - - // do something with the money amounts or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveMoneyAmounts (moneyAmountIds: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [moneyAmounts, count] = await pricingService.listAndCountMoneyAmounts( - { - id: moneyAmountIds - }, - { - relations: ["currency"], - skip, - take - } - ) - - // do something with the money amounts or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [moneyAmounts, count] = await pricingService.listAndCountMoneyAmounts( - { - $and: [ - { - id: moneyAmountIds - }, - { - currency_code: currencyCode - } - ] - }, - { - relations: ["currency"], - skip, - take - } - ) - - // do something with the money amounts or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules.mdx deleted file mode 100644 index e655997dfa9c0..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules.mdx +++ /dev/null @@ -1,339 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listAndCountPriceListRules -sidebar_label: listAndCountPriceListRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountPriceListRules - Pricing Module Reference - -This documentation provides a reference to the `listAndCountPriceListRules` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of price list ruless along with the total count of available price list ruless satisfying the provided filters. - -## Example - -To retrieve a list of price list vs using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function listAndCountPriceListRules (priceListRuleIds: string[]) { - const pricingService = await initializePricingModule() - - const [priceListRules, count] = await pricingService.listAndCountPriceListRules( - { - id: priceListRuleIds - }, - ) - - // do something with the price list rules or return them -} -``` - -To specify relations that should be retrieved within the price list rules: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function listAndCountPriceListRules (priceListRuleIds: string[]) { - const pricingService = await initializePricingModule() - - const [priceListRules, count] = await pricingService.listAndCountPriceListRules( - { - id: priceListRuleIds - }, - { - relations: ["price_list_rule_values"] - } - ) - - // do something with the price list rules or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function listAndCountPriceListRules (priceListRuleIds: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [priceListRules, count] = await pricingService.listAndCountPriceListRules( - { - id: priceListRuleIds - }, - { - relations: ["price_list_rule_values"], - skip, - take - } - ) - - // do something with the price list rules or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function listAndCountPriceListRules (priceListRuleIds: string[], ruleTypeIDs: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [priceListRules, count] = await pricingService.listAndCountPriceListRules( - { - $and: [ - { - id: priceListRuleIds - }, - { - rule_types: ruleTypeIDs - } - ] - }, - { - relations: ["price_list_rule_values"], - skip, - take - } - ) - - // do something with the price list rules or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists.mdx deleted file mode 100644 index 17ebb31b235e7..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists.mdx +++ /dev/null @@ -1,367 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listAndCountPriceLists -sidebar_label: listAndCountPriceLists ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountPriceLists - Pricing Module Reference - -This documentation provides a reference to the `listAndCountPriceLists` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of price lists along with the total count of available price lists satisfying the provided filters. - -## Example - -To retrieve a list of price lists using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceLists (priceListIds: string[]) { - const pricingService = await initializePricingModule() - - const [priceLists, count] = await pricingService.listPriceLists( - { - id: priceListIds - }, - ) - - // do something with the price lists or return them -} -``` - -To specify relations that should be retrieved within the price lists: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceLists (priceListIds: string[]) { - const pricingService = await initializePricingModule() - - const [priceLists, count] = await pricingService.listPriceLists( - { - id: priceListIds - }, - { - relations: ["price_set_money_amounts"] - } - ) - - // do something with the price lists or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceLists (priceListIds: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [priceLists, count] = await pricingService.listPriceLists( - { - id: priceListIds - }, - { - relations: ["price_set_money_amounts"], - skip, - take - } - ) - - // do something with the price lists or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceLists (priceListIds: string[], titles: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [priceLists, count] = await pricingService.listPriceLists( - { - $and: [ - { - id: priceListIds - }, - { - title: titles - } - ] - }, - { - relations: ["price_set_money_amounts"], - skip, - take - } - ) - - // do something with the price lists or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules.mdx deleted file mode 100644 index 729e186c076d1..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules.mdx +++ /dev/null @@ -1,328 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listAndCountPriceRules -sidebar_label: listAndCountPriceRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountPriceRules - Pricing Module Reference - -This documentation provides a reference to the `listAndCountPriceRules` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of price rules along with the total count of available price rules satisfying the provided filters. - -## Example - -To retrieve a list of price rules using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceRules (id: string) { - const pricingService = await initializePricingModule() - - const [priceRules, count] = await pricingService.listAndCountPriceRules({ - id: [id] - }) - - // do something with the price rules or return them -} -``` - -To specify relations that should be retrieved within the price rules: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceRules (id: string) { - const pricingService = await initializePricingModule() - - const [priceRules, count] = await pricingService.listAndCountPriceRules({ - id: [id], - }, { - relations: ["price_set"] - }) - - // do something with the price rules or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceRules (id: string, skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [priceRules, count] = await pricingService.listAndCountPriceRules({ - id: [id], - }, { - relations: ["price_set"], - skip, - take - }) - - // do something with the price rules or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceRules (ids: string[], name: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [priceRules, count] = await pricingService.listAndCountPriceRules({ - $and: [ - { - id: ids - }, - { - name - } - ] - }, { - relations: ["price_set"], - skip, - take - }) - - // do something with the price rules or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx deleted file mode 100644 index b33b275ea2eb2..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx +++ /dev/null @@ -1,329 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listAndCountPriceSetMoneyAmountRules -sidebar_label: listAndCountPriceSetMoneyAmountRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountPriceSetMoneyAmountRules - Pricing Module Reference - -This documentation provides a reference to the `listAndCountPriceSetMoneyAmountRules` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of price set money amount rules along with the total count of -available price set money amount rules satisfying the provided filters. - -## Example - -To retrieve a list of price set money amounts using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmountRules (id: string) { - const pricingService = await initializePricingModule() - - const [priceSetMoneyAmountRules, count] = await pricingService.listAndCountPriceSetMoneyAmountRules({ - id: [id] - }) - - // do something with the price set money amount rules or return them -} -``` - -To specify relations that should be retrieved within the price set money amount rules: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmountRules (id: string) { - const pricingService = await initializePricingModule() - - const [priceSetMoneyAmountRules, count] = await pricingService.listAndCountPriceSetMoneyAmountRules({ - id: [id] - }, { - relations: ["price_set_money_amount"], - }) - - // do something with the price set money amount rules or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmountRules (id: string, skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [priceSetMoneyAmountRules, count] = await pricingService.listAndCountPriceSetMoneyAmountRules({ - id: [id] - }, { - relations: ["price_set_money_amount"], - skip, - take - }) - - // do something with the price set money amount rules or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [priceSetMoneyAmountRules, count] = await pricingService.listAndCountPriceSetMoneyAmountRules({ - $and: [ - { - id: ids - }, - { - rule_type_id: ruleTypeId - } - ] - }, { - relations: ["price_set_money_amount"], - skip, - take - }) - - // do something with the price set money amount rules or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx deleted file mode 100644 index bde77c0f190ee..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx +++ /dev/null @@ -1,320 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listAndCountPriceSetMoneyAmounts -sidebar_label: listAndCountPriceSetMoneyAmounts ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountPriceSetMoneyAmounts - Pricing Module Reference - -This documentation provides a reference to the `listAndCountPriceSetMoneyAmounts` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of price set money amounts along with the total count of -available price set money amounts satisfying the provided filters. - -## Example - -To retrieve a list of price set money amounts using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmounts (id: string) { - const pricingService = await initializePricingModule() - - const [priceSetMoneyAmounts, count] = await pricingService.listAndCountPriceSetMoneyAmounts({ - id: [id] - }) - - // do something with the price set money amounts or return them -} -``` - -To specify relations that should be retrieved within the price set money amounts: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmounts (id: string) { - const pricingService = await initializePricingModule() - - const [priceSetMoneyAmounts, count] = await pricingService.listAndCountPriceSetMoneyAmounts({ - id: [id] - }, { - relations: ["price_rules"], - }) - - // do something with the price set money amounts or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmounts (id: string, skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [priceSetMoneyAmounts, count] = await pricingService.listAndCountPriceSetMoneyAmounts({ - id: [id] - }, { - relations: ["price_rules"], - skip, - take - }) - - // do something with the price set money amounts or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [priceSetMoneyAmounts, count] = await pricingService.listAndCountPriceSetMoneyAmounts({ - $and: [ - { - id: ids - }, - { - title: titles - } - ] - }, { - relations: ["price_rules"], - skip, - take - }) - - // do something with the price set money amounts or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountRuleTypes.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountRuleTypes.mdx deleted file mode 100644 index 17e07119a4f51..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountRuleTypes.mdx +++ /dev/null @@ -1,325 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listAndCountRuleTypes -sidebar_label: listAndCountRuleTypes ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountRuleTypes - Pricing Module Reference - -This documentation provides a reference to the `listAndCountRuleTypes` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of rule types along with the total count of available rule types satisfying the provided filters. - -## Example - -To retrieve a list of rule types using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveRuleTypes (ruleTypeId: string) { - const pricingService = await initializePricingModule() - - const [ruleTypes, count] = await pricingService.listAndCountRuleTypes({ - id: [ - ruleTypeId - ] - }) - - // do something with the rule types or return them -} -``` - -To specify attributes that should be retrieved within the rule types: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveRuleTypes (ruleTypeId: string) { - const pricingService = await initializePricingModule() - - const [ruleTypes, count] = await pricingService.listAndCountRuleTypes({ - id: [ - ruleTypeId - ] - }, { - select: ["name"] - }) - - // do something with the rule types or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveRuleTypes (ruleTypeId: string, skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [ruleTypes, count] = await pricingService.listAndCountRuleTypes({ - id: [ - ruleTypeId - ] - }, { - select: ["name"], - skip, - take - }) - - // do something with the rule types or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const [ruleTypes, count] = await pricingService.listAndCountRuleTypes({ - $and: [ - { - id: ruleTypeId - }, - { - name - } - ] - }, { - select: ["name"], - skip, - take - }) - - // do something with the rule types or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listCurrencies.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listCurrencies.mdx deleted file mode 100644 index 624f0ac8164fd..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listCurrencies.mdx +++ /dev/null @@ -1,281 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listCurrencies -sidebar_label: listCurrencies ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listCurrencies - Pricing Module Reference - -This documentation provides a reference to the `listCurrencies` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of currencies based on optional filters and configuration. - -## Example - -To retrieve a list of currencies using their codes: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveCurrencies (codes: string[]) { - const pricingService = await initializePricingModule() - - const currencies = await pricingService.listCurrencies( - { - code: codes - }, - ) - - // do something with the currencies or return them -} -``` - -To specify attributes that should be retrieved within the money amounts: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveCurrencies (codes: string[]) { - const pricingService = await initializePricingModule() - - const currencies = await pricingService.listCurrencies( - { - code: codes - }, - { - select: ["symbol_native"] - } - ) - - // do something with the currencies or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveCurrencies (codes: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const currencies = await pricingService.listCurrencies( - { - code: codes - }, - { - select: ["symbol_native"], - skip, - take - } - ) - - // do something with the currencies or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listMoneyAmounts.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listMoneyAmounts.mdx deleted file mode 100644 index 7aa95ce4a6d09..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listMoneyAmounts.mdx +++ /dev/null @@ -1,322 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listMoneyAmounts -sidebar_label: listMoneyAmounts ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listMoneyAmounts - Pricing Module Reference - -This documentation provides a reference to the `listMoneyAmounts` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of money amounts based on optional filters and configuration. - -## Example - -To retrieve a list of money amounts using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveMoneyAmounts (moneyAmountIds: string[]) { - const pricingService = await initializePricingModule() - - const moneyAmounts = await pricingService.listMoneyAmounts( - { - id: moneyAmountIds - } - ) - - // do something with the money amounts or return them -} -``` - -To specify relations that should be retrieved within the money amounts: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveMoneyAmounts (moneyAmountIds: string[]) { - const pricingService = await initializePricingModule() - - const moneyAmounts = await pricingService.listMoneyAmounts( - { - id: moneyAmountIds - }, - { - relations: ["currency"] - } - ) - - // do something with the money amounts or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveMoneyAmounts (moneyAmountIds: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const moneyAmounts = await pricingService.listMoneyAmounts( - { - id: moneyAmountIds - }, - { - relations: ["currency"], - skip, - take - } - ) - - // do something with the money amounts or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const moneyAmounts = await pricingService.listMoneyAmounts( - { - $and: [ - { - id: moneyAmountIds - }, - { - currency_code: currencyCode - } - ] - }, - { - relations: ["currency"], - skip, - take - } - ) - - // do something with the money amounts or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules.mdx deleted file mode 100644 index 257d377a08b7c..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules.mdx +++ /dev/null @@ -1,340 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listPriceListRules -sidebar_label: listPriceListRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listPriceListRules - Pricing Module Reference - -This documentation provides a reference to the `listPriceListRules` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of price list rules based on optional filters and configuration. - -## Example - -To retrieve a list of price list vs using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function listPriceListRules (priceListRuleIds: string[]) { - const pricingService = await initializePricingModule() - - const priceListRules = await pricingService.listPriceListRules( - { - id: priceListRuleIds - }, - ) - - // do something with the price list rules or return them -} -``` - -To specify relations that should be retrieved within the price list rules: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function listPriceListRules (priceListRuleIds: string[]) { - const pricingService = await initializePricingModule() - - const priceListRules = await pricingService.listPriceListRules( - { - id: priceListRuleIds - }, - { - relations: ["price_list_rule_values"] - } - ) - - // do something with the price list rules or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function listPriceListRules (priceListRuleIds: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const priceListRules = await pricingService.listPriceListRules( - { - id: priceListRuleIds - }, - { - relations: ["price_list_rule_values"], - skip, - take - } - ) - - // do something with the price list rules or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function listPriceListRules (priceListRuleIds: string[], ruleTypeIDs: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const priceListRules = await pricingService.listPriceListRules( - { - $and: [ - { - id: priceListRuleIds - }, - { - rule_types: ruleTypeIDs - } - ] - }, - { - relations: ["price_list_rule_values"], - skip, - take - } - ) - - // do something with the price list rules or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists.mdx deleted file mode 100644 index d97160f409162..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists.mdx +++ /dev/null @@ -1,368 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listPriceLists -sidebar_label: listPriceLists ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listPriceLists - Pricing Module Reference - -This documentation provides a reference to the `listPriceLists` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of price lists based on optional filters and configuration. - -## Example - -To retrieve a list of price lists using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function listPriceLists (priceListIds: string[]) { - const pricingService = await initializePricingModule() - - const priceLists = await pricingService.listPriceLists( - { - id: priceListIds - }, - ) - - // do something with the price lists or return them -} -``` - -To specify relations that should be retrieved within the price lists: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function listPriceLists (priceListIds: string[]) { - const pricingService = await initializePricingModule() - - const priceLists = await pricingService.listPriceLists( - { - id: priceListIds - }, - { - relations: ["price_set_money_amounts"] - } - ) - - // do something with the price lists or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function listPriceLists (priceListIds: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const priceLists = await pricingService.listPriceLists( - { - id: priceListIds - }, - { - relations: ["price_set_money_amounts"], - skip, - take - } - ) - - // do something with the price lists or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function listPriceLists (priceListIds: string[], titles: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const priceLists = await pricingService.listPriceLists( - { - $and: [ - { - id: priceListIds - }, - { - title: titles - } - ] - }, - { - relations: ["price_set_money_amounts"], - skip, - take - } - ) - - // do something with the price lists or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules.mdx deleted file mode 100644 index 004eb30c10e0a..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules.mdx +++ /dev/null @@ -1,329 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listPriceRules -sidebar_label: listPriceRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listPriceRules - Pricing Module Reference - -This documentation provides a reference to the `listPriceRules` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of price rules based on optional filters and configuration. - -## Example - -To retrieve a list of price rules using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceRules (id: string) { - const pricingService = await initializePricingModule() - - const priceRules = await pricingService.listPriceRules({ - id: [id] - }) - - // do something with the price rules or return them -} -``` - -To specify relations that should be retrieved within the price rules: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceRules (id: string) { - const pricingService = await initializePricingModule() - - const priceRules = await pricingService.listPriceRules({ - id: [id], - }, { - relations: ["price_set"] - }) - - // do something with the price rules or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceRules (id: string, skip: number, take: number) { - const pricingService = await initializePricingModule() - - const priceRules = await pricingService.listPriceRules({ - id: [id], - }, { - relations: ["price_set"], - skip, - take - }) - - // do something with the price rules or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceRules (ids: string[], name: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const priceRules = await pricingService.listPriceRules({ - $and: [ - { - id: ids - }, - { - name - } - ] - }, { - relations: ["price_set"], - skip, - take - }) - - // do something with the price rules or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmountRules.mdx deleted file mode 100644 index e0555472f3e6e..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmountRules.mdx +++ /dev/null @@ -1,329 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listPriceSetMoneyAmountRules -sidebar_label: listPriceSetMoneyAmountRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listPriceSetMoneyAmountRules - Pricing Module Reference - -This documentation provides a reference to the `listPriceSetMoneyAmountRules` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of price set money amount rules based on optional filters and configuration. - -## Example - -To retrieve a list of price set money amount rules using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmountRules (id: string) { - const pricingService = await initializePricingModule() - - const priceSetMoneyAmountRules = await pricingService.listPriceSetMoneyAmountRules({ - id: [id] - }) - - // do something with the price set money amount rules or return them -} -``` - -To specify relations that should be retrieved within the price set money amount rules: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmountRules (id: string) { - const pricingService = await initializePricingModule() - - const priceSetMoneyAmountRules = await pricingService.listPriceSetMoneyAmountRules({ - id: [id] - }, { - relations: ["price_set_money_amount"] - }) - - // do something with the price set money amount rules or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmountRules (id: string, skip: number, take: number) { - const pricingService = await initializePricingModule() - - const priceSetMoneyAmountRules = await pricingService.listPriceSetMoneyAmountRules({ - id: [id] - }, { - relations: ["price_set_money_amount"], - skip, - take - }) - - // do something with the price set money amount rules or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const priceSetMoneyAmountRules = await pricingService.listPriceSetMoneyAmountRules({ - $and: [ - { - id: ids - }, - { - rule_type_id: ruleTypeId - } - ] - }, { - relations: ["price_set_money_amount"], - skip, - take - }) - - // do something with the price set money amount rules or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmounts.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmounts.mdx deleted file mode 100644 index 6dcd060e81e92..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmounts.mdx +++ /dev/null @@ -1,320 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listPriceSetMoneyAmounts -sidebar_label: listPriceSetMoneyAmounts ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listPriceSetMoneyAmounts - Pricing Module Reference - -This documentation provides a reference to the `listPriceSetMoneyAmounts` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of price set money amounts based on optional filters and configuration. - -## Example - -To retrieve a list of price set money amounts using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmounts (id: string) { - const pricingService = await initializePricingModule() - - const priceSetMoneyAmounts = await pricingService.listPriceSetMoneyAmounts({ - id: [id] - }) - - // do something with the price set money amounts or return them -} -``` - -To specify relations that should be retrieved within the price set money amounts: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmounts (id: string) { - const pricingService = await initializePricingModule() - - const priceSetMoneyAmounts = await pricingService.listPriceSetMoneyAmounts({ - id: [id] - }, { - relations: ["price_rules"] - }) - - // do something with the price set money amounts or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmounts (id: string, skip: number, take: number) { - const pricingService = await initializePricingModule() - - const priceSetMoneyAmounts = await pricingService.listPriceSetMoneyAmounts({ - id: [id] - }, { - relations: ["price_rules"], - skip, - take - }) - - // do something with the price set money amounts or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const priceSetMoneyAmounts = await pricingService.listPriceSetMoneyAmounts({ - $and: [ - { - id: ids - }, - { - title: titles - } - ] - }, { - relations: ["price_rules"], - skip, - take - }) - - // do something with the price set money amounts or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listRuleTypes.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listRuleTypes.mdx deleted file mode 100644 index 16c4432122977..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.listRuleTypes.mdx +++ /dev/null @@ -1,326 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/listRuleTypes -sidebar_label: listRuleTypes ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listRuleTypes - Pricing Module Reference - -This documentation provides a reference to the `listRuleTypes` method. This belongs to the Pricing Module. - -This method is used to retrieve a paginated list of rule types based on optional filters and configuration. - -## Example - -To retrieve a list of rule types using their IDs: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveRuleTypes (ruleTypeId: string) { - const pricingService = await initializePricingModule() - - const ruleTypes = await pricingService.listRuleTypes({ - id: [ - ruleTypeId - ] - }) - - // do something with the rule types or return them -} -``` - -To specify attributes that should be retrieved within the rule types: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveRuleTypes (ruleTypeId: string) { - const pricingService = await initializePricingModule() - - const ruleTypes = await pricingService.listRuleTypes({ - id: [ - ruleTypeId - ] - }, { - select: ["name"] - }) - - // do something with the rule types or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveRuleTypes (ruleTypeId: string, skip: number, take: number) { - const pricingService = await initializePricingModule() - - const ruleTypes = await pricingService.listRuleTypes({ - id: [ - ruleTypeId - ] - }, { - select: ["name"], - skip, - take - }) - - // do something with the rule types or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: number, take: number) { - const pricingService = await initializePricingModule() - - const ruleTypes = await pricingService.listRuleTypes({ - $and: [ - { - id: ruleTypeId - }, - { - name - } - ] - }, { - select: ["name"], - skip, - take - }) - - // do something with the rule types or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules.mdx deleted file mode 100644 index 32c76bcb91b45..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules.mdx +++ /dev/null @@ -1,513 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/removePriceListRules -sidebar_label: removePriceListRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# removePriceListRules - Pricing Module Reference - -This documentation provides a reference to the `removePriceListRules` method. This belongs to the Pricing Module. - -This method is used to remove rules from a price list. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function setPriceListRules (priceListId: string) { - const pricingService = await initializePricingModule() - - const priceList = await pricingService.removePriceListRules({ - priceListId, - rules: ["region_id"] - }) - - // do something with the price list or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.removeRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.removeRules.mdx deleted file mode 100644 index f3465bf9332ac..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.removeRules.mdx +++ /dev/null @@ -1,137 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/removeRules -sidebar_label: removeRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# removeRules - Pricing Module Reference - -This documentation provides a reference to the `removeRules` method. This belongs to the Pricing Module. - -This method remove rules from a price set. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function removePriceSetRule (priceSetId: string, ruleAttributes: []) { - const pricingService = await initializePricingModule() - - await pricingService.removeRules([ - { - id: priceSetId, - rules: ruleAttributes - }, - ]) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieve.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieve.mdx deleted file mode 100644 index 44945d9e41711..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieve.mdx +++ /dev/null @@ -1,333 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/retrieve -sidebar_label: retrieve ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieve - Pricing Module Reference - -This documentation provides a reference to the `retrieve` method. This belongs to the Pricing Module. - -This method is used to retrieve a price set by its ID. - -## Example - -A simple example that retrieves a price set by its ID: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSet (priceSetId: string) { - const pricingService = await initializePricingModule() - - const priceSet = await pricingService.retrieve( - priceSetId - ) - - // do something with the price set or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSet (priceSetId: string) { - const pricingService = await initializePricingModule() - - const priceSet = await pricingService.retrieve( - priceSetId, - { - relations: ["money_amounts"] - } - ) - - // do something with the price set or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveCurrency.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveCurrency.mdx deleted file mode 100644 index 1325c2e92ea1a..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveCurrency.mdx +++ /dev/null @@ -1,241 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/retrieveCurrency -sidebar_label: retrieveCurrency ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveCurrency - Pricing Module Reference - -This documentation provides a reference to the `retrieveCurrency` method. This belongs to the Pricing Module. - -This method retrieves a currency by its code and and optionally based on the provided configurations. - -## Example - -A simple example that retrieves a currency by its code: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveCurrency (code: string) { - const pricingService = await initializePricingModule() - - const currency = await pricingService.retrieveCurrency( - code - ) - - // do something with the currency or return it -} -``` - -To specify attributes that should be retrieved: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveCurrency (code: string) { - const pricingService = await initializePricingModule() - - const currency = await pricingService.retrieveCurrency( - code, - { - select: ["symbol_native"] - } - ) - - // do something with the currency or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveMoneyAmount.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveMoneyAmount.mdx deleted file mode 100644 index 6b5e37529583a..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveMoneyAmount.mdx +++ /dev/null @@ -1,369 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/retrieveMoneyAmount -sidebar_label: retrieveMoneyAmount ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveMoneyAmount - Pricing Module Reference - -This documentation provides a reference to the `retrieveMoneyAmount` method. This belongs to the Pricing Module. - -This method retrieves a money amount by its ID. - -## Example - -To retrieve a money amount by its ID: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveMoneyAmount (moneyAmountId: string) { - const pricingService = await initializePricingModule() - - const moneyAmount = await pricingService.retrieveMoneyAmount( - moneyAmountId, - ) - - // do something with the money amount or return it -} -``` - -To retrieve relations along with the money amount: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveMoneyAmount (moneyAmountId: string) { - const pricingService = await initializePricingModule() - - const moneyAmount = await pricingService.retrieveMoneyAmount( - moneyAmountId, - { - relations: ["currency"] - } - ) - - // do something with the money amount or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList.mdx deleted file mode 100644 index c52008b6ee378..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList.mdx +++ /dev/null @@ -1,580 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/retrievePriceList -sidebar_label: retrievePriceList ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrievePriceList - Pricing Module Reference - -This documentation provides a reference to the `retrievePriceList` method. This belongs to the Pricing Module. - -This method is used to retrieve a price list by its ID. - -## Example - -A simple example that retrieves a price list by its ID: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceList (priceListId: string) { - const pricingService = await initializePricingModule() - - const priceList = await pricingService.retrievePriceList( - priceListId - ) - - // do something with the price list or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceList (priceListId: string) { - const pricingService = await initializePricingModule() - - const priceList = await pricingService.retrievePriceList( - priceListId, - { - relations: ["price_set_money_amounts"] - } - ) - - // do something with the price list or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule.mdx deleted file mode 100644 index bbdb8e958d6da..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule.mdx +++ /dev/null @@ -1,415 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/retrievePriceListRule -sidebar_label: retrievePriceListRule ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrievePriceListRule - Pricing Module Reference - -This documentation provides a reference to the `retrievePriceListRule` method. This belongs to the Pricing Module. - -This method is used to retrieve a price list rule by its ID. - -## Example - -A simple example that retrieves a price list rule by its ID: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceListRule (priceListRuleId: string) { - const pricingService = await initializePricingModule() - - const priceListRule = await pricingService.retrievePriceListRule( - priceListRuleId - ) - - // do something with the price list rule or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceListRule (priceListRuleId: string) { - const pricingService = await initializePricingModule() - - const priceListRule = await pricingService.retrievePriceListRule( - priceListRuleId, - { - relations: ["price_list"] - } - ) - - // do something with the price list rule or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule.mdx deleted file mode 100644 index 1e484cb7eb04b..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule.mdx +++ /dev/null @@ -1,346 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/retrievePriceRule -sidebar_label: retrievePriceRule ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrievePriceRule - Pricing Module Reference - -This documentation provides a reference to the `retrievePriceRule` method. This belongs to the Pricing Module. - -This method is used to retrieve a price rule by its ID. - -## Example - -A simple example that retrieves a price rule by its ID: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceRule (id: string) { - const pricingService = await initializePricingModule() - - const priceRule = await pricingService.retrievePriceRule(id) - - // do something with the price rule or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceRule (id: string) { - const pricingService = await initializePricingModule() - - const priceRule = await pricingService.retrievePriceRule(id, { - relations: ["price_set"] - }) - - // do something with the price rule or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx deleted file mode 100644 index ff2aea10b02c2..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx +++ /dev/null @@ -1,337 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/retrievePriceSetMoneyAmountRules -sidebar_label: retrievePriceSetMoneyAmountRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrievePriceSetMoneyAmountRules - Pricing Module Reference - -This documentation provides a reference to the `retrievePriceSetMoneyAmountRules` method. This belongs to the Pricing Module. - -This method is used to a price set money amount rule by its ID based on the provided configuration. - -## Example - -A simple example that retrieves a price set money amount rule by its ID: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmountRule (id: string) { - const pricingService = await initializePricingModule() - - const priceSetMoneyAmountRule = await pricingService.retrievePriceSetMoneyAmountRules(id) - - // do something with the price set money amount rule or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrievePriceSetMoneyAmountRule (id: string) { - const pricingService = await initializePricingModule() - - const priceSetMoneyAmountRule = await pricingService.retrievePriceSetMoneyAmountRules(id, { - relations: ["price_set_money_amount"] - }) - - // do something with the price set money amount rule or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveRuleType.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveRuleType.mdx deleted file mode 100644 index 18079954ff4ad..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.retrieveRuleType.mdx +++ /dev/null @@ -1,236 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/retrieveRuleType -sidebar_label: retrieveRuleType ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveRuleType - Pricing Module Reference - -This documentation provides a reference to the `retrieveRuleType` method. This belongs to the Pricing Module. - -This method is used to retrieve a rule type by its ID and and optionally based on the provided configurations. - -## Example - -A simple example that retrieves a rule type by its code: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveRuleType (ruleTypeId: string) { - const pricingService = await initializePricingModule() - - const ruleType = await pricingService.retrieveRuleType(ruleTypeId) - - // do something with the rule type or return it -} -``` - -To specify attributes that should be retrieved: - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function retrieveRuleType (ruleTypeId: string) { - const pricingService = await initializePricingModule() - - const ruleType = await pricingService.retrieveRuleType(ruleTypeId, { - select: ["name"] - }) - - // do something with the rule type or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules.mdx deleted file mode 100644 index 43304a7e8cb22..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules.mdx +++ /dev/null @@ -1,515 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/setPriceListRules -sidebar_label: setPriceListRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# setPriceListRules - Pricing Module Reference - -This documentation provides a reference to the `setPriceListRules` method. This belongs to the Pricing Module. - -This method is used to set the rules of a price list. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function setPriceListRules (priceListId: string) { - const pricingService = await initializePricingModule() - - const priceList = await pricingService.setPriceListRules({ - priceListId, - rules: { - region_id: "US" - } - }) - - // do something with the price list or return it -} -``` - -## Parameters - -`", - "description": "The rules to add to the price list. Each key of the object is a rule type's `rule_attribute`, and its value\nis the value(s) of the rule.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../pricing/interfaces/pricing.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updateCurrencies.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updateCurrencies.mdx deleted file mode 100644 index e9248d3310733..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updateCurrencies.mdx +++ /dev/null @@ -1,177 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/updateCurrencies -sidebar_label: updateCurrencies ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateCurrencies - Pricing Module Reference - -This documentation provides a reference to the `updateCurrencies` method. This belongs to the Pricing Module. - -This method is used to update existing currencies with the provided data. In each currency object, the currency code must be provided to identify which currency to update. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function updateCurrencies () { - const pricingService = await initializePricingModule() - - const currencies = await pricingService.updateCurrencies([ - { - code: "USD", - symbol: "$", - } - ]) - - // do something with the currencies or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updateMoneyAmounts.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updateMoneyAmounts.mdx deleted file mode 100644 index 241fd0365f7e0..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updateMoneyAmounts.mdx +++ /dev/null @@ -1,186 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/updateMoneyAmounts -sidebar_label: updateMoneyAmounts ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateMoneyAmounts - Pricing Module Reference - -This documentation provides a reference to the `updateMoneyAmounts` method. This belongs to the Pricing Module. - -This method updates existing money amounts. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function updateMoneyAmounts (moneyAmountId: string, amount: number) { - const pricingService = await initializePricingModule() - - const moneyAmounts = await pricingService.updateMoneyAmounts([ - { - id: moneyAmountId, - amount - } - ]) - - // do something with the money amounts or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListRules.mdx deleted file mode 100644 index 1d5600df58819..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListRules.mdx +++ /dev/null @@ -1,185 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/updatePriceListRules -sidebar_label: updatePriceListRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updatePriceListRules - Pricing Module Reference - -This documentation provides a reference to the `updatePriceListRules` method. This belongs to the Pricing Module. - -This method is used to update price list rules. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function updatePriceListRules (items: { - id: string - rule_type_id?: string - price_list_id?: string -}[]) { - const pricingService = await initializePricingModule() - - const priceListRules = await pricingService.updatePriceListRules(items) - - // do something with the price list rule or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists.mdx deleted file mode 100644 index 282fd3bc8b10b..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists.mdx +++ /dev/null @@ -1,224 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/updatePriceLists -sidebar_label: updatePriceLists ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updatePriceLists - Pricing Module Reference - -This documentation provides a reference to the `updatePriceLists` method. This belongs to the Pricing Module. - -This method is used to update price lists. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function updatePriceLists (items: { - id: string - title: string - description: string - starts_at?: string - ends_at?: string -}[]) { - const pricingService = await initializePricingModule() - - const priceList = await pricingService.updatePriceLists(items) - - // do something with the price lists or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules.mdx deleted file mode 100644 index 36cb3d1b1ff85..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules.mdx +++ /dev/null @@ -1,207 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/updatePriceRules -sidebar_label: updatePriceRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updatePriceRules - Pricing Module Reference - -This documentation provides a reference to the `updatePriceRules` method. This belongs to the Pricing Module. - -This method is used to update price rules, each with their provided data. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function updatePriceRules ( - id: string, - priceSetId: string, -) { - const pricingService = await initializePricingModule() - - const priceRules = await pricingService.updatePriceRules([ - { - id, - price_set_id: priceSetId, - } - ]) - - // do something with the price rules or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSetMoneyAmountRules.mdx deleted file mode 100644 index a21bbf8319a16..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSetMoneyAmountRules.mdx +++ /dev/null @@ -1,177 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/updatePriceSetMoneyAmountRules -sidebar_label: updatePriceSetMoneyAmountRules ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updatePriceSetMoneyAmountRules - Pricing Module Reference - -This documentation provides a reference to the `updatePriceSetMoneyAmountRules` method. This belongs to the Pricing Module. - -This method is used to update price set money amount rules, each with their provided data. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function updatePriceSetMoneyAmountRules (id: string, value: string) { - const pricingService = await initializePricingModule() - - const priceSetMoneyAmountRules = await pricingService.updatePriceSetMoneyAmountRules([ - { - id, - value - } - ]) - - // do something with the price set money amount rules or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updateRuleTypes.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updateRuleTypes.mdx deleted file mode 100644 index 1d3d69018421d..0000000000000 --- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.updateRuleTypes.mdx +++ /dev/null @@ -1,177 +0,0 @@ ---- -displayed_sidebar: pricingReference -badge: - variant: orange - text: Beta -slug: /references/pricing/updateRuleTypes -sidebar_label: updateRuleTypes ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateRuleTypes - Pricing Module Reference - -This documentation provides a reference to the `updateRuleTypes` method. This belongs to the Pricing Module. - -This method is used to update existing rule types with the provided data. - -## Example - -```ts -import { - initialize as initializePricingModule, -} from "@medusajs/pricing" - -async function updateRuleTypes (ruleTypeId: string) { - const pricingService = await initializePricingModule() - - const ruleTypes = await pricingService.updateRuleTypes([ - { - id: ruleTypeId, - name: "Region", - } - ]) - - // do something with the rule types or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.create.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.create.mdx deleted file mode 100644 index 95137b96b6dc2..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.create.mdx +++ /dev/null @@ -1,641 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/create -sidebar_label: create ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# create - Product Module Reference - -This documentation provides a reference to the create method. This belongs to the Product Module. - -This method is used to create a product. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function createProduct (title: string) { - const productModule = await initializeProductModule() - - const products = await productModule.create([ - { - title - } - ]) - - // do something with the products or return them -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`string`", - "description": "The MID Code of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "[CreateProductOptionDTO](../../product/interfaces/product.CreateProductOptionDTO.mdx)[]", - "description": "The product options to be created and associated with the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "product_id", - "type": "`string`", - "description": "The ID of the associated product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The product option's title.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "origin_country", - "type": "`string`", - "description": "The origin country of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "status", - "type": "[ProductStatus](../../product/enums/product.ProductStatus.mdx)", - "description": "The status of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "DRAFT", - "type": "`\"draft\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "PROPOSED", - "type": "`\"proposed\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "PUBLISHED", - "type": "`\"published\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "REJECTED", - "type": "`\"rejected\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "subtitle", - "type": "`string`", - "description": "The subttle of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "tags", - "type": "[CreateProductTagDTO](../../product/interfaces/product.CreateProductTagDTO.mdx)[]", - "description": "The product tags to be created and associated with the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "value", - "type": "`string`", - "description": "The value of the product tag.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "thumbnail", - "type": "`string`", - "description": "The URL of the product's thumbnail.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The title of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "type", - "type": "[CreateProductTypeDTO](../../product/interfaces/product.CreateProductTypeDTO.mdx)", - "description": "The product type to create and associate with the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "id", - "type": "`string`", - "description": "The product type's ID.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "value", - "type": "`string`", - "description": "The product type's value.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "type_id", - "type": "`string`", - "description": "The product type to be associated with the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "variants", - "type": "[CreateProductVariantDTO](../../product/interfaces/product.CreateProductVariantDTO.mdx)[]", - "description": "The product variants to be created and associated with the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "allow_backorder", - "type": "`boolean`", - "description": "Whether the product variant can be ordered when it's out of stock.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "barcode", - "type": "`string`", - "description": "The barcode of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "ean", - "type": "`string`", - "description": "The EAN of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "height", - "type": "`number`", - "description": "The height of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "hs_code", - "type": "`string`", - "description": "The HS Code of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "inventory_quantity", - "type": "`number`", - "description": "The inventory quantiy of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "length", - "type": "`number`", - "description": "The length of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manage_inventory", - "type": "`boolean`", - "description": "Whether the product variant's inventory should be managed by the core system.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "material", - "type": "`string`", - "description": "The material of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`string`", - "description": "The MID Code of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "[CreateProductVariantOptionDTO](../../product/interfaces/product.CreateProductVariantOptionDTO.mdx)[]", - "description": "The product variant options to create and associate with the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "origin_country", - "type": "`string`", - "description": "The origin country of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "product_id", - "type": "`string`", - "description": "The id of the product", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "sku", - "type": "`string`", - "description": "The SKU of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The tile of the product variant.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "upc", - "type": "`string`", - "description": "The UPC of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "weight", - "type": "`number`", - "description": "The weight of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`number`", - "description": "The width of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "weight", - "type": "`number`", - "description": "The weight of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`number`", - "description": "The width of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../product/interfaces/product.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createCategory.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createCategory.mdx deleted file mode 100644 index 569bc9443aac6..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createCategory.mdx +++ /dev/null @@ -1,482 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/createCategory -sidebar_label: createCategory ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createCategory - Product Module Reference - -This documentation provides a reference to the createCategory method. This belongs to the Product Module. - -This method is used to create a product category. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function createCategory (name: string, parent_category_id: string | null) { - const productModule = await initializeProductModule() - - const category = await productModule.createCategory({ - name, - parent_category_id - }) - - // do something with the product category or return it -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "name", - "type": "`string`", - "description": "The product category's name.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "parent_category_id", - "type": "`null` \\| `string`", - "description": "The ID of the parent product category, if it has any.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "rank", - "type": "`number`", - "description": "The ranking of the category among sibling categories.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../product/interfaces/product.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createCollections.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createCollections.mdx deleted file mode 100644 index 23c3a1229cb13..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createCollections.mdx +++ /dev/null @@ -1,176 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/createCollections -sidebar_label: createCollections ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createCollections - Product Module Reference - -This documentation provides a reference to the createCollections method. This belongs to the Product Module. - -This method is used to create product collections. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function createCollection (title: string) { - const productModule = await initializeProductModule() - - const collections = await productModule.createCollections([ - { - title - } - ]) - - // do something with the product collections or return them -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "product_ids", - "type": "`string`[]", - "description": "The products to associate with the collection.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The product collection's title.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../product/interfaces/product.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createOptions.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createOptions.mdx deleted file mode 100644 index 8554d5a94011b..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createOptions.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/createOptions -sidebar_label: createOptions ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createOptions - Product Module Reference - -This documentation provides a reference to the createOptions method. This belongs to the Product Module. - -This method is used to create product options. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function createProductOption (title: string, productId: string) { - const productModule = await initializeProductModule() - - const productOptions = await productModule.createOptions([ - { - title, - product_id: productId - } - ]) - - // do something with the product options or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createTags.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createTags.mdx deleted file mode 100644 index e202e22cbb1d7..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createTags.mdx +++ /dev/null @@ -1,149 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/createTags -sidebar_label: createTags ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createTags - Product Module Reference - -This documentation provides a reference to the createTags method. This belongs to the Product Module. - -This method is used to create product tags. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function createProductTags (values: string[]) { - const productModule = await initializeProductModule() - - const productTags = await productModule.createTags( - values.map((value) => ({ - value - })) - ) - - // do something with the product tags or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createTypes.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createTypes.mdx deleted file mode 100644 index bfd1b5529abaf..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createTypes.mdx +++ /dev/null @@ -1,167 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/createTypes -sidebar_label: createTypes ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createTypes - Product Module Reference - -This documentation provides a reference to the createTypes method. This belongs to the Product Module. - -This method is used to create a product type. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function createProductType (value: string) { - const productModule = await initializeProductModule() - - const productTypes = await productModule.createTypes([ - { - value - } - ]) - - // do something with the product types or return them -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "value", - "type": "`string`", - "description": "The product type's value.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../product/interfaces/product.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createVariants.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createVariants.mdx deleted file mode 100644 index 73d8eb426c8ee..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.createVariants.mdx +++ /dev/null @@ -1,329 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/createVariants -sidebar_label: createVariants ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# createVariants - Product Module Reference - -This documentation provides a reference to the createVariants method. This belongs to the Product Module. - -This method is used to create variants for a product. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function createProductVariants (items: { - product_id: string, - title: string -}[]) { - const productModule = await initializeProductModule() - - const productVariants = await productModule.createVariants(items) - - // do something with the product variants or return them -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`string`", - "description": "The MID Code of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "[CreateProductVariantOptionDTO](../../product/interfaces/product.CreateProductVariantOptionDTO.mdx)[]", - "description": "The product variant options to create and associate with the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "option_id", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "value", - "type": "`string`", - "description": "The value of a product variant option.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "origin_country", - "type": "`string`", - "description": "The origin country of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "product_id", - "type": "`string`", - "description": "The id of the product", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "sku", - "type": "`string`", - "description": "The SKU of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The tile of the product variant.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "upc", - "type": "`string`", - "description": "The UPC of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "weight", - "type": "`number`", - "description": "The weight of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`number`", - "description": "The width of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../product/interfaces/product.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.delete.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.delete.mdx deleted file mode 100644 index a6134d6169c04..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.delete.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/delete -sidebar_label: delete ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# delete - Product Module Reference - -This documentation provides a reference to the delete method. This belongs to the Product Module. - -This method is used to delete products. Unlike the [softDelete](product.IProductModuleService.softDelete.mdx) method, this method will completely remove the products and they can no longer be accessed or retrieved. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function deleteProducts (ids: string[]) { - const productModule = await initializeProductModule() - - await productModule.delete(ids) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteCategory.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteCategory.mdx deleted file mode 100644 index 12662005ac157..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteCategory.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/deleteCategory -sidebar_label: deleteCategory ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteCategory - Product Module Reference - -This documentation provides a reference to the deleteCategory method. This belongs to the Product Module. - -This method is used to delete a product category by its ID. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function deleteCategory (id: string) { - const productModule = await initializeProductModule() - - await productModule.deleteCategory(id) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteCollections.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteCollections.mdx deleted file mode 100644 index a752d7fe97054..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteCollections.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/deleteCollections -sidebar_label: deleteCollections ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteCollections - Product Module Reference - -This documentation provides a reference to the deleteCollections method. This belongs to the Product Module. - -This method is used to delete collections by their ID. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function deleteCollection (ids: string[]) { - const productModule = await initializeProductModule() - - await productModule.deleteCollections(ids) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteOptions.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteOptions.mdx deleted file mode 100644 index e6dcad3163bcc..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteOptions.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/deleteOptions -sidebar_label: deleteOptions ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteOptions - Product Module Reference - -This documentation provides a reference to the deleteOptions method. This belongs to the Product Module. - -This method is used to delete a product option. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function deleteProductOptions (ids: string[]) { - const productModule = await initializeProductModule() - - await productModule.deleteOptions(ids) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteTags.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteTags.mdx deleted file mode 100644 index 219839ca3d3d8..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteTags.mdx +++ /dev/null @@ -1,114 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/deleteTags -sidebar_label: deleteTags ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteTags - Product Module Reference - -This documentation provides a reference to the deleteTags method. This belongs to the Product Module. - -This method is used to delete product tags by their ID. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function deleteProductTags (ids: string[]) { - const productModule = await initializeProductModule() - - await productModule.deleteTags(ids) - -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteTypes.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteTypes.mdx deleted file mode 100644 index 7c664d9e15334..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteTypes.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/deleteTypes -sidebar_label: deleteTypes ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteTypes - Product Module Reference - -This documentation provides a reference to the deleteTypes method. This belongs to the Product Module. - -This method is used to delete a product type. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function deleteProductTypes (ids: string[]) { - const productModule = await initializeProductModule() - - await productModule.deleteTypes(ids) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteVariants.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteVariants.mdx deleted file mode 100644 index 85f55b67184c8..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.deleteVariants.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/deleteVariants -sidebar_label: deleteVariants ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# deleteVariants - Product Module Reference - -This documentation provides a reference to the deleteVariants method. This belongs to the Product Module. - -This method is used to delete ProductVariant. This method will completely remove the ProductVariant and they can no longer be accessed or retrieved. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function deleteProducts (ids: string[]) { - const productModule = await initializeProductModule() - - await productModule.deleteVariants(ids) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.list.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.list.mdx deleted file mode 100644 index f9506d8ddb549..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.list.mdx +++ /dev/null @@ -1,394 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/list -sidebar_label: list ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# list - Product Module Reference - -This documentation provides a reference to the list method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of price sets based on optional filters and configuration. - -## Example - -To retrieve a list of products using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProducts (ids: string[]) { - const productModule = await initializeProductModule() - - const products = await productModule.list({ - id: ids - }) - - // do something with the products or return them -} -``` - -To specify relations that should be retrieved within the products: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProducts (ids: string[]) { - const productModule = await initializeProductModule() - - const products = await productModule.list({ - id: ids - }, { - relations: ["categories"] - }) - - // do something with the products or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProducts (ids: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const products = await productModule.list({ - id: ids - }, { - relations: ["categories"], - skip, - take - }) - - // do something with the products or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProducts (ids: string[], title: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const products = await productModule.list({ - $and: [ - { - id: ids - }, - { - q: title - } - ] - }, { - relations: ["categories"], - skip, - take - }) - - // do something with the products or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCount.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCount.mdx deleted file mode 100644 index 08c6126781194..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCount.mdx +++ /dev/null @@ -1,393 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listAndCount -sidebar_label: listAndCount ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCount - Product Module Reference - -This documentation provides a reference to the listAndCount method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of products along with the total count of available products satisfying the provided filters. - -## Example - -To retrieve a list of products using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProducts (ids: string[]) { - const productModule = await initializeProductModule() - - const [products, count] = await productModule.listAndCount({ - id: ids - }) - - // do something with the products or return them -} -``` - -To specify relations that should be retrieved within the products: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProducts (ids: string[]) { - const productModule = await initializeProductModule() - - const [products, count] = await productModule.listAndCount({ - id: ids - }, { - relations: ["categories"] - }) - - // do something with the products or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProducts (ids: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const [products, count] = await productModule.listAndCount({ - id: ids - }, { - relations: ["categories"], - skip, - take - }) - - // do something with the products or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProducts (ids: string[], title: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const [products, count] = await productModule.listAndCount({ - $and: [ - { - id: ids - }, - { - q: title - } - ] - }, { - relations: ["categories"], - skip, - take - }) - - // do something with the products or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountCategories.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountCategories.mdx deleted file mode 100644 index 9db004cd37bb5..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountCategories.mdx +++ /dev/null @@ -1,355 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listAndCountCategories -sidebar_label: listAndCountCategories ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountCategories - Product Module Reference - -This documentation provides a reference to the listAndCountCategories method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of product categories along with the total count of available product categories satisfying the provided filters. - -## Example - -To retrieve a list of product categories using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCategories (ids: string[]) { - const productModule = await initializeProductModule() - - const [categories, count] = await productModule.listAndCountCategories({ - id: ids - }) - - // do something with the product category or return it -} -``` - -To specify relations that should be retrieved within the product categories: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCategories (ids: string[]) { - const productModule = await initializeProductModule() - - const [categories, count] = await productModule.listAndCountCategories({ - id: ids - }, { - relations: ["parent_category"] - }) - - // do something with the product category or return it -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCategories (ids: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const [categories, count] = await productModule.listAndCountCategories({ - id: ids - }, { - relations: ["parent_category"], - skip, - take - }) - - // do something with the product category or return it -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCategories (ids: string[], name: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const [categories, count] = await productModule.listAndCountCategories({ - $or: [ - { - id: ids - }, - { - name - } - ] - }, { - relations: ["parent_category"], - skip, - take - }) - - // do something with the product category or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountCollections.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountCollections.mdx deleted file mode 100644 index 93b3a9b72c21e..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountCollections.mdx +++ /dev/null @@ -1,319 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listAndCountCollections -sidebar_label: listAndCountCollections ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountCollections - Product Module Reference - -This documentation provides a reference to the listAndCountCollections method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of product collections along with the total count of available product collections satisfying the provided filters. - -## Example - -To retrieve a list of product collections using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCollections (ids: string[]) { - const productModule = await initializeProductModule() - - const [collections, count] = await productModule.listAndCountCollections({ - id: ids - }) - - // do something with the product collections or return them -} -``` - -To specify relations that should be retrieved within the product collections: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCollections (ids: string[]) { - const productModule = await initializeProductModule() - - const [collections, count] = await productModule.listAndCountCollections({ - id: ids - }, { - relations: ["products"] - }) - - // do something with the product collections or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCollections (ids: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const [collections, count] = await productModule.listAndCountCollections({ - id: ids - }, { - relations: ["products"], - skip, - take - }) - - // do something with the product collections or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCollections (ids: string[], title: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const [collections, count] = await productModule.listAndCountCollections({ - $and: [ - { - id: ids - }, - { - title - } - ] - }, { - relations: ["products"], - skip, - take - }) - - // do something with the product collections or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountOptions.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountOptions.mdx deleted file mode 100644 index 58d008bbec46d..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountOptions.mdx +++ /dev/null @@ -1,319 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listAndCountOptions -sidebar_label: listAndCountOptions ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountOptions - Product Module Reference - -This documentation provides a reference to the listAndCountOptions method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of product options along with the total count of available product options satisfying the provided filters. - -## Example - -To retrieve a list of product options using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductOptions (ids: string[]) { - const productModule = await initializeProductModule() - - const [productOptions, count] = await productModule.listAndCountOptions({ - id: ids - }) - - // do something with the product options or return them -} -``` - -To specify relations that should be retrieved within the product types: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductOptions (ids: string[]) { - const productModule = await initializeProductModule() - - const [productOptions, count] = await productModule.listAndCountOptions({ - id: ids - }, { - relations: ["product"] - }) - - // do something with the product options or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductOptions (ids: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const [productOptions, count] = await productModule.listAndCountOptions({ - id: ids - }, { - relations: ["product"], - skip, - take - }) - - // do something with the product options or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductOptions (ids: string[], title: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const [productOptions, count] = await productModule.listAndCountOptions({ - $and: [ - { - id: ids - }, - { - title - } - ] - }, { - relations: ["product"], - skip, - take - }) - - // do something with the product options or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountTags.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountTags.mdx deleted file mode 100644 index 6ef1446ca1f4f..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountTags.mdx +++ /dev/null @@ -1,310 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listAndCountTags -sidebar_label: listAndCountTags ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountTags - Product Module Reference - -This documentation provides a reference to the listAndCountTags method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of product tags along with the total count of available product tags satisfying the provided filters. - -## Example - -To retrieve a list of product tags using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTag (tagIds: string[]) { - const productModule = await initializeProductModule() - - const [productTags, count] = await productModule.listAndCountTags({ - id: tagIds - }) - - // do something with the product tags or return them -} -``` - -To specify relations that should be retrieved within the product tags: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTag (tagIds: string[]) { - const productModule = await initializeProductModule() - - const [productTags, count] = await productModule.listAndCountTags({ - id: tagIds - }, { - relations: ["products"] - }) - - // do something with the product tags or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTag (tagIds: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const [productTags, count] = await productModule.listAndCountTags({ - id: tagIds - }, { - relations: ["products"], - skip, - take - }) - - // do something with the product tags or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTag (tagIds: string[], value: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const [productTags, count] = await productModule.listAndCountTags({ - $and: [ - { - id: tagIds - }, - { - value - } - ] - }, { - relations: ["products"], - skip, - take - }) - - // do something with the product tags or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountTypes.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountTypes.mdx deleted file mode 100644 index 23e069d5f5a3d..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountTypes.mdx +++ /dev/null @@ -1,310 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listAndCountTypes -sidebar_label: listAndCountTypes ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountTypes - Product Module Reference - -This documentation provides a reference to the listAndCountTypes method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of product types along with the total count of available product types satisfying the provided filters. - -## Example - -To retrieve a list of product types using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTypes (ids: string[]) { - const productModule = await initializeProductModule() - - const [productTypes, count] = await productModule.listAndCountTypes({ - id: ids - }) - - // do something with the product types or return them -} -``` - -To specify attributes that should be retrieved within the product types: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTypes (ids: string[]) { - const productModule = await initializeProductModule() - - const [productTypes, count] = await productModule.listAndCountTypes({ - id: ids - }, { - select: ["value"] - }) - - // do something with the product types or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTypes (ids: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const [productTypes, count] = await productModule.listAndCountTypes({ - id: ids - }, { - select: ["value"], - skip, - take - }) - - // do something with the product types or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTypes (ids: string[], value: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const [productTypes, count] = await productModule.listAndCountTypes({ - $and: [ - { - id: ids - }, - { - value - } - ] - }, { - select: ["value"], - skip, - take - }) - - // do something with the product types or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountVariants.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountVariants.mdx deleted file mode 100644 index c9087b09089bb..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listAndCountVariants.mdx +++ /dev/null @@ -1,338 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listAndCountVariants -sidebar_label: listAndCountVariants ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCountVariants - Product Module Reference - -This documentation provides a reference to the listAndCountVariants method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of product variants along with the total count of available product variants satisfying the provided filters. - -## Example - -To retrieve a list of product variants using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductVariants (ids: string[]) { - const productModule = await initializeProductModule() - - const [variants, count] = await productModule.listAndCountVariants({ - id: ids - }) - - // do something with the product variants or return them -} -``` - -To specify relations that should be retrieved within the product variants: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductVariants (ids: string[]) { - const productModule = await initializeProductModule() - - const [variants, count] = await productModule.listAndCountVariants({ - id: ids - }, { - relations: ["options"] - }) - - // do something with the product variants or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductVariants (ids: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const [variants, count] = await productModule.listAndCountVariants({ - id: ids - }, { - relations: ["options"], - skip, - take - }) - - // do something with the product variants or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductVariants (ids: string[], sku: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const [variants, count] = await productModule.listAndCountVariants({ - $and: [ - { - id: ids - }, - { - sku - } - ] - }, { - relations: ["options"], - skip, - take - }) - - // do something with the product variants or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listCategories.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listCategories.mdx deleted file mode 100644 index a87d7f55f76f5..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listCategories.mdx +++ /dev/null @@ -1,356 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listCategories -sidebar_label: listCategories ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listCategories - Product Module Reference - -This documentation provides a reference to the listCategories method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of product categories based on optional filters and configuration. - -## Example - -To retrieve a list of product categories using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCategories (ids: string[]) { - const productModule = await initializeProductModule() - - const categories = await productModule.listCategories({ - id: ids - }) - - // do something with the product category or return it -} -``` - -To specify relations that should be retrieved within the product categories: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCategories (ids: string[]) { - const productModule = await initializeProductModule() - - const categories = await productModule.listCategories({ - id: ids - }, { - relations: ["parent_category"] - }) - - // do something with the product category or return it -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCategories (ids: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const categories = await productModule.listCategories({ - id: ids - }, { - relations: ["parent_category"], - skip, - take - }) - - // do something with the product category or return it -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCategories (ids: string[], name: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const categories = await productModule.listCategories({ - $or: [ - { - id: ids - }, - { - name - } - ] - }, { - relations: ["parent_category"], - skip, - take - }) - - // do something with the product category or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listCollections.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listCollections.mdx deleted file mode 100644 index 391bf6eee50f3..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listCollections.mdx +++ /dev/null @@ -1,320 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listCollections -sidebar_label: listCollections ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listCollections - Product Module Reference - -This documentation provides a reference to the listCollections method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of product collections based on optional filters and configuration. - -## Example - -To retrieve a list of product collections using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCollections (ids: string[]) { - const productModule = await initializeProductModule() - - const collections = await productModule.listCollections({ - id: ids - }) - - // do something with the product collections or return them -} -``` - -To specify relations that should be retrieved within the product collections: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCollections (ids: string[]) { - const productModule = await initializeProductModule() - - const collections = await productModule.listCollections({ - id: ids - }, { - relations: ["products"] - }) - - // do something with the product collections or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCollections (ids: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const collections = await productModule.listCollections({ - id: ids - }, { - relations: ["products"], - skip, - take - }) - - // do something with the product collections or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCollections (ids: string[], title: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const collections = await productModule.listCollections({ - $and: [ - { - id: ids - }, - { - title - } - ] - }, { - relations: ["products"], - skip, - take - }) - - // do something with the product collections or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listOptions.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listOptions.mdx deleted file mode 100644 index 1d016b4855d62..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listOptions.mdx +++ /dev/null @@ -1,320 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listOptions -sidebar_label: listOptions ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listOptions - Product Module Reference - -This documentation provides a reference to the listOptions method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of product options based on optional filters and configuration. - -## Example - -To retrieve a list of product options using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductOptions (ids: string[]) { - const productModule = await initializeProductModule() - - const productOptions = await productModule.listOptions({ - id: ids - }) - - // do something with the product options or return them -} -``` - -To specify relations that should be retrieved within the product types: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductOptions (ids: string[]) { - const productModule = await initializeProductModule() - - const productOptions = await productModule.listOptions({ - id: ids - }, { - relations: ["product"] - }) - - // do something with the product options or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductOptions (ids: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const productOptions = await productModule.listOptions({ - id: ids - }, { - relations: ["product"], - skip, - take - }) - - // do something with the product options or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductOptions (ids: string[], title: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const productOptions = await productModule.listOptions({ - $and: [ - { - id: ids - }, - { - title - } - ] - }, { - relations: ["product"], - skip, - take - }) - - // do something with the product options or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listTags.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listTags.mdx deleted file mode 100644 index 8f45e1d347321..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listTags.mdx +++ /dev/null @@ -1,311 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listTags -sidebar_label: listTags ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listTags - Product Module Reference - -This documentation provides a reference to the listTags method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of tags based on optional filters and configuration. - -## Example - -To retrieve a list of product tags using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTag (tagIds: string[]) { - const productModule = await initializeProductModule() - - const productTags = await productModule.listTags({ - id: tagIds - }) - - // do something with the product tags or return them -} -``` - -To specify relations that should be retrieved within the product tags: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTag (tagIds: string[]) { - const productModule = await initializeProductModule() - - const productTags = await productModule.listTags({ - id: tagIds - }, { - relations: ["products"] - }) - - // do something with the product tags or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTag (tagIds: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const productTags = await productModule.listTags({ - id: tagIds - }, { - relations: ["products"], - skip, - take - }) - - // do something with the product tags or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTag (tagIds: string[], value: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const productTags = await productModule.listTags({ - $and: [ - { - id: tagIds - }, - { - value - } - ] - }, { - relations: ["products"], - skip, - take - }) - - // do something with the product tags or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listTypes.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listTypes.mdx deleted file mode 100644 index 52e5961730119..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listTypes.mdx +++ /dev/null @@ -1,311 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listTypes -sidebar_label: listTypes ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listTypes - Product Module Reference - -This documentation provides a reference to the listTypes method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of product types based on optional filters and configuration. - -## Example - -To retrieve a list of product types using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTypes (ids: string[]) { - const productModule = await initializeProductModule() - - const productTypes = await productModule.listTypes({ - id: ids - }) - - // do something with the product types or return them -} -``` - -To specify attributes that should be retrieved within the product types: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTypes (ids: string[]) { - const productModule = await initializeProductModule() - - const productTypes = await productModule.listTypes({ - id: ids - }, { - select: ["value"] - }) - - // do something with the product types or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTypes (ids: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const productTypes = await productModule.listTypes({ - id: ids - }, { - select: ["value"], - skip, - take - }) - - // do something with the product types or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTypes (ids: string[], value: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const productTypes = await productModule.listTypes({ - $and: [ - { - id: ids - }, - { - value - } - ] - }, { - select: ["value"], - skip, - take - }) - - // do something with the product types or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listVariants.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listVariants.mdx deleted file mode 100644 index c2c9f9c30dd52..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.listVariants.mdx +++ /dev/null @@ -1,339 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/listVariants -sidebar_label: listVariants ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listVariants - Product Module Reference - -This documentation provides a reference to the listVariants method. This belongs to the Product Module. - -This method is used to retrieve a paginated list of product variants based on optional filters and configuration. - -## Example - -To retrieve a list of product variants using their IDs: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductVariants (ids: string[]) { - const productModule = await initializeProductModule() - - const variants = await productModule.listVariants({ - id: ids - }) - - // do something with the product variants or return them -} -``` - -To specify relations that should be retrieved within the product variants: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductVariants (ids: string[]) { - const productModule = await initializeProductModule() - - const variants = await productModule.listVariants({ - id: ids - }, { - relations: ["options"] - }) - - // do something with the product variants or return them -} -``` - -By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductVariants (ids: string[], skip: number, take: number) { - const productModule = await initializeProductModule() - - const variants = await productModule.listVariants({ - id: ids - }, { - relations: ["options"], - skip, - take - }) - - // do something with the product variants or return them -} -``` - -You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductVariants (ids: string[], sku: string, skip: number, take: number) { - const productModule = await initializeProductModule() - - const variants = await productModule.listVariants({ - $and: [ - { - id: ids - }, - { - sku - } - ] - }, { - relations: ["options"], - skip, - take - }) - - // do something with the product variants or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.restore.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.restore.mdx deleted file mode 100644 index 6c00e1421540b..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.restore.mdx +++ /dev/null @@ -1,160 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/restore -sidebar_label: restore ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# restore - Product Module Reference - -This documentation provides a reference to the restore method. This belongs to the Product Module. - -This method is used to restore products which were deleted using the [softDelete](product.IProductModuleService.softDelete.mdx) method. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function restoreProducts (ids: string[]) { - const productModule = await initializeProductModule() - - const cascadedEntities = await productModule.restore(ids, { - returnLinkableKeys: ["variant_id"] - }) - - // do something with the returned cascaded entity IDs or return them -} -``` - -## Type Parameters - - - -## Parameters - - - -## Returns - -`", - "optional": true, - "defaultValue": "", - "description": "", - "expandable": false, - "children": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.restoreVariants.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.restoreVariants.mdx deleted file mode 100644 index b962e90d55940..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.restoreVariants.mdx +++ /dev/null @@ -1,157 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/restoreVariants -sidebar_label: restoreVariants ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# restoreVariants - Product Module Reference - -This documentation provides a reference to the restoreVariants method. This belongs to the Product Module. - -This method is used to restore product varaints that were soft deleted. Product variants are soft deleted when they're not -provided in a product's details passed to the [update](product.IProductModuleService.update.mdx) method. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function restoreProductVariants (ids: string[]) { - const productModule = await initializeProductModule() - - await productModule.restoreVariants(ids) -} -``` - -## Type Parameters - - - -## Parameters - - - -## Returns - -`", - "optional": true, - "defaultValue": "", - "description": "", - "expandable": false, - "children": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieve.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieve.mdx deleted file mode 100644 index 730dd8ff37c12..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieve.mdx +++ /dev/null @@ -1,945 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/retrieve -sidebar_label: retrieve ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieve - Product Module Reference - -This documentation provides a reference to the retrieve method. This belongs to the Product Module. - -This method is used to retrieve a product by its ID - -## Example - -A simple example that retrieves a product by its ID: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProduct (id: string) { - const productModule = await initializeProductModule() - - const product = await productModule.retrieve(id) - - // do something with the product or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProduct (id: string) { - const productModule = await initializeProductModule() - - const product = await productModule.retrieve(id, { - relations: ["categories"] - }) - - // do something with the product or return it -} -``` - -## Parameters - - - -## Returns - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "products", - "type": "[ProductDTO](../../product/interfaces/product.ProductDTO.mdx)[]", - "description": "The associated products.", - "optional": true, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The title of the product collection.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "created_at", - "type": "`string` \\| `Date`", - "description": "When the product was created.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleted_at", - "type": "`string` \\| `Date`", - "description": "When the product was deleted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "description", - "type": "`null` \\| `string`", - "description": "The description of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "discountable", - "type": "`boolean`", - "description": "Whether the product can be discounted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "external_id", - "type": "`null` \\| `string`", - "description": "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.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "handle", - "type": "`null` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "height", - "type": "`null` \\| `number`", - "description": "The height of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "hs_code", - "type": "`null` \\| `string`", - "description": "The HS Code of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The ID of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "images", - "type": "[ProductImageDTO](../../product/interfaces/product.ProductImageDTO.mdx)[]", - "description": "The associated product images.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "deleted_at", - "type": "`string` \\| `Date`", - "description": "When the product image was deleted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The ID of the product image.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`null` \\| `Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "url", - "type": "`string`", - "description": "The URL of the product image.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "is_giftcard", - "type": "`boolean`", - "description": "Whether the product is a gift card.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "length", - "type": "`null` \\| `number`", - "description": "The length of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "material", - "type": "`null` \\| `string`", - "description": "The material of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`null` \\| `string`", - "description": "The MID Code of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO.mdx)[]", - "description": "The associated product options.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "deleted_at", - "type": "`string` \\| `Date`", - "description": "When the product option was deleted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The ID of the product option.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`null` \\| `Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "product", - "type": "[ProductDTO](../../product/interfaces/product.ProductDTO.mdx)", - "description": "The associated product.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The title of the product option.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "values", - "type": "[ProductOptionValueDTO](../../product/interfaces/product.ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - } - ] - }, - { - "name": "origin_country", - "type": "`null` \\| `string`", - "description": "The origin country of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "status", - "type": "[ProductStatus](../../product/enums/product.ProductStatus.mdx)", - "description": "The status of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "DRAFT", - "type": "`\"draft\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "PROPOSED", - "type": "`\"proposed\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "PUBLISHED", - "type": "`\"published\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "REJECTED", - "type": "`\"rejected\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "subtitle", - "type": "`null` \\| `string`", - "description": "The subttle of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "tags", - "type": "[ProductTagDTO](../../product/interfaces/product.ProductTagDTO.mdx)[]", - "description": "The associated product tags.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "id", - "type": "`string`", - "description": "The ID of the product tag.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`null` \\| `Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "products", - "type": "[ProductDTO](../../product/interfaces/product.ProductDTO.mdx)[]", - "description": "The associated products.", - "optional": true, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "value", - "type": "`string`", - "description": "The value of the product tag.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "thumbnail", - "type": "`null` \\| `string`", - "description": "The URL of the product's thumbnail.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The title of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "type", - "type": "[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO.mdx)[]", - "description": "The associated product type.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "deleted_at", - "type": "`string` \\| `Date`", - "description": "When the product type was deleted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The ID of the product type.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`null` \\| `Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "value", - "type": "`string`", - "description": "The value of the product type.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "updated_at", - "type": "`string` \\| `Date`", - "description": "When the product was updated.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "variants", - "type": "[ProductVariantDTO](../../product/interfaces/product.ProductVariantDTO.mdx)[]", - "description": "The associated product variants.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "allow_backorder", - "type": "`boolean`", - "description": "Whether the product variant can be ordered when it's out of stock.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "barcode", - "type": "`null` \\| `string`", - "description": "The barcode of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "created_at", - "type": "`string` \\| `Date`", - "description": "When the product variant was created.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleted_at", - "type": "`string` \\| `Date`", - "description": "When the product variant was deleted.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "ean", - "type": "`null` \\| `string`", - "description": "The EAN of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "height", - "type": "`null` \\| `number`", - "description": "The height of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "hs_code", - "type": "`null` \\| `string`", - "description": "The HS Code of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The ID of the product variant.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "inventory_quantity", - "type": "`number`", - "description": "The inventory quantiy of the product variant.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "length", - "type": "`null` \\| `number`", - "description": "The length of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manage_inventory", - "type": "`boolean`", - "description": "Whether the product variant's inventory should be managed by the core system.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "material", - "type": "`null` \\| `string`", - "description": "The material of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`null` \\| `Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`null` \\| `string`", - "description": "The MID Code of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "[ProductOptionValueDTO](../../product/interfaces/product.ProductOptionValueDTO.mdx)[]", - "description": "The associated product options.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "origin_country", - "type": "`null` \\| `string`", - "description": "The origin country of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "product", - "type": "[ProductDTO](../../product/interfaces/product.ProductDTO.mdx)", - "description": "The associated product.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_id", - "type": "`string`", - "description": "The ID of the associated product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "sku", - "type": "`null` \\| `string`", - "description": "The SKU of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The tile of the product variant.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "upc", - "type": "`null` \\| `string`", - "description": "The UPC of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updated_at", - "type": "`string` \\| `Date`", - "description": "When the product variant was updated.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "variant_rank", - "type": "`null` \\| `number`", - "description": "he ranking of the variant among other variants associated with the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "weight", - "type": "`null` \\| `number`", - "description": "The weight of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`null` \\| `number`", - "description": "The width of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "weight", - "type": "`null` \\| `number`", - "description": "The weight of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`null` \\| `number`", - "description": "The width of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveCategory.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveCategory.mdx deleted file mode 100644 index 8147f71dfa0c0..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveCategory.mdx +++ /dev/null @@ -1,499 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/retrieveCategory -sidebar_label: retrieveCategory ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveCategory - Product Module Reference - -This documentation provides a reference to the retrieveCategory method. This belongs to the Product Module. - -This method is used to retrieve a product category by its ID. - -## Example - -A simple example that retrieves a product category by its ID: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCategory (id: string) { - const productModule = await initializeProductModule() - - const category = await productModule.retrieveCategory(id) - - // do something with the product category or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCategory (id: string) { - const productModule = await initializeProductModule() - - const category = await productModule.retrieveCategory(id, { - relations: ["parent_category"] - }) - - // do something with the product category or return it -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveCollection.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveCollection.mdx deleted file mode 100644 index f0183712be176..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveCollection.mdx +++ /dev/null @@ -1,516 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/retrieveCollection -sidebar_label: retrieveCollection ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveCollection - Product Module Reference - -This documentation provides a reference to the retrieveCollection method. This belongs to the Product Module. - -This method is used to retrieve a product collection by its ID. - -## Example - -A simple example that retrieves a product collection by its ID: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCollection (id: string) { - const productModule = await initializeProductModule() - - const collection = await productModule.retrieveCollection(id) - - // do something with the product collection or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveCollection (id: string) { - const productModule = await initializeProductModule() - - const collection = await productModule.retrieveCollection(id, { - relations: ["products"] - }) - - // do something with the product collection or return it -} -``` - -## Parameters - - - -## Returns - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "products", - "type": "[ProductDTO](../../product/interfaces/product.ProductDTO.mdx)[]", - "description": "The associated products.", - "optional": true, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "categories", - "type": "`null` \\| [ProductCategoryDTO](../../product/interfaces/product.ProductCategoryDTO.mdx)[]", - "description": "The associated product categories.", - "optional": true, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "collection", - "type": "[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO.mdx)", - "description": "The associated product collection.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "created_at", - "type": "`string` \\| `Date`", - "description": "When the product was created.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleted_at", - "type": "`string` \\| `Date`", - "description": "When the product was deleted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "description", - "type": "`null` \\| `string`", - "description": "The description of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "discountable", - "type": "`boolean`", - "description": "Whether the product can be discounted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "external_id", - "type": "`null` \\| `string`", - "description": "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.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "handle", - "type": "`null` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "height", - "type": "`null` \\| `number`", - "description": "The height of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "hs_code", - "type": "`null` \\| `string`", - "description": "The HS Code of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The ID of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "images", - "type": "[ProductImageDTO](../../product/interfaces/product.ProductImageDTO.mdx)[]", - "description": "The associated product images.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "is_giftcard", - "type": "`boolean`", - "description": "Whether the product is a gift card.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "length", - "type": "`null` \\| `number`", - "description": "The length of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "material", - "type": "`null` \\| `string`", - "description": "The material of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`null` \\| `string`", - "description": "The MID Code of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO.mdx)[]", - "description": "The associated product options.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "origin_country", - "type": "`null` \\| `string`", - "description": "The origin country of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "status", - "type": "[ProductStatus](../../product/enums/product.ProductStatus.mdx)", - "description": "The status of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "subtitle", - "type": "`null` \\| `string`", - "description": "The subttle of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "tags", - "type": "[ProductTagDTO](../../product/interfaces/product.ProductTagDTO.mdx)[]", - "description": "The associated product tags.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "thumbnail", - "type": "`null` \\| `string`", - "description": "The URL of the product's thumbnail.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The title of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "type", - "type": "[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO.mdx)[]", - "description": "The associated product type.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "updated_at", - "type": "`string` \\| `Date`", - "description": "When the product was updated.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "variants", - "type": "[ProductVariantDTO](../../product/interfaces/product.ProductVariantDTO.mdx)[]", - "description": "The associated product variants.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "weight", - "type": "`null` \\| `number`", - "description": "The weight of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`null` \\| `number`", - "description": "The width of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "title", - "type": "`string`", - "description": "The title of the product collection.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveOption.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveOption.mdx deleted file mode 100644 index 709acd4e17017..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveOption.mdx +++ /dev/null @@ -1,571 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/retrieveOption -sidebar_label: retrieveOption ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveOption - Product Module Reference - -This documentation provides a reference to the retrieveOption method. This belongs to the Product Module. - -This method is used to retrieve a product option by its ID. - -## Example - -A simple example that retrieves a product option by its ID: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductOption (id: string) { - const productModule = await initializeProductModule() - - const productOption = await productModule.retrieveOption(id) - - // do something with the product option or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductOption (id: string) { - const productModule = await initializeProductModule() - - const productOption = await productModule.retrieveOption(id, { - relations: ["product"] - }) - - // do something with the product option or return it -} -``` - -## Parameters - - - -## Returns - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "product", - "type": "[ProductDTO](../../product/interfaces/product.ProductDTO.mdx)", - "description": "The associated product.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "categories", - "type": "`null` \\| [ProductCategoryDTO](../../product/interfaces/product.ProductCategoryDTO.mdx)[]", - "description": "The associated product categories.", - "optional": true, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "collection", - "type": "[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO.mdx)", - "description": "The associated product collection.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "created_at", - "type": "`string` \\| `Date`", - "description": "When the product was created.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleted_at", - "type": "`string` \\| `Date`", - "description": "When the product was deleted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "description", - "type": "`null` \\| `string`", - "description": "The description of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "discountable", - "type": "`boolean`", - "description": "Whether the product can be discounted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "external_id", - "type": "`null` \\| `string`", - "description": "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.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "handle", - "type": "`null` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "height", - "type": "`null` \\| `number`", - "description": "The height of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "hs_code", - "type": "`null` \\| `string`", - "description": "The HS Code of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The ID of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "images", - "type": "[ProductImageDTO](../../product/interfaces/product.ProductImageDTO.mdx)[]", - "description": "The associated product images.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "is_giftcard", - "type": "`boolean`", - "description": "Whether the product is a gift card.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "length", - "type": "`null` \\| `number`", - "description": "The length of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "material", - "type": "`null` \\| `string`", - "description": "The material of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`null` \\| `string`", - "description": "The MID Code of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO.mdx)[]", - "description": "The associated product options.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "origin_country", - "type": "`null` \\| `string`", - "description": "The origin country of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "status", - "type": "[ProductStatus](../../product/enums/product.ProductStatus.mdx)", - "description": "The status of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "subtitle", - "type": "`null` \\| `string`", - "description": "The subttle of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "tags", - "type": "[ProductTagDTO](../../product/interfaces/product.ProductTagDTO.mdx)[]", - "description": "The associated product tags.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "thumbnail", - "type": "`null` \\| `string`", - "description": "The URL of the product's thumbnail.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The title of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "type", - "type": "[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO.mdx)[]", - "description": "The associated product type.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "updated_at", - "type": "`string` \\| `Date`", - "description": "When the product was updated.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "variants", - "type": "[ProductVariantDTO](../../product/interfaces/product.ProductVariantDTO.mdx)[]", - "description": "The associated product variants.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "weight", - "type": "`null` \\| `number`", - "description": "The weight of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`null` \\| `number`", - "description": "The width of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "title", - "type": "`string`", - "description": "The title of the product option.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "values", - "type": "[ProductOptionValueDTO](../../product/interfaces/product.ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "deleted_at", - "type": "`string` \\| `Date`", - "description": "When the product option value was deleted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The ID of the product option value.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`null` \\| `Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "option", - "type": "[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO.mdx)", - "description": "The associated product option. It may only be available if the `option` relation is expanded.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "value", - "type": "`string`", - "description": "The value of the product option value.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "variant", - "type": "[ProductVariantDTO](../../product/interfaces/product.ProductVariantDTO.mdx)", - "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveTag.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveTag.mdx deleted file mode 100644 index b21702b984ef8..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveTag.mdx +++ /dev/null @@ -1,498 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/retrieveTag -sidebar_label: retrieveTag ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveTag - Product Module Reference - -This documentation provides a reference to the retrieveTag method. This belongs to the Product Module. - -This method is used to retrieve a tag by its ID. - -## Example - -A simple example that retrieves a product tag by its ID: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTag (tagId: string) { - const productModule = await initializeProductModule() - - const productTag = await productModule.retrieveTag(tagId) - - // do something with the product tag or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductTag (tagId: string) { - const productModule = await initializeProductModule() - - const productTag = await productModule.retrieveTag(tagId, { - relations: ["products"] - }) - - // do something with the product tag or return it -} -``` - -## Parameters - - - -## Returns - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "products", - "type": "[ProductDTO](../../product/interfaces/product.ProductDTO.mdx)[]", - "description": "The associated products.", - "optional": true, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "categories", - "type": "`null` \\| [ProductCategoryDTO](../../product/interfaces/product.ProductCategoryDTO.mdx)[]", - "description": "The associated product categories.", - "optional": true, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "collection", - "type": "[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO.mdx)", - "description": "The associated product collection.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "created_at", - "type": "`string` \\| `Date`", - "description": "When the product was created.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleted_at", - "type": "`string` \\| `Date`", - "description": "When the product was deleted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "description", - "type": "`null` \\| `string`", - "description": "The description of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "discountable", - "type": "`boolean`", - "description": "Whether the product can be discounted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "external_id", - "type": "`null` \\| `string`", - "description": "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.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "handle", - "type": "`null` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "height", - "type": "`null` \\| `number`", - "description": "The height of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "hs_code", - "type": "`null` \\| `string`", - "description": "The HS Code of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The ID of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "images", - "type": "[ProductImageDTO](../../product/interfaces/product.ProductImageDTO.mdx)[]", - "description": "The associated product images.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "is_giftcard", - "type": "`boolean`", - "description": "Whether the product is a gift card.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "length", - "type": "`null` \\| `number`", - "description": "The length of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "material", - "type": "`null` \\| `string`", - "description": "The material of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`null` \\| `string`", - "description": "The MID Code of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO.mdx)[]", - "description": "The associated product options.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "origin_country", - "type": "`null` \\| `string`", - "description": "The origin country of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "status", - "type": "[ProductStatus](../../product/enums/product.ProductStatus.mdx)", - "description": "The status of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "subtitle", - "type": "`null` \\| `string`", - "description": "The subttle of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "tags", - "type": "[ProductTagDTO](../../product/interfaces/product.ProductTagDTO.mdx)[]", - "description": "The associated product tags.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "thumbnail", - "type": "`null` \\| `string`", - "description": "The URL of the product's thumbnail.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The title of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "type", - "type": "[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO.mdx)[]", - "description": "The associated product type.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "updated_at", - "type": "`string` \\| `Date`", - "description": "When the product was updated.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "variants", - "type": "[ProductVariantDTO](../../product/interfaces/product.ProductVariantDTO.mdx)[]", - "description": "The associated product variants.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "weight", - "type": "`null` \\| `number`", - "description": "The weight of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`null` \\| `number`", - "description": "The width of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "value", - "type": "`string`", - "description": "The value of the product tag.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveType.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveType.mdx deleted file mode 100644 index 649838f0af5c2..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveType.mdx +++ /dev/null @@ -1,236 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/retrieveType -sidebar_label: retrieveType ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveType - Product Module Reference - -This documentation provides a reference to the retrieveType method. This belongs to the Product Module. - -This method is used to retrieve a product type by its ID. - -## Example - -A simple example that retrieves a product type by its ID: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductType (id: string) { - const productModule = await initializeProductModule() - - const productType = await productModule.retrieveType(id) - - // do something with the product type or return it -} -``` - -To specify attributes that should be retrieved: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductType (id: string) { - const productModule = await initializeProductModule() - - const productType = await productModule.retrieveType(id, { - select: ["value"] - }) - - // do something with the product type or return it -} -``` - -## Parameters - - - -## Returns - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "value", - "type": "`string`", - "description": "The value of the product type.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveVariant.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveVariant.mdx deleted file mode 100644 index 134b7e6c2d03c..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.retrieveVariant.mdx +++ /dev/null @@ -1,742 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/retrieveVariant -sidebar_label: retrieveVariant ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieveVariant - Product Module Reference - -This documentation provides a reference to the retrieveVariant method. This belongs to the Product Module. - -This method is used to retrieve a product variant by its ID. - -## Example - -A simple example that retrieves a product variant by its ID: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductVariant (id: string) { - const productModule = await initializeProductModule() - - const variant = await productModule.retrieveVariant(id) - - // do something with the product variant or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function retrieveProductVariant (id: string) { - const productModule = await initializeProductModule() - - const variant = await productModule.retrieveVariant(id, { - relations: ["options"] - }) - - // do something with the product variant or return it -} -``` - -## Parameters - - - -## Returns - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`null` \\| `string`", - "description": "The MID Code of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "[ProductOptionValueDTO](../../product/interfaces/product.ProductOptionValueDTO.mdx)[]", - "description": "The associated product options.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "deleted_at", - "type": "`string` \\| `Date`", - "description": "When the product option value was deleted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The ID of the product option value.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`null` \\| `Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "option", - "type": "[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO.mdx)", - "description": "The associated product option. It may only be available if the `option` relation is expanded.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "value", - "type": "`string`", - "description": "The value of the product option value.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "variant", - "type": "[ProductVariantDTO](../../product/interfaces/product.ProductVariantDTO.mdx)", - "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "origin_country", - "type": "`null` \\| `string`", - "description": "The origin country of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "product", - "type": "[ProductDTO](../../product/interfaces/product.ProductDTO.mdx)", - "description": "The associated product.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "categories", - "type": "`null` \\| [ProductCategoryDTO](../../product/interfaces/product.ProductCategoryDTO.mdx)[]", - "description": "The associated product categories.", - "optional": true, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "collection", - "type": "[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO.mdx)", - "description": "The associated product collection.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "created_at", - "type": "`string` \\| `Date`", - "description": "When the product was created.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "deleted_at", - "type": "`string` \\| `Date`", - "description": "When the product was deleted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "description", - "type": "`null` \\| `string`", - "description": "The description of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "discountable", - "type": "`boolean`", - "description": "Whether the product can be discounted.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "external_id", - "type": "`null` \\| `string`", - "description": "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.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "handle", - "type": "`null` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "height", - "type": "`null` \\| `number`", - "description": "The height of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "hs_code", - "type": "`null` \\| `string`", - "description": "The HS Code of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The ID of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "images", - "type": "[ProductImageDTO](../../product/interfaces/product.ProductImageDTO.mdx)[]", - "description": "The associated product images.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "is_giftcard", - "type": "`boolean`", - "description": "Whether the product is a gift card.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "length", - "type": "`null` \\| `number`", - "description": "The length of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "material", - "type": "`null` \\| `string`", - "description": "The material of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`null` \\| `string`", - "description": "The MID Code of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO.mdx)[]", - "description": "The associated product options.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "origin_country", - "type": "`null` \\| `string`", - "description": "The origin country of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "status", - "type": "[ProductStatus](../../product/enums/product.ProductStatus.mdx)", - "description": "The status of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "subtitle", - "type": "`null` \\| `string`", - "description": "The subttle of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "tags", - "type": "[ProductTagDTO](../../product/interfaces/product.ProductTagDTO.mdx)[]", - "description": "The associated product tags.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "thumbnail", - "type": "`null` \\| `string`", - "description": "The URL of the product's thumbnail.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The title of the product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "type", - "type": "[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO.mdx)[]", - "description": "The associated product type.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "updated_at", - "type": "`string` \\| `Date`", - "description": "When the product was updated.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "variants", - "type": "[ProductVariantDTO](../../product/interfaces/product.ProductVariantDTO.mdx)[]", - "description": "The associated product variants.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "weight", - "type": "`null` \\| `number`", - "description": "The weight of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`null` \\| `number`", - "description": "The width of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "product_id", - "type": "`string`", - "description": "The ID of the associated product.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "sku", - "type": "`null` \\| `string`", - "description": "The SKU of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The tile of the product variant.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "upc", - "type": "`null` \\| `string`", - "description": "The UPC of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updated_at", - "type": "`string` \\| `Date`", - "description": "When the product variant was updated.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "variant_rank", - "type": "`null` \\| `number`", - "description": "he ranking of the variant among other variants associated with the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "weight", - "type": "`null` \\| `number`", - "description": "The weight of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`null` \\| `number`", - "description": "The width of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.softDelete.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.softDelete.mdx deleted file mode 100644 index 6e42f473b8dd6..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.softDelete.mdx +++ /dev/null @@ -1,160 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/softDelete -sidebar_label: softDelete ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# softDelete - Product Module Reference - -This documentation provides a reference to the softDelete method. This belongs to the Product Module. - -This method is used to delete products. Unlike the [delete](product.IProductModuleService.delete.mdx) method, this method won't completely remove the product. It can still be accessed or retrieved using methods like [retrieve](product.IProductModuleService.retrieve.mdx) if you pass the `withDeleted` property to the `config` object parameter. - -The soft-deleted products can be restored using the [restore](product.IProductModuleService.restore.mdx) method. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function deleteProducts (ids: string[]) { - const productModule = await initializeProductModule() - - const cascadedEntities = await productModule.softDelete(ids) - - // do something with the returned cascaded entity IDs or return them -} -``` - -## Type Parameters - - - -## Parameters - - - -## Returns - -`", - "optional": true, - "defaultValue": "", - "description": "", - "expandable": false, - "children": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.update.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.update.mdx deleted file mode 100644 index 50d5914cb2f0f..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.update.mdx +++ /dev/null @@ -1,479 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/update -sidebar_label: update ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# update - Product Module Reference - -This documentation provides a reference to the update method. This belongs to the Product Module. - -This method is used to update a product. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function updateProduct (id: string, title: string) { - const productModule = await initializeProductModule() - - const products = await productModule.update([ - { - id, - title - } - ]) - - // do something with the products or return them -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`string`", - "description": "The MID Code of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "[CreateProductOptionDTO](../../product/interfaces/product.CreateProductOptionDTO.mdx)[]", - "description": "The product options to be created and associated with the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "product_id", - "type": "`string`", - "description": "The ID of the associated product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The product option's title.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "origin_country", - "type": "`string`", - "description": "The origin country of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "status", - "type": "[ProductStatus](../../product/enums/product.ProductStatus.mdx)", - "description": "The status of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "DRAFT", - "type": "`\"draft\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "PROPOSED", - "type": "`\"proposed\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "PUBLISHED", - "type": "`\"published\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "REJECTED", - "type": "`\"rejected\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "subtitle", - "type": "`string`", - "description": "The subttle of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "tags", - "type": "[CreateProductTagDTO](../../product/interfaces/product.CreateProductTagDTO.mdx)[]", - "description": "The product tags to be created and associated with the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "value", - "type": "`string`", - "description": "The value of the product tag.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "thumbnail", - "type": "`string`", - "description": "The URL of the product's thumbnail.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The title of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "type", - "type": "[CreateProductTypeDTO](../../product/interfaces/product.CreateProductTypeDTO.mdx)", - "description": "The product type to create and associate with the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "id", - "type": "`string`", - "description": "The product type's ID.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "value", - "type": "`string`", - "description": "The product type's value.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "type_id", - "type": "`null` \\| `string`", - "description": "The product type to be associated with the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "variants", - "type": "([CreateProductVariantDTO](../../product/interfaces/product.CreateProductVariantDTO.mdx) \\| [UpdateProductVariantDTO](../../product/interfaces/product.UpdateProductVariantDTO.mdx))[]", - "description": "The product variants to be created and associated with the product. You can also update existing product variants associated with the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "weight", - "type": "`number`", - "description": "The weight of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`number`", - "description": "The width of the product.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../product/interfaces/product.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateCategory.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateCategory.mdx deleted file mode 100644 index f0400e59a1d5a..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateCategory.mdx +++ /dev/null @@ -1,490 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/updateCategory -sidebar_label: updateCategory ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateCategory - Product Module Reference - -This documentation provides a reference to the updateCategory method. This belongs to the Product Module. - -This method is used to update a product category by its ID. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function updateCategory (id: string, name: string) { - const productModule = await initializeProductModule() - - const category = await productModule.updateCategory(id, { - name, - }) - - // do something with the product category or return it -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "name", - "type": "`string`", - "description": "The name of the product category.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "parent_category_id", - "type": "`null` \\| `string`", - "description": "The ID of the parent product category, if it has any.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "rank", - "type": "`number`", - "description": "The ranking of the category among sibling categories.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../product/interfaces/product.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateCollections.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateCollections.mdx deleted file mode 100644 index 7f00d76f6b362..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateCollections.mdx +++ /dev/null @@ -1,195 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/updateCollections -sidebar_label: updateCollections ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateCollections - Product Module Reference - -This documentation provides a reference to the updateCollections method. This belongs to the Product Module. - -This method is used to update existing product collections. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function updateCollection (id: string, title: string) { - const productModule = await initializeProductModule() - - const collections = await productModule.updateCollections([ - { - id, - title - } - ]) - - // do something with the product collections or return them -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "product_ids", - "type": "`string`[]", - "description": "The IDs of the products to associate with the product collection.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The title of the product collection.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "value", - "type": "`string`", - "description": "The value of the product collection.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../product/interfaces/product.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateOptions.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateOptions.mdx deleted file mode 100644 index e9973120b5344..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateOptions.mdx +++ /dev/null @@ -1,168 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/updateOptions -sidebar_label: updateOptions ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateOptions - Product Module Reference - -This documentation provides a reference to the updateOptions method. This belongs to the Product Module. - -This method is used to update existing product options. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function updateProductOption (id: string, title: string) { - const productModule = await initializeProductModule() - - const productOptions = await productModule.updateOptions([ - { - id, - title - } - ]) - - // do something with the product options or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateTags.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateTags.mdx deleted file mode 100644 index 3748968c91b74..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateTags.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/updateTags -sidebar_label: updateTags ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateTags - Product Module Reference - -This documentation provides a reference to the updateTags method. This belongs to the Product Module. - -This method is used to update existing product tags. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function updateProductTag (id: string, value: string) { - const productModule = await initializeProductModule() - - const productTags = await productModule.updateTags([ - { - id, - value - } - ]) - - // do something with the product tags or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateTypes.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateTypes.mdx deleted file mode 100644 index f9139a6474b6d..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateTypes.mdx +++ /dev/null @@ -1,168 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/updateTypes -sidebar_label: updateTypes ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateTypes - Product Module Reference - -This documentation provides a reference to the updateTypes method. This belongs to the Product Module. - -This method is used to update a product type - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" - -async function updateProductType (id: string, value: string) { - const productModule = await initializeProductModule() - - const productTypes = await productModule.updateTypes([ - { - id, - value - } - ]) - - // do something with the product types or return them -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "value", - "type": "`string`", - "description": "The new value of the product type.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../product/interfaces/product.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateVariants.mdx b/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateVariants.mdx deleted file mode 100644 index 7e4cad49d7018..0000000000000 --- a/www/apps/docs/content/references/IProductModuleService/methods/product.IProductModuleService.updateVariants.mdx +++ /dev/null @@ -1,329 +0,0 @@ ---- -displayed_sidebar: productReference -badge: - variant: orange - text: Beta -slug: /references/product/updateVariants -sidebar_label: updateVariants ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# updateVariants - Product Module Reference - -This documentation provides a reference to the updateVariants method. This belongs to the Product Module. - -This method is used to update a product's variants. - -## Example - -```ts -import { - initialize as initializeProductModule, -} from "@medusajs/product" -import { - UpdateProductVariantDTO -} from "@medusajs/product/dist/types/services/product-variant" - -async function updateProductVariants (items: UpdateProductVariantDTO[]) { - const productModule = await initializeProductModule() - - const productVariants = await productModule.updateVariants(items) - - // do something with the product variants or return them -} -``` - -## Parameters - -`", - "description": "Holds custom data in key-value pairs.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "mid_code", - "type": "`string`", - "description": "The MID Code of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "[CreateProductVariantOptionDTO](../../product/interfaces/product.CreateProductVariantOptionDTO.mdx)[]", - "description": "The product variant options to create and associate with the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "option_id", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "value", - "type": "`string`", - "description": "The value of a product variant option.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "origin_country", - "type": "`string`", - "description": "The origin country of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "sku", - "type": "`string`", - "description": "The SKU of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "title", - "type": "`string`", - "description": "The tile of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "upc", - "type": "`string`", - "description": "The UPC of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "weight", - "type": "`number`", - "description": "The weight of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "width", - "type": "`number`", - "description": "The width of the product variant.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sharedContext", - "type": "[Context](../../product/interfaces/product.Context.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "enableNestedTransactions", - "type": "`boolean`", - "description": "A boolean value indicating whether nested transactions are enabled.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isolationLevel", - "type": "`string`", - "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "manager", - "type": "`TManager`", - "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionId", - "type": "`string`", - "description": "A string indicating the ID of the current transaction.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`TManager`", - "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - - diff --git a/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.create.mdx b/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.create.mdx deleted file mode 100644 index fc442872b6fe6..0000000000000 --- a/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.create.mdx +++ /dev/null @@ -1,315 +0,0 @@ ---- -displayed_sidebar: stockLocationReference -slug: /references/stock-location/create -sidebar_label: create ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# create - Stock Location Module Reference - -This documentation provides a reference to the `create` method. This belongs to the Stock Location Module. - -This method is used to create a stock location. - -## Example - -```ts -import { - initialize as initializeStockLocationModule, -} from "@medusajs/stock-location" - -async function createStockLocation (name: string) { - const stockLocationModule = await initializeStockLocationModule({}) - - const stockLocation = await stockLocationModule.create({ - name - }) - - // do something with the stock location or return it -} -``` - -## Parameters - -`", - "description": "An optional key-value map with additional details", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "name", - "type": "`string`", - "description": "The stock location name", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "context", - "type": "[SharedContext](../../stock_location/interfaces/stock_location.SharedContext.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "manager", - "type": "`EntityManager`", - "description": "An instance of an entity manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`EntityManager`", - "description": "An instance of a transaction manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - -` \\| `null`", - "description": "An optional key-value map with additional details", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "phone", - "type": "`string` \\| `null`", - "description": "Stock location address' phone number", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "postal_code", - "type": "`string` \\| `null`", - "description": "Stock location address' postal code", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "province", - "type": "`string` \\| `null`", - "description": "Stock location address' province", - "optional": true, - "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": "address_id", - "type": "`string`", - "description": "Stock location address' ID", - "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": "deleted_at", - "type": "`string` \\| `Date` \\| `null`", - "description": "The date with timezone at which the resource was deleted.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The stock location's ID", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record` \\| `null`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "name", - "type": "`string`", - "description": "The name of the stock location", - "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/IStockLocationService/methods/stock_location.IStockLocationService.delete.mdx b/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.delete.mdx deleted file mode 100644 index 367d096b6b816..0000000000000 --- a/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.delete.mdx +++ /dev/null @@ -1,83 +0,0 @@ ---- -displayed_sidebar: stockLocationReference -slug: /references/stock-location/delete -sidebar_label: delete ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# delete - Stock Location Module Reference - -This documentation provides a reference to the `delete` method. This belongs to the Stock Location Module. - -This method is used to delete a stock location. - -## Example - -```ts -import { - initialize as initializeStockLocationModule, -} from "@medusajs/stock-location" - -async function deleteStockLocation (id:string) { - const stockLocationModule = await initializeStockLocationModule({}) - - await stockLocationModule.delete(id) -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.list.mdx b/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.list.mdx deleted file mode 100644 index 1637af280856c..0000000000000 --- a/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.list.mdx +++ /dev/null @@ -1,234 +0,0 @@ ---- -displayed_sidebar: stockLocationReference -slug: /references/stock-location/list -sidebar_label: list ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# list - Stock Location Module Reference - -This documentation provides a reference to the `list` method. This belongs to the Stock Location Module. - -This method is used to retrieve a paginated list of stock locations based on optional filters and configuration. - -## Example - -To retrieve a list of stock locations using their IDs: - -```ts -import { - initialize as initializeStockLocationModule, -} from "@medusajs/stock-location" - -async function listStockLocations (ids: string[]) { - const stockLocationModule = await initializeStockLocationModule({}) - - const stockLocations = await stockLocationModule.list({ - id: ids - }) - - // do something with the stock locations or return them -} -``` - -To specify relations that should be retrieved within the stock locations: - -```ts -import { - initialize as initializeStockLocationModule, -} from "@medusajs/stock-location" - -async function listStockLocations (ids: string[]) { - const stockLocationModule = await initializeStockLocationModule({}) - - const stockLocations = await stockLocationModule.list({ - id: ids - }, { - relations: ["address"] - }) - - // do something with the stock locations or return them -} -``` - -By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeStockLocationModule, -} from "@medusajs/stock-location" - -async function listStockLocations (ids: string[], skip: number, take: number) { - const stockLocationModule = await initializeStockLocationModule({}) - - const stockLocations = await stockLocationModule.list({ - id: ids - }, { - relations: ["address"], - skip, - take - }) - - // do something with the stock locations or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.listAndCount.mdx b/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.listAndCount.mdx deleted file mode 100644 index 3e418a58093a5..0000000000000 --- a/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.listAndCount.mdx +++ /dev/null @@ -1,233 +0,0 @@ ---- -displayed_sidebar: stockLocationReference -slug: /references/stock-location/listAndCount -sidebar_label: listAndCount ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# listAndCount - Stock Location Module Reference - -This documentation provides a reference to the `listAndCount` method. This belongs to the Stock Location Module. - -This method is used to retrieve a paginated list of stock locations along with the total count of available stock locations satisfying the provided filters. - -## Example - -To retrieve a list of stock locations using their IDs: - -```ts -import { - initialize as initializeStockLocationModule, -} from "@medusajs/stock-location" - -async function listStockLocations (ids: string[]) { - const stockLocationModule = await initializeStockLocationModule({}) - - const [stockLocations, count] = await stockLocationModule.listAndCount({ - id: ids - }) - - // do something with the stock locations or return them -} -``` - -To specify relations that should be retrieved within the stock locations: - -```ts -import { - initialize as initializeStockLocationModule, -} from "@medusajs/stock-location" - -async function listStockLocations (ids: string[]) { - const stockLocationModule = await initializeStockLocationModule({}) - - const [stockLocations, count] = await stockLocationModule.listAndCount({ - id: ids - }, { - relations: ["address"] - }) - - // do something with the stock locations or return them -} -``` - -By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: - -```ts -import { - initialize as initializeStockLocationModule, -} from "@medusajs/stock-location" - -async function listStockLocations (ids: string[], skip: number, take: number) { - const stockLocationModule = await initializeStockLocationModule({}) - - const [stockLocations, count] = await stockLocationModule.listAndCount({ - id: ids - }, { - relations: ["address"], - skip, - take - }) - - // do something with the stock locations or return them -} -``` - -## Parameters - - - -## Returns - - diff --git a/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.retrieve.mdx b/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.retrieve.mdx deleted file mode 100644 index 2f13c4fc1b1c7..0000000000000 --- a/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.retrieve.mdx +++ /dev/null @@ -1,360 +0,0 @@ ---- -displayed_sidebar: stockLocationReference -slug: /references/stock-location/retrieve -sidebar_label: retrieve ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# retrieve - Stock Location Module Reference - -This documentation provides a reference to the `retrieve` method. This belongs to the Stock Location Module. - -This method is used to retrieve a stock location by its ID - -## Example - -A simple example that retrieves a inventory item by its ID: - -```ts -import { - initialize as initializeStockLocationModule, -} from "@medusajs/stock-location" - -async function retrieveStockLocation (id: string) { - const stockLocationModule = await initializeStockLocationModule({}) - - const stockLocation = await stockLocationModule.retrieve(id) - - // do something with the stock location or return it -} -``` - -To specify relations that should be retrieved: - -```ts -import { - initialize as initializeStockLocationModule, -} from "@medusajs/stock-location" - -async function retrieveStockLocation (id: string) { - const stockLocationModule = await initializeStockLocationModule({}) - - const stockLocation = await stockLocationModule.retrieve(id, { - relations: ["address"] - }) - - // do something with the stock location or return it -} -``` - -## Parameters - - - -## Returns - -` \\| `null`", - "description": "An optional key-value map with additional details", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "phone", - "type": "`string` \\| `null`", - "description": "Stock location address' phone number", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "postal_code", - "type": "`string` \\| `null`", - "description": "Stock location address' postal code", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "province", - "type": "`string` \\| `null`", - "description": "Stock location address' province", - "optional": true, - "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": "address_id", - "type": "`string`", - "description": "Stock location address' ID", - "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": "deleted_at", - "type": "`string` \\| `Date` \\| `null`", - "description": "The date with timezone at which the resource was deleted.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The stock location's ID", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record` \\| `null`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "name", - "type": "`string`", - "description": "The name of the stock location", - "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/IStockLocationService/methods/stock_location.IStockLocationService.update.mdx b/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.update.mdx deleted file mode 100644 index 1cd1f8dc8ba03..0000000000000 --- a/www/apps/docs/content/references/IStockLocationService/methods/stock_location.IStockLocationService.update.mdx +++ /dev/null @@ -1,397 +0,0 @@ ---- -displayed_sidebar: stockLocationReference -slug: /references/stock-location/update -sidebar_label: update ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# update - Stock Location Module Reference - -This documentation provides a reference to the `update` method. This belongs to the Stock Location Module. - -This method is used to update a stock location. - -## Example - -```ts -import { - initialize as initializeStockLocationModule, -} from "@medusajs/stock-location" - -async function updateStockLocation (id:string, name: string) { - const stockLocationModule = await initializeStockLocationModule({}) - - const stockLocation = await stockLocationModule.update(id, { - name - }) - - // do something with the stock location or return it -} -``` - -## Parameters - -`", - "description": "An optional key-value map with additional details", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "phone", - "type": "`string`", - "description": "Stock location address' phone number", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "postal_code", - "type": "`string`", - "description": "Stock location address' postal code", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "province", - "type": "`string`", - "description": "Stock location address' province", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "address_id", - "type": "`string`", - "description": "The Stock location address ID", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record`", - "description": "An optional key-value map with additional details", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "name", - "type": "`string`", - "description": "The stock location name", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "context", - "type": "[SharedContext](../../stock_location/interfaces/stock_location.SharedContext.mdx)", - "description": "A context used to share resources, such as transaction manager, between the application and the module.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "manager", - "type": "`EntityManager`", - "description": "An instance of an entity manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transactionManager", - "type": "`EntityManager`", - "description": "An instance of a transaction manager.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -## Returns - -` \\| `null`", - "description": "An optional key-value map with additional details", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "phone", - "type": "`string` \\| `null`", - "description": "Stock location address' phone number", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "postal_code", - "type": "`string` \\| `null`", - "description": "Stock location address' postal code", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "province", - "type": "`string` \\| `null`", - "description": "Stock location address' province", - "optional": true, - "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": "address_id", - "type": "`string`", - "description": "Stock location address' ID", - "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": "deleted_at", - "type": "`string` \\| `Date` \\| `null`", - "description": "The date with timezone at which the resource was deleted.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The stock location's ID", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "metadata", - "type": "`Record` \\| `null`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "name", - "type": "`string`", - "description": "The name of the stock location", - "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/LoggerTypes/interfaces/types.LoggerTypes.Logger.mdx b/www/apps/docs/content/references/LoggerTypes/interfaces/types.LoggerTypes.Logger.mdx deleted file mode 100644 index 8e9a4f07c2502..0000000000000 --- a/www/apps/docs/content/references/LoggerTypes/interfaces/types.LoggerTypes.Logger.mdx +++ /dev/null @@ -1,125 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# Logger - -## Properties - - `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "debug", - "type": "(`message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "error", - "type": "(`messageOrError`: `any`, `error?`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "failure", - "type": "(`activityId`: `any`, `message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "info", - "type": "(`message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "log", - "type": "(...`args`: `any`[]) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "panic", - "type": "(`data`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "progress", - "type": "(`activityId`: `any`, `message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "setLogLevel", - "type": "(`level`: `string`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "shouldLog", - "type": "(`level`: `string`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "success", - "type": "(`activityId`: `any`, `message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "unsetLogLevel", - "type": "() => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "warn", - "type": "(`message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions.mdx b/www/apps/docs/content/references/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions.mdx deleted file mode 100644 index b4abaa1736c0a..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions.mdx +++ /dev/null @@ -1,216 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ModuleServiceInitializeOptions - -## Properties - -`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "host", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "password", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "pool", - "type": "`Record`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "port", - "type": "`number`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "schema", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "user", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "database.clientUrl", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database.connection", - "type": "`any`", - "description": "Forces to use a shared knex connection", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database.database", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database.debug", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database.driverOptions", - "type": "`Record`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database.host", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database.password", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database.pool", - "type": "`Record`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database.port", - "type": "`number`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database.schema", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "database.user", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor.mdx deleted file mode 100644 index 6b0063395bfd1..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor.mdx +++ /dev/null @@ -1,35 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# Constructor - - **Constructor**: (...`args`: `any`[]) => `T` - -## Type Parameters - - - -## Type declaration - -### Parameters - - diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration.mdx deleted file mode 100644 index 7e74f7865e356..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration.mdx +++ /dev/null @@ -1,183 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ExternalModuleDeclaration - - **ExternalModuleDeclaration**: `Object` - -## Type declaration - -`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "scope", - "type": "[EXTERNAL](../enums/types.ModulesSdkTypes.MODULE_SCOPE.mdx#external)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "server", - "type": "`object`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "keepAlive", - "type": "`boolean`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "type", - "type": "`\"http\"`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "url", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration.mdx deleted file mode 100644 index 2805d2969af4f..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration.mdx +++ /dev/null @@ -1,192 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# InternalModuleDeclaration - - **InternalModuleDeclaration**: `Object` - -## Type declaration - -`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "resolve", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "resources", - "type": "[MODULE_RESOURCE_TYPE](../enums/types.ModulesSdkTypes.MODULE_RESOURCE_TYPE.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "ISOLATED", - "type": "`\"isolated\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "SHARED", - "type": "`\"shared\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "scope", - "type": "[INTERNAL](../enums/types.ModulesSdkTypes.MODULE_SCOPE.mdx#internal)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkModuleDefinition.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkModuleDefinition.mdx deleted file mode 100644 index cd41bf2c32cad..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkModuleDefinition.mdx +++ /dev/null @@ -1,238 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# LinkModuleDefinition - - **LinkModuleDefinition**: `Object` - -## Type declaration - -`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "resolve", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "resources", - "type": "[MODULE_RESOURCE_TYPE](../enums/types.ModulesSdkTypes.MODULE_RESOURCE_TYPE.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "ISOLATED", - "type": "`\"isolated\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "SHARED", - "type": "`\"shared\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "scope", - "type": "[INTERNAL](../enums/types.ModulesSdkTypes.MODULE_SCOPE.mdx#internal)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "dependencies", - "type": "`string`[]", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "key", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "label", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "registrationName", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.LoaderOptions.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.LoaderOptions.mdx deleted file mode 100644 index 7e78bc47b689f..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.LoaderOptions.mdx +++ /dev/null @@ -1,188 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# LoaderOptions - - **LoaderOptions**: `Object` - -## Type Parameters - - - -## Type declaration - - [MedusaContainer](../../CommonTypes/types/types.CommonTypes.MedusaContainer.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "registerAdd", - "type": "``(`name`: `string`, `registration`: `T`) => [MedusaContainer](../../CommonTypes/types/types.CommonTypes.MedusaContainer.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "logger", - "type": "[Logger](../../LoggerTypes/interfaces/types.LoggerTypes.Logger.mdx)", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "activity", - "type": "(`message`: `string`, `config?`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "debug", - "type": "(`message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "error", - "type": "(`messageOrError`: `any`, `error?`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "failure", - "type": "(`activityId`: `any`, `message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "info", - "type": "(`message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "log", - "type": "(...`args`: `any`[]) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "panic", - "type": "(`data`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "progress", - "type": "(`activityId`: `any`, `message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "setLogLevel", - "type": "(`level`: `string`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "shouldLog", - "type": "(`level`: `string`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "success", - "type": "(`activityId`: `any`, `message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "unsetLogLevel", - "type": "() => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "warn", - "type": "(`message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "options", - "type": "`TOptions`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleConfig.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleConfig.mdx deleted file mode 100644 index 80315c4400462..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleConfig.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ModuleConfig - - **ModuleConfig**: [ModuleDeclaration](../../types/types/types.ModuleDeclaration.mdx) & `object` diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition.mdx deleted file mode 100644 index 07d1960f42058..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition.mdx +++ /dev/null @@ -1,100 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ModuleDefinition - - **ModuleDefinition**: `Object` - -## Type declaration - - diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports.mdx deleted file mode 100644 index 85cc5a57a02ab..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports.mdx +++ /dev/null @@ -1,64 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ModuleExports - - **ModuleExports**: `Object` - -## Type declaration - - Promise<void>", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "runMigrations", - "type": "(`options`: [LoaderOptions](types.ModulesSdkTypes.LoaderOptions.mdx)<Record<string, unknown>>, `moduleDeclaration?`: [InternalModuleDeclaration](types.ModulesSdkTypes.InternalModuleDeclaration.mdx)) => Promise<void>", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig.mdx deleted file mode 100644 index e5a43f5784cc2..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ModuleJoinerConfig - - **ModuleJoinerConfig**: Omit<[JoinerServiceConfig](../../types/interfaces/types.JoinerServiceConfig.mdx), "serviceName" \| "primaryKeys" \| "relationships" \| "extends"> & `object` diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleLoaderFunction.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleLoaderFunction.mdx deleted file mode 100644 index 658d6169bb114..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleLoaderFunction.mdx +++ /dev/null @@ -1,392 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ModuleLoaderFunction - - **ModuleLoaderFunction**: (`options`: [LoaderOptions](types.ModulesSdkTypes.LoaderOptions.mdx), `moduleDeclaration?`: [InternalModuleDeclaration](types.ModulesSdkTypes.InternalModuleDeclaration.mdx)) => Promise<void> - -## Type declaration - -### Parameters - - [MedusaContainer](../../CommonTypes/types/types.CommonTypes.MedusaContainer.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "registerAdd", - "type": "``(`name`: `string`, `registration`: `T`) => [MedusaContainer](../../CommonTypes/types/types.CommonTypes.MedusaContainer.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "logger", - "type": "[Logger](../../LoggerTypes/interfaces/types.LoggerTypes.Logger.mdx)", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "activity", - "type": "(`message`: `string`, `config?`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "debug", - "type": "(`message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "error", - "type": "(`messageOrError`: `any`, `error?`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "failure", - "type": "(`activityId`: `any`, `message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "info", - "type": "(`message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "log", - "type": "(...`args`: `any`[]) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "panic", - "type": "(`data`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "progress", - "type": "(`activityId`: `any`, `message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "setLogLevel", - "type": "(`level`: `string`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "shouldLog", - "type": "(`level`: `string`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "success", - "type": "(`activityId`: `any`, `message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "unsetLogLevel", - "type": "() => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "warn", - "type": "(`message`: `any`) => `void`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "options", - "type": "`TOptions`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "moduleDeclaration", - "type": "[InternalModuleDeclaration](types.ModulesSdkTypes.InternalModuleDeclaration.mdx)", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "alias", - "type": "`string`", - "description": "If multiple modules are registered with the same key, the alias can be used to differentiate them", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "definition", - "type": "[ModuleDefinition](types.ModulesSdkTypes.ModuleDefinition.mdx)", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "canOverride", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "defaultModuleDeclaration", - "type": "[InternalModuleDeclaration](types.ModulesSdkTypes.InternalModuleDeclaration.mdx) \\| [ExternalModuleDeclaration](types.ModulesSdkTypes.ExternalModuleDeclaration.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "defaultPackage", - "type": "`string` \\| `false`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "dependencies", - "type": "`string`[]", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isLegacy", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isQueryable", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "isRequired", - "type": "`boolean`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "key", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "label", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "registrationName", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "dependencies", - "type": "`string`[]", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "main", - "type": "`boolean`", - "description": "If the module is the main module for the key when multiple ones are registered", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "options", - "type": "`Record`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "resolve", - "type": "`string`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "resources", - "type": "[MODULE_RESOURCE_TYPE](../enums/types.ModulesSdkTypes.MODULE_RESOURCE_TYPE.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "ISOLATED", - "type": "`\"isolated\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "SHARED", - "type": "`\"shared\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "scope", - "type": "[INTERNAL](../enums/types.ModulesSdkTypes.MODULE_SCOPE.mdx#internal)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - } -]} /> - -### Returns - - diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution.mdx deleted file mode 100644 index db257ed9ae07a..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution.mdx +++ /dev/null @@ -1,192 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ModuleResolution - - **ModuleResolution**: `Object` - -## Type declaration - -`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "resolutionPath", - "type": "`string` \\| `false`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions.mdx deleted file mode 100644 index 2c558004a0f55..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions.mdx +++ /dev/null @@ -1,28 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ModuleServiceInitializeCustomDataLayerOptions - - **ModuleServiceInitializeCustomDataLayerOptions**: `Object` - -## Type declaration - - diff --git a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction.mdx b/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction.mdx deleted file mode 100644 index 1819e1d5dc537..0000000000000 --- a/www/apps/docs/content/references/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction.mdx +++ /dev/null @@ -1,44 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# RemoteQueryFunction - - **RemoteQueryFunction**: (`query`: `string` \| [RemoteJoinerQuery](../../types/interfaces/types.RemoteJoinerQuery.mdx) \| `object`, `variables?`: `Record`) => Promise<any> \| `null` - -## Type declaration - -### Parameters - -`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> - -### Returns - - diff --git a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListDTO.mdx b/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListDTO.mdx deleted file mode 100644 index d55ec8d3dac3a..0000000000000 --- a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListDTO.mdx +++ /dev/null @@ -1,357 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# CreatePriceListDTO - -## Properties - - diff --git a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListPriceDTO.mdx b/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListPriceDTO.mdx deleted file mode 100644 index e7e89a9fc0ab1..0000000000000 --- a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListPriceDTO.mdx +++ /dev/null @@ -1,62 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# CreatePriceListPriceDTO - -## Properties - - diff --git a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListRuleDTO.mdx b/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListRuleDTO.mdx deleted file mode 100644 index 7291218ea03fe..0000000000000 --- a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListRuleDTO.mdx +++ /dev/null @@ -1,26 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# CreatePriceListRuleDTO - -## Properties - - diff --git a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowDTO.mdx b/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowDTO.mdx deleted file mode 100644 index c823d85d97627..0000000000000 --- a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowDTO.mdx +++ /dev/null @@ -1,172 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# CreatePriceListWorkflowDTO - -## Properties - - diff --git a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowInputDTO.mdx b/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowInputDTO.mdx deleted file mode 100644 index 81dabf3315e2e..0000000000000 --- a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowInputDTO.mdx +++ /dev/null @@ -1,182 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# CreatePriceListWorkflowInputDTO - -## Properties - - diff --git a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListPricesWorkflowInputDTO.mdx b/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListPricesWorkflowInputDTO.mdx deleted file mode 100644 index cdae88c73dcdf..0000000000000 --- a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListPricesWorkflowInputDTO.mdx +++ /dev/null @@ -1,26 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# RemovePriceListPricesWorkflowInputDTO - -## Properties - - diff --git a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListProductsWorkflowInputDTO.mdx b/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListProductsWorkflowInputDTO.mdx deleted file mode 100644 index 76be7dd123a00..0000000000000 --- a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListProductsWorkflowInputDTO.mdx +++ /dev/null @@ -1,26 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# RemovePriceListProductsWorkflowInputDTO - -## Properties - - diff --git a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListVariantsWorkflowInputDTO.mdx b/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListVariantsWorkflowInputDTO.mdx deleted file mode 100644 index 5e22658bc466f..0000000000000 --- a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListVariantsWorkflowInputDTO.mdx +++ /dev/null @@ -1,26 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# RemovePriceListVariantsWorkflowInputDTO - -## Properties - - diff --git a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListWorkflowInputDTO.mdx b/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListWorkflowInputDTO.mdx deleted file mode 100644 index 31b1d04ccde24..0000000000000 --- a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListWorkflowInputDTO.mdx +++ /dev/null @@ -1,17 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# RemovePriceListWorkflowInputDTO - -## Properties - - diff --git a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowDTO.mdx b/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowDTO.mdx deleted file mode 100644 index 056d023cab69d..0000000000000 --- a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowDTO.mdx +++ /dev/null @@ -1,109 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# UpdatePriceListWorkflowDTO - -## Properties - - diff --git a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowInputDTO.mdx b/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowInputDTO.mdx deleted file mode 100644 index cb27c849f799a..0000000000000 --- a/www/apps/docs/content/references/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowInputDTO.mdx +++ /dev/null @@ -1,119 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# UpdatePriceListWorkflowInputDTO - -## Properties - - diff --git a/www/apps/docs/content/references/SalesChannelTypes/interfaces/types.SalesChannelTypes.SalesChannelDTO.mdx b/www/apps/docs/content/references/SalesChannelTypes/interfaces/types.SalesChannelTypes.SalesChannelDTO.mdx deleted file mode 100644 index 5c5d923c2b5b9..0000000000000 --- a/www/apps/docs/content/references/SalesChannelTypes/interfaces/types.SalesChannelTypes.SalesChannelDTO.mdx +++ /dev/null @@ -1,127 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# SalesChannelDTO - -## Properties - -`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sales_channel_id", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "metadata", - "type": "`null` \\| `Record`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/SalesChannelTypes/interfaces/types.SalesChannelTypes.SalesChannelLocationDTO.mdx b/www/apps/docs/content/references/SalesChannelTypes/interfaces/types.SalesChannelTypes.SalesChannelLocationDTO.mdx deleted file mode 100644 index a89ca5f75b605..0000000000000 --- a/www/apps/docs/content/references/SalesChannelTypes/interfaces/types.SalesChannelTypes.SalesChannelLocationDTO.mdx +++ /dev/null @@ -1,109 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# SalesChannelLocationDTO - -## Properties - -`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "sales_channel_id", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/SearchTypes/interfaces/types.SearchTypes.ISearchService.mdx b/www/apps/docs/content/references/SearchTypes/interfaces/types.SearchTypes.ISearchService.mdx deleted file mode 100644 index 44108ee007bbc..0000000000000 --- a/www/apps/docs/content/references/SearchTypes/interfaces/types.SearchTypes.ISearchService.mdx +++ /dev/null @@ -1,372 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ISearchService - -## Properties - -`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> - -___ - -## Methods - -### addDocuments - -Used to index documents by the search engine provider - -#### Parameters - - - -#### Returns - - - -___ - -### createIndex - -Used to create an index - -#### Parameters - - - -#### Returns - - - -___ - -### deleteAllDocuments - -Used to delete all documents - -#### Parameters - - - -#### Returns - - - -___ - -### deleteDocument - -Used to delete document - -#### Parameters - - - -#### Returns - - - -___ - -### getIndex - -Used to get an index - -#### Parameters - - - -#### Returns - - - -___ - -### replaceDocuments - -Used to replace documents - -#### Parameters - - - -#### Returns - - - -___ - -### search - -Used to search for a document in an index - -#### Parameters - - - -#### Returns - - - -___ - -### updateSettings - -Used to update the settings of an index - -#### Parameters - - - -#### Returns - - diff --git a/www/apps/docs/content/references/SearchTypes/types/types.SearchTypes.IndexSettings.mdx b/www/apps/docs/content/references/SearchTypes/types/types.SearchTypes.IndexSettings.mdx deleted file mode 100644 index e11ee933770c7..0000000000000 --- a/www/apps/docs/content/references/SearchTypes/types/types.SearchTypes.IndexSettings.mdx +++ /dev/null @@ -1,37 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# IndexSettings - - **IndexSettings**: `Object` - -## Type declaration - -`", - "description": "Settings specific to the provider. E.g. `searchableAttributes`.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "primaryKey", - "type": "`string`", - "description": "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.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "transformer", - "type": "(`document`: `any`) => `any`", - "description": "Document transformer. Used to transform documents before they are added to the index.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/TransactionBaseTypes/interfaces/types.TransactionBaseTypes.ITransactionBaseService.mdx b/www/apps/docs/content/references/TransactionBaseTypes/interfaces/types.TransactionBaseTypes.ITransactionBaseService.mdx deleted file mode 100644 index 5d2316a5a3a7f..0000000000000 --- a/www/apps/docs/content/references/TransactionBaseTypes/interfaces/types.TransactionBaseTypes.ITransactionBaseService.mdx +++ /dev/null @@ -1,35 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# ITransactionBaseService - -## Methods - -### withTransaction - -#### Parameters - - - -#### Returns - - [ITransactionBaseService](types.TransactionBaseTypes.ITransactionBaseService.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} /> diff --git a/www/apps/docs/content/references/WorkflowTypes/modules/types.WorkflowTypes.CartWorkflow.mdx b/www/apps/docs/content/references/WorkflowTypes/modules/types.WorkflowTypes.CartWorkflow.mdx deleted file mode 100644 index 468413efe07c2..0000000000000 --- a/www/apps/docs/content/references/WorkflowTypes/modules/types.WorkflowTypes.CartWorkflow.mdx +++ /dev/null @@ -1,8 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# CartWorkflow - -## Interfaces - -- [CreateCartWorkflowInputDTO](../../CartWorkflow/interfaces/types.WorkflowTypes.CartWorkflow.CreateCartWorkflowInputDTO.mdx) -- [CreateLineItemInputDTO](../../CartWorkflow/interfaces/types.WorkflowTypes.CartWorkflow.CreateLineItemInputDTO.mdx) diff --git a/www/apps/docs/content/references/WorkflowTypes/modules/types.WorkflowTypes.CommonWorkflow.mdx b/www/apps/docs/content/references/WorkflowTypes/modules/types.WorkflowTypes.CommonWorkflow.mdx deleted file mode 100644 index ed19327617d3f..0000000000000 --- a/www/apps/docs/content/references/WorkflowTypes/modules/types.WorkflowTypes.CommonWorkflow.mdx +++ /dev/null @@ -1,7 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# CommonWorkflow - -## Interfaces - -- [WorkflowInputConfig](../../CommonWorkflow/interfaces/types.WorkflowTypes.CommonWorkflow.WorkflowInputConfig.mdx) diff --git a/www/apps/docs/content/references/WorkflowTypes/modules/types.WorkflowTypes.PriceListWorkflow.mdx b/www/apps/docs/content/references/WorkflowTypes/modules/types.WorkflowTypes.PriceListWorkflow.mdx deleted file mode 100644 index 96d572d49beae..0000000000000 --- a/www/apps/docs/content/references/WorkflowTypes/modules/types.WorkflowTypes.PriceListWorkflow.mdx +++ /dev/null @@ -1,21 +0,0 @@ -import ParameterTypes from "@site/src/components/ParameterTypes" - -# PriceListWorkflow - -## Interfaces - -- [CreatePriceListDTO](../../PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListDTO.mdx) -- [CreatePriceListPriceDTO](../../PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListPriceDTO.mdx) -- [CreatePriceListRuleDTO](../../PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListRuleDTO.mdx) -- [CreatePriceListWorkflowDTO](../../PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowDTO.mdx) -- [CreatePriceListWorkflowInputDTO](../../PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListWorkflowInputDTO.mdx) -- [RemovePriceListPricesWorkflowInputDTO](../../PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListPricesWorkflowInputDTO.mdx) -- [RemovePriceListProductsWorkflowInputDTO](../../PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListProductsWorkflowInputDTO.mdx) -- [RemovePriceListVariantsWorkflowInputDTO](../../PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListVariantsWorkflowInputDTO.mdx) -- [RemovePriceListWorkflowInputDTO](../../PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.RemovePriceListWorkflowInputDTO.mdx) -- [UpdatePriceListWorkflowDTO](../../PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowDTO.mdx) -- [UpdatePriceListWorkflowInputDTO](../../PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.UpdatePriceListWorkflowInputDTO.mdx) - -## Type Aliases - -- [PriceListVariantPriceDTO](../../PriceListWorkflow/types/types.WorkflowTypes.PriceListWorkflow.PriceListVariantPriceDTO.mdx) diff --git a/www/apps/docs/content/references/entities/classes/entities.Address.mdx b/www/apps/docs/content/references/entities/classes/entities.Address.mdx index 4dfd5687f5630..975eaa1759054 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Address.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Address.mdx @@ -11,167 +11,4 @@ An address is used across the Medusa backend within other schemas and object typ ## Properties -`", - "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": [] - } -]} 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":"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":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.AnalyticsConfig.mdx b/www/apps/docs/content/references/entities/classes/entities.AnalyticsConfig.mdx index c51415727a418..fa31254312d48 100644 --- a/www/apps/docs/content/references/entities/classes/entities.AnalyticsConfig.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.AnalyticsConfig.mdx @@ -9,68 +9,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Properties - + 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 25d551487328f..15e8e7f3604e1 100644 --- a/www/apps/docs/content/references/entities/classes/entities.BatchJob.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.BatchJob.mdx @@ -11,386 +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": "failed_at", - "type": "`Date`", - "description": "The date when the job failed.", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The unique identifier for the batch job.", - "optional": false, - "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": [] - }, - { - "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": [] - } -]} 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":"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"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.Cart.mdx b/www/apps/docs/content/references/entities/classes/entities.Cart.mdx index ae86f91545276..f4e44a80461fc 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Cart.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Cart.mdx @@ -11,383 +11,4 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a ## Properties -`", - "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.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": "discount_total", - "type": "`number`", - "description": "The total of discount rounded", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "discounts", - "type": "[Discount](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_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": "gift_cards", - "type": "[GiftCard](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": "item_tax_total", - "type": "`null` \\| `number`", - "description": "The total of items with taxes", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "items", - "type": "[LineItem](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.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.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.PaymentSession.mdx)[]", - "description": "The details of all payment sessions created on the cart.", - "optional": false, - "defaultValue": "", - "expandable": true, - "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": "region", - "type": "[Region](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.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.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.ShippingMethod.mdx)[]", - "description": "The details of the shipping methods added to the cart.", - "optional": false, - "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": "type", - "type": "[CartType](../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": [] - } -]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> +`","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.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.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.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.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.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.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.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](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.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.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.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../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":"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":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.ClaimImage.mdx b/www/apps/docs/content/references/entities/classes/entities.ClaimImage.mdx index 1644fa8fa868e..8c0c6cbc98d29 100644 --- a/www/apps/docs/content/references/entities/classes/entities.ClaimImage.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.ClaimImage.mdx @@ -11,222 +11,4 @@ The details of an image attached to a claim. ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "note", - "type": "`string`", - "description": "An optional note about the claim, for additional information", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "quantity", - "type": "`number`", - "description": "The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "reason", - "type": "[ClaimReason](../enums/entities.ClaimReason.mdx)", - "description": "The reason for the claim", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "tags", - "type": "[ClaimTag](entities.ClaimTag.mdx)[]", - "description": "User defined tags for easy filtering and grouping.", - "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": "variant", - "type": "[ProductVariant](entities.ProductVariant.mdx)", - "description": "The details of the product variant to potentially replace the item in the original order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "variant_id", - "type": "`string`", - "description": "The ID of the product variant that is claimed.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "claim_item_id", - "type": "`string`", - "description": "The ID of the claim item associated with the image", - "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 claim image'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": "url", - "type": "`string`", - "description": "The URL of the image", - "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":"note","type":"`string`","description":"An optional note about the claim, for additional information","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../enums/entities.ClaimReason.mdx)","description":"The reason for the claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ClaimTag](entities.ClaimTag.mdx)[]","description":"User defined tags for easy filtering and grouping.","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":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant to potentially replace the item in the original order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the product variant that is claimed.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim_item_id","type":"`string`","description":"The ID of the claim item associated with the image","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 claim image'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":"url","type":"`string`","description":"The URL of the image","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/classes/entities.ClaimItem.mdx b/www/apps/docs/content/references/entities/classes/entities.ClaimItem.mdx index 12ff44748a460..675a2fdeb70f8 100644 --- a/www/apps/docs/content/references/entities/classes/entities.ClaimItem.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.ClaimItem.mdx @@ -11,1146 +11,4 @@ A claim item is an item created as part of a claim. It references an item in the ## Properties -`", - "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.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](../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.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.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.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](../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": "claim_order_id", - "type": "`string`", - "description": "The ID of the claim this item is associated with.", - "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 claim item's ID", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "images", - "type": "[ClaimImage](entities.ClaimImage.mdx)[]", - "description": "The claim images that are attached to the claim item.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "claim_item", - "type": "[ClaimItem](entities.ClaimItem.mdx)", - "description": "The details of the claim item this image is associated with.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "claim_item_id", - "type": "`string`", - "description": "The ID of the claim item associated with the image", - "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 claim image'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": "url", - "type": "`string`", - "description": "The URL of the image", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "item", - "type": "[LineItem](entities.LineItem.mdx)", - "description": "The details of the line item in the original order that this claim item refers to.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "adjustments", - "type": "[LineItemAdjustment](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.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.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": "discount_total", - "type": "`null` \\| `number`", - "description": "The total of discount of the line item rounded", - "optional": true, - "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": "gift_card_total", - "type": "`null` \\| `number`", - "description": "The total of the gift card of the line item", - "optional": true, - "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.Order.mdx)", - "description": "The details of the order that the line item may belongs to.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "order_edit", - "type": "`null` \\| [OrderEdit](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": "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": "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": "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": "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": "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": "subtotal", - "type": "`null` \\| `number`", - "description": "The subtotal of the line item", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "swap", - "type": "[Swap](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.LineItemTaxLine.mdx)[]", - "description": "The details of the item's tax lines.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "tax_total", - "type": "`null` \\| `number`", - "description": "The total of tax of the line item", - "optional": true, - "defaultValue": "", - "expandable": false, - "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": "total", - "type": "`null` \\| `number`", - "description": "The total amount of the line item", - "optional": true, - "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.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": "item_id", - "type": "`string`", - "description": "The ID of the line item that the claim item refers to.", - "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 about the claim, for additional information", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "quantity", - "type": "`number`", - "description": "The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "reason", - "type": "[ClaimReason](../enums/entities.ClaimReason.mdx)", - "description": "The reason for the claim", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [ - { - "name": "MISSING_ITEM", - "type": "`\"missing_item\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "OTHER", - "type": "`\"other\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "PRODUCTION_FAILURE", - "type": "`\"production_failure\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "WRONG_ITEM", - "type": "`\"wrong_item\"`", - "description": "", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - } - ] - }, - { - "name": "tags", - "type": "[ClaimTag](entities.ClaimTag.mdx)[]", - "description": "User defined tags for easy filtering and grouping.", - "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 claim 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 claim tag holds", - "optional": false, - "defaultValue": "", - "expandable": false, - "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 to potentially replace the item in the original order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "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.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.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.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.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": "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": [] - }, - { - "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": "variant_id", - "type": "`string`", - "description": "The ID of the product variant that is claimed.", - "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":"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.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](../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.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.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.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](../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":"claim_order_id","type":"`string`","description":"The ID of the claim this item is associated with.","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 claim item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[ClaimImage](entities.ClaimImage.mdx)[]","description":"The claim images that are attached to the claim item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"claim_item","type":"[ClaimItem](entities.ClaimItem.mdx)","description":"The details of the claim item this image is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_item_id","type":"`string`","description":"The ID of the claim item associated with the image","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 claim image'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":"url","type":"`string`","description":"The URL of the image","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item in the original order that this claim item refers to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"adjustments","type":"[LineItemAdjustment](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.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.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.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.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.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.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.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":"item_id","type":"`string`","description":"The ID of the line item that the claim item refers to.","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 about the claim, for additional information","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../enums/entities.ClaimReason.mdx)","description":"The reason for the claim","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tags","type":"[ClaimTag](entities.ClaimTag.mdx)[]","description":"User defined tags for easy filtering and grouping.","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 claim 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 claim tag holds","optional":false,"defaultValue":"","expandable":false,"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 to potentially replace the item in the original order.","optional":false,"defaultValue":"","expandable":true,"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.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.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.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.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":[]}]},{"name":"variant_id","type":"`string`","description":"The ID of the product variant that is claimed.","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/classes/entities.ClaimOrder.mdx b/www/apps/docs/content/references/entities/classes/entities.ClaimOrder.mdx index 5facd9f70a048..fa5a6977a648e 100644 --- a/www/apps/docs/content/references/entities/classes/entities.ClaimOrder.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.ClaimOrder.mdx @@ -11,194 +11,4 @@ A Claim represents a group of faulty or missing items. It consists of claim item ## Properties -`", - "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.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](../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.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.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.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](../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": [] - } -]} 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":"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.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](../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.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.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.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](../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":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.ClaimTag.mdx b/www/apps/docs/content/references/entities/classes/entities.ClaimTag.mdx index 9b2ce3d820f1c..4ae4eb4e7d247 100644 --- a/www/apps/docs/content/references/entities/classes/entities.ClaimTag.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.ClaimTag.mdx @@ -11,59 +11,4 @@ Claim Tags are user defined tags that can be assigned to claim items for easy fi ## Properties -`", - "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 claim tag holds", - "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":"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 claim tag holds","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/classes/entities.Country.mdx b/www/apps/docs/content/references/entities/classes/entities.Country.mdx index 94953c2bdb8f7..e025bd2c4969b 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Country.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Country.mdx @@ -11,250 +11,4 @@ Country details ## 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 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.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.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.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": "`null` \\| `string`", - "description": "The region ID this country is associated with.", - "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 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.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.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.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":"`null` \\| `string`","description":"The region ID this country is associated with.","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/classes/entities.Currency.mdx b/www/apps/docs/content/references/entities/classes/entities.Currency.mdx index ecc7bac389927..863ea15718c2e 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Currency.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Currency.mdx @@ -11,51 +11,4 @@ Currency ## Properties - + diff --git a/www/apps/docs/content/references/entities/classes/entities.CustomShippingOption.mdx b/www/apps/docs/content/references/entities/classes/entities.CustomShippingOption.mdx index dc5692bd651f3..4f8c1b412bd95 100644 --- a/www/apps/docs/content/references/entities/classes/entities.CustomShippingOption.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.CustomShippingOption.mdx @@ -11,647 +11,4 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus ## Properties -`", - "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.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": "discount_total", - "type": "`number`", - "description": "The total of discount rounded", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "discounts", - "type": "[Discount](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_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": "gift_cards", - "type": "[GiftCard](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": "item_tax_total", - "type": "`null` \\| `number`", - "description": "The total of items with taxes", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "items", - "type": "[LineItem](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.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.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.PaymentSession.mdx)[]", - "description": "The details of all payment sessions created on the cart.", - "optional": false, - "defaultValue": "", - "expandable": true, - "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": "region", - "type": "[Region](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.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.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.ShippingMethod.mdx)[]", - "description": "The details of the shipping methods added to the cart.", - "optional": false, - "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": "type", - "type": "[CartType](../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": "cart_id", - "type": "`string`", - "description": "The ID of the Cart that the custom shipping option is attached 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": "id", - "type": "`string`", - "description": "The custom shipping option'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": "price", - "type": "`number`", - "description": "The custom price set that will override the shipping option's original price", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "shipping_option", - "type": "[ShippingOption](entities.ShippingOption.mdx)", - "description": "The details of the overridden shipping options.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "admin_only", - "type": "`boolean`", - "description": "Flag to indicate if the Shipping Option usage is restricted to admin users.", - "optional": false, - "defaultValue": "false", - "expandable": false, - "children": [] - }, - { - "name": "amount", - "type": "`null` \\| `number`", - "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", - "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 needed for the Fulfillment Provider to identify the Shipping Option.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "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 shipping option's ID", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "includes_tax", - "type": "`boolean`", - "description": "Whether the shipping option price include tax", - "optional": false, - "defaultValue": "false", - "expandable": false, - "featureFlag": "tax_inclusive_pricing", - "children": [] - }, - { - "name": "is_return", - "type": "`boolean`", - "description": "Flag to indicate if the Shipping Option can be used for Return shipments.", - "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": "name", - "type": "`string`", - "description": "The name given to the Shipping Option - this may be displayed to the Customer.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "price_type", - "type": "[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)", - "description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "profile", - "type": "[ShippingProfile](entities.ShippingProfile.mdx)", - "description": "The details of the shipping profile that the shipping option belongs to.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "profile_id", - "type": "`string`", - "description": "The ID of the Shipping Profile that the shipping option belongs to.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "provider", - "type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)", - "description": "The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "provider_id", - "type": "`string`", - "description": "The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "region", - "type": "[Region](entities.Region.mdx)", - "description": "The details of the region this shipping option can be used in.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "region_id", - "type": "`string`", - "description": "The ID of the region this shipping option can be used in.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "requirements", - "type": "[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]", - "description": "The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.", - "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": "shipping_option_id", - "type": "`string`", - "description": "The ID of the Shipping Option that the custom shipping option overrides", - "optional": false, - "defaultValue": "", - "expandable": 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":"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.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.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.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.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.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.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.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](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.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.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.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../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":"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 custom shipping option is attached 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":"id","type":"`string`","description":"The custom shipping option'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":"price","type":"`number`","description":"The custom price set that will override the shipping option's original price","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"[ShippingOption](entities.ShippingOption.mdx)","description":"The details of the overridden shipping options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"admin_only","type":"`boolean`","description":"Flag to indicate if the Shipping Option usage is restricted to admin users.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"amount","type":"`null` \\| `number`","description":"The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.","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 needed for the Fulfillment Provider to identify the Shipping Option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"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 shipping option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the shipping option price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"is_return","type":"`boolean`","description":"Flag to indicate if the Shipping Option can be used for Return shipments.","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":"name","type":"`string`","description":"The name given to the Shipping Option - this may be displayed to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)","description":"The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the Shipping Profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requirements","type":"[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]","description":"The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.","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":"shipping_option_id","type":"`string`","description":"The ID of the Shipping Option that the custom shipping option overrides","optional":false,"defaultValue":"","expandable":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/classes/entities.Customer.mdx b/www/apps/docs/content/references/entities/classes/entities.Customer.mdx index 505cbdf924f0e..63a2a3eb7f9b6 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Customer.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Customer.mdx @@ -11,1062 +11,4 @@ A customer can make purchases in your store and manage their profile. ## Properties -`", - "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.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.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.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.Order.mdx)[]", - "description": "The details of the orders this customer placed.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "billing_address", - "type": "[Address](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.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.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.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.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.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.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.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](../enums/entities.FulfillmentStatus.mdx)", - "description": "The order's fulfillment status", - "optional": false, - "defaultValue": "not_fulfilled", - "expandable": false, - "children": [] - }, - { - "name": "fulfillments", - "type": "[Fulfillment](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.GiftCardTransaction.mdx)[]", - "description": "The gift card transactions made in the order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "gift_cards", - "type": "[GiftCard](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.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](../enums/entities.PaymentStatus.mdx)", - "description": "The order's payment status", - "optional": false, - "defaultValue": "not_paid", - "expandable": false, - "children": [] - }, - { - "name": "payments", - "type": "[Payment](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.Refund.mdx)[]", - "description": "The details of the refunds created for the order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "region", - "type": "[Region](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": "returnable_items", - "type": "[LineItem](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": "returns", - "type": "[Return](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.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.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.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](../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.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": "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.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.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.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/development/entities/repositories#retrieving-a-list-of-records"/> +`","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.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.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.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.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](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.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.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.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.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.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.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.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](../enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](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.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](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.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](../enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](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.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](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.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](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.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.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](../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.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.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":"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.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.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.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/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.CustomerGroup.mdx b/www/apps/docs/content/references/entities/classes/entities.CustomerGroup.mdx index 861044d5fc117..64b89212c6d25 100644 --- a/www/apps/docs/content/references/entities/classes/entities.CustomerGroup.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.CustomerGroup.mdx @@ -11,341 +11,4 @@ A customer group that can be used to organize customers into groups of similar t ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "orders", - "type": "[Order](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.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.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.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.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/development/entities/repositories#retrieving-a-list-of-records"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](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.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.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.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.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/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.Discount.mdx b/www/apps/docs/content/references/entities/classes/entities.Discount.mdx index 4044028f4c0a0..6c83696a3152b 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Discount.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Discount.mdx @@ -11,594 +11,4 @@ A discount can be applied to a cart for promotional purposes. ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "parent_discount", - "type": "[Discount](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.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.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.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.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.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.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.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.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.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.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.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](../enums/entities.AllocationType.mdx)", - "description": "The scope that the discount should apply to.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "conditions", - "type": "[DiscountCondition](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](../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/development/entities/repositories#retrieving-a-list-of-records"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](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.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.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.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.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.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.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.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.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.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.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.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](../enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](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](../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/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.DiscountCondition.mdx b/www/apps/docs/content/references/entities/classes/entities.DiscountCondition.mdx index 538898abfd106..f43f342dfcfd4 100644 --- a/www/apps/docs/content/references/entities/classes/entities.DiscountCondition.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.DiscountCondition.mdx @@ -11,860 +11,4 @@ Holds rule conditions for when a discount is applicable ## 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": "discount_rule", - "type": "[DiscountRule](entities.DiscountRule.mdx)", - "description": "The details of the discount rule associated with the condition.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "allocation", - "type": "[AllocationType](../enums/entities.AllocationType.mdx)", - "description": "The scope that the discount should apply to.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "conditions", - "type": "[DiscountCondition](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](../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](../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.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.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.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.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.Product.mdx)[]", - "description": "products associated with this condition if `type` is `products`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "categories", - "type": "[ProductCategory](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.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.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.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.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.ShippingProfile.mdx)[]", - "description": "Available if the relation `profiles` is expanded.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "sales_channels", - "type": "[SalesChannel](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](../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.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.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.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](../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/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":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](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](../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](../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.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.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.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.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.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](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.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.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.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.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.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](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](../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.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.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.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](../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/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.DiscountConditionCustomerGroup.mdx b/www/apps/docs/content/references/entities/classes/entities.DiscountConditionCustomerGroup.mdx index f25f6c43862f5..f1a7bfb549e45 100644 --- a/www/apps/docs/content/references/entities/classes/entities.DiscountConditionCustomerGroup.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.DiscountConditionCustomerGroup.mdx @@ -11,268 +11,4 @@ Associates a discount condition with a customer group ## 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": "customer_group_id", - "type": "`string`", - "description": "The ID of the Product Tag", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "discount_condition", - "type": "[DiscountCondition](entities.DiscountCondition.mdx)", - "description": "Available if the relation `discount\\_condition` is expanded.", - "optional": true, - "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_groups", - "type": "[CustomerGroup](entities.CustomerGroup.mdx)[]", - "description": "Customer groups associated with this condition if `type` is `customer\\_groups`.", - "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": "discount_rule", - "type": "[DiscountRule](entities.DiscountRule.mdx)", - "description": "The details of the discount rule associated with the condition.", - "optional": false, - "defaultValue": "", - "expandable": true, - "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](../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": "product_collections", - "type": "[ProductCollection](entities.ProductCollection.mdx)[]", - "description": "Product collections associated with this condition if `type` is `product\\_collections`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_tags", - "type": "[ProductTag](entities.ProductTag.mdx)[]", - "description": "Product tags associated with this condition if `type` is `product\\_tags`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_types", - "type": "[ProductType](entities.ProductType.mdx)[]", - "description": "Product types associated with this condition if `type` is `product\\_types`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "products", - "type": "[Product](entities.Product.mdx)[]", - "description": "products associated with this condition if `type` is `products`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "type", - "type": "[DiscountConditionType](../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": "updated_at", - "type": "`Date`", - "description": "The date with timezone at which the resource was updated.", - "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": [] - } -]} 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":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_group","type":"[CustomerGroup](entities.CustomerGroup.mdx)","description":"Available if the relation `customer\\_group` is expanded.","optional":true,"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":"customers","type":"[Customer](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.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":"discount_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"Available if the relation `discount\\_condition` is expanded.","optional":true,"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_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"Customer groups associated with this condition if `type` is `customer\\_groups`.","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":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"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](../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":"product_collections","type":"[ProductCollection](entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[DiscountConditionType](../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":"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/classes/entities.DiscountConditionProduct.mdx b/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProduct.mdx index fefabea561344..e11c1aae5e16c 100644 --- a/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProduct.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProduct.mdx @@ -11,512 +11,4 @@ This represents the association between a discount condition and a product ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "operator", - "type": "[DiscountConditionOperator](../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": "product_collections", - "type": "[ProductCollection](entities.ProductCollection.mdx)[]", - "description": "Product collections associated with this condition if `type` is `product\\_collections`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_tags", - "type": "[ProductTag](entities.ProductTag.mdx)[]", - "description": "Product tags associated with this condition if `type` is `product\\_tags`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_types", - "type": "[ProductType](entities.ProductType.mdx)[]", - "description": "Product types associated with this condition if `type` is `product\\_types`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "products", - "type": "[Product](entities.Product.mdx)[]", - "description": "products associated with this condition if `type` is `products`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "type", - "type": "[DiscountConditionType](../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": "updated_at", - "type": "`Date`", - "description": "The date with timezone at which the resource was updated.", - "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": "product", - "type": "[Product](entities.Product.mdx)", - "description": "The details of the product.", - "optional": true, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "categories", - "type": "[ProductCategory](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.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.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.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.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.ShippingProfile.mdx)[]", - "description": "Available if the relation `profiles` is expanded.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "sales_channels", - "type": "[SalesChannel](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](../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.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.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.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": "product_id", - "type": "`string`", - "description": "The ID of the Product Tag", - "optional": false, - "defaultValue": "", - "expandable": 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":"product_id","type":"`string`","description":"The ID of the Product Tag","optional":false,"defaultValue":"","expandable":false,"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_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"The details of the discount condition.","optional":true,"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.CustomerGroup.mdx)[]","description":"Customer groups associated with this condition if `type` is `customer\\_groups`.","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":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"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](../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":"product_collections","type":"[ProductCollection](entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[DiscountConditionType](../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":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](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.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.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.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.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.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](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](../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.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.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.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":[]}]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductCollection.mdx b/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductCollection.mdx index 77d89dc3a8c4c..c8895963f550d 100644 --- a/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductCollection.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductCollection.mdx @@ -11,268 +11,4 @@ This represents the association between a discount condition and a product colle ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "operator", - "type": "[DiscountConditionOperator](../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": "product_collections", - "type": "[ProductCollection](entities.ProductCollection.mdx)[]", - "description": "Product collections associated with this condition if `type` is `product\\_collections`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_tags", - "type": "[ProductTag](entities.ProductTag.mdx)[]", - "description": "Product tags associated with this condition if `type` is `product\\_tags`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_types", - "type": "[ProductType](entities.ProductType.mdx)[]", - "description": "Product types associated with this condition if `type` is `product\\_types`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "products", - "type": "[Product](entities.Product.mdx)[]", - "description": "products associated with this condition if `type` is `products`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "type", - "type": "[DiscountConditionType](../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": "updated_at", - "type": "`Date`", - "description": "The date with timezone at which the resource was updated.", - "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": "product_collection", - "type": "[ProductCollection](entities.ProductCollection.mdx)", - "description": "The details of the product collection.", - "optional": true, - "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.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_collection_id", - "type": "`string`", - "description": "The ID of the Product 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/development/entities/repositories#retrieving-a-list-of-records"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection_id","type":"`string`","description":"The ID of the Product 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":"discount_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"The details of the discount condition.","optional":true,"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.CustomerGroup.mdx)[]","description":"Customer groups associated with this condition if `type` is `customer\\_groups`.","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":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"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](../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":"product_collections","type":"[ProductCollection](entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[DiscountConditionType](../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":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_collection","type":"[ProductCollection](entities.ProductCollection.mdx)","description":"The details of the product collection.","optional":true,"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.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":[]}]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductTag.mdx b/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductTag.mdx index 6b518dad29f4c..f44fa99bc6bc2 100644 --- a/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductTag.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductTag.mdx @@ -11,250 +11,4 @@ This represents the association between a discount condition and a product tag ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "operator", - "type": "[DiscountConditionOperator](../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": "product_collections", - "type": "[ProductCollection](entities.ProductCollection.mdx)[]", - "description": "Product collections associated with this condition if `type` is `product\\_collections`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_tags", - "type": "[ProductTag](entities.ProductTag.mdx)[]", - "description": "Product tags associated with this condition if `type` is `product\\_tags`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_types", - "type": "[ProductType](entities.ProductType.mdx)[]", - "description": "Product types associated with this condition if `type` is `product\\_types`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "products", - "type": "[Product](entities.Product.mdx)[]", - "description": "products associated with this condition if `type` is `products`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "type", - "type": "[DiscountConditionType](../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": "updated_at", - "type": "`Date`", - "description": "The date with timezone at which the resource was updated.", - "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": "product_tag", - "type": "[ProductTag](entities.ProductTag.mdx)", - "description": "The details of the product tag.", - "optional": true, - "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_tag_id", - "type": "`string`", - "description": "The ID of the Product Tag", - "optional": false, - "defaultValue": "", - "expandable": 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":"product_tag_id","type":"`string`","description":"The ID of the Product Tag","optional":false,"defaultValue":"","expandable":false,"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_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"The details of the discount condition.","optional":true,"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.CustomerGroup.mdx)[]","description":"Customer groups associated with this condition if `type` is `customer\\_groups`.","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":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"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](../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":"product_collections","type":"[ProductCollection](entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[DiscountConditionType](../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":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_tag","type":"[ProductTag](entities.ProductTag.mdx)","description":"The details of the product tag.","optional":true,"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":[]}]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductType.mdx b/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductType.mdx index 11a414a195f28..8babc8e3bbcd2 100644 --- a/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductType.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductType.mdx @@ -11,250 +11,4 @@ This represents the association between a discount condition and a product type ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "operator", - "type": "[DiscountConditionOperator](../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": "product_collections", - "type": "[ProductCollection](entities.ProductCollection.mdx)[]", - "description": "Product collections associated with this condition if `type` is `product\\_collections`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_tags", - "type": "[ProductTag](entities.ProductTag.mdx)[]", - "description": "Product tags associated with this condition if `type` is `product\\_tags`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_types", - "type": "[ProductType](entities.ProductType.mdx)[]", - "description": "Product types associated with this condition if `type` is `product\\_types`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "products", - "type": "[Product](entities.Product.mdx)[]", - "description": "products associated with this condition if `type` is `products`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "type", - "type": "[DiscountConditionType](../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": "updated_at", - "type": "`Date`", - "description": "The date with timezone at which the resource was updated.", - "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": "product_type", - "type": "[ProductType](entities.ProductType.mdx)", - "description": "The details of the product type.", - "optional": true, - "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": "product_type_id", - "type": "`string`", - "description": "The ID of the Product Tag", - "optional": false, - "defaultValue": "", - "expandable": 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":"product_type_id","type":"`string`","description":"The ID of the Product Tag","optional":false,"defaultValue":"","expandable":false,"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_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"The details of the discount condition.","optional":true,"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.CustomerGroup.mdx)[]","description":"Customer groups associated with this condition if `type` is `customer\\_groups`.","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":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"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](../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":"product_collections","type":"[ProductCollection](entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[DiscountConditionType](../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":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_type","type":"[ProductType](entities.ProductType.mdx)","description":"The details of the product type.","optional":true,"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":[]}]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.DiscountRule.mdx b/www/apps/docs/content/references/entities/classes/entities.DiscountRule.mdx index 88e665bfd2e83..2fb43a3935063 100644 --- a/www/apps/docs/content/references/entities/classes/entities.DiscountRule.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.DiscountRule.mdx @@ -11,269 +11,4 @@ A discount rule defines how a Discount is calculated when applied to a Cart. ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "operator", - "type": "[DiscountConditionOperator](../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": "product_collections", - "type": "[ProductCollection](entities.ProductCollection.mdx)[]", - "description": "Product collections associated with this condition if `type` is `product\\_collections`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_tags", - "type": "[ProductTag](entities.ProductTag.mdx)[]", - "description": "Product tags associated with this condition if `type` is `product\\_tags`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "product_types", - "type": "[ProductType](entities.ProductType.mdx)[]", - "description": "Product types associated with this condition if `type` is `product\\_types`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "products", - "type": "[Product](entities.Product.mdx)[]", - "description": "products associated with this condition if `type` is `products`.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "type", - "type": "[DiscountConditionType](../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": "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": "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](../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": "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": "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": [] - } -]} 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":"operator","type":"[DiscountConditionOperator](../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":"product_collections","type":"[ProductCollection](entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[DiscountConditionType](../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":"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":"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](../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":"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":"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":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.DraftOrder.mdx b/www/apps/docs/content/references/entities/classes/entities.DraftOrder.mdx index 4d76cd9fa089d..c0a84d62dd8e3 100644 --- a/www/apps/docs/content/references/entities/classes/entities.DraftOrder.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.DraftOrder.mdx @@ -11,131 +11,4 @@ A draft order is created by an admin without direct involvement of the customer. ## Properties -`", - "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.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](../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": [] - } -]} 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":"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.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](../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":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.Fulfillment.mdx b/www/apps/docs/content/references/entities/classes/entities.Fulfillment.mdx index 91b7145e8c939..ee0391db7c02a 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Fulfillment.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Fulfillment.mdx @@ -11,1271 +11,4 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm ## Properties -`", - "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.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](../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.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.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.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](../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": "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.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": "fulfillment", - "type": "[Fulfillment](entities.Fulfillment.mdx)", - "description": "The details of the fulfillment.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "fulfillment_id", - "type": "`string`", - "description": "The ID of the Fulfillment that the Fulfillment Item belongs to.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "item", - "type": "[LineItem](entities.LineItem.mdx)", - "description": "The details of the line item.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "item_id", - "type": "`string`", - "description": "The ID of the Line Item that the Fulfillment Item references.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "quantity", - "type": "`number`", - "description": "The quantity of the Line Item that is included in the Fulfillment.", - "optional": false, - "defaultValue": "", - "expandable": false, - "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.Order.mdx)", - "description": "The details of the order that the fulfillment may belong to.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "billing_address", - "type": "[Address](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.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.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.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.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.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.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.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](../enums/entities.FulfillmentStatus.mdx)", - "description": "The order's fulfillment status", - "optional": false, - "defaultValue": "not_fulfilled", - "expandable": false, - "children": [] - }, - { - "name": "fulfillments", - "type": "[Fulfillment](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.GiftCardTransaction.mdx)[]", - "description": "The gift card transactions made in the order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "gift_cards", - "type": "[GiftCard](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.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](../enums/entities.PaymentStatus.mdx)", - "description": "The order's payment status", - "optional": false, - "defaultValue": "not_paid", - "expandable": false, - "children": [] - }, - { - "name": "payments", - "type": "[Payment](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.Refund.mdx)[]", - "description": "The details of the refunds created for the order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "region", - "type": "[Region](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": "returnable_items", - "type": "[LineItem](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": "returns", - "type": "[Return](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.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.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.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](../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.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": "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.FulfillmentProvider.mdx)", - "description": "The details of the fulfillment provider responsible for handling the fulfillment.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "id", - "type": "`string`", - "description": "The ID of the fulfillment provider as given by the fulfillment service.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "is_installed", - "type": "`boolean`", - "description": "Whether the fulfillment service is installed in the current version. If a fulfillment 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 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.Swap.mdx)", - "description": "The details of the swap that the fulfillment may belong to.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "additional_items", - "type": "[LineItem](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.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](../enums/entities.SwapFulfillmentStatus.mdx)", - "description": "The status of the Fulfillment of the Swap.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "fulfillments", - "type": "[Fulfillment](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.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.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](../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.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.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.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 the Fulfillment belongs to.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "tracking_links", - "type": "[TrackingLink](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": "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": "fulfillment", - "type": "[Fulfillment](entities.Fulfillment.mdx)", - "description": "The details of the fulfillment that the tracking link belongs to.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "fulfillment_id", - "type": "`string`", - "description": "The ID of the fulfillment that the tracking link belongs to.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "The tracking link's ID", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "idempotency_key", - "type": "`string`", - "description": "Randomly generated key used to continue the completion of a process 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": "tracking_number", - "type": "`string`", - "description": "The tracking number given by the shipping carrier.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "updated_at", - "type": "`Date`", - "description": "The date with timezone at which the resource was updated.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "url", - "type": "`string`", - "description": "The URL at which the status of the shipment can be tracked.", - "optional": false, - "defaultValue": "", - "expandable": false, - "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": [] - } -]} 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":"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.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](../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.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.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.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](../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":"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.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":"fulfillment","type":"[Fulfillment](entities.Fulfillment.mdx)","description":"The details of the fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillment_id","type":"`string`","description":"The ID of the Fulfillment that the Fulfillment Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the Line Item that the Fulfillment Item references.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the Line Item that is included in the Fulfillment.","optional":false,"defaultValue":"","expandable":false,"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.Order.mdx)","description":"The details of the order that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](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.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.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.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.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.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.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.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](../enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](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.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](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.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](../enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](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.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](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.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](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.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.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](../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.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.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":"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.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment provider as given by the fulfillment service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the fulfillment service is installed in the current version. If a fulfillment 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 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.Swap.mdx)","description":"The details of the swap that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"additional_items","type":"[LineItem](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.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](../enums/entities.SwapFulfillmentStatus.mdx)","description":"The status of the Fulfillment of the Swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](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.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.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](../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.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.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.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 the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_links","type":"[TrackingLink](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":"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":"fulfillment","type":"[Fulfillment](entities.Fulfillment.mdx)","description":"The details of the fulfillment that the tracking link belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillment_id","type":"`string`","description":"The ID of the fulfillment that the tracking link belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The tracking link's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a process 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":"tracking_number","type":"`string`","description":"The tracking number given by the shipping carrier.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL at which the status of the shipment can be tracked.","optional":false,"defaultValue":"","expandable":false,"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":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.FulfillmentItem.mdx b/www/apps/docs/content/references/entities/classes/entities.FulfillmentItem.mdx index 6a3b0f3869c73..7c7e60ed156ba 100644 --- a/www/apps/docs/content/references/entities/classes/entities.FulfillmentItem.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.FulfillmentItem.mdx @@ -11,629 +11,4 @@ This represents the association between a Line Item and a Fulfillment. ## Properties -`", - "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.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.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.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.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.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": "fulfillment_id", - "type": "`string`", - "description": "The ID of the Fulfillment that the Fulfillment Item belongs to.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "item", - "type": "[LineItem](entities.LineItem.mdx)", - "description": "The details of the line item.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "adjustments", - "type": "[LineItemAdjustment](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.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.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": "discount_total", - "type": "`null` \\| `number`", - "description": "The total of discount of the line item rounded", - "optional": true, - "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": "gift_card_total", - "type": "`null` \\| `number`", - "description": "The total of the gift card of the line item", - "optional": true, - "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.Order.mdx)", - "description": "The details of the order that the line item may belongs to.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "order_edit", - "type": "`null` \\| [OrderEdit](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": "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": "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": "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": "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": "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": "subtotal", - "type": "`null` \\| `number`", - "description": "The subtotal of the line item", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "swap", - "type": "[Swap](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.LineItemTaxLine.mdx)[]", - "description": "The details of the item's tax lines.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "tax_total", - "type": "`null` \\| `number`", - "description": "The total of tax of the line item", - "optional": true, - "defaultValue": "", - "expandable": false, - "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": "total", - "type": "`null` \\| `number`", - "description": "The total amount of the line item", - "optional": true, - "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.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": "item_id", - "type": "`string`", - "description": "The ID of the Line Item that the Fulfillment Item references.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "quantity", - "type": "`number`", - "description": "The quantity of the Line Item that is included in the Fulfillment.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> +`","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.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.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.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.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.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":"fulfillment_id","type":"`string`","description":"The ID of the Fulfillment that the Fulfillment Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"adjustments","type":"[LineItemAdjustment](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.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.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.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.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.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.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.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":"item_id","type":"`string`","description":"The ID of the Line Item that the Fulfillment Item references.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the Line Item that is included in the Fulfillment.","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/classes/entities.FulfillmentProvider.mdx b/www/apps/docs/content/references/entities/classes/entities.FulfillmentProvider.mdx index 3bf88d64a6b04..c87dc0adee554 100644 --- a/www/apps/docs/content/references/entities/classes/entities.FulfillmentProvider.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.FulfillmentProvider.mdx @@ -11,23 +11,4 @@ A fulfillment provider represents a fulfillment service installed in the Medusa ## Properties - + diff --git a/www/apps/docs/content/references/entities/classes/entities.GiftCard.mdx b/www/apps/docs/content/references/entities/classes/entities.GiftCard.mdx index 4aaff751b1f47..9a2fdd6a1759d 100644 --- a/www/apps/docs/content/references/entities/classes/entities.GiftCard.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.GiftCard.mdx @@ -11,827 +11,4 @@ Gift Cards are redeemable and represent a value that can be used towards the pay ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "order", - "type": "[Order](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.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.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.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.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.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.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.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.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](../enums/entities.FulfillmentStatus.mdx)", - "description": "The order's fulfillment status", - "optional": false, - "defaultValue": "not_fulfilled", - "expandable": false, - "children": [] - }, - { - "name": "fulfillments", - "type": "[Fulfillment](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.GiftCardTransaction.mdx)[]", - "description": "The gift card transactions made in the order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "gift_cards", - "type": "[GiftCard](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.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](../enums/entities.PaymentStatus.mdx)", - "description": "The order's payment status", - "optional": false, - "defaultValue": "not_paid", - "expandable": false, - "children": [] - }, - { - "name": "payments", - "type": "[Payment](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.Refund.mdx)[]", - "description": "The details of the refunds created for the order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "region", - "type": "[Region](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": "returnable_items", - "type": "[LineItem](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": "returns", - "type": "[Return](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.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.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.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](../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.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": "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.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.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.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.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.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.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.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/development/entities/repositories#retrieving-a-list-of-records"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](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.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.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.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.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.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.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.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.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](../enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](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.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](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.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](../enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](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.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](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.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](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.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.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](../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.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.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":"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.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.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.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.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.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.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.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/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.GiftCardTransaction.mdx b/www/apps/docs/content/references/entities/classes/entities.GiftCardTransaction.mdx index 1493ffa7c6bdc..259848f1b6270 100644 --- a/www/apps/docs/content/references/entities/classes/entities.GiftCardTransaction.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.GiftCardTransaction.mdx @@ -11,736 +11,4 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "order", - "type": "[Order](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.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": "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.Order.mdx)", - "description": "The details of the order that the gift card was used for payment.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [ - { - "name": "billing_address", - "type": "[Address](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.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.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.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.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.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.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.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](../enums/entities.FulfillmentStatus.mdx)", - "description": "The order's fulfillment status", - "optional": false, - "defaultValue": "not_fulfilled", - "expandable": false, - "children": [] - }, - { - "name": "fulfillments", - "type": "[Fulfillment](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.GiftCardTransaction.mdx)[]", - "description": "The gift card transactions made in the order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "gift_cards", - "type": "[GiftCard](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.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](../enums/entities.PaymentStatus.mdx)", - "description": "The order's payment status", - "optional": false, - "defaultValue": "not_paid", - "expandable": false, - "children": [] - }, - { - "name": "payments", - "type": "[Payment](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.Refund.mdx)[]", - "description": "The details of the refunds created for the order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "region", - "type": "[Region](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": "returnable_items", - "type": "[LineItem](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": "returns", - "type": "[Return](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.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.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.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](../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.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": "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": [] - } -]} 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":"order","type":"[Order](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.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":"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.Order.mdx)","description":"The details of the order that the gift card was used for payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](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.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.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.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.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.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.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.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](../enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](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.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](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.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](../enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](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.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](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.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](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.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.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](../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.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.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":"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":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.IdempotencyKey.mdx b/www/apps/docs/content/references/entities/classes/entities.IdempotencyKey.mdx index 54e47055fba02..cbc010bb1106a 100644 --- a/www/apps/docs/content/references/entities/classes/entities.IdempotencyKey.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.IdempotencyKey.mdx @@ -11,95 +11,4 @@ Idempotency Key is used to continue a process in case of any failure that might ## Properties -`", - "description": "The parameters passed to the request", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "request_path", - "type": "`string`", - "description": "The request's path", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "response_body", - "type": "`Record`", - "description": "The response's body", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "response_code", - "type": "`number`", - "description": "The response's code.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> +`","description":"The parameters passed to the request","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"request_path","type":"`string`","description":"The request's path","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"response_body","type":"`Record`","description":"The response's body","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"response_code","type":"`number`","description":"The response's code.","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/classes/entities.Image.mdx b/www/apps/docs/content/references/entities/classes/entities.Image.mdx index 0f4ad2f67545a..698a2c788331f 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Image.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Image.mdx @@ -11,59 +11,4 @@ An Image is used to store details about uploaded images. Images are uploaded by ## Properties -`", - "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": "url", - "type": "`string`", - "description": "The URL at which the image file can be found.", - "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":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL at which the image file can be found.","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/classes/entities.Invite.mdx b/www/apps/docs/content/references/entities/classes/entities.Invite.mdx index af60c291f8e0d..4913a7889fa94 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Invite.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Invite.mdx @@ -11,123 +11,4 @@ An invite is created when an admin user invites a new user to join the store's t ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "role", - "type": "[UserRoles](../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/development/entities/repositories#retrieving-a-list-of-records"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../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/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.LineItem.mdx b/www/apps/docs/content/references/entities/classes/entities.LineItem.mdx index 0de5572b61ba4..044fd439b2f6d 100644 --- a/www/apps/docs/content/references/entities/classes/entities.LineItem.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.LineItem.mdx @@ -11,393 +11,4 @@ Line Items are created when a product is added to a Cart. When Line Items are pu ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "order", - "type": "[Order](entities.Order.mdx)", - "description": "The details of the order that the line item may belongs to.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "order_edit", - "type": "`null` \\| [OrderEdit](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": "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": "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": "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": "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": "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": "subtotal", - "type": "`null` \\| `number`", - "description": "The subtotal of the line item", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "swap", - "type": "[Swap](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.LineItemTaxLine.mdx)[]", - "description": "The details of the item's tax lines.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "tax_total", - "type": "`null` \\| `number`", - "description": "The total of tax of the line item", - "optional": true, - "defaultValue": "", - "expandable": false, - "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": "total", - "type": "`null` \\| `number`", - "description": "The total amount of the line item", - "optional": true, - "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.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": [] - } -]} 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":"order","type":"[Order](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.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.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.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.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":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.LineItemAdjustment.mdx b/www/apps/docs/content/references/entities/classes/entities.LineItemAdjustment.mdx index 2dd31984c03dd..33185d63c32d4 100644 --- a/www/apps/docs/content/references/entities/classes/entities.LineItemAdjustment.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.LineItemAdjustment.mdx @@ -11,77 +11,4 @@ A Line Item Adjustment includes details on discounts applied on a line item. ## Properties -`", - "description": "An optional key-value map with additional details", - "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":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.LineItemTaxLine.mdx b/www/apps/docs/content/references/entities/classes/entities.LineItemTaxLine.mdx index 253156e2009e1..9c90a9c1e134b 100644 --- a/www/apps/docs/content/references/entities/classes/entities.LineItemTaxLine.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.LineItemTaxLine.mdx @@ -11,86 +11,4 @@ A Line Item Tax Line represents the taxes applied on a line item. ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "name", - "type": "`string`", - "description": "A human friendly name for the tax", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "rate", - "type": "`number`", - "description": "The numeric rate to charge tax 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/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":"A human friendly name for the tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The numeric rate to charge tax 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/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.MoneyAmount.mdx b/www/apps/docs/content/references/entities/classes/entities.MoneyAmount.mdx index 654775d193105..c3e8012b27779 100644 --- a/www/apps/docs/content/references/entities/classes/entities.MoneyAmount.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.MoneyAmount.mdx @@ -11,875 +11,4 @@ A Money Amount represent a price amount, for example, a product variant's price ## 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 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.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.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.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": "`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": "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.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.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.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.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": "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": [] - }, - { - "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": "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": "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.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.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.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.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": "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": [] - }, - { - "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": [] - } - ] - } -]} 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":"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.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.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.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":[]}]},{"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":"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.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.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.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.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":[]}]},{"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":"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":"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":"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.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.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.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.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.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.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":[]}]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.Note.mdx b/www/apps/docs/content/references/entities/classes/entities.Note.mdx index 80902b160fc92..1775779aee932 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Note.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Note.mdx @@ -11,195 +11,4 @@ A Note is an element that can be used in association with different resources to ## Properties -`", - "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": "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/development/entities/repositories#retrieving-a-list-of-records"/> +`","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":"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/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.Notification.mdx b/www/apps/docs/content/references/entities/classes/entities.Notification.mdx index bd71691224419..f81be2418d30d 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Notification.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Notification.mdx @@ -11,576 +11,4 @@ A notification is an alert sent, typically to customers, using the installed Not ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "orders", - "type": "[Order](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.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.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.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.Notification.mdx)", - "description": "The details of the parent notification.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "provider", - "type": "[NotificationProvider](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.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.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.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.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.Notification.mdx)", - "description": "The details of the parent notification.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "provider", - "type": "[NotificationProvider](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.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/development/entities/repositories#retrieving-a-list-of-records"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](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.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.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.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.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider","type":"[NotificationProvider](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.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.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.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.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.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider","type":"[NotificationProvider](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.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/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.NotificationProvider.mdx b/www/apps/docs/content/references/entities/classes/entities.NotificationProvider.mdx index 771c41cf1d26a..ae7aaedb9b14d 100644 --- a/www/apps/docs/content/references/entities/classes/entities.NotificationProvider.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.NotificationProvider.mdx @@ -11,23 +11,4 @@ A notification provider represents a notification service installed in the Medus ## Properties - + diff --git a/www/apps/docs/content/references/entities/classes/entities.Oauth.mdx b/www/apps/docs/content/references/entities/classes/entities.Oauth.mdx index 42164ba714fef..cc5215ba1f16f 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Oauth.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Oauth.mdx @@ -9,59 +9,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Properties -`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "display_name", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "id", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "install_url", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "uninstall_url", - "type": "`string`", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - } -]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"install_url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"uninstall_url","type":"`string`","description":"","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/classes/entities.Order.mdx b/www/apps/docs/content/references/entities/classes/entities.Order.mdx index b20943549eaa0..aa56ad30c750d 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Order.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Order.mdx @@ -11,518 +11,4 @@ An order is a purchase made by a customer. It holds details about payment and fu ## Properties -`", - "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](../enums/entities.PaymentStatus.mdx)", - "description": "The order's payment status", - "optional": false, - "defaultValue": "not_paid", - "expandable": false, - "children": [] - }, - { - "name": "payments", - "type": "[Payment](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.Refund.mdx)[]", - "description": "The details of the refunds created for the order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "region", - "type": "[Region](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": "returnable_items", - "type": "[LineItem](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": "returns", - "type": "[Return](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.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.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.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](../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.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": [] - } -]} 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":"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](../enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](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.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](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.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](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.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.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](../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.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.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":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.OrderEdit.mdx b/www/apps/docs/content/references/entities/classes/entities.OrderEdit.mdx index 82db06713c7a5..e77ecc0296161 100644 --- a/www/apps/docs/content/references/entities/classes/entities.OrderEdit.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.OrderEdit.mdx @@ -11,266 +11,4 @@ Order edit allows modifying items in an order, such as adding, updating, or dele ## Properties - + diff --git a/www/apps/docs/content/references/entities/classes/entities.OrderItemChange.mdx b/www/apps/docs/content/references/entities/classes/entities.OrderItemChange.mdx index e6f792f69ad5e..7bdfe44f13f47 100644 --- a/www/apps/docs/content/references/entities/classes/entities.OrderItemChange.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.OrderItemChange.mdx @@ -11,104 +11,4 @@ An order item change is a change made within an order edit to an order's items. ## Properties - + diff --git a/www/apps/docs/content/references/entities/classes/entities.Payment.mdx b/www/apps/docs/content/references/entities/classes/entities.Payment.mdx index f4acd6bf16c56..6a71c457595ab 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Payment.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Payment.mdx @@ -11,1333 +11,4 @@ A payment is originally created from a payment session. Once a payment session i ## Properties -`", - "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.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": "discount_total", - "type": "`number`", - "description": "The total of discount rounded", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "discounts", - "type": "[Discount](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_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": "gift_cards", - "type": "[GiftCard](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": "item_tax_total", - "type": "`null` \\| `number`", - "description": "The total of items with taxes", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "items", - "type": "[LineItem](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.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.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.PaymentSession.mdx)[]", - "description": "The details of all payment sessions created on the cart.", - "optional": false, - "defaultValue": "", - "expandable": true, - "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": "region", - "type": "[Region](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.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.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.ShippingMethod.mdx)[]", - "description": "The details of the shipping methods added to the cart.", - "optional": false, - "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": "type", - "type": "[CartType](../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": "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.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": "includes_tax", - "type": "`boolean`", - "description": "Whether the currency prices include tax", - "optional": true, - "defaultValue": "false", - "expandable": false, - "featureFlag": "tax_inclusive_pricing", - "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": "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.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.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.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.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.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.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.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.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.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](../enums/entities.FulfillmentStatus.mdx)", - "description": "The order's fulfillment status", - "optional": false, - "defaultValue": "not_fulfilled", - "expandable": false, - "children": [] - }, - { - "name": "fulfillments", - "type": "[Fulfillment](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.GiftCardTransaction.mdx)[]", - "description": "The gift card transactions made in the order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "gift_cards", - "type": "[GiftCard](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.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](../enums/entities.PaymentStatus.mdx)", - "description": "The order's payment status", - "optional": false, - "defaultValue": "not_paid", - "expandable": false, - "children": [] - }, - { - "name": "payments", - "type": "[Payment](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.Refund.mdx)[]", - "description": "The details of the refunds created for the order.", - "optional": false, - "defaultValue": "", - "expandable": true, - "children": [] - }, - { - "name": "region", - "type": "[Region](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": "returnable_items", - "type": "[LineItem](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": "returns", - "type": "[Return](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.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.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.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](../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.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": "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.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.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.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](../enums/entities.SwapFulfillmentStatus.mdx)", - "description": "The status of the Fulfillment of the Swap.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "fulfillments", - "type": "[Fulfillment](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.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.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](../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.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.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.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/development/entities/repositories#retrieving-a-list-of-records"/> +`","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.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.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.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.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.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.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.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](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.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.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.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../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":"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.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.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.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.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.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.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.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.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.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.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](../enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](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.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](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.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](../enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](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.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](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.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](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.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.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](../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.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.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":"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.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.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.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](../enums/entities.SwapFulfillmentStatus.mdx)","description":"The status of the Fulfillment of the Swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](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.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.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](../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.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.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.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/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.PaymentCollection.mdx b/www/apps/docs/content/references/entities/classes/entities.PaymentCollection.mdx index 89248513bfca8..bc5de78db4fb3 100644 --- a/www/apps/docs/content/references/entities/classes/entities.PaymentCollection.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.PaymentCollection.mdx @@ -11,714 +11,4 @@ A payment collection allows grouping and managing a list of payments at one. Thi ## Properties -`", - "description": "An optional key-value map with additional details", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "payment_sessions", - "type": "[PaymentSession](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.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.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.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.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.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.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.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.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.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.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.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.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.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](../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](../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/development/entities/repositories#retrieving-a-list-of-records"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](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.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.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.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.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.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.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.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.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.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.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.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.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.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](../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](../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/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.PaymentProvider.mdx b/www/apps/docs/content/references/entities/classes/entities.PaymentProvider.mdx index cc24b65aa06e4..a84f7496901f4 100644 --- a/www/apps/docs/content/references/entities/classes/entities.PaymentProvider.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.PaymentProvider.mdx @@ -11,23 +11,4 @@ A payment provider represents a payment service installed in the Medusa backend, ## Properties - + diff --git a/www/apps/docs/content/references/entities/classes/entities.PaymentSession.mdx b/www/apps/docs/content/references/entities/classes/entities.PaymentSession.mdx index d23f891416fe0..c3db3616eefc8 100644 --- a/www/apps/docs/content/references/entities/classes/entities.PaymentSession.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.PaymentSession.mdx @@ -11,501 +11,4 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c ## Properties -`", - "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.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": "discount_total", - "type": "`number`", - "description": "The total of discount rounded", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "discounts", - "type": "[Discount](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_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": "gift_cards", - "type": "[GiftCard](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": "item_tax_total", - "type": "`null` \\| `number`", - "description": "The total of items with taxes", - "optional": true, - "defaultValue": "", - "expandable": false, - "children": [] - }, - { - "name": "items", - "type": "[LineItem](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.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.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.PaymentSession.mdx)[]", - "description": "The details of all payment sessions created on the cart.", - "optional": false, - "defaultValue": "", - "expandable": true, - "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": "region", - "type": "[Region](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.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.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.ShippingMethod.mdx)[]", - "description": "The details of the shipping methods added to the cart.", - "optional": false, - "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": "type", - "type": "[CartType](../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": "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": [] - } -]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> +`","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.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.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.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.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.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.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.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](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.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.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.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../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":"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":"`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":[]}]} 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 cc735b8ec889f..f972e6d960726 100644 --- a/www/apps/docs/content/references/entities/classes/entities.PriceList.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.PriceList.mdx @@ -11,379 +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", - "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": "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", - "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": "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": "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":"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"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.Product.mdx b/www/apps/docs/content/references/entities/classes/entities.Product.mdx index 0732ef9ac74d4..d70f51ad752bd 100644 --- a/www/apps/docs/content/references/entities/classes/entities.Product.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.Product.mdx @@ -11,1322 +11,4 @@ A product is a saleable item that holds general information such as name or desc ## Properties -
          ) } diff --git a/www/packages/docs-ui/package.json b/www/packages/docs-ui/package.json index 77dc187479271..441d0e32c07e6 100644 --- a/www/packages/docs-ui/package.json +++ b/www/packages/docs-ui/package.json @@ -63,7 +63,7 @@ "@react-hook/resize-observer": "^1.2.6", "@segment/analytics-next": "^1.55.0", "algoliasearch": "^4.20.0", - "prism-react-renderer": "^2.3.0", + "prism-react-renderer": "2.3.1", "react-google-recaptcha": "^3.1.0", "react-instantsearch": "^7.0.3", "react-markdown": "^8.0.7", diff --git a/www/packages/docs-ui/src/components/CodeBlock/index.tsx b/www/packages/docs-ui/src/components/CodeBlock/index.tsx index 32898c20d5690..1fc5dbc8423a8 100644 --- a/www/packages/docs-ui/src/components/CodeBlock/index.tsx +++ b/www/packages/docs-ui/src/components/CodeBlock/index.tsx @@ -44,7 +44,7 @@ export const CodeBlock = ({ }, }} code={source.trim()} - language={lang} + language={lang.toLowerCase()} {...rest} > {({ @@ -71,7 +71,7 @@ export const CodeBlock = ({ )} > {tokens.map((line, i) => { - const lineProps = getLineProps({ line }) + const lineProps = getLineProps({ line, key: i }) return ( {line.map((token, key) => ( - + ))} diff --git a/www/yarn.lock b/www/yarn.lock index 775c23a8c4b24..de44a58799202 100644 --- a/www/yarn.lock +++ b/www/yarn.lock @@ -7814,6 +7814,129 @@ __metadata: languageName: node linkType: hard +"@swc/core-darwin-arm64@npm:1.3.102": + version: 1.3.102 + resolution: "@swc/core-darwin-arm64@npm:1.3.102" + conditions: os=darwin & cpu=arm64 + languageName: node + linkType: hard + +"@swc/core-darwin-x64@npm:1.3.102": + version: 1.3.102 + resolution: "@swc/core-darwin-x64@npm:1.3.102" + conditions: os=darwin & cpu=x64 + languageName: node + linkType: hard + +"@swc/core-linux-arm-gnueabihf@npm:1.3.102": + version: 1.3.102 + resolution: "@swc/core-linux-arm-gnueabihf@npm:1.3.102" + conditions: os=linux & cpu=arm + languageName: node + linkType: hard + +"@swc/core-linux-arm64-gnu@npm:1.3.102": + version: 1.3.102 + resolution: "@swc/core-linux-arm64-gnu@npm:1.3.102" + conditions: os=linux & cpu=arm64 & libc=glibc + languageName: node + linkType: hard + +"@swc/core-linux-arm64-musl@npm:1.3.102": + version: 1.3.102 + resolution: "@swc/core-linux-arm64-musl@npm:1.3.102" + conditions: os=linux & cpu=arm64 & libc=musl + languageName: node + linkType: hard + +"@swc/core-linux-x64-gnu@npm:1.3.102": + version: 1.3.102 + resolution: "@swc/core-linux-x64-gnu@npm:1.3.102" + conditions: os=linux & cpu=x64 & libc=glibc + languageName: node + linkType: hard + +"@swc/core-linux-x64-musl@npm:1.3.102": + version: 1.3.102 + resolution: "@swc/core-linux-x64-musl@npm:1.3.102" + conditions: os=linux & cpu=x64 & libc=musl + languageName: node + linkType: hard + +"@swc/core-win32-arm64-msvc@npm:1.3.102": + version: 1.3.102 + resolution: "@swc/core-win32-arm64-msvc@npm:1.3.102" + conditions: os=win32 & cpu=arm64 + languageName: node + linkType: hard + +"@swc/core-win32-ia32-msvc@npm:1.3.102": + version: 1.3.102 + resolution: "@swc/core-win32-ia32-msvc@npm:1.3.102" + conditions: os=win32 & cpu=ia32 + languageName: node + linkType: hard + +"@swc/core-win32-x64-msvc@npm:1.3.102": + version: 1.3.102 + resolution: "@swc/core-win32-x64-msvc@npm:1.3.102" + conditions: os=win32 & cpu=x64 + languageName: node + linkType: hard + +"@swc/core@npm:^1.3.102": + version: 1.3.102 + resolution: "@swc/core@npm:1.3.102" + dependencies: + "@swc/core-darwin-arm64": 1.3.102 + "@swc/core-darwin-x64": 1.3.102 + "@swc/core-linux-arm-gnueabihf": 1.3.102 + "@swc/core-linux-arm64-gnu": 1.3.102 + "@swc/core-linux-arm64-musl": 1.3.102 + "@swc/core-linux-x64-gnu": 1.3.102 + "@swc/core-linux-x64-musl": 1.3.102 + "@swc/core-win32-arm64-msvc": 1.3.102 + "@swc/core-win32-ia32-msvc": 1.3.102 + "@swc/core-win32-x64-msvc": 1.3.102 + "@swc/counter": ^0.1.1 + "@swc/types": ^0.1.5 + peerDependencies: + "@swc/helpers": ^0.5.0 + dependenciesMeta: + "@swc/core-darwin-arm64": + optional: true + "@swc/core-darwin-x64": + optional: true + "@swc/core-linux-arm-gnueabihf": + optional: true + "@swc/core-linux-arm64-gnu": + optional: true + "@swc/core-linux-arm64-musl": + optional: true + "@swc/core-linux-x64-gnu": + optional: true + "@swc/core-linux-x64-musl": + optional: true + "@swc/core-win32-arm64-msvc": + optional: true + "@swc/core-win32-ia32-msvc": + optional: true + "@swc/core-win32-x64-msvc": + optional: true + peerDependenciesMeta: + "@swc/helpers": + optional: true + checksum: e87bf302b3e6e7c0a6cf6abb001e196f9461fa8fdfc20c6dcef217f50298f31e81aed4ff7402833470241dccd35d354e4e17ac56d0e551792735aefeb4604871 + languageName: node + linkType: hard + +"@swc/counter@npm:^0.1.1": + version: 0.1.2 + resolution: "@swc/counter@npm:0.1.2" + checksum: 18be012107d4ba1f79776c48d83391ca2159103d7d31a59ff52fcc8024db51b71c5f46714a9fb73981739bc8a38dc6f385a046b71cc08f6043f3c47f5c409eab + languageName: node + linkType: hard + "@swc/helpers@npm:0.5.2, @swc/helpers@npm:^0.5.0": version: 0.5.2 resolution: "@swc/helpers@npm:0.5.2" @@ -7823,6 +7946,13 @@ __metadata: languageName: node linkType: hard +"@swc/types@npm:^0.1.5": + version: 0.1.5 + resolution: "@swc/types@npm:0.1.5" + checksum: b35f93fe896a2240f6f10544e408f9648c2bd4bcff9bd8d022d9a6942d31cf859f86119fb0bbb04a12eefa1f6a6745ffc7d18f3a490d76d7b6a074a7c9608144 + languageName: node + linkType: hard + "@szmarczak/http-timer@npm:^5.0.1": version: 5.0.1 resolution: "@szmarczak/http-timer@npm:5.0.1" @@ -9299,7 +9429,7 @@ __metadata: openapi-sampler: ^1.3.1 openapi-types: ^12.1.3 postcss: 8.4.27 - prism-react-renderer: ^2.3.0 + prism-react-renderer: 2.3.1 react: latest react-dom: latest react-instantsearch: ^7.0.1 @@ -11799,7 +11929,7 @@ __metadata: cpy-cli: ^5.0.0 eslint-config-docs: "*" next: latest - prism-react-renderer: ^2.3.0 + prism-react-renderer: 2.3.1 react: ^18.2.0 react-dom: ^18.2.0 react-google-recaptcha: ^3.1.0 @@ -11842,6 +11972,7 @@ __metadata: "@mdx-js/react": 3 "@medusajs/icons": ^1.0.0 "@svgr/webpack": 6.2.1 + "@swc/core": ^1.3.102 "@types/react": ^18.2.0 "@types/react-dom": ^18.2.0 "@types/react-transition-group": ^4.4.6 @@ -11861,6 +11992,7 @@ __metadata: react-dom: ^18.2.0 react-tooltip: 5.7.4 react-transition-group: ^4.4.5 + swc-loader: ^0.2.3 tailwind: "*" tailwindcss: ^3.3.2 tsconfig: "*" @@ -19444,6 +19576,18 @@ __metadata: languageName: node linkType: hard +"prism-react-renderer@npm:2.3.1": + version: 2.3.1 + resolution: "prism-react-renderer@npm:2.3.1" + dependencies: + "@types/prismjs": ^1.26.0 + clsx: ^2.0.0 + peerDependencies: + react: ">=16.0.0" + checksum: 566932127ca18049a651aa038a8f8c7c1ca15950d21b659c2ce71fd95bd03bef2b5d40c489e7aa3453eaf15d984deef542a609d7842e423e6a13427dd90bd371 + languageName: node + linkType: hard + "prism-react-renderer@npm:^2.0.6": version: 2.0.6 resolution: "prism-react-renderer@npm:2.0.6" @@ -21641,6 +21785,16 @@ __metadata: languageName: node linkType: hard +"swc-loader@npm:^0.2.3": + version: 0.2.3 + resolution: "swc-loader@npm:0.2.3" + peerDependencies: + "@swc/core": ^1.2.147 + webpack: ">=2" + checksum: cb3f9b116fbd292b881e804a4fe66cd6d543a7de2572f5a68e067e4780ee2d59a8da87a90736ba6e8e286e4368c98214ae3486b1b872080292814e5d3062f09c + languageName: node + linkType: hard + "swr@npm:^2.2.0": version: 2.2.2 resolution: "swr@npm:2.2.2" From dc46ee1189c3eb719355da6a1d701c14a77e4578 Mon Sep 17 00:00:00 2001 From: Riqwan Thamir Date: Fri, 5 Jan 2024 16:17:22 +0100 Subject: [PATCH 5/9] feat(types): promotion delete / update / retrieve / add/remove-rules (#5988) --- .changeset/great-cameras-stare.md | 5 + .../__fixtures__/promotion/index.ts | 7 +- .../promotion-module/promotion.spec.ts | 546 +++++++++++++++++- .../src/models/application-method.ts | 15 +- packages/promotion/src/models/promotion.ts | 1 + .../src/services/promotion-module.ts | 302 +++++++++- .../promotion/src/types/application-method.ts | 26 +- packages/promotion/src/types/promotion.ts | 4 + .../utils/validations/application-method.ts | 62 +- .../promotion/common/application-method.ts | 37 +- .../src/promotion/common/promotion-rule.ts | 4 + .../types/src/promotion/common/promotion.ts | 14 +- packages/types/src/promotion/service.ts | 40 ++ 13 files changed, 1014 insertions(+), 49 deletions(-) create mode 100644 .changeset/great-cameras-stare.md diff --git a/.changeset/great-cameras-stare.md b/.changeset/great-cameras-stare.md new file mode 100644 index 0000000000000..08eb7fab3291c --- /dev/null +++ b/.changeset/great-cameras-stare.md @@ -0,0 +1,5 @@ +--- +"@medusajs/types": patch +--- + +feat(types): promotion delete / update / retrieve diff --git a/packages/promotion/integration-tests/__fixtures__/promotion/index.ts b/packages/promotion/integration-tests/__fixtures__/promotion/index.ts index 80ef2f7e662c7..2339d9a583fa3 100644 --- a/packages/promotion/integration-tests/__fixtures__/promotion/index.ts +++ b/packages/promotion/integration-tests/__fixtures__/promotion/index.ts @@ -1,3 +1,4 @@ +import { CreatePromotionDTO } from "@medusajs/types" import { SqlEntityManager } from "@mikro-orm/postgresql" import { Promotion } from "@models" import { defaultPromotionsData } from "./data" @@ -6,9 +7,9 @@ export * from "./data" export async function createPromotions( manager: SqlEntityManager, - promotionsData = defaultPromotionsData + promotionsData: CreatePromotionDTO[] = defaultPromotionsData ): Promise { - const promotion: Promotion[] = [] + const promotions: Promotion[] = [] for (let promotionData of promotionsData) { let promotion = manager.create(Promotion, promotionData) @@ -18,5 +19,5 @@ export async function createPromotions( await manager.flush() } - return promotion + return promotions } diff --git a/packages/promotion/integration-tests/__tests__/services/promotion-module/promotion.spec.ts b/packages/promotion/integration-tests/__tests__/services/promotion-module/promotion.spec.ts index 5c5e8742ef2f7..ddcff28851086 100644 --- a/packages/promotion/integration-tests/__tests__/services/promotion-module/promotion.spec.ts +++ b/packages/promotion/integration-tests/__tests__/services/promotion-module/promotion.spec.ts @@ -2,6 +2,7 @@ import { IPromotionModuleService } from "@medusajs/types" import { PromotionType } from "@medusajs/utils" import { SqlEntityManager } from "@mikro-orm/postgresql" import { initialize } from "../../../../src" +import { createPromotions } from "../../../__fixtures__/promotion" import { DB_URL, MikroOrmWrapper } from "../../../utils" jest.setTimeout(30000) @@ -70,7 +71,7 @@ describe("Promotion Service", () => { application_method: { type: "fixed", target_type: "order", - value: 100, + value: "100", }, }, ]) @@ -106,7 +107,7 @@ describe("Promotion Service", () => { application_method: { type: "fixed", target_type: "order", - value: 100, + value: "100", target_rules: [ { attribute: "product_id", @@ -164,7 +165,7 @@ describe("Promotion Service", () => { application_method: { type: "fixed", target_type: "item", - value: 100, + value: "100", }, }, ]) @@ -185,7 +186,7 @@ describe("Promotion Service", () => { type: "fixed", allocation: "each", target_type: "shipping", - value: 100, + value: "100", }, }, ]) @@ -347,4 +348,541 @@ describe("Promotion Service", () => { ) }) }) + + describe("update", () => { + it("should throw an error when required params are not passed", async () => { + const error = await service + .update([ + { + type: PromotionType.STANDARD, + } as any, + ]) + .catch((e) => e) + + expect(error.message).toContain('Promotion with id "undefined" not found') + }) + + it("should update the attributes of a promotion successfully", async () => { + await createPromotions(repositoryManager) + + const [updatedPromotion] = await service.update([ + { + id: "promotion-id-1", + is_automatic: true, + code: "TEST", + type: PromotionType.BUYGET, + }, + ]) + + expect(updatedPromotion).toEqual( + expect.objectContaining({ + is_automatic: true, + code: "TEST", + type: PromotionType.BUYGET, + }) + ) + }) + + it("should update the attributes of a application method successfully", async () => { + const [createdPromotion] = await service.create([ + { + code: "TEST", + type: PromotionType.STANDARD, + application_method: { + type: "fixed", + target_type: "item", + allocation: "across", + value: "100", + }, + }, + ]) + const applicationMethod = createdPromotion.application_method + + const [updatedPromotion] = await service.update([ + { + id: createdPromotion.id, + application_method: { + id: applicationMethod?.id as string, + value: "200", + }, + }, + ]) + + expect(updatedPromotion).toEqual( + expect.objectContaining({ + application_method: expect.objectContaining({ + value: 200, + }), + }) + ) + }) + + it("should change max_quantity to 0 when target_type is changed to order", async () => { + const [createdPromotion] = await service.create([ + { + code: "TEST", + type: PromotionType.STANDARD, + application_method: { + type: "fixed", + target_type: "item", + allocation: "each", + value: "100", + max_quantity: 500, + }, + }, + ]) + const applicationMethod = createdPromotion.application_method + + const [updatedPromotion] = await service.update([ + { + id: createdPromotion.id, + application_method: { + id: applicationMethod?.id as string, + target_type: "order", + allocation: "across", + }, + }, + ]) + + expect(updatedPromotion).toEqual( + expect.objectContaining({ + application_method: expect.objectContaining({ + target_type: "order", + allocation: "across", + max_quantity: 0, + }), + }) + ) + }) + + it("should validate the attributes of a application method successfully", async () => { + const [createdPromotion] = await service.create([ + { + code: "TEST", + type: PromotionType.STANDARD, + application_method: { + type: "fixed", + target_type: "order", + allocation: "across", + value: "100", + }, + }, + ]) + const applicationMethod = createdPromotion.application_method + + let error = await service + .update([ + { + id: createdPromotion.id, + application_method: { + id: applicationMethod?.id as string, + target_type: "should-error", + } as any, + }, + ]) + .catch((e) => e) + + expect(error.message).toContain( + `application_method.target_type should be one of order, shipping, item` + ) + + error = await service + .update([ + { + id: createdPromotion.id, + application_method: { + id: applicationMethod?.id as string, + allocation: "should-error", + } as any, + }, + ]) + .catch((e) => e) + + expect(error.message).toContain( + `application_method.allocation should be one of each, across` + ) + + error = await service + .update([ + { + id: createdPromotion.id, + application_method: { + id: applicationMethod?.id as string, + type: "should-error", + } as any, + }, + ]) + .catch((e) => e) + + expect(error.message).toContain( + `application_method.type should be one of fixed, percentage` + ) + }) + }) + + describe("retrieve", () => { + beforeEach(async () => { + await createPromotions(repositoryManager) + }) + + const id = "promotion-id-1" + + it("should return promotion for the given id", async () => { + const promotion = await service.retrieve(id) + + expect(promotion).toEqual( + expect.objectContaining({ + id, + }) + ) + }) + + it("should throw an error when promotion with id does not exist", async () => { + let error + + try { + await service.retrieve("does-not-exist") + } catch (e) { + error = e + } + + expect(error.message).toEqual( + "Promotion with id: does-not-exist was not found" + ) + }) + + it("should throw an error when a id is not provided", async () => { + let error + + try { + await service.retrieve(undefined as unknown as string) + } catch (e) { + error = e + } + + expect(error.message).toEqual('"promotionId" must be defined') + }) + + it("should return promotion based on config select param", async () => { + const promotion = await service.retrieve(id, { + select: ["id"], + }) + + const serialized = JSON.parse(JSON.stringify(promotion)) + + expect(serialized).toEqual({ + id, + }) + }) + }) + + describe("delete", () => { + beforeEach(async () => { + await createPromotions(repositoryManager) + }) + + const id = "promotion-id-1" + + it("should delete the promotions given an id successfully", async () => { + await service.delete([id]) + + const promotions = await service.list({ + id: [id], + }) + + expect(promotions).toHaveLength(0) + }) + }) + + describe("addPromotionRules", () => { + let promotion + + beforeEach(async () => { + ;[promotion] = await service.create([ + { + code: "TEST", + type: PromotionType.STANDARD, + application_method: { + type: "fixed", + target_type: "item", + allocation: "each", + value: "100", + max_quantity: 500, + }, + }, + ]) + }) + + it("should throw an error when promotion with id does not exist", async () => { + let error + + try { + await service.addPromotionRules("does-not-exist", []) + } catch (e) { + error = e + } + + expect(error.message).toEqual( + "Promotion with id: does-not-exist was not found" + ) + }) + + it("should throw an error when a id is not provided", async () => { + let error + + try { + await service.addPromotionRules(undefined as unknown as string, []) + } catch (e) { + error = e + } + + expect(error.message).toEqual('"promotionId" must be defined') + }) + + it("should successfully create rules for a promotion", async () => { + promotion = await service.addPromotionRules(promotion.id, [ + { + attribute: "customer_group_id", + operator: "in", + values: ["VIP", "top100"], + }, + ]) + + expect(promotion).toEqual( + expect.objectContaining({ + id: promotion.id, + rules: [ + expect.objectContaining({ + attribute: "customer_group_id", + operator: "in", + values: [ + expect.objectContaining({ value: "VIP" }), + expect.objectContaining({ value: "top100" }), + ], + }), + ], + }) + ) + }) + }) + + describe("addPromotionTargetRules", () => { + let promotion + + beforeEach(async () => { + ;[promotion] = await service.create([ + { + code: "TEST", + type: PromotionType.STANDARD, + application_method: { + type: "fixed", + target_type: "item", + allocation: "each", + value: "100", + max_quantity: 500, + }, + }, + ]) + }) + + it("should throw an error when promotion with id does not exist", async () => { + let error + + try { + await service.addPromotionTargetRules("does-not-exist", []) + } catch (e) { + error = e + } + + expect(error.message).toEqual( + "Promotion with id: does-not-exist was not found" + ) + }) + + it("should throw an error when a id is not provided", async () => { + let error + + try { + await service.addPromotionTargetRules( + undefined as unknown as string, + [] + ) + } catch (e) { + error = e + } + + expect(error.message).toEqual('"promotionId" must be defined') + }) + + it("should successfully create target rules for a promotion", async () => { + promotion = await service.addPromotionTargetRules(promotion.id, [ + { + attribute: "customer_group_id", + operator: "in", + values: ["VIP", "top100"], + }, + ]) + + expect(promotion).toEqual( + expect.objectContaining({ + id: promotion.id, + application_method: expect.objectContaining({ + target_rules: [ + expect.objectContaining({ + attribute: "customer_group_id", + operator: "in", + values: [ + expect.objectContaining({ value: "VIP" }), + expect.objectContaining({ value: "top100" }), + ], + }), + ], + }), + }) + ) + }) + }) + + describe("removePromotionRules", () => { + let promotion + + beforeEach(async () => { + ;[promotion] = await service.create([ + { + code: "TEST", + type: PromotionType.STANDARD, + rules: [ + { + attribute: "customer_group_id", + operator: "in", + values: ["VIP", "top100"], + }, + ], + application_method: { + type: "fixed", + target_type: "item", + allocation: "each", + value: "100", + max_quantity: 500, + }, + }, + ]) + }) + + it("should throw an error when promotion with id does not exist", async () => { + let error + + try { + await service.removePromotionRules("does-not-exist", []) + } catch (e) { + error = e + } + + expect(error.message).toEqual( + "Promotion with id: does-not-exist was not found" + ) + }) + + it("should throw an error when a id is not provided", async () => { + let error + + try { + await service.removePromotionRules(undefined as unknown as string, []) + } catch (e) { + error = e + } + + expect(error.message).toEqual('"promotionId" must be defined') + }) + + it("should successfully create rules for a promotion", async () => { + const [ruleId] = promotion.rules.map((rule) => rule.id) + + promotion = await service.removePromotionRules(promotion.id, [ + { id: ruleId }, + ]) + + expect(promotion).toEqual( + expect.objectContaining({ + id: promotion.id, + rules: [], + }) + ) + }) + }) + + describe("removePromotionTargetRules", () => { + let promotion + + beforeEach(async () => { + ;[promotion] = await service.create([ + { + code: "TEST", + type: PromotionType.STANDARD, + application_method: { + type: "fixed", + target_type: "item", + allocation: "each", + value: "100", + max_quantity: 500, + target_rules: [ + { + attribute: "customer_group_id", + operator: "in", + values: ["VIP", "top100"], + }, + ], + }, + }, + ]) + }) + + it("should throw an error when promotion with id does not exist", async () => { + let error + + try { + await service.removePromotionTargetRules("does-not-exist", []) + } catch (e) { + error = e + } + + expect(error.message).toEqual( + "Promotion with id: does-not-exist was not found" + ) + }) + + it("should throw an error when a id is not provided", async () => { + let error + + try { + await service.removePromotionTargetRules( + undefined as unknown as string, + [] + ) + } catch (e) { + error = e + } + + expect(error.message).toEqual('"promotionId" must be defined') + }) + + it("should successfully create rules for a promotion", async () => { + const [ruleId] = promotion.application_method.target_rules.map( + (rule) => rule.id + ) + + promotion = await service.removePromotionTargetRules(promotion.id, [ + { id: ruleId }, + ]) + + expect(promotion).toEqual( + expect.objectContaining({ + id: promotion.id, + application_method: expect.objectContaining({ + target_rules: [], + }), + }) + ) + }) + }) }) diff --git a/packages/promotion/src/models/application-method.ts b/packages/promotion/src/models/application-method.ts index 24a0dc4b098c2..6eab16e0e62b6 100644 --- a/packages/promotion/src/models/application-method.ts +++ b/packages/promotion/src/models/application-method.ts @@ -1,7 +1,7 @@ import { - ApplicationMethodAllocation, - ApplicationMethodTargetType, - ApplicationMethodType, + ApplicationMethodAllocationValues, + ApplicationMethodTargetTypeValues, + ApplicationMethodTypeValues, } from "@medusajs/types" import { PromotionUtils, generateEntityId } from "@medusajs/utils" import { @@ -27,6 +27,7 @@ type OptionalFields = | "created_at" | "updated_at" | "deleted_at" + @Entity() export default class ApplicationMethod { [OptionalProps]?: OptionalFields @@ -35,25 +36,25 @@ export default class ApplicationMethod { id!: string @Property({ columnType: "numeric", nullable: true, serializer: Number }) - value?: number | null + value?: string | null @Property({ columnType: "numeric", nullable: true, serializer: Number }) max_quantity?: number | null @Index({ name: "IDX_application_method_type" }) @Enum(() => PromotionUtils.ApplicationMethodType) - type: ApplicationMethodType + type: ApplicationMethodTypeValues @Index({ name: "IDX_application_method_target_type" }) @Enum(() => PromotionUtils.ApplicationMethodTargetType) - target_type: ApplicationMethodTargetType + target_type: ApplicationMethodTargetTypeValues @Index({ name: "IDX_application_method_allocation" }) @Enum({ items: () => PromotionUtils.ApplicationMethodAllocation, nullable: true, }) - allocation?: ApplicationMethodAllocation + allocation?: ApplicationMethodAllocationValues @OneToOne({ entity: () => Promotion, diff --git a/packages/promotion/src/models/promotion.ts b/packages/promotion/src/models/promotion.ts index 6e585684806d4..94af940a8e36a 100644 --- a/packages/promotion/src/models/promotion.ts +++ b/packages/promotion/src/models/promotion.ts @@ -48,6 +48,7 @@ export default class Promotion { @OneToOne({ entity: () => ApplicationMethod, mappedBy: (am) => am.promotion, + cascade: ["soft-remove"] as any, }) application_method: ApplicationMethod diff --git a/packages/promotion/src/services/promotion-module.ts b/packages/promotion/src/services/promotion-module.ts index dcf4b548182d4..fbe52aa512d17 100644 --- a/packages/promotion/src/services/promotion-module.ts +++ b/packages/promotion/src/services/promotion-module.ts @@ -10,6 +10,7 @@ import { InjectManager, InjectTransactionManager, MedusaContext, + MedusaError, } from "@medusajs/utils" import { ApplicationMethod, Promotion } from "@models" import { @@ -19,8 +20,14 @@ import { PromotionService, } from "@services" import { joinerConfig } from "../joiner-config" -import { CreateApplicationMethodDTO, CreatePromotionDTO } from "../types" import { + CreateApplicationMethodDTO, + CreatePromotionDTO, + UpdateApplicationMethodDTO, + UpdatePromotionDTO, +} from "../types" +import { + allowedAllocationForQuantity, validateApplicationMethodAttributes, validatePromotionRuleAttributes, } from "../utils" @@ -64,6 +71,26 @@ export default class PromotionModuleService< return joinerConfig } + @InjectManager("baseRepository_") + async retrieve( + id: string, + config: FindConfig = {}, + @MedusaContext() sharedContext: Context = {} + ): Promise { + const promotion = await this.promotionService_.retrieve( + id, + config, + sharedContext + ) + + return await this.baseRepository_.serialize( + promotion, + { + populate: true, + } + ) + } + @InjectManager("baseRepository_") async list( filters: PromotionTypes.FilterablePromotionProps = {}, @@ -76,7 +103,7 @@ export default class PromotionModuleService< sharedContext ) - return this.baseRepository_.serialize( + return await this.baseRepository_.serialize( promotions, { populate: true, @@ -94,7 +121,13 @@ export default class PromotionModuleService< return await this.list( { id: promotions.map((p) => p!.id) }, { - relations: ["application_method", "rules", "rules.values"], + relations: [ + "application_method", + "application_method.target_rules", + "application_method.target_rules.values", + "rules", + "rules.values", + ], }, sharedContext ) @@ -195,6 +228,162 @@ export default class PromotionModuleService< return createdPromotions } + @InjectManager("baseRepository_") + async update( + data: PromotionTypes.UpdatePromotionDTO[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + const promotions = await this.update_(data, sharedContext) + + return await this.list( + { id: promotions.map((p) => p!.id) }, + { + relations: [ + "application_method", + "application_method.target_rules", + "rules", + "rules.values", + ], + }, + sharedContext + ) + } + + @InjectTransactionManager("baseRepository_") + protected async update_( + data: PromotionTypes.UpdatePromotionDTO[], + @MedusaContext() sharedContext: Context = {} + ) { + const promotionIds = data.map((d) => d.id) + const existingPromotions = await this.promotionService_.list( + { + id: promotionIds, + }, + { + relations: ["application_method"], + } + ) + const existingPromotionsMap = new Map( + existingPromotions.map((promotion) => [promotion.id, promotion]) + ) + + const promotionsData: UpdatePromotionDTO[] = [] + const applicationMethodsData: UpdateApplicationMethodDTO[] = [] + + for (const { + application_method: applicationMethodData, + ...promotionData + } of data) { + promotionsData.push(promotionData) + + if (!applicationMethodData) { + continue + } + + const existingPromotion = existingPromotionsMap.get(promotionData.id) + const existingApplicationMethod = existingPromotion?.application_method + + if (!existingApplicationMethod) { + continue + } + + if ( + applicationMethodData.allocation && + !allowedAllocationForQuantity.includes(applicationMethodData.allocation) + ) { + applicationMethodData.max_quantity = null + } + + validateApplicationMethodAttributes({ + type: applicationMethodData.type || existingApplicationMethod.type, + target_type: + applicationMethodData.target_type || + existingApplicationMethod.target_type, + allocation: + applicationMethodData.allocation || + existingApplicationMethod.allocation, + max_quantity: + applicationMethodData.max_quantity || + existingApplicationMethod.max_quantity, + }) + + applicationMethodsData.push(applicationMethodData) + } + + const updatedPromotions = this.promotionService_.update( + promotionsData, + sharedContext + ) + + if (applicationMethodsData.length) { + await this.applicationMethodService_.update( + applicationMethodsData, + sharedContext + ) + } + + return updatedPromotions + } + + @InjectManager("baseRepository_") + @InjectTransactionManager("baseRepository_") + async addPromotionRules( + promotionId: string, + rulesData: PromotionTypes.CreatePromotionRuleDTO[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + const promotion = await this.promotionService_.retrieve(promotionId) + + await this.createPromotionRulesAndValues( + rulesData, + "promotions", + promotion, + sharedContext + ) + + return this.retrieve(promotionId, { + relations: ["rules", "rules.values"], + }) + } + + @InjectManager("baseRepository_") + @InjectTransactionManager("baseRepository_") + async addPromotionTargetRules( + promotionId: string, + rulesData: PromotionTypes.CreatePromotionRuleDTO[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + const promotion = await this.promotionService_.retrieve(promotionId, { + relations: ["application_method"], + }) + + const applicationMethod = promotion.application_method + + if (!applicationMethod) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + `application_method for promotion not found` + ) + } + + await this.createPromotionRulesAndValues( + rulesData, + "application_methods", + applicationMethod, + sharedContext + ) + + return this.retrieve(promotionId, { + relations: [ + "rules", + "rules.values", + "application_method", + "application_method.target_rules", + "application_method.target_rules.values", + ], + }) + } + protected async createPromotionRulesAndValues( rulesData: PromotionTypes.CreatePromotionRuleDTO[], relationName: "promotions" | "application_methods", @@ -224,4 +413,111 @@ export default class PromotionModuleService< await this.promotionRuleValueService_.create(promotionRuleValuesData) } } + + @InjectTransactionManager("baseRepository_") + async delete( + ids: string[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + await this.promotionService_.delete(ids, sharedContext) + } + + @InjectManager("baseRepository_") + async removePromotionRules( + promotionId: string, + rulesData: PromotionTypes.RemovePromotionRuleDTO[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + await this.removePromotionRules_(promotionId, rulesData, sharedContext) + + return this.retrieve( + promotionId, + { relations: ["rules", "rules.values"] }, + sharedContext + ) + } + + @InjectTransactionManager("baseRepository_") + protected async removePromotionRules_( + promotionId: string, + rulesData: PromotionTypes.RemovePromotionRuleDTO[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + const promotionRuleIdsToRemove = rulesData.map((ruleData) => ruleData.id) + const promotion = await this.promotionService_.retrieve( + promotionId, + { relations: ["rules"] }, + sharedContext + ) + + const existingPromotionRuleIds = promotion.rules + .toArray() + .map((rule) => rule.id) + + const idsToRemove = promotionRuleIdsToRemove.filter((ruleId) => + existingPromotionRuleIds.includes(ruleId) + ) + + await this.promotionRuleService_.delete(idsToRemove, sharedContext) + } + + @InjectManager("baseRepository_") + async removePromotionTargetRules( + promotionId: string, + rulesData: PromotionTypes.RemovePromotionRuleDTO[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + await this.removePromotionTargetRules_( + promotionId, + rulesData, + sharedContext + ) + + return this.retrieve( + promotionId, + { + relations: [ + "rules", + "rules.values", + "application_method", + "application_method.target_rules", + "application_method.target_rules.values", + ], + }, + sharedContext + ) + } + + @InjectTransactionManager("baseRepository_") + protected async removePromotionTargetRules_( + promotionId: string, + rulesData: PromotionTypes.RemovePromotionRuleDTO[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + const promotionRuleIds = rulesData.map((ruleData) => ruleData.id) + const promotion = await this.promotionService_.retrieve( + promotionId, + { relations: ["application_method.target_rules"] }, + sharedContext + ) + + const applicationMethod = promotion.application_method + + if (!applicationMethod) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + `application_method for promotion not found` + ) + } + + const targetRuleIdsToRemove = applicationMethod.target_rules + .toArray() + .filter((rule) => promotionRuleIds.includes(rule.id)) + .map((rule) => rule.id) + + await this.promotionRuleService_.delete( + targetRuleIdsToRemove, + sharedContext + ) + } } diff --git a/packages/promotion/src/types/application-method.ts b/packages/promotion/src/types/application-method.ts index b683958f03733..f269b4de2b7b6 100644 --- a/packages/promotion/src/types/application-method.ts +++ b/packages/promotion/src/types/application-method.ts @@ -1,19 +1,27 @@ import { - ApplicationMethodAllocation, - ApplicationMethodTargetType, - ApplicationMethodType, + ApplicationMethodAllocationValues, + ApplicationMethodTargetTypeValues, + ApplicationMethodTypeValues, PromotionDTO, } from "@medusajs/types" +import { Promotion } from "@models" + export interface CreateApplicationMethodDTO { - type: ApplicationMethodType - target_type: ApplicationMethodTargetType - allocation?: ApplicationMethodAllocation - value?: number - promotion: PromotionDTO | string - max_quantity?: number + type: ApplicationMethodTypeValues + target_type: ApplicationMethodTargetTypeValues + allocation?: ApplicationMethodAllocationValues + value?: string | null + promotion: Promotion | string | PromotionDTO + max_quantity?: number | null } export interface UpdateApplicationMethodDTO { id: string + type?: ApplicationMethodTypeValues + target_type?: ApplicationMethodTargetTypeValues + allocation?: ApplicationMethodAllocationValues + value?: string | null + promotion?: Promotion | string | PromotionDTO + max_quantity?: number | null } diff --git a/packages/promotion/src/types/promotion.ts b/packages/promotion/src/types/promotion.ts index 835f82df1b95f..502e4fdd60633 100644 --- a/packages/promotion/src/types/promotion.ts +++ b/packages/promotion/src/types/promotion.ts @@ -8,4 +8,8 @@ export interface CreatePromotionDTO { export interface UpdatePromotionDTO { id: string + code?: string + // TODO: add this when buyget is available + // type: PromotionType + is_automatic?: boolean } diff --git a/packages/promotion/src/utils/validations/application-method.ts b/packages/promotion/src/utils/validations/application-method.ts index 99e193a3877bc..75dc0275a0e1b 100644 --- a/packages/promotion/src/utils/validations/application-method.ts +++ b/packages/promotion/src/utils/validations/application-method.ts @@ -1,44 +1,86 @@ +import { + ApplicationMethodAllocationValues, + ApplicationMethodTargetTypeValues, + ApplicationMethodTypeValues, +} from "@medusajs/types" import { ApplicationMethodAllocation, ApplicationMethodTargetType, + ApplicationMethodType, MedusaError, isDefined, } from "@medusajs/utils" -import { CreateApplicationMethodDTO } from "../../types" -const allowedTargetTypes: string[] = [ +export const allowedAllocationTargetTypes: string[] = [ ApplicationMethodTargetType.SHIPPING, ApplicationMethodTargetType.ITEM, ] -const allowedAllocationTypes: string[] = [ +export const allowedAllocationTypes: string[] = [ ApplicationMethodAllocation.ACROSS, ApplicationMethodAllocation.EACH, ] -const allowedAllocationForQuantity: string[] = [ +export const allowedAllocationForQuantity: string[] = [ ApplicationMethodAllocation.EACH, ] -export function validateApplicationMethodAttributes( - data: CreateApplicationMethodDTO -) { +export function validateApplicationMethodAttributes(data: { + type: ApplicationMethodTypeValues + target_type: ApplicationMethodTargetTypeValues + allocation?: ApplicationMethodAllocationValues + max_quantity?: number | null +}) { + const allTargetTypes: string[] = Object.values(ApplicationMethodTargetType) + + if (!allTargetTypes.includes(data.target_type)) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + `application_method.target_type should be one of ${allTargetTypes.join( + ", " + )}` + ) + } + + const allTypes: string[] = Object.values(ApplicationMethodType) + + if (!allTypes.includes(data.type)) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + `application_method.type should be one of ${allTypes.join(", ")}` + ) + } + if ( - allowedTargetTypes.includes(data.target_type) && + allowedAllocationTargetTypes.includes(data.target_type) && !allowedAllocationTypes.includes(data.allocation || "") ) { throw new MedusaError( MedusaError.Types.INVALID_DATA, `application_method.allocation should be either '${allowedAllocationTypes.join( " OR " - )}' when application_method.target_type is either '${allowedTargetTypes.join( + )}' when application_method.target_type is either '${allowedAllocationTargetTypes.join( " OR " )}'` ) } + const allAllocationTypes: string[] = Object.values( + ApplicationMethodAllocation + ) + + if (data.allocation && !allAllocationTypes.includes(data.allocation)) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + `application_method.allocation should be one of ${allAllocationTypes.join( + ", " + )}` + ) + } + if ( - allowedAllocationForQuantity.includes(data.allocation || "") && + data.allocation && + allowedAllocationForQuantity.includes(data.allocation) && !isDefined(data.max_quantity) ) { throw new MedusaError( diff --git a/packages/types/src/promotion/common/application-method.ts b/packages/types/src/promotion/common/application-method.ts index a288e2fa6bfde..c5ce5a2d2a19e 100644 --- a/packages/types/src/promotion/common/application-method.ts +++ b/packages/types/src/promotion/common/application-method.ts @@ -1,33 +1,46 @@ import { BaseFilterable } from "../../dal" import { PromotionDTO } from "./promotion" -import { CreatePromotionRuleDTO } from "./promotion-rule" +import { CreatePromotionRuleDTO, PromotionRuleDTO } from "./promotion-rule" -export type ApplicationMethodType = "fixed" | "percentage" -export type ApplicationMethodTargetType = "order" | "shipping" | "item" -export type ApplicationMethodAllocation = "each" | "across" +export type ApplicationMethodTypeValues = "fixed" | "percentage" +export type ApplicationMethodTargetTypeValues = "order" | "shipping" | "item" +export type ApplicationMethodAllocationValues = "each" | "across" export interface ApplicationMethodDTO { id: string + type?: ApplicationMethodTypeValues + target_type?: ApplicationMethodTargetTypeValues + allocation?: ApplicationMethodAllocationValues + value?: string | null + max_quantity?: number | null + promotion?: PromotionDTO | string + target_rules?: PromotionRuleDTO[] } export interface CreateApplicationMethodDTO { - type: ApplicationMethodType - target_type: ApplicationMethodTargetType - allocation?: ApplicationMethodAllocation - value?: number - max_quantity?: number + type: ApplicationMethodTypeValues + target_type: ApplicationMethodTargetTypeValues + allocation?: ApplicationMethodAllocationValues + value?: string | null + max_quantity?: number | null promotion?: PromotionDTO | string target_rules?: CreatePromotionRuleDTO[] } export interface UpdateApplicationMethodDTO { id: string + type?: ApplicationMethodTypeValues + target_type?: ApplicationMethodTargetTypeValues + allocation?: ApplicationMethodAllocationValues + value?: string | null + max_quantity?: number | null + promotion?: PromotionDTO | string } export interface FilterableApplicationMethodProps extends BaseFilterable { id?: string[] - type?: ApplicationMethodType[] - target_type?: ApplicationMethodTargetType[] - allocation?: ApplicationMethodAllocation[] + type?: ApplicationMethodTypeValues[] + target_type?: ApplicationMethodTargetTypeValues[] + allocation?: ApplicationMethodAllocationValues[] } diff --git a/packages/types/src/promotion/common/promotion-rule.ts b/packages/types/src/promotion/common/promotion-rule.ts index 4b5b5fb4bc77e..98adedc37f262 100644 --- a/packages/types/src/promotion/common/promotion-rule.ts +++ b/packages/types/src/promotion/common/promotion-rule.ts @@ -24,6 +24,10 @@ export interface UpdatePromotionRuleDTO { id: string } +export interface RemovePromotionRuleDTO { + id: string +} + export interface FilterablePromotionRuleProps extends BaseFilterable { id?: string[] diff --git a/packages/types/src/promotion/common/promotion.ts b/packages/types/src/promotion/common/promotion.ts index e2dd6834f5a33..7fbbef439e29d 100644 --- a/packages/types/src/promotion/common/promotion.ts +++ b/packages/types/src/promotion/common/promotion.ts @@ -1,11 +1,19 @@ import { BaseFilterable } from "../../dal" -import { CreateApplicationMethodDTO } from "./application-method" +import { + ApplicationMethodDTO, + CreateApplicationMethodDTO, + UpdateApplicationMethodDTO, +} from "./application-method" import { CreatePromotionRuleDTO } from "./promotion-rule" export type PromotionType = "standard" | "buyget" export interface PromotionDTO { id: string + code?: string + type?: PromotionType + is_automatic?: boolean + application_method?: ApplicationMethodDTO } export interface CreatePromotionDTO { @@ -18,6 +26,10 @@ export interface CreatePromotionDTO { export interface UpdatePromotionDTO { id: string + is_automatic?: boolean + code?: string + type?: PromotionType + application_method?: UpdateApplicationMethodDTO } export interface FilterablePromotionProps diff --git a/packages/types/src/promotion/service.ts b/packages/types/src/promotion/service.ts index dbbba24ffa2c5..cacda1faa517c 100644 --- a/packages/types/src/promotion/service.ts +++ b/packages/types/src/promotion/service.ts @@ -3,8 +3,11 @@ import { IModuleService } from "../modules-sdk" import { Context } from "../shared-context" import { CreatePromotionDTO, + CreatePromotionRuleDTO, FilterablePromotionProps, PromotionDTO, + RemovePromotionRuleDTO, + UpdatePromotionDTO, } from "./common" export interface IPromotionModuleService extends IModuleService { @@ -13,9 +16,46 @@ export interface IPromotionModuleService extends IModuleService { sharedContext?: Context ): Promise + update( + data: UpdatePromotionDTO[], + sharedContext?: Context + ): Promise + list( filters?: FilterablePromotionProps, config?: FindConfig, sharedContext?: Context ): Promise + + retrieve( + id: string, + config?: FindConfig, + sharedContext?: Context + ): Promise + + delete(ids: string[], sharedContext?: Context): Promise + + addPromotionRules( + promotionId: string, + rulesData: CreatePromotionRuleDTO[], + sharedContext?: Context + ): Promise + + addPromotionTargetRules( + promotionId: string, + rulesData: CreatePromotionRuleDTO[], + sharedContext?: Context + ): Promise + + removePromotionRules( + promotionId: string, + rulesData: RemovePromotionRuleDTO[], + sharedContext?: Context + ): Promise + + removePromotionTargetRules( + promotionId: string, + rulesData: RemovePromotionRuleDTO[], + sharedContext?: Context + ): Promise } From b57ad67d2fab957d262062956a2887ae44a1f9ba Mon Sep 17 00:00:00 2001 From: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Date: Fri, 5 Jan 2024 18:32:36 +0100 Subject: [PATCH 6/9] feat(cart): Data models (#5986) **What** Adds Cart Module data models --- packages/cart/src/models/address.ts | 82 +++++++++ packages/cart/src/models/adjustment-line.ts | 45 +++++ packages/cart/src/models/cart.ts | 122 ++++++++++++- packages/cart/src/models/index.ts | 11 +- .../src/models/line-item-adjustment-line.ts | 28 +++ .../cart/src/models/line-item-tax-line.ts | 23 +++ packages/cart/src/models/line-item.ts | 169 ++++++++++++++++++ .../models/shipping-method-adjustment-line.ts | 23 +++ .../src/models/shipping-method-tax-line.ts | 23 +++ packages/cart/src/models/shipping-method.ts | 108 +++++++++++ packages/cart/src/models/tax-line.ts | 40 +++++ 11 files changed, 670 insertions(+), 4 deletions(-) create mode 100644 packages/cart/src/models/address.ts create mode 100644 packages/cart/src/models/adjustment-line.ts create mode 100644 packages/cart/src/models/line-item-adjustment-line.ts create mode 100644 packages/cart/src/models/line-item-tax-line.ts create mode 100644 packages/cart/src/models/line-item.ts create mode 100644 packages/cart/src/models/shipping-method-adjustment-line.ts create mode 100644 packages/cart/src/models/shipping-method-tax-line.ts create mode 100644 packages/cart/src/models/shipping-method.ts create mode 100644 packages/cart/src/models/tax-line.ts diff --git a/packages/cart/src/models/address.ts b/packages/cart/src/models/address.ts new file mode 100644 index 0000000000000..a603018efad1e --- /dev/null +++ b/packages/cart/src/models/address.ts @@ -0,0 +1,82 @@ +import { DAL } from "@medusajs/types" +import { generateEntityId } from "@medusajs/utils" +import { + BeforeCreate, + Entity, + OnInit, + OptionalProps, + PrimaryKey, + Property +} from "@mikro-orm/core" + + +type OptionalAddressProps = DAL.EntityDateColumns // TODO: To be revisited when more clear + +@Entity({ tableName: "cart_address" }) +export default class Address { + [OptionalProps]: OptionalAddressProps + + @PrimaryKey({ columnType: "text" }) + id!: string + + @Property({ columnType: "text", nullable: true }) + customer_id?: string | null + + @Property({ columnType: "text", nullable: true }) + company?: string | null + + @Property({ columnType: "text", nullable: true }) + first_name?: string | null + + @Property({ columnType: "text", nullable: true }) + last_name?: string | null + + @Property({ columnType: "text", nullable: true }) + address_1?: string | null + + @Property({ columnType: "text", nullable: true }) + address_2?: string | null + + @Property({ columnType: "text", nullable: true }) + city?: string | null + + @Property({ columnType: "text", nullable: true }) + country_code?: string | null + + @Property({ columnType: "text", nullable: true }) + province?: string | null + + @Property({ columnType: "text", nullable: true }) + postal_code?: string | null + + @Property({ columnType: "text", nullable: true }) + phone?: string | null + + @Property({ columnType: "jsonb", nullable: true }) + metadata?: Record | null + + @Property({ + onCreate: () => new Date(), + columnType: "timestamptz", + defaultRaw: "now()", + }) + created_at: Date + + @Property({ + onCreate: () => new Date(), + onUpdate: () => new Date(), + columnType: "timestamptz", + defaultRaw: "now()", + }) + updated_at: Date + + @BeforeCreate() + onCreate() { + this.id = generateEntityId(this.id, "caaddr") + } + + @OnInit() + onInit() { + this.id = generateEntityId(this.id, "caaddr") + } +} diff --git a/packages/cart/src/models/adjustment-line.ts b/packages/cart/src/models/adjustment-line.ts new file mode 100644 index 0000000000000..4b714542a7237 --- /dev/null +++ b/packages/cart/src/models/adjustment-line.ts @@ -0,0 +1,45 @@ +import { DAL } from "@medusajs/types" +import { OptionalProps, PrimaryKey, Property } from "@mikro-orm/core" + +type OptionalAdjustmentLineProps = DAL.EntityDateColumns // TODO: To be revisited when more clear + +/** + * As per the Mikro ORM docs, superclasses should use the abstract class definition + * Source: https://mikro-orm.io/docs/inheritance-mapping + */ +export default abstract class AdjustmentLine { + [OptionalProps]: OptionalAdjustmentLineProps + + @PrimaryKey({ columnType: "text" }) + id: string + + @Property({ columnType: "text", nullable: true }) + description?: string | null + + @Property({ columnType: "text", nullable: true }) + promotion_id?: string | null + + @Property({ columnType: "text" }) + code: string + + @Property({ columnType: "numeric" }) + amount: number + + @Property({ columnType: "text", nullable: true }) + provider_id?: string | null + + @Property({ + onCreate: () => new Date(), + columnType: "timestamptz", + defaultRaw: "now()", + }) + created_at: Date + + @Property({ + onCreate: () => new Date(), + onUpdate: () => new Date(), + columnType: "timestamptz", + defaultRaw: "now()", + }) + updated_at: Date +} diff --git a/packages/cart/src/models/cart.ts b/packages/cart/src/models/cart.ts index 50e2c12dc7ef0..2e816919a4b8a 100644 --- a/packages/cart/src/models/cart.ts +++ b/packages/cart/src/models/cart.ts @@ -1,10 +1,126 @@ +import { DAL } from "@medusajs/types" import { generateEntityId } from "@medusajs/utils" -import { BeforeCreate, Entity, OnInit, PrimaryKey } from "@mikro-orm/core" +import { + BeforeCreate, + Cascade, + Collection, + Entity, + OnInit, + OneToMany, + OneToOne, + PrimaryKey, + Property, +} from "@mikro-orm/core" +import Address from "./address" +import LineItem from "./line-item" +import ShippingMethod from "./shipping-method" -@Entity() +type OptionalCartProps = + | "shipping_address" + | "billing_address" + | DAL.EntityDateColumns // TODO: To be revisited when more clear + +@Entity({ tableName: "cart" }) export default class Cart { @PrimaryKey({ columnType: "text" }) - id!: string + id: string + + @Property({ columnType: "text", nullable: true }) + region_id?: string | null + + @Property({ + columnType: "text", + nullable: true, + index: "IDX_cart_customer_id", + }) + customer_id?: string | null + + @Property({ columnType: "text", nullable: true }) + sales_channel_id?: string | null + + @Property({ columnType: "text", nullable: true }) + email?: string | null + + @Property({ columnType: "text" }) + currency_code: string + + @OneToOne({ + entity: () => Address, + joinColumn: "shipping_address_id", + cascade: [Cascade.REMOVE], + nullable: true, + }) + shipping_address?: Address | null + + @OneToOne({ + entity: () => Address, + joinColumn: "billing_address_id", + cascade: [Cascade.REMOVE], + nullable: true, + }) + billing_address?: Address | null + + @Property({ columnType: "jsonb", nullable: true }) + metadata?: Record | null + + @OneToMany(() => LineItem, (lineItem) => lineItem.cart, { + orphanRemoval: true, + }) + items = new Collection(this) + + @OneToMany(() => ShippingMethod, (shippingMethod) => shippingMethod.cart, { + orphanRemoval: true, + }) + shipping_methods = new Collection(this) + + /** COMPUTED PROPERTIES - START */ + + // compare_at_item_total?: number + // compare_at_item_subtotal?: number + // compare_at_item_tax_total?: number + + // original_item_total: number + // original_item_subtotal: number + // original_item_tax_total: number + + // item_total: number + // item_subtotal: number + // item_tax_total: number + + // original_total: number + // original_subtotal: number + // original_tax_total: number + + // total: number + // subtotal: number + // tax_total: number + // discount_total: number + // discount_tax_total: number + + // shipping_total: number + // shipping_subtotal: number + // shipping_tax_total: number + + // original_shipping_total: number + // original_shipping_subtotal: number + // original_shipping_tax_total: number + + /** COMPUTED PROPERTIES - END */ + + @Property({ + onCreate: () => new Date(), + columnType: "timestamptz", + defaultRaw: "now()", + }) + created_at: Date + + @Property({ + onCreate: () => new Date(), + onUpdate: () => new Date(), + columnType: "timestamptz", + defaultRaw: "now()", + }) + updated_at: Date @BeforeCreate() onCreate() { diff --git a/packages/cart/src/models/index.ts b/packages/cart/src/models/index.ts index 434874897e1bb..d83594ffc2857 100644 --- a/packages/cart/src/models/index.ts +++ b/packages/cart/src/models/index.ts @@ -1,2 +1,11 @@ -export { default as Cart } from "./cart"; +export { default as Address } from "./address" +export { default as AdjustmentLine } from "./adjustment-line" +export { default as Cart } from "./cart" +export { default as LineItem } from "./line-item" +export { default as LineItemAdjustmentLine } from "./line-item-adjustment-line" +export { default as LineItemTaxLine } from "./line-item-tax-line" +export { default as ShippingMethod } from "./shipping-method" +export { default as ShippingMethodAdjustmentLine } from "./shipping-method-adjustment-line" +export { default as ShippingMethodTaxLine } from "./shipping-method-tax-line" +export { default as TaxLine } from "./tax-line" diff --git a/packages/cart/src/models/line-item-adjustment-line.ts b/packages/cart/src/models/line-item-adjustment-line.ts new file mode 100644 index 0000000000000..b26250fdd47a6 --- /dev/null +++ b/packages/cart/src/models/line-item-adjustment-line.ts @@ -0,0 +1,28 @@ +import { generateEntityId } from "@medusajs/utils" +import { + BeforeCreate, + Entity, + ManyToOne, + OnInit +} from "@mikro-orm/core" +import AdjustmentLine from "./adjustment-line" +import LineItem from "./line-item" + +@Entity({ tableName: "cart_line_item_adjustment_line" }) +export default class LineItemAdjustmentLine extends AdjustmentLine { + @ManyToOne(() => LineItem, { + joinColumn: "line_item", + fieldName: "line_item_id", + }) + line_item: LineItem + + @BeforeCreate() + onCreate() { + this.id = generateEntityId(this.id, "caliadj") + } + + @OnInit() + onInit() { + this.id = generateEntityId(this.id, "caliadj") + } +} diff --git a/packages/cart/src/models/line-item-tax-line.ts b/packages/cart/src/models/line-item-tax-line.ts new file mode 100644 index 0000000000000..7fa461d87c204 --- /dev/null +++ b/packages/cart/src/models/line-item-tax-line.ts @@ -0,0 +1,23 @@ +import { generateEntityId } from "@medusajs/utils" +import { BeforeCreate, Entity, ManyToOne, OnInit } from "@mikro-orm/core" +import LineItem from "./line-item" +import TaxLine from "./tax-line" + +@Entity({ tableName: "cart_line_item_tax_line" }) +export default class LineItemTaxLine extends TaxLine { + @ManyToOne(() => LineItem, { + joinColumn: "line_item", + fieldName: "line_item_id", + }) + line_item: LineItem + + @BeforeCreate() + onCreate() { + this.id = generateEntityId(this.id, "calitxl") + } + + @OnInit() + onInit() { + this.id = generateEntityId(this.id, "calitxl") + } +} diff --git a/packages/cart/src/models/line-item.ts b/packages/cart/src/models/line-item.ts new file mode 100644 index 0000000000000..de5f50b2571b1 --- /dev/null +++ b/packages/cart/src/models/line-item.ts @@ -0,0 +1,169 @@ +import { DAL } from "@medusajs/types" +import { generateEntityId } from "@medusajs/utils" +import { + BeforeCreate, + Cascade, + Check, + Collection, + Entity, + ManyToOne, + OnInit, + OneToMany, + OptionalProps, + PrimaryKey, + Property +} from "@mikro-orm/core" +import Cart from "./cart" +import LineItemAdjustmentLine from "./line-item-adjustment-line" +import LineItemTaxLine from "./line-item-tax-line" + +type OptionalLineItemProps = + | "is_discoutable" + | "is_tax_inclusive" + | "compare_at_unit_price" + | "requires_shipping" + | DAL.EntityDateColumns + +@Entity({ tableName: "cart_line_item" }) +export default class LineItem { + [OptionalProps]?: OptionalLineItemProps + + @PrimaryKey({ columnType: "text" }) + id: string + + @ManyToOne(() => Cart, { + onDelete: "cascade", + index: "IDX_line_item_cart_id", + fieldName: "cart_id", + }) + cart!: Cart + + @Property({ columnType: "text" }) + title: string + + @Property({ columnType: "text", nullable: true }) + subtitle: string | null + + @Property({ columnType: "text", nullable: true }) + thumbnail?: string | null + + @Property({ columnType: "text" }) + quantity: number + + @Property({ + columnType: "text", + nullable: true, + index: "IDX_line_item_variant_id", + }) + variant_id?: string | null + + @Property({ columnType: "text", nullable: true }) + product_id?: string | null + + @Property({ columnType: "text", nullable: true }) + product_title?: string | null + + @Property({ columnType: "text", nullable: true }) + product_description?: string | null + + @Property({ columnType: "text", nullable: true }) + product_subtitle?: string | null + + @Property({ columnType: "text", nullable: true }) + product_type?: string | null + + @Property({ columnType: "text", nullable: true }) + product_collection?: string | null + + @Property({ columnType: "text", nullable: true }) + product_handle?: string | null + + @Property({ columnType: "text", nullable: true }) + variant_sku?: string | null + + @Property({ columnType: "text", nullable: true }) + variant_barcode?: string | null + + @Property({ columnType: "text", nullable: true }) + variant_title?: string | null + + @Property({ columnType: "jsonb", nullable: true }) + variant_option_values?: Record | null + + @Property({ columnType: "boolean" }) + requires_shipping = true + + @Property({ columnType: "boolean" }) + is_discountable = true + + @Property({ columnType: "boolean" }) + is_tax_inclusive = false + + @Property({ columnType: "numeric", nullable: true }) + compare_at_unit_price?: number + + @Property({ columnType: "numeric", serializer: Number }) + @Check({ expression: "unit_price >= 0" }) // TODO: Validate that numeric types work with the expression + unit_price: number + + @OneToMany(() => LineItemTaxLine, (taxLine) => taxLine.line_item, { + cascade: [Cascade.REMOVE], + }) + tax_lines = new Collection(this) + + @OneToMany( + () => LineItemAdjustmentLine, + (adjustment) => adjustment.line_item, + { + cascade: [Cascade.REMOVE], + } + ) + adjustments = new Collection(this) + + /** COMPUTED PROPERTIES - START */ + + // compare_at_total?: number + // compare_at_subtotal?: number + // compare_at_tax_total?: number + + // original_total: number + // original_subtotal: number + // original_tax_total: number + + // item_total: number + // item_subtotal: number + // item_tax_total: number + + // total: number + // subtotal: number + // tax_total: number + // discount_total: number + // discount_tax_total: number + + /** COMPUTED PROPERTIES - END */ + + @Property({ + onCreate: () => new Date(), + columnType: "timestamptz", + defaultRaw: "now()", + }) + created_at: Date + + @Property({ + onCreate: () => new Date(), + onUpdate: () => new Date(), + columnType: "timestamptz", + defaultRaw: "now()", + }) + updated_at: Date + + @BeforeCreate() + onCreate() { + this.id = generateEntityId(this.id, "cali") + } + + @OnInit() + onInit() { + this.id = generateEntityId(this.id, "cali") + } +} diff --git a/packages/cart/src/models/shipping-method-adjustment-line.ts b/packages/cart/src/models/shipping-method-adjustment-line.ts new file mode 100644 index 0000000000000..e56e82313ab1d --- /dev/null +++ b/packages/cart/src/models/shipping-method-adjustment-line.ts @@ -0,0 +1,23 @@ +import { generateEntityId } from "@medusajs/utils" +import { BeforeCreate, Entity, ManyToOne, OnInit } from "@mikro-orm/core" +import AdjustmentLine from "./adjustment-line" +import ShippingMethod from "./shipping-method" + +@Entity({ tableName: "cart_shipping_method_adjustment_line" }) +export default class ShippingMethodAdjustmentLine extends AdjustmentLine { + @ManyToOne(() => ShippingMethod, { + joinColumn: "shipping_method", + fieldName: "shipping_method_id", + }) + shipping_method: ShippingMethod + + @BeforeCreate() + onCreate() { + this.id = generateEntityId(this.id, "casmadj") + } + + @OnInit() + onInit() { + this.id = generateEntityId(this.id, "casmadj") + } +} diff --git a/packages/cart/src/models/shipping-method-tax-line.ts b/packages/cart/src/models/shipping-method-tax-line.ts new file mode 100644 index 0000000000000..5d726936500ba --- /dev/null +++ b/packages/cart/src/models/shipping-method-tax-line.ts @@ -0,0 +1,23 @@ +import { generateEntityId } from "@medusajs/utils" +import { BeforeCreate, Entity, ManyToOne, OnInit } from "@mikro-orm/core" +import ShippingMethod from "./shipping-method" +import TaxLine from "./tax-line" + +@Entity({ tableName: "cart_shipping_method_tax_line" }) +export default class ShippingMethodTaxLine extends TaxLine { + @ManyToOne(() => ShippingMethod, { + joinColumn: "shipping_method", + fieldName: "shipping_method_id", + }) + shipping_method: ShippingMethod + + @BeforeCreate() + onCreate() { + this.id = generateEntityId(this.id, "casmtxl") + } + + @OnInit() + onInit() { + this.id = generateEntityId(this.id, "casmtxl") + } +} diff --git a/packages/cart/src/models/shipping-method.ts b/packages/cart/src/models/shipping-method.ts new file mode 100644 index 0000000000000..084bec89a666c --- /dev/null +++ b/packages/cart/src/models/shipping-method.ts @@ -0,0 +1,108 @@ +import { generateEntityId } from "@medusajs/utils" +import { + BeforeCreate, + Cascade, + Check, + Collection, + Entity, + ManyToOne, + OnInit, + OneToMany, + PrimaryKey, + Property, +} from "@mikro-orm/core" +import Cart from "./cart" +import ShippingMethodAdjustmentLine from "./shipping-method-adjustment-line" +import ShippingMethodTaxLine from "./shipping-method-tax-line" + +@Entity({ tableName: "cart_shipping_method" }) +export default class ShippingMethod { + @PrimaryKey({ columnType: "text" }) + id: string + + @ManyToOne(() => Cart, { + onDelete: "cascade", + index: "IDX_shipping_method_cart_id", + fieldName: "cart_id", + }) + cart: Cart + + @Property({ columnType: "text" }) + title: string + + @Property({ columnType: "jsonb", nullable: true }) + description?: string | null + + @Property({ columnType: "numeric", serializer: Number }) + @Check({ expression: "amount >= 0" }) // TODO: Validate that numeric types work with the expression + amount: number + + @Property({ columnType: "boolean" }) + tax_inclusive = false + + @Property({ columnType: "text", nullable: true }) + shipping_option_id?: string | null + + @Property({ columnType: "jsonb", nullable: true }) + data?: Record | null + + @Property({ columnType: "jsonb", nullable: true }) + metadata?: Record | null + + @OneToMany( + () => ShippingMethodTaxLine, + (taxLine) => taxLine.shipping_method, + { + cascade: [Cascade.REMOVE], + } + ) + tax_lines = new Collection(this) + + @OneToMany( + () => ShippingMethodAdjustmentLine, + (adjustment) => adjustment.shipping_method, + { + cascade: [Cascade.REMOVE], + } + ) + adjustments = new Collection(this) + + /** COMPUTED PROPERTIES - START */ + + // original_total: number + // original_subtotal: number + // original_tax_total: number + + // total: number + // subtotal: number + // tax_total: number + // discount_total: number + // discount_tax_total: number + + /** COMPUTED PROPERTIES - END */ + + @Property({ + onCreate: () => new Date(), + columnType: "timestamptz", + defaultRaw: "now()", + }) + created_at: Date + + @Property({ + onCreate: () => new Date(), + onUpdate: () => new Date(), + columnType: "timestamptz", + defaultRaw: "now()", + }) + updated_at: Date + + @BeforeCreate() + onCreate() { + this.id = generateEntityId(this.id, "casm") + } + + @OnInit() + onInit() { + this.id = generateEntityId(this.id, "casm") + } +} diff --git a/packages/cart/src/models/tax-line.ts b/packages/cart/src/models/tax-line.ts new file mode 100644 index 0000000000000..7a55a930c7bdb --- /dev/null +++ b/packages/cart/src/models/tax-line.ts @@ -0,0 +1,40 @@ +import { PrimaryKey, Property } from "@mikro-orm/core" + +/** + * As per the Mikro ORM docs, superclasses should use the abstract class definition + * Source: https://mikro-orm.io/docs/inheritance-mapping + */ +export default abstract class TaxLine { + @PrimaryKey({ columnType: "text" }) + id: string + + @Property({ columnType: "text", nullable: true }) + description?: string | null + + @Property({ columnType: "text", nullable: true }) + tax_rate_id?: string | null + + @Property({ columnType: "text" }) + code: string + + @Property({ columnType: "numeric" }) + rate: number + + @Property({ columnType: "text", nullable: true }) + provider_id?: string | null + + @Property({ + onCreate: () => new Date(), + columnType: "timestamptz", + defaultRaw: "now()", + }) + created_at: Date + + @Property({ + onCreate: () => new Date(), + onUpdate: () => new Date(), + columnType: "timestamptz", + defaultRaw: "now()", + }) + updated_at: Date +} From 47be2ad7230966f9ce0f7afe5c845bf2abde5071 Mon Sep 17 00:00:00 2001 From: Adrien de Peretti Date: Sun, 7 Jan 2024 13:58:30 +0100 Subject: [PATCH 7/9] fix(medusa): Order by using joins and pagination (#5990) --- .changeset/sour-birds-build.md | 5 ++ .../api/__tests__/admin/sales-channels.js | 2 +- packages/medusa/src/repositories/product.ts | 2 +- packages/medusa/src/utils/repository.ts | 82 +++++++++++++++++-- 4 files changed, 80 insertions(+), 11 deletions(-) create mode 100644 .changeset/sour-birds-build.md diff --git a/.changeset/sour-birds-build.md b/.changeset/sour-birds-build.md new file mode 100644 index 0000000000000..a5fdda11077fc --- /dev/null +++ b/.changeset/sour-birds-build.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa": patch +--- + +fix(medusa): Ordering management using joins and pagination diff --git a/integration-tests/api/__tests__/admin/sales-channels.js b/integration-tests/api/__tests__/admin/sales-channels.js index 9340c65f9dc8a..15cd0d357ebbe 100644 --- a/integration-tests/api/__tests__/admin/sales-channels.js +++ b/integration-tests/api/__tests__/admin/sales-channels.js @@ -23,7 +23,7 @@ const adminReqConfig = { }, } -jest.setTimeout(50000) +jest.setTimeout(60000) describe("sales channels", () => { let medusaProcess diff --git a/packages/medusa/src/repositories/product.ts b/packages/medusa/src/repositories/product.ts index 37252b7e11ff2..11751b86f7bec 100644 --- a/packages/medusa/src/repositories/product.ts +++ b/packages/medusa/src/repositories/product.ts @@ -74,7 +74,7 @@ export const ProductRepository = dataSource.getRepository(Product).extend({ optionsWithoutRelations?.where?.discount_condition_id delete optionsWithoutRelations?.where?.discount_condition_id - return queryEntityWithoutRelations({ + return await queryEntityWithoutRelations({ repository: this, optionsWithoutRelations, shouldCount, diff --git a/packages/medusa/src/utils/repository.ts b/packages/medusa/src/utils/repository.ts index f7a4c8b70a328..f07fb8e53f068 100644 --- a/packages/medusa/src/utils/repository.ts +++ b/packages/medusa/src/utils/repository.ts @@ -150,11 +150,7 @@ export async function queryEntityWithoutRelations({ }): Promise<[T[], number]> { const alias = repository.metadata.name.toLowerCase() - const qb = repository - .createQueryBuilder(alias) - .select([`${alias}.id`]) - .skip(optionsWithoutRelations.skip) - .take(optionsWithoutRelations.take) + const qb = repository.createQueryBuilder(alias).select([`${alias}.id`]) if (optionsWithoutRelations.where) { qb.where(optionsWithoutRelations.where) @@ -189,14 +185,82 @@ export async function queryEntityWithoutRelations({ qb.withDeleted() } + /* + * Deduplicate tuples for join + ordering (e.g. variants.prices.amount) since typeorm doesnt + * know how to manage it by itself + */ + const expressionMapAllOrderBys = qb.expressionMap.allOrderBys + if ( + expressionMapAllOrderBys && + Object.keys(expressionMapAllOrderBys).length + ) { + const orderBysString = Object.keys(expressionMapAllOrderBys) + .map((column) => { + return `${column} ${expressionMapAllOrderBys[column]}` + }) + .join(", ") + + qb.addSelect( + `row_number() OVER (PARTITION BY ${alias}.id ORDER BY ${orderBysString}) AS rownum` + ) + } else { + qb.addSelect(`1 AS rownum`) + } + + /* + * In typeorm SelectQueryBuilder, the orderBy is removed from the original query when there is pagination + * and join involved together. + * + * This workaround allows us to include the order as part of the original query (including joins) before + * selecting the distinct ids of the main alias entity. The distinct ids deduplication + * is managed by the rownum column added to the select below. + * + * see: node_modules/typeorm/query-builder/SelectQueryBuilder.js(1973) + */ + const outerQb = new SelectQueryBuilder(qb.connection, (qb as any).queryRunner) + .select(`${qb.escape(`${alias}_id`)}`) + .from(`(${qb.getQuery()})`, alias) + .where(`${alias}.rownum = 1`) + .setParameters(qb.getParameters()) + .setNativeParameters(qb.expressionMap.nativeParameters) + .offset(optionsWithoutRelations.skip) + .limit(optionsWithoutRelations.take) + + const mapToEntities = (array: any) => { + return array.map((rawProduct) => ({ + id: rawProduct[`${alias}_id`], + })) as unknown as T[] + } + let entities: T[] let count = 0 if (shouldCount) { - const result = await promiseAll([qb.getMany(), qb.getCount()]) - entities = result[0] - count = result[1] + const outerQbCount = new SelectQueryBuilder( + qb.connection, + (qb as any).queryRunner + ) + .select(`COUNT(1)`, `count`) + .from(`(${qb.getQuery()})`, alias) + .where(`${alias}.rownum = 1`) + .setParameters(qb.getParameters()) + .setNativeParameters(qb.expressionMap.nativeParameters) + .orderBy() + .groupBy() + .offset(undefined) + .limit(undefined) + .skip(undefined) + .take(undefined) + + const result = await promiseAll([ + outerQb.getRawMany(), + outerQbCount.getRawOne(), + ]) + + entities = mapToEntities(result[0]) + count = Number(result[1].count) } else { - entities = await qb.getMany() + const result = await outerQb.getRawMany() + entities = mapToEntities(result) } return [entities, count] From 46d610bc555797df2ae81eb89b18faf1411b33b8 Mon Sep 17 00:00:00 2001 From: Mohamed Abusaid Date: Sun, 7 Jan 2024 13:33:40 +0000 Subject: [PATCH 8/9] feat(admin): Add Libya admin region and set Libya to formal name (#6001) --- .changeset/neat-suits-attack.md | 8 ++++++++ packages/admin-ui/ui/src/utils/countries.ts | 3 ++- packages/medusa-core-utils/src/countries.ts | 7 +------ packages/medusa/src/utils/countries.ts | 7 +------ 4 files changed, 12 insertions(+), 13 deletions(-) create mode 100644 .changeset/neat-suits-attack.md diff --git a/.changeset/neat-suits-attack.md b/.changeset/neat-suits-attack.md new file mode 100644 index 0000000000000..3cf8df1883714 --- /dev/null +++ b/.changeset/neat-suits-attack.md @@ -0,0 +1,8 @@ +--- +"@medusajs/medusa": patch +"@medusajs/admin-ui": patch +"@medusajs/admin": patch +"medusa-core-utils": patch +--- + +Add missing country in admin region and set Libya to formal name diff --git a/packages/admin-ui/ui/src/utils/countries.ts b/packages/admin-ui/ui/src/utils/countries.ts index 75467867272fc..0424f5a930024 100644 --- a/packages/admin-ui/ui/src/utils/countries.ts +++ b/packages/admin-ui/ui/src/utils/countries.ts @@ -122,7 +122,7 @@ export const isoAlpha2Countries = { LB: "Lebanon", LS: "Lesotho", LR: "Liberia", - LY: "Libyan Arab Jamahiriya", + LY: "Libya", LI: "Liechtenstein", LT: "Lithuania", LU: "Luxembourg", @@ -414,6 +414,7 @@ export const countries = [ { alpha2: "LB", name: "Lebanon", alpha3: "LBN", numeric: "422" }, { alpha2: "LS", name: "Lesotho", alpha3: "LSO", numeric: "426" }, { alpha2: "LR", name: "Liberia", alpha3: "LBR", numeric: "430" }, + { alpha2: "LY", name: "Libya", alpha3: "LBY", numeric: "434" }, { alpha2: "LI", name: "Liechtenstein", alpha3: "LIE", numeric: "438" }, { alpha2: "LT", name: "Lithuania", alpha3: "LTU", numeric: "440" }, { alpha2: "LU", name: "Luxembourg", alpha3: "LUX", numeric: "442" }, diff --git a/packages/medusa-core-utils/src/countries.ts b/packages/medusa-core-utils/src/countries.ts index 44f5f76b40308..edd587e1edad1 100644 --- a/packages/medusa-core-utils/src/countries.ts +++ b/packages/medusa-core-utils/src/countries.ts @@ -197,12 +197,7 @@ export const countries: Country[] = [ { alpha2: "LB", name: "Lebanon", alpha3: "LBN", numeric: "422" }, { alpha2: "LS", name: "Lesotho", alpha3: "LSO", numeric: "426" }, { alpha2: "LR", name: "Liberia", alpha3: "LBR", numeric: "430" }, - { - alpha2: "LY", - name: "Libyan Arab Jamahiriya", - alpha3: "LBY", - numeric: "434", - }, + { alpha2: "LY", name: "Libya", alpha3: "LBY", numeric: "434" }, { alpha2: "LI", name: "Liechtenstein", alpha3: "LIE", numeric: "438" }, { alpha2: "LT", name: "Lithuania", alpha3: "LTU", numeric: "440" }, { alpha2: "LU", name: "Luxembourg", alpha3: "LUX", numeric: "442" }, diff --git a/packages/medusa/src/utils/countries.ts b/packages/medusa/src/utils/countries.ts index 3ca7aed34f074..c388984016200 100644 --- a/packages/medusa/src/utils/countries.ts +++ b/packages/medusa/src/utils/countries.ts @@ -197,12 +197,7 @@ export const countries: Country[] = [ { alpha2: "LB", name: "Lebanon", alpha3: "LBN", numeric: "422" }, { alpha2: "LS", name: "Lesotho", alpha3: "LSO", numeric: "426" }, { alpha2: "LR", name: "Liberia", alpha3: "LBR", numeric: "430" }, - { - alpha2: "LY", - name: "Libyan Arab Jamahiriya", - alpha3: "LBY", - numeric: "434", - }, + { alpha2: "LY", name: "Libya", alpha3: "LBY", numeric: "434" }, { alpha2: "LI", name: "Liechtenstein", alpha3: "LIE", numeric: "438" }, { alpha2: "LT", name: "Lithuania", alpha3: "LTU", numeric: "440" }, { alpha2: "LU", name: "Luxembourg", alpha3: "LUX", numeric: "442" }, From 6b0b3fed7a3fb18c8f781eb08b7549317dcbfaeb Mon Sep 17 00:00:00 2001 From: Sajarin M Date: Sun, 7 Jan 2024 19:07:32 +0530 Subject: [PATCH 9/9] fix(medusa): Fix typo in discounts error message (#5853) --- .changeset/forty-rules-fix.md | 5 +++++ packages/medusa/src/services/__tests__/discount.js | 2 +- packages/medusa/src/services/discount.ts | 2 +- 3 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 .changeset/forty-rules-fix.md diff --git a/.changeset/forty-rules-fix.md b/.changeset/forty-rules-fix.md new file mode 100644 index 0000000000000..be420056927fb --- /dev/null +++ b/.changeset/forty-rules-fix.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa": patch +--- + +Fix typo in discounts error message diff --git a/packages/medusa/src/services/__tests__/discount.js b/packages/medusa/src/services/__tests__/discount.js index 58ade91a5e7e5..107028d836f74 100644 --- a/packages/medusa/src/services/__tests__/discount.js +++ b/packages/medusa/src/services/__tests__/discount.js @@ -75,7 +75,7 @@ describe("DiscountService", () => { .catch((e) => e) expect(err.type).toEqual("invalid_data") - expect(err.message).toEqual("Discount must have atleast 1 region") + expect(err.message).toEqual("Discount must have at least 1 region") expect(discountRepository.create).toHaveBeenCalledTimes(0) }) diff --git a/packages/medusa/src/services/discount.ts b/packages/medusa/src/services/discount.ts index 5bc90eb67a481..039e6db3f1461 100644 --- a/packages/medusa/src/services/discount.ts +++ b/packages/medusa/src/services/discount.ts @@ -210,7 +210,7 @@ class DiscountService extends TransactionBaseService { if (!discount.regions?.length) { throw new MedusaError( MedusaError.Types.INVALID_DATA, - "Discount must have atleast 1 region" + "Discount must have at least 1 region" ) }